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 doesn't have any options. It reads
1701 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1702 installed) to get the current CPU frequency. If this file does not exist make
1703 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1704 installed and an "cpu governor" (that's a kernel module) is loaded.
1706 =head2 Plugin C<cpusleep>
1708 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1709 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1710 BOOTTIME clock increments while device is suspended and MONOTONIC
1711 clock does not, the derivative of the difference between these clocks
1712 gives the relative amount of time the device has spent in suspend
1713 state. The recorded value is in milliseconds of sleep per seconds of
1716 =head2 Plugin C<csv>
1720 =item B<DataDir> I<Directory>
1722 Set the directory to store CSV-files under. Per default CSV-files are generated
1723 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1724 The special strings B<stdout> and B<stderr> can be used to write to the standard
1725 output and standard error channels, respectively. This, of course, only makes
1726 much sense when collectd is running in foreground- or non-daemon-mode.
1728 =item B<StoreRates> B<true|false>
1730 If set to B<true>, convert counter values to rates. If set to B<false> (the
1731 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1736 =head2 cURL Statistics
1738 All cURL-based plugins support collection of generic, request-based
1739 statistics. These are disabled by default and can be enabled selectively for
1740 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1741 the documentation of those plugins for specific information. This section
1742 describes the available metrics that can be configured for each plugin. All
1743 options are disabled by default.
1745 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1749 =item B<TotalTime> B<true|false>
1751 Total time of the transfer, including name resolving, TCP connect, etc.
1753 =item B<NamelookupTime> B<true|false>
1755 Time it took from the start until name resolving was completed.
1757 =item B<ConnectTime> B<true|false>
1759 Time it took from the start until the connect to the remote host (or proxy)
1762 =item B<AppconnectTime> B<true|false>
1764 Time it took from the start until the SSL/SSH connect/handshake to the remote
1767 =item B<PretransferTime> B<true|false>
1769 Time it took from the start until just before the transfer begins.
1771 =item B<StarttransferTime> B<true|false>
1773 Time it took from the start until the first byte was received.
1775 =item B<RedirectTime> B<true|false>
1777 Time it took for all redirection steps include name lookup, connect,
1778 pre-transfer and transfer before final transaction was started.
1780 =item B<RedirectCount> B<true|false>
1782 The total number of redirections that were actually followed.
1784 =item B<SizeUpload> B<true|false>
1786 The total amount of bytes that were uploaded.
1788 =item B<SizeDownload> B<true|false>
1790 The total amount of bytes that were downloaded.
1792 =item B<SpeedDownload> B<true|false>
1794 The average download speed that curl measured for the complete download.
1796 =item B<SpeedUpload> B<true|false>
1798 The average upload speed that curl measured for the complete upload.
1800 =item B<HeaderSize> B<true|false>
1802 The total size of all the headers received.
1804 =item B<RequestSize> B<true|false>
1806 The total size of the issued requests.
1808 =item B<ContentLengthDownload> B<true|false>
1810 The content-length of the download.
1812 =item B<ContentLengthUpload> B<true|false>
1814 The specified size of the upload.
1816 =item B<NumConnects> B<true|false>
1818 The number of new connections that were created to achieve the transfer.
1822 =head2 Plugin C<curl>
1824 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1825 and the match infrastructure (the same code used by the tail plugin) to use
1826 regular expressions with the received data.
1828 The following example will read the current value of AMD stock from Google's
1829 finance page and dispatch the value to collectd.
1832 <Page "stock_quotes">
1834 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1840 CACert "/path/to/ca.crt"
1841 Header "X-Custom-Header: foobar"
1844 MeasureResponseTime false
1845 MeasureResponseCode false
1848 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1849 DSType "GaugeAverage"
1850 # Note: `stock_value' is not a standard type.
1857 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1858 a web page and one or more "matches" to be performed on the returned data. The
1859 string argument to the B<Page> block is used as plugin instance.
1861 The following options are valid within B<Page> blocks:
1865 =item B<Plugin> I<Plugin>
1867 Use I<Plugin> as the plugin name when submitting values.
1868 Defaults to C<curl>.
1872 URL of the web site to retrieve. Since a regular expression will be used to
1873 extract information from this data, non-binary data is a big plus here ;)
1875 =item B<User> I<Name>
1877 Username to use if authorization is required to read the page.
1879 =item B<Password> I<Password>
1881 Password to use if authorization is required to read the page.
1883 =item B<Digest> B<true>|B<false>
1885 Enable HTTP digest authentication.
1887 =item B<VerifyPeer> B<true>|B<false>
1889 Enable or disable peer SSL certificate verification. See
1890 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1892 =item B<VerifyHost> B<true>|B<false>
1894 Enable or disable peer host name verification. If enabled, the plugin checks if
1895 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1896 matches the host name provided by the B<URL> option. If this identity check
1897 fails, the connection is aborted. Obviously, only works when connecting to a
1898 SSL enabled server. Enabled by default.
1900 =item B<CACert> I<file>
1902 File that holds one or more SSL certificates. If you want to use HTTPS you will
1903 possibly need this option. What CA certificates come bundled with C<libcurl>
1904 and are checked by default depends on the distribution you use.
1906 =item B<Header> I<Header>
1908 A HTTP header to add to the request. Multiple headers are added if this option
1909 is specified more than once.
1911 =item B<Post> I<Body>
1913 Specifies that the HTTP operation should be a POST instead of a GET. The
1914 complete data to be posted is given as the argument. This option will usually
1915 need to be accompanied by a B<Header> option to set an appropriate
1916 C<Content-Type> for the post body (e.g. to
1917 C<application/x-www-form-urlencoded>).
1919 =item B<MeasureResponseTime> B<true>|B<false>
1921 Measure response time for the request. If this setting is enabled, B<Match>
1922 blocks (see below) are optional. Disabled by default.
1924 Beware that requests will get aborted if they take too long to complete. Adjust
1925 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1928 This option is similar to enabling the B<TotalTime> statistic but it's
1929 measured by collectd instead of cURL.
1931 =item B<MeasureResponseCode> B<true>|B<false>
1933 Measure response code for the request. If this setting is enabled, B<Match>
1934 blocks (see below) are optional. Disabled by default.
1936 =item B<E<lt>StatisticsE<gt>>
1938 One B<Statistics> block can be used to specify cURL statistics to be collected
1939 for each request to the remote web site. See the section "cURL Statistics"
1940 above for details. If this setting is enabled, B<Match> blocks (see below) are
1943 =item B<E<lt>MatchE<gt>>
1945 One or more B<Match> blocks that define how to match information in the data
1946 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1947 used by the C<tail> plugin, so please see the documentation of the C<tail>
1948 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1949 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1952 =item B<Timeout> I<Milliseconds>
1954 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1955 milliseconds. By default, the configured B<Interval> is used to set the
1956 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1957 indefinitely. This legacy behaviour can be achieved by setting the value of
1960 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1961 network connection will stall one read thread. Adjust the B<ReadThreads> global
1962 setting accordingly to prevent this from blocking other plugins.
1966 =head2 Plugin C<curl_json>
1968 The B<curl_json plugin> collects values from JSON data to be parsed by
1969 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1970 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1971 unix socket. The former can be used, for example, to collect values
1972 from CouchDB documents (which are stored JSON notation), and the
1973 latter to collect values from a uWSGI stats socket.
1975 The following example will collect several values from the built-in
1976 C<_stats> runtime statistics module of I<CouchDB>
1977 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1980 <URL "http://localhost:5984/_stats">
1982 <Key "httpd/requests/count">
1983 Type "http_requests"
1986 <Key "httpd_request_methods/*/count">
1987 Type "http_request_methods"
1990 <Key "httpd_status_codes/*/count">
1991 Type "http_response_codes"
1996 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1999 <Sock "/var/run/uwsgi.stats.sock">
2001 <Key "workers/*/requests">
2002 Type "http_requests"
2005 <Key "workers/*/apps/*/requests">
2006 Type "http_requests"
2011 In the B<Plugin> block, there may be one or more B<URL> blocks, each
2012 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
2013 blocks defining a unix socket to read JSON from directly. Each of
2014 these blocks may have one or more B<Key> blocks.
2016 The B<Key> string argument must be in a path format. Each component is
2017 used to match the key from a JSON map or the index of an JSON
2018 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
2019 values for all map keys or array indices will be collectd.
2021 The following options are valid within B<URL> blocks:
2025 =item B<Host> I<Name>
2027 Use I<Name> as the host name when submitting values. Defaults to the global
2030 =item B<Plugin> I<Plugin>
2032 Use I<Plugin> as the plugin name when submitting values.
2033 Defaults to C<curl_json>.
2035 =item B<Instance> I<Instance>
2037 Sets the plugin instance to I<Instance>.
2039 =item B<Interval> I<Interval>
2041 Sets the interval (in seconds) in which the values will be collected from this
2042 URL. By default the global B<Interval> setting will be used.
2044 =item B<User> I<Name>
2046 =item B<Password> I<Password>
2048 =item B<Digest> B<true>|B<false>
2050 =item B<VerifyPeer> B<true>|B<false>
2052 =item B<VerifyHost> B<true>|B<false>
2054 =item B<CACert> I<file>
2056 =item B<Header> I<Header>
2058 =item B<Post> I<Body>
2060 =item B<Timeout> I<Milliseconds>
2062 These options behave exactly equivalent to the appropriate options of the
2063 I<cURL> plugin. Please see there for a detailed description.
2065 =item B<E<lt>StatisticsE<gt>>
2067 One B<Statistics> block can be used to specify cURL statistics to be collected
2068 for each request to the remote URL. See the section "cURL Statistics" above
2073 The following options are valid within B<Key> blocks:
2077 =item B<Type> I<Type>
2079 Sets the type used to dispatch the values to the daemon. Detailed information
2080 about types and their configuration can be found in L<types.db(5)>. This
2081 option is mandatory.
2083 =item B<Instance> I<Instance>
2085 Type-instance to use. Defaults to the current map key or current string array element value.
2089 =head2 Plugin C<curl_xml>
2091 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2092 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2095 <URL "http://localhost/stats.xml">
2098 Instance "some_instance"
2103 CACert "/path/to/ca.crt"
2104 Header "X-Custom-Header: foobar"
2107 <XPath "table[@id=\"magic_level\"]/tr">
2109 #InstancePrefix "prefix-"
2110 InstanceFrom "td[1]"
2111 #PluginInstanceFrom "td[1]"
2112 ValuesFrom "td[2]/span[@class=\"level\"]"
2117 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2118 URL to be fetched using libcurl. Within each B<URL> block there are
2119 options which specify the connection parameters, for example authentication
2120 information, and one or more B<XPath> blocks.
2122 Each B<XPath> block specifies how to get one type of information. The
2123 string argument must be a valid XPath expression which returns a list
2124 of "base elements". One value is dispatched for each "base element". The
2125 I<type instance> and values are looked up using further I<XPath> expressions
2126 that should be relative to the base element.
2128 Within the B<URL> block the following options are accepted:
2132 =item B<Host> I<Name>
2134 Use I<Name> as the host name when submitting values. Defaults to the global
2137 =item B<Plugin> I<Plugin>
2139 Use I<Plugin> as the plugin name when submitting values.
2140 Defaults to 'curl_xml'.
2142 =item B<Instance> I<Instance>
2144 Use I<Instance> as the plugin instance when submitting values.
2145 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2146 Defaults to an empty string (no plugin instance).
2148 =item B<Namespace> I<Prefix> I<URL>
2150 If an XPath expression references namespaces, they must be specified
2151 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2152 I<URL> is the "namespace name", an URI reference uniquely identifying the
2153 namespace. The option can be repeated to register multiple namespaces.
2157 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2158 Namespace "m" "http://www.w3.org/1998/Math/MathML"
2160 =item B<User> I<User>
2162 =item B<Password> I<Password>
2164 =item B<Digest> B<true>|B<false>
2166 =item B<VerifyPeer> B<true>|B<false>
2168 =item B<VerifyHost> B<true>|B<false>
2170 =item B<CACert> I<CA Cert File>
2172 =item B<Header> I<Header>
2174 =item B<Post> I<Body>
2176 =item B<Timeout> I<Milliseconds>
2178 These options behave exactly equivalent to the appropriate options of the
2179 I<cURL plugin>. Please see there for a detailed description.
2181 =item B<E<lt>StatisticsE<gt>>
2183 One B<Statistics> block can be used to specify cURL statistics to be collected
2184 for each request to the remote URL. See the section "cURL Statistics" above
2187 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2189 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2190 B<XPath> block specifies how to get one type of information. The string
2191 argument must be a valid XPath expression which returns a list of "base
2192 elements". One value is dispatched for each "base element".
2194 Within the B<XPath> block the following options are accepted:
2198 =item B<Type> I<Type>
2200 Specifies the I<Type> used for submitting patches. This determines the number
2201 of values that are required / expected and whether the strings are parsed as
2202 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2203 This option is required.
2205 =item B<InstancePrefix> I<InstancePrefix>
2207 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2208 concatenated together without any separator.
2209 This option is optional.
2211 =item B<InstanceFrom> I<InstanceFrom>
2213 Specifies a XPath expression to use for determining the I<type instance>. The
2214 XPath expression must return exactly one element. The element's value is then
2215 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2217 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2219 Specifies a XPath expression to use for determining the I<plugin instance>. The
2220 XPath expression must return exactly one element. The element's value is then
2221 used as I<plugin instance>.
2225 If the "base XPath expression" (the argument to the B<XPath> block) returns
2226 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2227 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2231 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2233 Specifies one or more XPath expression to use for reading the values. The
2234 number of XPath expressions must match the number of data sources in the
2235 I<type> specified with B<Type> (see above). Each XPath expression must return
2236 exactly one element. The element's value is then parsed as a number and used as
2237 value for the appropriate value in the value list dispatched to the daemon.
2238 This option is required.
2244 =head2 Plugin C<dbi>
2246 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2247 connect to various databases, execute I<SQL> statements and read back the
2248 results. I<dbi> is an acronym for "database interface" in case you were
2249 wondering about the name. You can configure how each column is to be
2250 interpreted and the plugin will generate one or more data sets from each row
2251 returned according to these rules.
2253 Because the plugin is very generic, the configuration is a little more complex
2254 than those of other plugins. It usually looks something like this:
2257 <Query "out_of_stock">
2258 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2259 # Use with MySQL 5.0.0 or later
2263 InstancePrefix "out_of_stock"
2264 InstancesFrom "category"
2268 <Database "product_information">
2272 DriverOption "host" "localhost"
2273 DriverOption "username" "collectd"
2274 DriverOption "password" "aZo6daiw"
2275 DriverOption "dbname" "prod_info"
2276 SelectDB "prod_info"
2277 Query "out_of_stock"
2281 The configuration above defines one query with one result and one database. The
2282 query is then linked to the database with the B<Query> option I<within> the
2283 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2284 and you can also use the B<Include> statement to split up the configuration
2285 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2286 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2289 The following is a complete list of options:
2291 =head3 B<Query> blocks
2293 Query blocks define I<SQL> statements and how the returned data should be
2294 interpreted. They are identified by the name that is given in the opening line
2295 of the block. Thus the name needs to be unique. Other than that, the name is
2296 not used in collectd.
2298 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2299 define which column holds which value or instance information. You can use
2300 multiple B<Result> blocks to create multiple values from one returned row. This
2301 is especially useful, when queries take a long time and sending almost the same
2302 query again and again is not desirable.
2306 <Query "environment">
2307 Statement "select station, temperature, humidity from environment"
2310 # InstancePrefix "foo"
2311 InstancesFrom "station"
2312 ValuesFrom "temperature"
2316 InstancesFrom "station"
2317 ValuesFrom "humidity"
2321 The following options are accepted:
2325 =item B<Statement> I<SQL>
2327 Sets the statement that should be executed on the server. This is B<not>
2328 interpreted by collectd, but simply passed to the database server. Therefore,
2329 the SQL dialect that's used depends on the server collectd is connected to.
2331 The query has to return at least two columns, one for the instance and one
2332 value. You cannot omit the instance, even if the statement is guaranteed to
2333 always return exactly one line. In that case, you can usually specify something
2336 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2338 (That works with MySQL but may not be valid SQL according to the spec. If you
2339 use a more strict database server, you may have to select from a dummy table or
2342 Please note that some databases, for example B<Oracle>, will fail if you
2343 include a semicolon at the end of the statement.
2345 =item B<MinVersion> I<Version>
2347 =item B<MaxVersion> I<Value>
2349 Only use this query for the specified database version. You can use these
2350 options to provide multiple queries with the same name but with a slightly
2351 different syntax. The plugin will use only those queries, where the specified
2352 minimum and maximum versions fit the version of the database in use.
2354 The database version is determined by C<dbi_conn_get_engine_version>, see the
2355 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2356 for details. Basically, each part of the version is assumed to be in the range
2357 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2358 "40102", version "5.0.42" becomes "50042".
2360 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2361 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2362 happen. Don't to it! A valid example would be something along these lines:
2373 In the above example, there are three ranges that don't overlap. The last one
2374 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2375 before "4.0.0" are not specified.
2377 =item B<Type> I<Type>
2379 The B<type> that's used for each line returned. See L<types.db(5)> for more
2380 details on how types are defined. In short: A type is a predefined layout of
2381 data and the number of values and type of values has to match the type
2384 If you specify "temperature" here, you need exactly one gauge column. If you
2385 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2388 There must be exactly one B<Type> option inside each B<Result> block.
2390 =item B<InstancePrefix> I<prefix>
2392 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2393 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2394 all strings returned in the appropriate columns are concatenated together,
2395 separated by dashes I<("-")>.
2397 =item B<InstancesFrom> I<column0> [I<column1> ...]
2399 Specifies the columns whose values will be used to create the "type-instance"
2400 for each row. If you specify more than one column, the value of all columns
2401 will be joined together with dashes I<("-")> as separation characters.
2403 The plugin itself does not check whether or not all built instances are
2404 different. It's your responsibility to assure that each is unique. This is
2405 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2406 sure that only one row is returned in this case.
2408 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2411 =item B<ValuesFrom> I<column0> [I<column1> ...]
2413 Names the columns whose content is used as the actual data for the data sets
2414 that are dispatched to the daemon. How many such columns you need is determined
2415 by the B<Type> setting above. If you specify too many or not enough columns,
2416 the plugin will complain about that and no data will be submitted to the
2419 The actual data type in the columns is not that important. The plugin will
2420 automatically cast the values to the right type if it know how to do that. So
2421 it should be able to handle integer an floating point types, as well as strings
2422 (if they include a number at the beginning).
2424 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2426 =item B<MetadataFrom> [I<column0> I<column1> ...]
2428 Names the columns whose content is used as metadata for the data sets
2429 that are dispatched to the daemon.
2431 The actual data type in the columns is not that important. The plugin will
2432 automatically cast the values to the right type if it know how to do that. So
2433 it should be able to handle integer an floating point types, as well as strings
2434 (if they include a number at the beginning).
2438 =head3 B<Database> blocks
2440 Database blocks define a connection to a database and which queries should be
2441 sent to that database. Since the used "dbi" library can handle a wide variety
2442 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2443 documentationE<nbsp>- we stick as close to the terminology used there.
2445 Each database needs a "name" as string argument in the starting tag of the
2446 block. This name will be used as "PluginInstance" in the values submitted to
2447 the daemon. Other than that, that name is not used.
2451 =item B<Plugin> I<Plugin>
2453 Use I<Plugin> as the plugin name when submitting query results from
2454 this B<Database>. Defaults to C<dbi>.
2456 =item B<Interval> I<Interval>
2458 Sets the interval (in seconds) in which the values will be collected from this
2459 database. By default the global B<Interval> setting will be used.
2461 =item B<Driver> I<Driver>
2463 Specifies the driver to use to connect to the database. In many cases those
2464 drivers are named after the database they can connect to, but this is not a
2465 technical necessity. These drivers are sometimes referred to as "DBD",
2466 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2467 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2468 project at L<http://libdbi-drivers.sourceforge.net/>.
2470 You need to give the driver name as expected by the "dbi" library here. You
2471 should be able to find that in the documentation for each driver. If you
2472 mistype the driver name, the plugin will dump a list of all known driver names
2475 =item B<DriverOption> I<Key> I<Value>
2477 Sets driver-specific options. What option a driver supports can be found in the
2478 documentation for each driver, somewhere at
2479 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2480 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2482 DBDs can register two types of options: String options and numeric options. The
2483 plugin will use the C<dbi_conn_set_option> function when the configuration
2484 provides a string and the C<dbi_conn_require_option_numeric> function when the
2485 configuration provides a number. So these two lines will actually result in
2486 different calls being used:
2488 DriverOption "Port" 1234 # numeric
2489 DriverOption "Port" "1234" # string
2491 Unfortunately, drivers are not too keen to report errors when an unknown option
2492 is passed to them, so invalid settings here may go unnoticed. This is not the
2493 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2494 the driver. If a driver complains about an option, the plugin will dump a
2495 complete list of all options understood by that driver to the log. There is no
2496 way to programmatically find out if an option expects a string or a numeric
2497 argument, so you will have to refer to the appropriate DBD's documentation to
2498 find this out. Sorry.
2500 =item B<SelectDB> I<Database>
2502 In some cases, the database name you connect with is not the database name you
2503 want to use for querying data. If this option is set, the plugin will "select"
2504 (switch to) that database after the connection is established.
2506 =item B<Query> I<QueryName>
2508 Associates the query named I<QueryName> with this database connection. The
2509 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2510 blocks you want to refer to must be placed above the database block you want to
2513 =item B<Host> I<Hostname>
2515 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2516 values. Defaults to the global hostname setting.
2524 =item B<Device> I<Device>
2526 Select partitions based on the devicename.
2528 See F</"IGNORELISTS"> for details.
2530 =item B<MountPoint> I<Directory>
2532 Select partitions based on the mountpoint.
2534 See F</"IGNORELISTS"> for details.
2536 =item B<FSType> I<FSType>
2538 Select partitions based on the filesystem type.
2540 See F</"IGNORELISTS"> for details.
2542 =item B<IgnoreSelected> B<true>|B<false>
2544 Invert the selection: If set to true, all partitions B<except> the ones that
2545 match any one of the criteria are collected. By default only selected
2546 partitions are collected if a selection is made. If no selection is configured
2547 at all, B<all> partitions are selected.
2549 =item B<ReportByDevice> B<true>|B<false>
2551 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2552 (the default), it will report a disk as "root", but with it I<true>, it will be
2553 "sda1" (or whichever).
2555 =item B<ReportInodes> B<true>|B<false>
2557 Enables or disables reporting of free, reserved and used inodes. Defaults to
2558 inode collection being disabled.
2560 Enable this option if inodes are a scarce resource for you, usually because
2561 many small files are stored on the disk. This is a usual scenario for mail
2562 transfer agents and web caches.
2564 =item B<ValuesAbsolute> B<true>|B<false>
2566 Enables or disables reporting of free and used disk space in 1K-blocks.
2567 Defaults to B<true>.
2569 =item B<ValuesPercentage> B<false>|B<true>
2571 Enables or disables reporting of free and used disk space in percentage.
2572 Defaults to B<false>.
2574 This is useful for deploying I<collectd> on the cloud, where machines with
2575 different disk size may exist. Then it is more practical to configure
2576 thresholds based on relative disk size.
2580 =head2 Plugin C<disk>
2582 The C<disk> plugin collects information about the usage of physical disks and
2583 logical disks (partitions). Values collected are the number of octets written
2584 to and read from a disk or partition, the number of read/write operations
2585 issued to the disk and a rather complex "time" it took for these commands to be
2588 Using the following two options you can ignore some disks or configure the
2589 collection only of specific disks.
2593 =item B<Disk> I<Name>
2595 Select the disk I<Name>. Whether it is collected or ignored depends on the
2596 B<IgnoreSelected> setting, see below. As with other plugins that use the
2597 daemon's ignorelist functionality, a string that starts and ends with a slash
2598 is interpreted as a regular expression. Examples:
2603 See F</"IGNORELISTS"> for details.
2605 =item B<IgnoreSelected> B<true>|B<false>
2607 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2608 statements, are ignored or if all other disks are ignored. The behavior
2609 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2610 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2611 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2612 is set to B<true>, all disks are collected B<except> the ones matched.
2614 =item B<UseBSDName> B<true>|B<false>
2616 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2617 default major/minor numbers. Requires collectd to be built with Apple's
2620 =item B<UdevNameAttr> I<Attribute>
2622 Attempt to override disk instance name with the value of a specified udev
2623 attribute when built with B<libudev>. If the attribute is not defined for the
2624 given device, the default name is used. Example:
2626 UdevNameAttr "DM_NAME"
2630 =head2 Plugin C<dns>
2634 =item B<Interface> I<Interface>
2636 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2637 option sets the interface that should be used. If this option is not set, or
2638 set to "any", the plugin will try to get packets from B<all> interfaces. This
2639 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2641 =item B<IgnoreSource> I<IP-address>
2643 Ignore packets that originate from this address.
2645 =item B<SelectNumericQueryTypes> B<true>|B<false>
2647 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2651 =head2 Plugin C<dpdkevents>
2653 The I<dpdkevents plugin> collects events from DPDK such as link status of
2654 network ports and Keep Alive status of DPDK logical cores.
2655 In order to get Keep Alive events following requirements must be met:
2657 - support for Keep Alive implemented in DPDK application. More details can
2658 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2662 <Plugin "dpdkevents">
2668 <Event "link_status">
2669 SendEventsOnUpdate true
2670 EnabledPortMask 0xffff
2671 PortName "interface1"
2672 PortName "interface2"
2673 SendNotification false
2675 <Event "keep_alive">
2676 SendEventsOnUpdate true
2678 KeepAliveShmName "/dpdk_keepalive_shm_name"
2679 SendNotification false
2686 =head3 The EAL block
2690 =item B<Coremask> I<Mask>
2692 =item B<Memorychannels> I<Channels>
2694 Number of memory channels per processor socket.
2696 =item B<FilePrefix> I<File>
2698 The prefix text used for hugepage filenames. The filename will be set to
2699 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2703 =head3 The Event block
2705 The B<Event> block defines configuration for specific event. It accepts a
2706 single argument which specifies the name of the event.
2708 =head4 Link Status event
2712 =item B<SendEventOnUpdate> I<true|false>
2714 If set to true link status value will be dispatched only when it is
2715 different from previously read value. This is an optional argument - default
2718 =item B<EnabledPortMask> I<Mask>
2720 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2721 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2722 that all ports will be enabled. This is an optional argument - by default
2723 all ports are enabled.
2725 =item B<PortName> I<Name>
2727 A string containing an optional name for the enabled DPDK ports. Each PortName
2728 option should contain only one port name; specify as many PortName options as
2729 desired. Default naming convention will be used if PortName is blank. If there
2730 are less PortName options than there are enabled ports, the default naming
2731 convention will be used for the additional ports.
2733 =item B<SendNotification> I<true|false>
2735 If set to true, link status notifications are sent, instead of link status
2736 being collected as a statistic. This is an optional argument - default
2741 =head4 Keep Alive event
2745 =item B<SendEventOnUpdate> I<true|false>
2747 If set to true keep alive value will be dispatched only when it is
2748 different from previously read value. This is an optional argument - default
2751 =item B<LCoreMask> I<Mask>
2753 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2755 =item B<KeepAliveShmName> I<Name>
2757 Shared memory name identifier that is used by secondary process to monitor
2758 the keep alive cores state.
2760 =item B<SendNotification> I<true|false>
2762 If set to true, keep alive notifications are sent, instead of keep alive
2763 information being collected as a statistic. This is an optional
2764 argument - default value is false.
2768 =head2 Plugin C<dpdkstat>
2770 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2771 extended NIC stats API in DPDK.
2782 RteDriverLibPath "/usr/lib/dpdk-pmd"
2784 SharedMemObj "dpdk_collectd_stats_0"
2785 EnabledPortMask 0xffff
2786 PortName "interface1"
2787 PortName "interface2"
2792 =head3 The EAL block
2796 =item B<Coremask> I<Mask>
2798 A string containing an hexadecimal bit mask of the cores to run on. Note that
2799 core numbering can change between platforms and should be determined beforehand.
2801 =item B<Memorychannels> I<Channels>
2803 A string containing a number of memory channels per processor socket.
2805 =item B<FilePrefix> I<File>
2807 The prefix text used for hugepage filenames. The filename will be set to
2808 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2810 =item B<SocketMemory> I<MB>
2812 A string containing amount of Memory to allocate from hugepages on specific
2813 sockets in MB. This is an optional value.
2815 =item B<LogLevel> I<LogLevel_number>
2817 A string containing log level number. This parameter is optional.
2818 If parameter is not present then default value "7" - (INFO) is used.
2819 Value "8" - (DEBUG) can be set to enable debug traces.
2821 =item B<RteDriverLibPath> I<Path>
2823 A string containing path to shared pmd driver lib or path to directory,
2824 where shared pmd driver libs are available. This parameter is optional.
2825 This parameter enable loading of shared pmd driver libs from defined path.
2826 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2827 or "/usr/lib/dpdk-pmd"
2833 =item B<SharedMemObj> I<Mask>
2835 A string containing the name of the shared memory object that should be used to
2836 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2837 Defaults to dpdk_collectd_stats if no other value is configured.
2839 =item B<EnabledPortMask> I<Mask>
2841 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2842 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2843 that all ports will be enabled. This is an optional argument - default
2844 is all ports enabled.
2846 =item B<PortName> I<Name>
2848 A string containing an optional name for the enabled DPDK ports. Each PortName
2849 option should contain only one port name; specify as many PortName options as
2850 desired. Default naming convention will be used if PortName is blank. If there
2851 are less PortName options than there are enabled ports, the default naming
2852 convention will be used for the additional ports.
2856 =head2 Plugin C<email>
2860 =item B<SocketFile> I<Path>
2862 Sets the socket-file which is to be created.
2864 =item B<SocketGroup> I<Group>
2866 If running as root change the group of the UNIX-socket after it has been
2867 created. Defaults to B<collectd>.
2869 =item B<SocketPerms> I<Permissions>
2871 Change the file permissions of the UNIX-socket after it has been created. The
2872 permissions must be given as a numeric, octal value as you would pass to
2873 L<chmod(1)>. Defaults to B<0770>.
2875 =item B<MaxConns> I<Number>
2877 Sets the maximum number of connections that can be handled in parallel. Since
2878 this many threads will be started immediately setting this to a very high
2879 value will waste valuable resources. Defaults to B<5> and will be forced to be
2880 at most B<16384> to prevent typos and dumb mistakes.
2884 =head2 Plugin C<ethstat>
2886 The I<ethstat plugin> collects information about network interface cards (NICs)
2887 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2893 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2894 Map "multicast" "if_multicast"
2901 =item B<Interface> I<Name>
2903 Collect statistical information about interface I<Name>.
2905 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2907 By default, the plugin will submit values as type C<derive> and I<type
2908 instance> set to I<Name>, the name of the metric as reported by the driver. If
2909 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2910 I<TypeInstance> will be used.
2912 =item B<MappedOnly> B<true>|B<false>
2914 When set to B<true>, only metrics that can be mapped to a I<type> will be
2915 collected, all other metrics will be ignored. Defaults to B<false>.
2919 =head2 Plugin C<exec>
2921 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2922 contains valuable information on when the executable is executed and the
2923 output that is expected from it.
2927 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2929 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2931 Execute the executable I<Executable> as user I<User>. If the user name is
2932 followed by a colon and a group name, the effective group is set to that group.
2933 The real group and saved-set group will be set to the default group of that
2934 user. If no group is given the effective group ID will be the same as the real
2937 Please note that in order to change the user and/or group the daemon needs
2938 superuser privileges. If the daemon is run as an unprivileged user you must
2939 specify the same user/group here. If the daemon is run with superuser
2940 privileges, you must supply a non-root user here.
2942 The executable may be followed by optional arguments that are passed to the
2943 program. Please note that due to the configuration parsing numbers and boolean
2944 values may be changed. If you want to be absolutely sure that something is
2945 passed as-is please enclose it in quotes.
2947 The B<Exec> and B<NotificationExec> statements change the semantics of the
2948 programs executed, i.E<nbsp>e. the data passed to them and the response
2949 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2953 =head2 Plugin C<fhcount>
2955 The C<fhcount> plugin provides statistics about used, unused and total number of
2956 file handles on Linux.
2958 The I<fhcount plugin> provides the following configuration options:
2962 =item B<ValuesAbsolute> B<true>|B<false>
2964 Enables or disables reporting of file handles usage in absolute numbers,
2965 e.g. file handles used. Defaults to B<true>.
2967 =item B<ValuesPercentage> B<false>|B<true>
2969 Enables or disables reporting of file handles usage in percentages, e.g.
2970 percent of file handles used. Defaults to B<false>.
2974 =head2 Plugin C<filecount>
2976 The C<filecount> plugin counts the number of files in a certain directory (and
2977 its subdirectories) and their combined size. The configuration is very straight
2980 <Plugin "filecount">
2981 <Directory "/var/qmail/queue/mess">
2982 Instance "qmail-message"
2984 <Directory "/var/qmail/queue/todo">
2985 Instance "qmail-todo"
2987 <Directory "/var/lib/php5">
2988 Instance "php5-sessions"
2993 The example above counts the number of files in QMail's queue directories and
2994 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2995 QMail has not yet looked at, the "message" queue holds the messages that were
2996 classified into "local" and "remote".
2998 As you can see, the configuration consists of one or more C<Directory> blocks,
2999 each of which specifies a directory in which to count the files. Within those
3000 blocks, the following options are recognized:
3004 =item B<Plugin> I<Plugin>
3006 Use I<Plugin> as the plugin name when submitting values.
3007 Defaults to B<filecount>.
3009 =item B<Instance> I<Instance>
3011 Sets the plugin instance to I<Instance>. If not given, the instance is set to
3012 the directory name with all slashes replaced by underscores and all leading
3013 underscores removed. Empty value is allowed.
3015 =item B<Name> I<Pattern>
3017 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
3018 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
3019 against the pattern, not the entire path. In case this makes it easier for you:
3020 This option has been named after the B<-name> parameter to L<find(1)>.
3022 =item B<MTime> I<Age>
3024 Count only files of a specific age: If I<Age> is greater than zero, only files
3025 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
3026 a negative number, this is inversed. For example, if B<-60> is specified, only
3027 files that have been modified in the last minute will be counted.
3029 The number can also be followed by a "multiplier" to easily specify a larger
3030 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3031 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3032 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3033 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3034 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3037 =item B<Size> I<Size>
3039 Count only files of a specific size. When I<Size> is a positive number, only
3040 files that are at least this big are counted. If I<Size> is a negative number,
3041 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3042 I<Size> are counted.
3044 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3045 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3046 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3047 note that there are 1000 bytes in a kilobyte, not 1024.
3049 =item B<Recursive> I<true>|I<false>
3051 Controls whether or not to recurse into subdirectories. Enabled by default.
3053 =item B<IncludeHidden> I<true>|I<false>
3055 Controls whether or not to include "hidden" files and directories in the count.
3056 "Hidden" files and directories are those, whose name begins with a dot.
3057 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3059 =item B<RegularOnly> I<true>|I<false>
3061 Controls whether or not to include only regular files in the count.
3062 Defaults to I<true>, i.e. by default non regular files are ignored.
3064 =item B<FilesSizeType> I<Type>
3066 Sets the type used to dispatch files combined size. Empty value ("") disables
3067 reporting. Defaults to B<bytes>.
3069 =item B<FilesCountType> I<Type>
3071 Sets the type used to dispatch number of files. Empty value ("") disables
3072 reporting. Defaults to B<files>.
3074 =item B<TypeInstance> I<Instance>
3076 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3077 (no plugin instance).
3081 =head2 Plugin C<GenericJMX>
3083 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3084 L<collectd-java(5)>.
3086 =head2 Plugin C<gmond>
3088 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3089 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3090 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3095 MCReceiveFrom "239.2.11.71" "8649"
3096 <Metric "swap_total">
3098 TypeInstance "total"
3101 <Metric "swap_free">
3108 The following metrics are built-in:
3114 load_one, load_five, load_fifteen
3118 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3122 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3134 Available configuration options:
3138 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3140 Sets sets the multicast group and UDP port to which to subscribe.
3142 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3144 =item E<lt>B<Metric> I<Name>E<gt>
3146 These blocks add a new metric conversion to the internal table. I<Name>, the
3147 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3151 =item B<Type> I<Type>
3153 Type to map this metric to. Required.
3155 =item B<TypeInstance> I<Instance>
3157 Type-instance to use. Optional.
3159 =item B<DataSource> I<Name>
3161 Data source to map this metric to. If the configured type has exactly one data
3162 source, this is optional. Otherwise the option is required.
3168 =head2 Plugin C<gps>
3170 The C<gps plugin> connects to gpsd on the host machine.
3171 The host, port, timeout and pause are configurable.
3173 This is useful if you run an NTP server using a GPS for source and you want to
3176 Mind your GPS must send $--GSA for having the data reported!
3178 The following elements are collected:
3184 Number of satellites used for fix (type instance "used") and in view (type
3185 instance "visible"). 0 means no GPS satellites are visible.
3187 =item B<dilution_of_precision>
3189 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3190 It should be between 0 and 3.
3191 Look at the documentation of your GPS to know more.
3199 # Connect to localhost on gpsd regular port:
3204 # PauseConnect of 5 sec. between connection attempts.
3208 Available configuration options:
3212 =item B<Host> I<Host>
3214 The host on which gpsd daemon runs. Defaults to B<localhost>.
3216 =item B<Port> I<Port>
3218 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3220 =item B<Timeout> I<Seconds>
3222 Timeout in seconds (default 0.015 sec).
3224 The GPS data stream is fetch by the plugin form the daemon.
3225 It waits for data to be available, if none arrives it times out
3226 and loop for another reading.
3227 Mind to put a low value gpsd expects value in the micro-seconds area
3228 (recommended is 500 us) since the waiting function is blocking.
3229 Value must be between 500 us and 5 sec., if outside that range the
3230 default value is applied.
3232 This only applies from gpsd release-2.95.
3234 =item B<PauseConnect> I<Seconds>
3236 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3240 =head2 Plugin C<grpc>
3242 The I<grpc> plugin provides an RPC interface to submit values to or query
3243 values from collectd based on the open source gRPC framework. It exposes an
3244 end-point for dispatching values to the daemon.
3246 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3250 =item B<Server> I<Host> I<Port>
3252 The B<Server> statement sets the address of a server to which to send metrics
3253 via the C<DispatchValues> function.
3255 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3257 Optionally, B<Server> may be specified as a configuration block which supports
3258 the following options:
3262 =item B<EnableSSL> B<false>|B<true>
3264 Whether to require SSL for outgoing connections. Default: false.
3266 =item B<SSLCACertificateFile> I<Filename>
3268 =item B<SSLCertificateFile> I<Filename>
3270 =item B<SSLCertificateKeyFile> I<Filename>
3272 Filenames specifying SSL certificate and key material to be used with SSL
3277 =item B<Listen> I<Host> I<Port>
3279 The B<Listen> statement sets the network address to bind to. When multiple
3280 statements are specified, the daemon will bind to all of them. If none are
3281 specified, it defaults to B<0.0.0.0:50051>.
3283 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3285 Optionally, B<Listen> may be specified as a configuration block which
3286 supports the following options:
3290 =item B<EnableSSL> I<true>|I<false>
3292 Whether to enable SSL for incoming connections. Default: false.
3294 =item B<SSLCACertificateFile> I<Filename>
3296 =item B<SSLCertificateFile> I<Filename>
3298 =item B<SSLCertificateKeyFile> I<Filename>
3300 Filenames specifying SSL certificate and key material to be used with SSL
3303 =item B<VerifyPeer> B<true>|B<false>
3305 When enabled, a valid client certificate is required to connect to the server.
3306 When disabled, a client certifiacte is not requested and any unsolicited client
3307 certificate is accepted.
3314 =head2 Plugin C<hddtemp>
3316 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3317 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3318 default values, see below. C<hddtemp> has to be running to work correctly. If
3319 C<hddtemp> is not running timeouts may appear which may interfere with other
3322 The B<hddtemp> homepage can be found at
3323 L<http://www.guzu.net/linux/hddtemp.php>.
3327 =item B<Host> I<Hostname>
3329 Hostname to connect to. Defaults to B<127.0.0.1>.
3331 =item B<Port> I<Port>
3333 TCP-Port to connect to. Defaults to B<7634>.
3337 =head2 Plugin C<hugepages>
3339 To collect B<hugepages> information, collectd reads directories
3340 "/sys/devices/system/node/*/hugepages" and
3341 "/sys/kernel/mm/hugepages".
3342 Reading of these directories can be disabled by the following
3343 options (default is enabled).
3347 =item B<ReportPerNodeHP> B<true>|B<false>
3349 If enabled, information will be collected from the hugepage
3350 counters in "/sys/devices/system/node/*/hugepages".
3351 This is used to check the per-node hugepage statistics on
3354 =item B<ReportRootHP> B<true>|B<false>
3356 If enabled, information will be collected from the hugepage
3357 counters in "/sys/kernel/mm/hugepages".
3358 This can be used on both NUMA and non-NUMA systems to check
3359 the overall hugepage statistics.
3361 =item B<ValuesPages> B<true>|B<false>
3363 Whether to report hugepages metrics in number of pages.
3364 Defaults to B<true>.
3366 =item B<ValuesBytes> B<false>|B<true>
3368 Whether to report hugepages metrics in bytes.
3369 Defaults to B<false>.
3371 =item B<ValuesPercentage> B<false>|B<true>
3373 Whether to report hugepages metrics as percentage.
3374 Defaults to B<false>.
3378 =head2 Plugin C<intel_pmu>
3380 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3381 Linux perf interface. All events are reported on a per core basis.
3386 ReportHardwareCacheEvents true
3387 ReportKernelPMUEvents true
3388 ReportSoftwareEvents true
3389 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3390 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3391 Cores "0-3" "4,6" "[12-15]"
3398 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3400 Enable or disable measuring of hardware CPU cache events:
3402 - L1-dcache-load-misses
3404 - L1-dcache-store-misses
3405 - L1-dcache-prefetches
3406 - L1-dcache-prefetch-misses
3408 - L1-icache-load-misses
3409 - L1-icache-prefetches
3410 - L1-icache-prefetch-misses
3416 - LLC-prefetch-misses
3422 - dTLB-prefetch-misses
3426 - branch-load-misses
3428 =item B<ReportKernelPMUEvents> B<false>|B<true>
3430 Enable or disable measuring of the following events:
3439 =item B<ReportSoftwareEvents> B<false>|B<true>
3441 Enable or disable measuring of software events provided by kernel:
3452 =item B<EventList> I<filename>
3454 JSON performance counter event list file name. To be able to monitor all Intel
3455 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3456 event_download.py script to download event list for current CPU.
3458 =item B<HardwareEvents> I<events>
3460 This field is a list of event names or groups of comma separated event names.
3461 This option requires B<EventList> option to be configured.
3463 =item B<Cores> I<cores groups>
3465 All events are reported on a per core basis. Monitoring of the events can be
3466 configured for a group of cores (aggregated statistics). This field defines
3467 groups of cores on which to monitor supported events. The field is represented
3468 as list of strings with core group values. Each string represents a list of
3469 cores in a group. If a group is enclosed in square brackets each core is added
3470 individually to a separate group (that is statistics are not aggregated).
3471 Allowed formats are:
3477 If an empty string is provided as value for this field default cores
3478 configuration is applied - that is separate group is created for each core.
3482 =head2 Plugin C<intel_rdt>
3484 The I<intel_rdt> plugin collects information provided by monitoring features of
3485 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3486 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3487 information about utilization of shared resources. CMT monitors last level cache
3488 occupancy (LLC). MBM supports two types of events reporting local and remote
3489 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3490 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3491 reports the bandwidth of accessing the remote socket. Also this technology
3492 allows to monitor instructions per clock (IPC).
3493 Monitor events are hardware dependant. Monitoring capabilities are detected on
3494 plugin initialization and only supported events are monitored.
3496 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3497 require an additional capability to be enabled if collectd is run as a service.
3498 Please refer to I<contrib/systemd.collectd.service> file for more details.
3502 <Plugin "intel_rdt">
3503 Cores "0-2" "3,4,6" "8-10,15"
3510 =item B<Interval> I<seconds>
3512 The interval within which to retrieve statistics on monitored events in seconds.
3513 For milliseconds divide the time by 1000 for example if the desired interval
3514 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3515 recommended to set interval higher than 1 sec.
3517 =item B<Cores> I<cores groups>
3519 All events are reported on a per core basis. Monitoring of the events can be
3520 configured for group of cores (aggregated statistics). This field defines groups
3521 of cores on which to monitor supported events. The field is represented as list
3522 of strings with core group values. Each string represents a list of cores in a
3523 group. Allowed formats are:
3528 If an empty string is provided as value for this field default cores
3529 configuration is applied - a separate group is created for each core.
3533 B<Note:> By default global interval is used to retrieve statistics on monitored
3534 events. To configure a plugin specific interval use B<Interval> option of the
3535 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3536 example if the desired interval is 50ms, set interval to 0.05.
3537 Due to limited capacity of counters it is not recommended to set interval higher
3540 =head2 Plugin C<interface>
3544 =item B<Interface> I<Interface>
3546 Select this interface. By default these interfaces will then be collected. For
3547 a more detailed description see B<IgnoreSelected> below.
3549 See F</"IGNORELISTS"> for details.
3551 =item B<IgnoreSelected> I<true>|I<false>
3553 If no configuration is given, the B<interface>-plugin will collect data from
3554 all interfaces. This may not be practical, especially for loopback- and
3555 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3556 interfaces you're interested in. Sometimes, however, it's easier/preferred
3557 to collect all interfaces I<except> a few ones. This option enables you to
3558 do that: By setting B<IgnoreSelected> to I<true> the effect of
3559 B<Interface> is inverted: All selected interfaces are ignored and all
3560 other interfaces are collected.
3562 It is possible to use regular expressions to match interface names, if the
3563 name is surrounded by I</.../> and collectd was compiled with support for
3564 regexps. This is useful if there's a need to collect (or ignore) data
3565 for a group of interfaces that are similarly named, without the need to
3566 explicitly list all of them (especially useful if the list is dynamic).
3571 Interface "/^tun[0-9]+/"
3572 IgnoreSelected "true"
3574 This will ignore the loopback interface, all interfaces with names starting
3575 with I<veth> and all interfaces with names starting with I<tun> followed by
3578 =item B<ReportInactive> I<true>|I<false>
3580 When set to I<false>, only interfaces with non-zero traffic will be
3581 reported. Note that the check is done by looking into whether a
3582 package was sent at any time from boot and the corresponding counter
3583 is non-zero. So, if the interface has been sending data in the past
3584 since boot, but not during the reported time-interval, it will still
3587 The default value is I<true> and results in collection of the data
3588 from all interfaces that are selected by B<Interface> and
3589 B<IgnoreSelected> options.
3591 =item B<UniqueName> I<true>|I<false>
3593 Interface name is not unique on Solaris (KSTAT), interface name is unique
3594 only within a module/instance. Following tuple is considered unique:
3595 (ks_module, ks_instance, ks_name)
3596 If this option is set to true, interface name contains above three fields
3597 separated by an underscore. For more info on KSTAT, visit
3598 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3600 This option is only available on Solaris.
3604 =head2 Plugin C<ipmi>
3606 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3607 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3609 The plugin configuration consists of one or more B<Instance> blocks which
3610 specify one I<ipmi> connection each. Each block requires one unique string
3611 argument as the instance name. If instances are not configured, an instance with
3612 the default option values will be created.
3614 For backwards compatibility, any option other than B<Instance> block will trigger
3615 legacy config handling and it will be treated as an option within B<Instance>
3616 block. This support will go away in the next major version of Collectd.
3618 Within the B<Instance> blocks, the following options are allowed:
3622 =item B<Address> I<Address>
3624 Hostname or IP to connect to. If not specified, plugin will try to connect to
3625 local management controller (BMC).
3627 =item B<Username> I<Username>
3629 =item B<Password> I<Password>
3631 The username and the password to use for the connection to remote BMC.
3633 =item B<AuthType> I<MD5>|I<rmcp+>
3635 Forces the authentication type to use for the connection to remote BMC.
3636 By default most secure type is seleted.
3638 =item B<Host> I<Hostname>
3640 Sets the B<host> field of dispatched values. Defaults to the global hostname
3643 =item B<Sensor> I<Sensor>
3645 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3647 See F</"IGNORELISTS"> for details.
3649 =item B<IgnoreSelected> I<true>|I<false>
3651 If no configuration if given, the B<ipmi> plugin will collect data from all
3652 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3653 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3654 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3655 all other sensors are collected.
3657 =item B<NotifySensorAdd> I<true>|I<false>
3659 If a sensor appears after initialization time of a minute a notification
3662 =item B<NotifySensorRemove> I<true>|I<false>
3664 If a sensor disappears a notification is sent.
3666 =item B<NotifySensorNotPresent> I<true>|I<false>
3668 If you have for example dual power supply and one of them is (un)plugged then
3669 a notification is sent.
3671 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3673 If a IPMI connection state changes after initialization time of a minute
3674 a notification is sent. Defaults to B<false>.
3676 =item B<SELEnabled> I<true>|I<false>
3678 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3679 and discrete events. When event is received the notification is sent.
3680 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3682 Defaults to B<false>.
3684 =item B<SELSensor> I<SELSensor>
3686 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3688 See F</"IGNORELISTS"> for details.
3690 =item B<SELIgnoreSelected> I<true>|I<false>
3692 If no configuration is given, the B<ipmi> plugin will pass events from all
3693 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3694 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3695 sensors are ignored and all events from other sensors are passed.
3697 =item B<SELClearEvent> I<true>|I<false>
3699 If SEL clear event is enabled, plugin will delete event from SEL list after
3700 it is received and successfully handled. In this case other tools that are
3701 subscribed for SEL events will receive an empty event.
3702 Defaults to B<false>.
3706 =head2 Plugin C<iptables>
3710 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3712 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3714 Select the iptables/ip6tables filter rules to count packets and bytes from.
3716 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3717 of all rules which have a comment-match. The comment is then used as
3720 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3721 the I<n>th rule will be collected. Again, the comment (or the number) will be
3722 used as the type-instance.
3724 If I<Name> is supplied, it will be used as the type-instance instead of the
3725 comment or the number.
3729 =head2 Plugin C<irq>
3735 Select this irq. By default these irqs will then be collected. For a more
3736 detailed description see B<IgnoreSelected> below.
3738 See F</"IGNORELISTS"> for details.
3740 =item B<IgnoreSelected> I<true>|I<false>
3742 If no configuration if given, the B<irq>-plugin will collect data from all
3743 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3744 can use the B<Irq>-option to pick the interrupt you're interested in.
3745 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3746 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3747 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3748 and all other interrupts are collected.
3752 =head2 Plugin C<java>
3754 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3755 This section only discusses the syntax and semantic of the configuration
3756 options. For more in-depth information on the I<Java> plugin, please read
3757 L<collectd-java(5)>.
3762 JVMArg "-verbose:jni"
3763 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3764 LoadPlugin "org.collectd.java.Foobar"
3765 <Plugin "org.collectd.java.Foobar">
3766 # To be parsed by the plugin
3770 Available configuration options:
3774 =item B<JVMArg> I<Argument>
3776 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3777 exactly the way the arguments to the I<java> binary on the command line work.
3778 Execute C<javaE<nbsp>--help> for details.
3780 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3781 any other options! When another option is found, the JVM will be started and
3782 later options will have to be ignored!
3784 =item B<LoadPlugin> I<JavaClass>
3786 Instantiates a new I<JavaClass> object. The constructor of this object very
3787 likely then registers one or more callback methods with the server.
3789 See L<collectd-java(5)> for details.
3791 When the first such option is found, the virtual machine (JVM) is created. This
3792 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3793 B<LoadPlugin> options!
3795 =item B<Plugin> I<Name>
3797 The entire block is passed to the Java plugin as an
3798 I<org.collectd.api.OConfigItem> object.
3800 For this to work, the plugin has to register a configuration callback first,
3801 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3802 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3803 depends on the (Java) plugin registering the callback and is completely
3804 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3808 =head2 Plugin C<load>
3810 The I<Load plugin> collects the system load. These numbers give a rough overview
3811 over the utilization of a machine. The system load is defined as the number of
3812 runnable tasks in the run-queue and is provided by many operating systems as a
3813 one, five or fifteen minute average.
3815 The following configuration options are available:
3819 =item B<ReportRelative> B<false>|B<true>
3821 When enabled, system load divided by number of available CPU cores is reported
3822 for intervals 1 min, 5 min and 15 min. Defaults to false.
3827 =head2 Plugin C<logfile>
3831 =item B<LogLevel> B<debug|info|notice|warning|err>
3833 Sets the log-level. If, for example, set to B<notice>, then all events with
3834 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3836 Please note that B<debug> is only available if collectd has been compiled with
3839 =item B<File> I<File>
3841 Sets the file to write log messages to. The special strings B<stdout> and
3842 B<stderr> can be used to write to the standard output and standard error
3843 channels, respectively. This, of course, only makes much sense when I<collectd>
3844 is running in foreground- or non-daemon-mode.
3846 =item B<Timestamp> B<true>|B<false>
3848 Prefix all lines printed by the current time. Defaults to B<true>.
3850 =item B<PrintSeverity> B<true>|B<false>
3852 When enabled, all lines are prefixed by the severity of the log message, for
3853 example "warning". Defaults to B<false>.
3857 B<Note>: There is no need to notify the daemon after moving or removing the
3858 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3859 for each line it writes.
3861 =head2 Plugin C<log_logstash>
3863 The I<log logstash plugin> behaves like the logfile plugin but formats
3864 messages as JSON events for logstash to parse and input.
3868 =item B<LogLevel> B<debug|info|notice|warning|err>
3870 Sets the log-level. If, for example, set to B<notice>, then all events with
3871 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3873 Please note that B<debug> is only available if collectd has been compiled with
3876 =item B<File> I<File>
3878 Sets the file to write log messages to. The special strings B<stdout> and
3879 B<stderr> can be used to write to the standard output and standard error
3880 channels, respectively. This, of course, only makes much sense when I<collectd>
3881 is running in foreground- or non-daemon-mode.
3885 B<Note>: There is no need to notify the daemon after moving or removing the
3886 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3887 for each line it writes.
3889 =head2 Plugin C<lpar>
3891 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3892 virtualization technique for IBM POWER processors. It takes into account CPU
3893 time stolen from or donated to a partition, in addition to the usual user,
3894 system, I/O statistics.
3896 The following configuration options are available:
3900 =item B<CpuPoolStats> B<false>|B<true>
3902 When enabled, statistics about the processor pool are read, too. The partition
3903 needs to have pool authority in order to be able to acquire this information.
3906 =item B<ReportBySerial> B<false>|B<true>
3908 If enabled, the serial of the physical machine the partition is currently
3909 running on is reported as I<hostname> and the logical hostname of the machine
3910 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3911 used (just like other plugins) and the I<plugin instance> will be empty.
3916 =head2 Plugin C<lua>
3918 This plugin embeds a Lua interpreter into collectd and provides an interface
3919 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3922 =head2 Plugin C<mbmon>
3924 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3926 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3927 B<Host> and B<Port> options can be used to change these values, see below.
3928 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3929 timeouts may appear which may interfere with other statistics..
3931 C<mbmon> must be run with the -r option ("print TAG and Value format");
3932 Debian's F</etc/init.d/mbmon> script already does this, other people
3933 will need to ensure that this is the case.
3937 =item B<Host> I<Hostname>
3939 Hostname to connect to. Defaults to B<127.0.0.1>.
3941 =item B<Port> I<Port>
3943 TCP-Port to connect to. Defaults to B<411>.
3947 =head2 Plugin C<mcelog>
3949 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3951 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3952 mcelog server is running. When the server is running, the plugin will tail the
3953 specified logfile to retrieve machine check exception information and send a
3954 notification with the details from the logfile. The plugin will use the mcelog
3955 client protocol to retrieve memory related machine check exceptions. Note that
3956 for memory exceptions, notifications are only sent when there is a change in
3957 the number of corrected/uncorrected memory errors.
3959 =head3 The Memory block
3961 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3966 =item B<McelogClientSocket> I<Path>
3967 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3968 Defaults to B<"/var/run/mcelog-client">.
3970 =item B<PersistentNotification> B<true>|B<false>
3971 Override default configuration to only send notifications when sent when there
3972 is a change in the number of corrected/uncorrected memory errors. When set to
3973 true notifications will be sent for every read cycle. Default is false. Does
3974 not affect the stats being dispatched.
3980 =item B<McelogLogfile> I<Path>
3982 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3983 cannot be used in conjunction with the memory block options, they are mutually
3990 The C<md plugin> collects information from Linux Software-RAID devices (md).
3992 All reported values are of the type C<md_disks>. Reported type instances are
3993 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3994 I<missing> (physically absent) disks.
3998 =item B<Device> I<Device>
4000 Select md devices based on device name. The I<device name> is the basename of
4001 the device, i.e. the name of the block device without the leading C</dev/>.
4002 See B<IgnoreSelected> for more details.
4004 See F</"IGNORELISTS"> for details.
4006 =item B<IgnoreSelected> B<true>|B<false>
4008 Invert device selection: If set to B<true>, all md devices B<except> those
4009 listed using B<Device> are collected. If B<false> (the default), only those
4010 listed are collected. If no configuration is given, the B<md> plugin will
4011 collect data from all md devices.
4015 =head2 Plugin C<memcachec>
4017 The C<memcachec plugin> connects to a memcached server, queries one or more
4018 given I<pages> and parses the returned data according to user specification.
4019 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4022 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4023 library. Please note that there is another library with a very similar name,
4024 libmemcache (notice the missing `d'), which is not applicable.
4026 Synopsis of the configuration:
4028 <Plugin "memcachec">
4029 <Page "plugin_instance">
4032 Plugin "plugin_name"
4034 Regex "(\\d+) bytes sent"
4037 Instance "type_instance"
4042 The configuration options are:
4046 =item E<lt>B<Page> I<Name>E<gt>
4048 Each B<Page> block defines one I<page> to be queried from the memcached server.
4049 The block requires one string argument which is used as I<plugin instance>.
4051 =item B<Server> I<Address>
4053 Sets the server address to connect to when querying the page. Must be inside a
4058 When connected to the memcached server, asks for the page I<Key>.
4060 =item B<Plugin> I<Plugin>
4062 Use I<Plugin> as the plugin name when submitting values.
4063 Defaults to C<memcachec>.
4065 =item E<lt>B<Match>E<gt>
4067 Match blocks define which strings to look for and how matches substrings are
4068 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4072 =head2 Plugin C<memcached>
4074 The B<memcached plugin> connects to a memcached server and queries statistics
4075 about cache utilization, memory and bandwidth used.
4076 L<http://memcached.org/>
4078 <Plugin "memcached">
4080 #Host "memcache.example.com"
4086 The plugin configuration consists of one or more B<Instance> blocks which
4087 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4088 following options are allowed:
4092 =item B<Host> I<Hostname>
4094 Sets the B<host> field of dispatched values. Defaults to the global hostname
4096 For backwards compatibility, values are also dispatched with the global
4097 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4100 =item B<Address> I<Address>
4102 Hostname or IP to connect to. For backwards compatibility, defaults to the
4103 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4105 =item B<Port> I<Port>
4107 TCP port to connect to. Defaults to B<11211>.
4109 =item B<Socket> I<Path>
4111 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4112 setting is given, the B<Address> and B<Port> settings are ignored.
4116 =head2 Plugin C<mic>
4118 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4119 Intel's Many Integrated Core (MIC) systems.
4128 ShowTemperatures true
4131 IgnoreSelectedTemperature true
4136 IgnoreSelectedPower true
4139 The following options are valid inside the B<PluginE<nbsp>mic> block:
4143 =item B<ShowCPU> B<true>|B<false>
4145 If enabled (the default) a sum of the CPU usage across all cores is reported.
4147 =item B<ShowCPUCores> B<true>|B<false>
4149 If enabled (the default) per-core CPU usage is reported.
4151 =item B<ShowMemory> B<true>|B<false>
4153 If enabled (the default) the physical memory usage of the MIC system is
4156 =item B<ShowTemperatures> B<true>|B<false>
4158 If enabled (the default) various temperatures of the MIC system are reported.
4160 =item B<Temperature> I<Name>
4162 This option controls which temperatures are being reported. Whether matching
4163 temperatures are being ignored or I<only> matching temperatures are reported
4164 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4165 temperatures are reported.
4167 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4169 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4170 (the default) only temperatures matching a B<Temperature> option are reported
4171 or, if no B<Temperature> option is specified, all temperatures are reported. If
4172 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4175 Known temperature names are:
4209 =item B<ShowPower> B<true>|B<false>
4211 If enabled (the default) various temperatures of the MIC system are reported.
4213 =item B<Power> I<Name>
4215 This option controls which power readings are being reported. Whether matching
4216 power readings are being ignored or I<only> matching power readings are reported
4217 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4218 power readings are reported.
4220 =item B<IgnoreSelectedPower> B<false>|B<true>
4222 Controls the behavior of the B<Power> setting above. If set to B<false>
4223 (the default) only power readings matching a B<Power> option are reported
4224 or, if no B<Power> option is specified, all power readings are reported. If
4225 set to B<true>, matching power readings are I<ignored> and all other power readings
4228 Known power names are:
4234 Total power utilization averaged over Time Window 0 (uWatts).
4238 Total power utilization averaged over Time Window 0 (uWatts).
4242 Instantaneous power (uWatts).
4246 Max instantaneous power (uWatts).
4250 PCI-E connector power (uWatts).
4254 2x3 connector power (uWatts).
4258 2x4 connector power (uWatts).
4266 Uncore rail (uVolts).
4270 Memory subsystem rail (uVolts).
4276 =head2 Plugin C<memory>
4278 The I<memory plugin> provides the following configuration options:
4282 =item B<ValuesAbsolute> B<true>|B<false>
4284 Enables or disables reporting of physical memory usage in absolute numbers,
4285 i.e. bytes. Defaults to B<true>.
4287 =item B<ValuesPercentage> B<false>|B<true>
4289 Enables or disables reporting of physical memory usage in percentages, e.g.
4290 percent of physical memory used. Defaults to B<false>.
4292 This is useful for deploying I<collectd> in a heterogeneous environment in
4293 which the sizes of physical memory vary.
4297 =head2 Plugin C<modbus>
4299 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4300 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4301 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4302 floating point values (two registers interpreted as IEEE floats in big endian
4307 <Data "voltage-input-1">
4310 RegisterCmd ReadHolding
4317 <Data "voltage-input-2">
4320 RegisterCmd ReadHolding
4325 <Data "supply-temperature-1">
4328 RegisterCmd ReadHolding
4333 <Host "modbus.example.com">
4334 Address "192.168.0.42"
4339 Instance "power-supply"
4340 Collect "voltage-input-1"
4341 Collect "voltage-input-2"
4346 Device "/dev/ttyUSB0"
4351 Instance "temperature"
4352 Collect "supply-temperature-1"
4358 =item E<lt>B<Data> I<Name>E<gt> blocks
4360 Data blocks define a mapping between register numbers and the "types" used by
4363 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4367 =item B<RegisterBase> I<Number>
4369 Configures the base register to read from the device. If the option
4370 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4371 register will be read (the register number is increased by one).
4373 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4375 Specifies what kind of data is returned by the device. This defaults to
4376 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4377 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4378 and B<RegisterBase+1> will be read and the data is combined into one
4379 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4380 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4381 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4382 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4383 registers are swapped with the most significant 16E<nbsp>bits in
4384 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4385 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4386 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4387 B<RegisterBase+3> will be read and the data combined into one
4390 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4392 Specifies register type to be collected from device. Works only with libmodbus
4393 2.9.2 or higher. Defaults to B<ReadHolding>.
4395 =item B<Type> I<Type>
4397 Specifies the "type" (data set) to use when dispatching the value to
4398 I<collectd>. Currently, only data sets with exactly one data source are
4401 =item B<Instance> I<Instance>
4403 Sets the type instance to use when dispatching the value to I<Instance>. If
4404 unset, an empty string (no type instance) is used.
4406 =item B<Scale> I<Value>
4408 The values taken from device are multiplied by I<Value>. The field is optional
4409 and the default is B<1.0>.
4411 =item B<Shift> I<Value>
4413 I<Value> is added to values from device after they have been multiplied by
4414 B<Scale> value. The field is optional and the default value is B<0.0>.
4418 =item E<lt>B<Host> I<Name>E<gt> blocks
4420 Host blocks are used to specify to which hosts to connect and what data to read
4421 from their "slaves". The string argument I<Name> is used as hostname when
4422 dispatching the values to I<collectd>.
4424 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4428 =item B<Address> I<Hostname>
4430 For Modbus/TCP, specifies the node name (the actual network address) used to
4431 connect to the host. This may be an IP address or a hostname. Please note that
4432 the used I<libmodbus> library only supports IPv4 at the moment.
4434 =item B<Port> I<Service>
4436 for Modbus/TCP, specifies the port used to connect to the host. The port can
4437 either be given as a number or as a service name. Please note that the
4438 I<Service> argument must be a string, even if ports are given in their numerical
4439 form. Defaults to "502".
4441 =item B<Device> I<Devicenode>
4443 For Modbus/RTU, specifies the path to the serial device being used.
4445 =item B<Baudrate> I<Baudrate>
4447 For Modbus/RTU, specifies the baud rate of the serial device.
4448 Note, connections currently support only 8/N/1.
4450 =item B<Interval> I<Interval>
4452 Sets the interval (in seconds) in which the values will be collected from this
4453 host. By default the global B<Interval> setting will be used.
4455 =item E<lt>B<Slave> I<ID>E<gt>
4457 Over each connection, multiple Modbus devices may be reached. The slave ID
4458 is used to specify which device should be addressed. For each device you want
4459 to query, one B<Slave> block must be given.
4461 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4465 =item B<Instance> I<Instance>
4467 Specify the plugin instance to use when dispatching the values to I<collectd>.
4468 By default "slave_I<ID>" is used.
4470 =item B<Collect> I<DataName>
4472 Specifies which data to retrieve from the device. I<DataName> must be the same
4473 string as the I<Name> argument passed to a B<Data> block. You can specify this
4474 option multiple times to collect more than one value from a slave. At least one
4475 B<Collect> option is mandatory.
4483 =head2 Plugin C<mqtt>
4485 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4486 values from MQTT (B<Subscribe> blocks).
4492 Host "mqtt.example.com"
4496 Host "mqtt.example.com"
4501 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4502 configuring the sending and receiving direction respectively. The plugin will
4503 register a write callback named C<mqtt/I<name>> where I<name> is the string
4504 argument given to the B<Publish> block. Both types of blocks share many but not
4505 all of the following options. If an option is valid in only one of the blocks,
4506 it will be mentioned explicitly.
4512 =item B<Host> I<Hostname>
4514 Hostname of the MQTT broker to connect to.
4516 =item B<Port> I<Service>
4518 Port number or service name of the MQTT broker to connect to.
4520 =item B<User> I<UserName>
4522 Username used when authenticating to the MQTT broker.
4524 =item B<Password> I<Password>
4526 Password used when authenticating to the MQTT broker.
4528 =item B<ClientId> I<ClientId>
4530 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4532 =item B<QoS> [B<0>-B<2>]
4534 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4552 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4553 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4554 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4555 on a message is larger than the maximum accepted QoS of a subscriber, the
4556 message's QoS will be downgraded.
4558 =item B<Prefix> I<Prefix> (Publish only)
4560 This plugin will use one topic per I<value list> which will looks like a path.
4561 I<Prefix> is used as the first path element and defaults to B<collectd>.
4563 An example topic name would be:
4565 collectd/cpu-0/cpu-user
4567 =item B<Retain> B<false>|B<true> (Publish only)
4569 Controls whether the MQTT broker will retain (keep a copy of) the last message
4570 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4572 =item B<StoreRates> B<true>|B<false> (Publish only)
4574 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4575 before sending. Defaults to B<true>.
4577 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4579 Controls whether the MQTT "cleans" the session up after the subscriber
4580 disconnects or if it maintains the subscriber's subscriptions and all messages
4581 that arrive while the subscriber is disconnected. Defaults to B<true>.
4583 =item B<Topic> I<TopicName> (Subscribe only)
4585 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4586 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4587 the B<collectd> branch.
4589 =item B<CACert> I<file>
4591 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4592 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4593 port of the MQTT broker.
4594 This option enables the use of TLS.
4596 =item B<CertificateFile> I<file>
4598 Path to the PEM-encoded certificate file to use as client certificate when
4599 connecting to the MQTT broker.
4600 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4602 =item B<CertificateKeyFile> I<file>
4604 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4605 Only valid if B<CACert> and B<CertificateFile> are also set.
4607 =item B<TLSProtocol> I<protocol>
4609 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4610 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4611 version is used which depends on the version of OpenSSL the Mosquitto library
4613 Only valid if B<CACert> is set.
4615 =item B<CipherSuite> I<ciphersuite>
4617 A string describing the ciphers available for use. See L<ciphers(1)> and the
4618 C<openssl ciphers> utility for more information. If unset, the default ciphers
4620 Only valid if B<CACert> is set.
4624 =head2 Plugin C<mysql>
4626 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4627 one or more databases when started and keeps the connection up as long as
4628 possible. When the connection is interrupted for whatever reason it will try
4629 to re-connect. The plugin will complain loudly in case anything goes wrong.
4631 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4632 and collects information about MySQL network traffic, executed statements,
4633 requests, the query cache and threads by evaluating the
4634 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4635 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4636 Status Variables> for an explanation of these values.
4638 Optionally, master and slave statistics may be collected in a MySQL
4639 replication setup. In that case, information about the synchronization state
4640 of the nodes are collected by evaluating the C<Position> return value of the
4641 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4642 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4643 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4644 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4645 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4657 SSLKey "/path/to/key.pem"
4658 SSLCert "/path/to/cert.pem"
4659 SSLCA "/path/to/ca.pem"
4660 SSLCAPath "/path/to/cas/"
4661 SSLCipher "DHE-RSA-AES256-SHA"
4667 Socket "/var/run/mysql/mysqld.sock"
4669 SlaveNotifications true
4675 Socket "/var/run/mysql/mysqld.sock"
4680 A B<Database> block defines one connection to a MySQL database. It accepts a
4681 single argument which specifies the name of the database. None of the other
4682 options are required. MySQL will use default values as documented in the
4683 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4684 B<MySQL reference manual>.
4688 =item B<Alias> I<Alias>
4690 Alias to use as sender instead of hostname when reporting. This may be useful
4691 when having cryptic hostnames.
4693 =item B<Host> I<Hostname>
4695 Hostname of the database server. Defaults to B<localhost>.
4697 =item B<User> I<Username>
4699 Username to use when connecting to the database. The user does not have to be
4700 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4701 unless you want to collectd replication statistics (see B<MasterStats> and
4702 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4703 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4705 =item B<Password> I<Password>
4707 Password needed to log into the database.
4709 =item B<Database> I<Database>
4711 Select this database. Defaults to I<no database> which is a perfectly reasonable
4712 option for what this plugin does.
4714 =item B<Port> I<Port>
4716 TCP-port to connect to. The port must be specified in its numeric form, but it
4717 must be passed as a string nonetheless. For example:
4721 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4722 See the documentation for the C<mysql_real_connect> function for details.
4724 =item B<Socket> I<Socket>
4726 Specifies the path to the UNIX domain socket of the MySQL server. This option
4727 only has any effect, if B<Host> is set to B<localhost> (the default).
4728 Otherwise, use the B<Port> option above. See the documentation for the
4729 C<mysql_real_connect> function for details.
4731 =item B<InnodbStats> I<true|false>
4733 If enabled, metrics about the InnoDB storage engine are collected.
4734 Disabled by default.
4736 =item B<MasterStats> I<true|false>
4738 =item B<SlaveStats> I<true|false>
4740 Enable the collection of master / slave statistics in a replication setup. In
4741 order to be able to get access to these statistics, the user needs special
4742 privileges. See the B<User> documentation above. Defaults to B<false>.
4744 =item B<SlaveNotifications> I<true|false>
4746 If enabled, the plugin sends a notification if the replication slave I/O and /
4747 or SQL threads are not running. Defaults to B<false>.
4749 =item B<WsrepStats> I<true|false>
4751 Enable the collection of wsrep plugin statistics, used in Master-Master
4752 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4753 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4755 =item B<ConnectTimeout> I<Seconds>
4757 Sets the connect timeout for the MySQL client.
4759 =item B<SSLKey> I<Path>
4761 If provided, the X509 key in PEM format.
4763 =item B<SSLCert> I<Path>
4765 If provided, the X509 cert in PEM format.
4767 =item B<SSLCA> I<Path>
4769 If provided, the CA file in PEM format (check OpenSSL docs).
4771 =item B<SSLCAPath> I<Path>
4773 If provided, the CA directory (check OpenSSL docs).
4775 =item B<SSLCipher> I<String>
4777 If provided, the SSL cipher to use.
4781 =head2 Plugin C<netapp>
4783 The netapp plugin can collect various performance and capacity information
4784 from a NetApp filer using the NetApp API.
4786 Please note that NetApp has a wide line of products and a lot of different
4787 software versions for each of these products. This plugin was developed for a
4788 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4789 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4790 model and software version but it is very hard to test this.
4791 If you have used this plugin with other models and/or software version, feel
4792 free to send us a mail to tell us about the results, even if it's just a short
4795 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4796 basic authentication.
4798 B<Do not use a regular user for this!> Create a special collectd user with just
4799 the minimum of capabilities needed. The user only needs the "login-http-admin"
4800 capability as well as a few more depending on which data will be collected.
4801 Required capabilities are documented below.
4806 <Host "netapp1.example.com">
4830 IgnoreSelectedIO false
4832 IgnoreSelectedOps false
4833 GetLatency "volume0"
4834 IgnoreSelectedLatency false
4841 IgnoreSelectedCapacity false
4844 IgnoreSelectedSnapshot false
4872 The netapp plugin accepts the following configuration options:
4876 =item B<Host> I<Name>
4878 A host block defines one NetApp filer. It will appear in collectd with the name
4879 you specify here which does not have to be its real name nor its hostname (see
4880 the B<Address> option below).
4882 =item B<VFiler> I<Name>
4884 A B<VFiler> block may only be used inside a host block. It accepts all the
4885 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4886 will execute all NetApp API commands in the context of the specified
4887 VFiler(R). It will appear in collectd with the name you specify here which
4888 does not have to be its real name. The VFiler name may be specified using the
4889 B<VFilerName> option. If this is not specified, it will default to the name
4892 The VFiler block inherits all connection related settings from the surrounding
4893 B<Host> block (which appear before the B<VFiler> block) but they may be
4894 overwritten inside the B<VFiler> block.
4896 This feature is useful, for example, when using a VFiler as SnapVault target
4897 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4898 available in the host filer (vfiler0) but only in the respective VFiler
4901 =item B<Protocol> B<httpd>|B<http>
4903 The protocol collectd will use to query this host.
4911 Valid options: http, https
4913 =item B<Address> I<Address>
4915 The hostname or IP address of the host.
4921 Default: The "host" block's name.
4923 =item B<Port> I<Port>
4925 The TCP port to connect to on the host.
4931 Default: 80 for protocol "http", 443 for protocol "https"
4933 =item B<User> I<User>
4935 =item B<Password> I<Password>
4937 The username and password to use to login to the NetApp.
4943 =item B<VFilerName> I<Name>
4945 The name of the VFiler in which context to execute API commands. If not
4946 specified, the name provided to the B<VFiler> block will be used instead.
4952 Default: name of the B<VFiler> block
4954 B<Note:> This option may only be used inside B<VFiler> blocks.
4956 =item B<Interval> I<Interval>
4962 The following options decide what kind of data will be collected. You can
4963 either use them as a block and fine tune various parameters inside this block,
4964 use them as a single statement to just accept all default values, or omit it to
4965 not collect any data.
4967 The following options are valid inside all blocks:
4971 =item B<Interval> I<Seconds>
4973 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4974 host specific setting.
4978 =head3 The System block
4980 This will collect various performance data about the whole system.
4982 B<Note:> To get this data the collectd user needs the
4983 "api-perf-object-get-instances" capability.
4987 =item B<Interval> I<Seconds>
4989 Collect disk statistics every I<Seconds> seconds.
4991 =item B<GetCPULoad> B<true>|B<false>
4993 If you set this option to true the current CPU usage will be read. This will be
4994 the average usage between all CPUs in your NetApp without any information about
4997 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4998 returns in the "CPU" field.
5006 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5008 =item B<GetInterfaces> B<true>|B<false>
5010 If you set this option to true the current traffic of the network interfaces
5011 will be read. This will be the total traffic over all interfaces of your NetApp
5012 without any information about individual interfaces.
5014 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5015 in the "Net kB/s" field.
5025 Result: One value list of type "if_octects".
5027 =item B<GetDiskIO> B<true>|B<false>
5029 If you set this option to true the current IO throughput will be read. This
5030 will be the total IO of your NetApp without any information about individual
5031 disks, volumes or aggregates.
5033 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5034 in the "DiskE<nbsp>kB/s" field.
5042 Result: One value list of type "disk_octets".
5044 =item B<GetDiskOps> B<true>|B<false>
5046 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5047 iSCSI, etc. operations will be read. This will be the total number of
5048 operations on your NetApp without any information about individual volumes or
5051 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5052 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5060 Result: A variable number of value lists of type "disk_ops_complex". Each type
5061 of operation will result in one value list with the name of the operation as
5066 =head3 The WAFL block
5068 This will collect various performance data about the WAFL file system. At the
5069 moment this just means cache performance.
5071 B<Note:> To get this data the collectd user needs the
5072 "api-perf-object-get-instances" capability.
5074 B<Note:> The interface to get these values is classified as "Diagnostics" by
5075 NetApp. This means that it is not guaranteed to be stable even between minor
5080 =item B<Interval> I<Seconds>
5082 Collect disk statistics every I<Seconds> seconds.
5084 =item B<GetNameCache> B<true>|B<false>
5092 Result: One value list of type "cache_ratio" and type instance
5095 =item B<GetDirCache> B<true>|B<false>
5103 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5105 =item B<GetInodeCache> B<true>|B<false>
5113 Result: One value list of type "cache_ratio" and type instance
5116 =item B<GetBufferCache> B<true>|B<false>
5118 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5119 in the "Cache hit" field.
5127 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5131 =head3 The Disks block
5133 This will collect performance data about the individual disks in the NetApp.
5135 B<Note:> To get this data the collectd user needs the
5136 "api-perf-object-get-instances" capability.
5140 =item B<Interval> I<Seconds>
5142 Collect disk statistics every I<Seconds> seconds.
5144 =item B<GetBusy> B<true>|B<false>
5146 If you set this option to true the busy time of all disks will be calculated
5147 and the value of the busiest disk in the system will be written.
5149 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5150 in the "Disk util" field. Probably.
5158 Result: One value list of type "percent" and type instance "disk_busy".
5162 =head3 The VolumePerf block
5164 This will collect various performance data about the individual volumes.
5166 You can select which data to collect about which volume using the following
5167 options. They follow the standard ignorelist semantic.
5169 B<Note:> To get this data the collectd user needs the
5170 I<api-perf-object-get-instances> capability.
5174 =item B<Interval> I<Seconds>
5176 Collect volume performance data every I<Seconds> seconds.
5178 =item B<GetIO> I<Volume>
5180 =item B<GetOps> I<Volume>
5182 =item B<GetLatency> I<Volume>
5184 Select the given volume for IO, operations or latency statistics collection.
5185 The argument is the name of the volume without the C</vol/> prefix.
5187 Since the standard ignorelist functionality is used here, you can use a string
5188 starting and ending with a slash to specify regular expression matching: To
5189 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5192 GetIO "/^vol[027]$/"
5194 If no regular expression is specified, an exact match is required. Both,
5195 regular and exact matching are case sensitive.
5197 If no volume was specified at all for either of the three options, that data
5198 will be collected for all available volumes.
5200 See F</"IGNORELISTS"> for details.
5202 =item B<IgnoreSelectedIO> B<true>|B<false>
5204 =item B<IgnoreSelectedOps> B<true>|B<false>
5206 =item B<IgnoreSelectedLatency> B<true>|B<false>
5208 When set to B<true>, the volumes selected for IO, operations or latency
5209 statistics collection will be ignored and the data will be collected for all
5212 When set to B<false>, data will only be collected for the specified volumes and
5213 all other volumes will be ignored.
5215 If no volumes have been specified with the above B<Get*> options, all volumes
5216 will be collected regardless of the B<IgnoreSelected*> option.
5218 Defaults to B<false>
5222 =head3 The VolumeUsage block
5224 This will collect capacity data about the individual volumes.
5226 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5231 =item B<Interval> I<Seconds>
5233 Collect volume usage statistics every I<Seconds> seconds.
5235 =item B<GetCapacity> I<VolumeName>
5237 The current capacity of the volume will be collected. This will result in two
5238 to four value lists, depending on the configuration of the volume. All data
5239 sources are of type "df_complex" with the name of the volume as
5242 There will be type_instances "used" and "free" for the number of used and
5243 available bytes on the volume. If the volume has some space reserved for
5244 snapshots, a type_instance "snap_reserved" will be available. If the volume
5245 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5246 number of bytes saved by the SIS feature.
5248 B<Note:> The current NetApp API has a bug that results in this value being
5249 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5250 number which works most of the time. If you see strange values here, bug
5251 NetApp support to fix this.
5253 Repeat this option to specify multiple volumes.
5255 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5257 Specify whether to collect only the volumes selected by the B<GetCapacity>
5258 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5259 B<false>. However, if no B<GetCapacity> option is specified at all, all
5260 capacities will be selected anyway.
5262 =item B<GetSnapshot> I<VolumeName>
5264 Select volumes from which to collect snapshot information.
5266 Usually, the space used for snapshots is included in the space reported as
5267 "used". If snapshot information is collected as well, the space used for
5268 snapshots is subtracted from the used space.
5270 To make things even more interesting, it is possible to reserve space to be
5271 used for snapshots. If the space required for snapshots is less than that
5272 reserved space, there is "reserved free" and "reserved used" space in addition
5273 to "free" and "used". If the space required for snapshots exceeds the reserved
5274 space, that part allocated in the normal space is subtracted from the "used"
5277 Repeat this option to specify multiple volumes.
5279 =item B<IgnoreSelectedSnapshot>
5281 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5282 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5283 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5284 capacities will be selected anyway.
5288 =head3 The Quota block
5290 This will collect (tree) quota statistics (used disk space and number of used
5291 files). This mechanism is useful to get usage information for single qtrees.
5292 In case the quotas are not used for any other purpose, an entry similar to the
5293 following in C</etc/quotas> would be sufficient:
5295 /vol/volA/some_qtree tree - - - - -
5297 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5301 =item B<Interval> I<Seconds>
5303 Collect SnapVault(R) statistics every I<Seconds> seconds.
5307 =head3 The SnapVault block
5309 This will collect statistics about the time and traffic of SnapVault(R)
5314 =item B<Interval> I<Seconds>
5316 Collect SnapVault(R) statistics every I<Seconds> seconds.
5320 =head2 Plugin C<netlink>
5322 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5323 statistics of various interface and routing aspects.
5327 =item B<Interface> I<Interface>
5329 =item B<VerboseInterface> I<Interface>
5331 Instruct the plugin to collect interface statistics. This is basically the same
5332 as the statistics provided by the C<interface> plugin (see above) but
5333 potentially much more detailed.
5335 When configuring with B<Interface> only the basic statistics will be collected,
5336 namely octets, packets, and errors. These statistics are collected by
5337 the C<interface> plugin, too, so using both at the same time is no benefit.
5339 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5340 so that no data needs to be collected twice if you use the C<interface> plugin.
5341 This includes dropped packets, received multicast packets, collisions and a
5342 whole zoo of differentiated RX and TX errors. You can try the following command
5343 to get an idea of what awaits you:
5347 If I<Interface> is B<All>, all interfaces will be selected.
5349 =item B<QDisc> I<Interface> [I<QDisc>]
5351 =item B<Class> I<Interface> [I<Class>]
5353 =item B<Filter> I<Interface> [I<Filter>]
5355 Collect the octets and packets that pass a certain qdisc, class or filter.
5357 QDiscs and classes are identified by their type and handle (or classid).
5358 Filters don't necessarily have a handle, therefore the parent's handle is used.
5359 The notation used in collectd differs from that used in tc(1) in that it
5360 doesn't skip the major or minor number if it's zero and doesn't print special
5361 ids by their name. So, for example, a qdisc may be identified by
5362 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5363 thus not displayed by tc(1).
5365 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5366 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5367 associated with that interface will be collected.
5369 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5370 used. This may lead to problems when more than one filter is attached to a
5371 qdisc or class. This isn't nice, but we don't know how this could be done any
5372 better. If you have a idea, please don't hesitate to tell us.
5374 As with the B<Interface> option you can specify B<All> as the interface,
5375 meaning all interfaces.
5377 Here are some examples to help you understand the above text more easily:
5380 VerboseInterface "All"
5381 QDisc "eth0" "pfifo_fast-1:0"
5383 Class "ppp0" "htb-1:10"
5384 Filter "ppp0" "u32-1:0"
5387 See F</"IGNORELISTS"> for details.
5389 =item B<IgnoreSelected>
5391 The behavior is the same as with all other similar plugins: If nothing is
5392 selected at all, everything is collected. If some things are selected using the
5393 options described above, only these statistics are collected. If you set
5394 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5395 specified statistics will not be collected.
5399 =head2 Plugin C<network>
5401 The Network plugin sends data to a remote instance of collectd, receives data
5402 from a remote instance, or both at the same time. Data which has been received
5403 from the network is usually not transmitted again, but this can be activated, see
5404 the B<Forward> option below.
5406 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5407 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5409 Both, B<Server> and B<Listen> can be used as single option or as block. When
5410 used as block, given options are valid for this socket only. The following
5411 example will export the metrics twice: Once to an "internal" server (without
5412 encryption and signing) and one to an external server (with cryptographic
5416 # Export to an internal server
5417 # (demonstrates usage without additional options)
5418 Server "collectd.internal.tld"
5420 # Export to an external server
5421 # (demonstrates usage with signature options)
5422 <Server "collectd.external.tld">
5423 SecurityLevel "sign"
5424 Username "myhostname"
5431 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5433 The B<Server> statement/block sets the server to send datagrams to. The
5434 statement may occur multiple times to send each datagram to multiple
5437 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5438 optional second argument specifies a port number or a service name. If not
5439 given, the default, B<25826>, is used.
5441 The following options are recognized within B<Server> blocks:
5445 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5447 Set the security you require for network communication. When the security level
5448 has been set to B<Encrypt>, data sent over the network will be encrypted using
5449 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5450 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5451 authentication code. When set to B<None>, data is sent without any security.
5453 This feature is only available if the I<network> plugin was linked with
5456 =item B<Username> I<Username>
5458 Sets the username to transmit. This is used by the server to lookup the
5459 password. See B<AuthFile> below. All security levels except B<None> require
5462 This feature is only available if the I<network> plugin was linked with
5465 =item B<Password> I<Password>
5467 Sets a password (shared secret) for this socket. All security levels except
5468 B<None> require this setting.
5470 This feature is only available if the I<network> plugin was linked with
5473 =item B<Interface> I<Interface name>
5475 Set the outgoing interface for IP packets. This applies at least
5476 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5477 undefined or a non-existent interface name is specified, the default
5478 behavior is to let the kernel choose the appropriate interface. Be warned
5479 that the manual selection of an interface for unicast traffic is only
5480 necessary in rare cases.
5482 =item B<BindAddress> I<IP Address>
5484 Set the outgoing IP address for IP packets. This option can be used instead of
5485 the I<Interface> option to explicitly define the IP address which will be used
5486 to send Packets to the remote server.
5488 =item B<ResolveInterval> I<Seconds>
5490 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5491 useful to force a regular DNS lookup to support a high availability setup. If
5492 not specified, re-resolves are never attempted.
5496 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5498 The B<Listen> statement sets the interfaces to bind to. When multiple
5499 statements are found the daemon will bind to multiple interfaces.
5501 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5502 the argument is a multicast address the daemon will join that multicast group.
5503 The optional second argument specifies a port number or a service name. If not
5504 given, the default, B<25826>, is used.
5506 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5510 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5512 Set the security you require for network communication. When the security level
5513 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5514 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5515 signed and encrypted data is accepted. When set to B<None>, all data will be
5516 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5517 decrypted if possible.
5519 This feature is only available if the I<network> plugin was linked with
5522 =item B<AuthFile> I<Filename>
5524 Sets a file in which usernames are mapped to passwords. These passwords are
5525 used to verify signatures and to decrypt encrypted network packets. If
5526 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5527 verified and encrypted packets are decrypted. Otherwise, signed data is
5528 accepted without checking the signature and encrypted data cannot be decrypted.
5529 For the other security levels this option is mandatory.
5531 The file format is very simple: Each line consists of a username followed by a
5532 colon and any number of spaces followed by the password. To demonstrate, an
5533 example file could look like this:
5538 Each time a packet is received, the modification time of the file is checked
5539 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5540 the file is being read, it is locked using L<fcntl(2)>.
5542 =item B<Interface> I<Interface name>
5544 Set the incoming interface for IP packets explicitly. This applies at least
5545 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5546 undefined or a non-existent interface name is specified, the default
5547 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5548 traffic gets only accepted, if it arrives on the given interface.
5552 =item B<TimeToLive> I<1-255>
5554 Set the time-to-live of sent packets. This applies to all, unicast and
5555 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5556 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5559 =item B<MaxPacketSize> I<1024-65535>
5561 Set the maximum size for datagrams received over the network. Packets larger
5562 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5563 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5566 On the server side, this limit should be set to the largest value used on
5567 I<any> client. Likewise, the value on the client must not be larger than the
5568 value on the server, or data will be lost.
5570 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5571 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5572 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5575 =item B<Forward> I<true|false>
5577 If set to I<true>, write packets that were received via the network plugin to
5578 the sending sockets. This should only be activated when the B<Listen>- and
5579 B<Server>-statements differ. Otherwise packets may be send multiple times to
5580 the same multicast group. While this results in more network traffic than
5581 necessary it's not a huge problem since the plugin has a duplicate detection,
5582 so the values will not loop.
5584 =item B<ReportStats> B<true>|B<false>
5586 The network plugin cannot only receive and send statistics, it can also create
5587 statistics about itself. Collectd data included the number of received and
5588 sent octets and packets, the length of the receive queue and the number of
5589 values handled. When set to B<true>, the I<Network plugin> will make these
5590 statistics available. Defaults to B<false>.
5594 =head2 Plugin C<nfs>
5596 The I<nfs plugin> collects information about the usage of the Network File
5597 System (NFS). It counts the number of procedure calls for each procedure,
5598 grouped by version and whether the system runs as server or client.
5600 It is possibly to omit metrics for a specific NFS version by setting one or
5601 more of the following options to B<false> (all of them default to B<true>).
5605 =item B<ReportV2> B<true>|B<false>
5607 =item B<ReportV3> B<true>|B<false>
5609 =item B<ReportV4> B<true>|B<false>
5613 =head2 Plugin C<nginx>
5615 This plugin collects the number of connections and requests handled by the
5616 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5617 queries the page provided by the C<ngx_http_stub_status_module> module, which
5618 isn't compiled by default. Please refer to
5619 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5620 how to compile and configure nginx and this module.
5622 The following options are accepted by the C<nginx plugin>:
5626 =item B<URL> I<http://host/nginx_status>
5628 Sets the URL of the C<ngx_http_stub_status_module> output.
5630 =item B<User> I<Username>
5632 Optional user name needed for authentication.
5634 =item B<Password> I<Password>
5636 Optional password needed for authentication.
5638 =item B<VerifyPeer> B<true|false>
5640 Enable or disable peer SSL certificate verification. See
5641 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5643 =item B<VerifyHost> B<true|false>
5645 Enable or disable peer host name verification. If enabled, the plugin checks
5646 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5647 certificate matches the host name provided by the B<URL> option. If this
5648 identity check fails, the connection is aborted. Obviously, only works when
5649 connecting to a SSL enabled server. Enabled by default.
5651 =item B<CACert> I<File>
5653 File that holds one or more SSL certificates. If you want to use HTTPS you will
5654 possibly need this option. What CA certificates come bundled with C<libcurl>
5655 and are checked by default depends on the distribution you use.
5657 =item B<Timeout> I<Milliseconds>
5659 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5660 milliseconds. By default, the configured B<Interval> is used to set the
5665 =head2 Plugin C<notify_desktop>
5667 This plugin sends a desktop notification to a notification daemon, as defined
5668 in the Desktop Notification Specification. To actually display the
5669 notifications, B<notification-daemon> is required and B<collectd> has to be
5670 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5671 environment variables have to be set correctly) and the D-Bus message bus.
5673 The Desktop Notification Specification can be found at
5674 L<http://www.galago-project.org/specs/notification/>.
5678 =item B<OkayTimeout> I<timeout>
5680 =item B<WarningTimeout> I<timeout>
5682 =item B<FailureTimeout> I<timeout>
5684 Set the I<timeout>, in milliseconds, after which to expire the notification
5685 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5686 been specified, the displayed notification will not be closed at all - the
5687 user has to do so herself. These options default to 5000. If a negative number
5688 has been specified, the default is used as well.
5692 =head2 Plugin C<notify_email>
5694 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5695 configured email address.
5697 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5699 Available configuration options:
5703 =item B<From> I<Address>
5705 Email address from which the emails should appear to come from.
5707 Default: C<root@localhost>
5709 =item B<Recipient> I<Address>
5711 Configures the email address(es) to which the notifications should be mailed.
5712 May be repeated to send notifications to multiple addresses.
5714 At least one B<Recipient> must be present for the plugin to work correctly.
5716 =item B<SMTPServer> I<Hostname>
5718 Hostname of the SMTP server to connect to.
5720 Default: C<localhost>
5722 =item B<SMTPPort> I<Port>
5724 TCP port to connect to.
5728 =item B<SMTPUser> I<Username>
5730 Username for ASMTP authentication. Optional.
5732 =item B<SMTPPassword> I<Password>
5734 Password for ASMTP authentication. Optional.
5736 =item B<Subject> I<Subject>
5738 Subject-template to use when sending emails. There must be exactly two
5739 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5740 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5743 Default: C<Collectd notify: %s@%s>
5747 =head2 Plugin C<notify_nagios>
5749 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5750 a I<passive service check result>.
5752 Available configuration options:
5756 =item B<CommandFile> I<Path>
5758 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5762 =head2 Plugin C<ntpd>
5764 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5767 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5768 the wire - using B<mode 7> specific requests. This mode is deprecated with
5769 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5770 correctly with them, the ntp daemon must be explicitly configured to
5771 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5772 manual page for details.
5774 Available configuration options for the C<ntpd> plugin:
5778 =item B<Host> I<Hostname>
5780 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5782 =item B<Port> I<Port>
5784 UDP-Port to connect to. Defaults to B<123>.
5786 =item B<ReverseLookups> B<true>|B<false>
5788 Sets whether or not to perform reverse lookups on peers. Since the name or
5789 IP-address may be used in a filename it is recommended to disable reverse
5790 lookups. The default is to do reverse lookups to preserve backwards
5791 compatibility, though.
5793 =item B<IncludeUnitID> B<true>|B<false>
5795 When a peer is a refclock, include the unit ID in the I<type instance>.
5796 Defaults to B<false> for backward compatibility.
5798 If two refclock peers use the same driver and this is B<false>, the plugin will
5799 try to write simultaneous measurements from both to the same type instance.
5800 This will result in error messages in the log and only one set of measurements
5805 =head2 Plugin C<nut>
5809 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5811 Add a UPS to collect data from. The format is identical to the one accepted by
5814 =item B<ForceSSL> B<true>|B<false>
5816 Stops connections from falling back to unsecured if an SSL connection
5817 cannot be established. Defaults to false if undeclared.
5819 =item B<VerifyPeer> I<true>|I<false>
5821 If set to true, requires a CAPath be provided. Will use the CAPath to find
5822 certificates to use as Trusted Certificates to validate a upsd server certificate.
5823 If validation of the upsd server certificate fails, the connection will not be
5824 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5825 will override and set ForceSSL to true.
5827 =item B<CAPath> I/path/to/certs/folder
5829 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5830 The folder pointed at must contain certificate(s) named according to their hash.
5831 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5832 occur because two different certs have the same hash value, Y can be incremented
5833 in order to avoid conflict. To create a symbolic link to a certificate the following
5834 command can be used from within the directory where the cert resides:
5836 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5838 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5839 generate links like the one described above for ALL certs in a given folder.
5841 C<c_rehash /path/to/certs/folder>
5843 =item B<ConnectTimeout> I<Milliseconds>
5845 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5846 By default, the configured B<Interval> is used to set the timeout.
5850 =head2 Plugin C<olsrd>
5852 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5853 the Optimized Link State Routing daemon and reads information about the current
5854 state of the meshed network.
5856 The following configuration options are understood:
5860 =item B<Host> I<Host>
5862 Connect to I<Host>. Defaults to B<"localhost">.
5864 =item B<Port> I<Port>
5866 Specifies the port to connect to. This must be a string, even if you give the
5867 port as a number rather than a service name. Defaults to B<"2006">.
5869 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5871 Specifies what information to collect about links, i.E<nbsp>e. direct
5872 connections of the daemon queried. If set to B<No>, no information is
5873 collected. If set to B<Summary>, the number of links and the average of all
5874 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5875 If set to B<Detail> LQ and NLQ are collected per link.
5877 Defaults to B<Detail>.
5879 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5881 Specifies what information to collect about routes of the daemon queried. If
5882 set to B<No>, no information is collected. If set to B<Summary>, the number of
5883 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5884 metric and ETX are collected per route.
5886 Defaults to B<Summary>.
5888 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5890 Specifies what information to collect about the global topology. If set to
5891 B<No>, no information is collected. If set to B<Summary>, the number of links
5892 in the entire topology and the average I<link quality> (LQ) is calculated.
5893 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5895 Defaults to B<Summary>.
5899 =head2 Plugin C<onewire>
5901 B<EXPERIMENTAL!> See notes below.
5903 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5904 L<http://owfs.org/> to read sensors connected via the onewire bus.
5906 It can be used in two possible modes - standard or advanced.
5908 In the standard mode only temperature sensors (sensors with the family code
5909 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5910 other sensors you would like to have included, please send a sort request to
5911 the mailing list. You can select sensors to be read or to be ignored depending
5912 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5913 walked and all sensors are read.
5915 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5916 experimental, below.
5918 In the advanced mode you can configure any sensor to be read (only numerical
5919 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5920 In this mode you have to list all the sensors. Neither default bus walk nor
5921 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5922 the path automatically and should produce compatible structure with the "standard"
5923 mode (basically the path is expected as for example
5924 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5925 "F10FCA000800" and the rest after the slash is considered the type - here
5927 There are two advantages to this mode - you can access virtually any sensor
5928 (not just temperature), select whether to use cached or directly read values
5929 and it is slighlty faster. The downside is more complex configuration.
5931 The two modes are distinguished automatically by the format of the address.
5932 It is not possible to mix the two modes. Once a full path is detected in any
5933 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5934 (and as standard addresses will fail parsing they will be ignored).
5938 =item B<Device> I<Device>
5940 Sets the device to read the values from. This can either be a "real" hardware
5941 device, such as a serial port or an USB port, or the address of the
5942 L<owserver(1)> socket, usually B<localhost:4304>.
5944 Though the documentation claims to automatically recognize the given address
5945 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5946 with that version, the following configuration worked for us:
5949 Device "-s localhost:4304"
5952 This directive is B<required> and does not have a default value.
5954 =item B<Sensor> I<Sensor>
5956 In the standard mode selects sensors to collect or to ignore
5957 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5958 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5959 and B<not> include the leading C<10.> family byte and point.
5960 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5961 sensors (see above) are read.
5963 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5964 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5965 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5967 As there can be multiple devices on the bus you can list multiple sensor (use
5968 multiple B<Sensor> elements).
5970 See F</"IGNORELISTS"> for details.
5972 =item B<IgnoreSelected> I<true>|I<false>
5974 If no configuration is given, the B<onewire> plugin will collect data from all
5975 sensors found. This may not be practical, especially if sensors are added and
5976 removed regularly. Sometimes, however, it's easier/preferred to collect only
5977 specific sensors or all sensors I<except> a few specified ones. This option
5978 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5979 B<Sensor> is inverted: All selected interfaces are ignored and all other
5980 interfaces are collected.
5982 Used only in the standard mode - see above.
5984 =item B<Interval> I<Seconds>
5986 Sets the interval in which all sensors should be read. If not specified, the
5987 global B<Interval> setting is used.
5991 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5992 work with big setups. It works with one sensor being attached to one
5993 controller, but as soon as you throw in a couple more senors and maybe a hub
5994 or two, reading all values will take more than ten seconds (the default
5995 interval). We will probably add some separate thread for reading the sensors
5996 and some cache or something like that, but it's not done yet. We will try to
5997 maintain backwards compatibility in the future, but we can't promise. So in
5998 short: If it works for you: Great! But keep in mind that the config I<might>
5999 change, though this is unlikely. Oh, and if you want to help improving this
6000 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
6002 =head2 Plugin C<openldap>
6004 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
6005 server correctly. The backend database C<monitor> needs to be loaded and
6006 working. See slapd-monitor(5) for the details.
6008 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6009 blocks. Each block requires one string argument as the instance name. For
6014 URL "ldap://localhost/"
6017 URL "ldaps://localhost/"
6021 The instance name will be used as the I<plugin instance>. To emulate the old
6022 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6023 plugin to work correctly, each instance name must be unique. This is not
6024 enforced by the plugin and it is your responsibility to ensure it is.
6026 The following options are accepted within each B<Instance> block:
6030 =item B<URL> I<ldap://host/binddn>
6032 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6035 =item B<BindDN> I<BindDN>
6037 Name in the form of an LDAP distinguished name intended to be used for
6038 authentication. Defaults to empty string to establish an anonymous authorization.
6040 =item B<Password> I<Password>
6042 Password for simple bind authentication. If this option is not set,
6043 unauthenticated bind operation is used.
6045 =item B<StartTLS> B<true|false>
6047 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6048 Disabled by default.
6050 =item B<VerifyHost> B<true|false>
6052 Enables or disables peer host name verification. If enabled, the plugin checks
6053 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6054 certificate matches the host name provided by the B<URL> option. If this
6055 identity check fails, the connection is aborted. Enabled by default.
6057 =item B<CACert> I<File>
6059 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6060 may possibly need this option. What CA certificates are checked by default
6061 depends on the distribution you use and can be changed with the usual ldap
6062 client configuration mechanisms. See ldap.conf(5) for the details.
6064 =item B<Timeout> I<Seconds>
6066 Sets the timeout value for ldap operations, in seconds. By default, the
6067 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6070 =item B<Version> I<Version>
6072 An integer which sets the LDAP protocol version number to use when connecting
6073 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6077 =head2 Plugin C<openvpn>
6079 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6080 traffic statistics about connected clients.
6082 To set up OpenVPN to write to the status file periodically, use the
6083 B<--status> option of OpenVPN.
6085 So, in a nutshell you need:
6087 openvpn $OTHER_OPTIONS \
6088 --status "/var/run/openvpn-status" 10
6094 =item B<StatusFile> I<File>
6096 Specifies the location of the status file.
6098 =item B<ImprovedNamingSchema> B<true>|B<false>
6100 When enabled, the filename of the status file will be used as plugin instance
6101 and the client's "common name" will be used as type instance. This is required
6102 when reading multiple status files. Enabling this option is recommended, but to
6103 maintain backwards compatibility this option is disabled by default.
6105 =item B<CollectCompression> B<true>|B<false>
6107 Sets whether or not statistics about the compression used by OpenVPN should be
6108 collected. This information is only available in I<single> mode. Enabled by
6111 =item B<CollectIndividualUsers> B<true>|B<false>
6113 Sets whether or not traffic information is collected for each connected client
6114 individually. If set to false, currently no traffic data is collected at all
6115 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6117 =item B<CollectUserCount> B<true>|B<false>
6119 When enabled, the number of currently connected clients or users is collected.
6120 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6121 can be configured independently from that option. Defaults to B<false>.
6125 =head2 Plugin C<oracle>
6127 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6128 Oracle® Database and lets you execute SQL statements there. It is very similar
6129 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6130 plugin's documentation above for details.
6133 <Query "out_of_stock">
6134 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6137 # InstancePrefix "foo"
6138 InstancesFrom "category"
6142 <Database "product_information">
6147 Query "out_of_stock"
6151 =head3 B<Query> blocks
6153 The Query blocks are handled identically to the Query blocks of the "dbi"
6154 plugin. Please see its documentation above for details on how to specify
6157 =head3 B<Database> blocks
6159 Database blocks define a connection to a database and which queries should be
6160 sent to that database. Each database needs a "name" as string argument in the
6161 starting tag of the block. This name will be used as "PluginInstance" in the
6162 values submitted to the daemon. Other than that, that name is not used.
6166 =item B<Plugin> I<Plugin>
6168 Use I<Plugin> as the plugin name when submitting query results from
6169 this B<Database>. Defaults to C<oracle>.
6171 =item B<ConnectID> I<ID>
6173 Defines the "database alias" or "service name" to connect to. Usually, these
6174 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6176 =item B<Host> I<Host>
6178 Hostname to use when dispatching values for this database. Defaults to using
6179 the global hostname of the I<collectd> instance.
6181 =item B<Username> I<Username>
6183 Username used for authentication.
6185 =item B<Password> I<Password>
6187 Password used for authentication.
6189 =item B<Query> I<QueryName>
6191 Associates the query named I<QueryName> with this database connection. The
6192 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6193 blocks you want to refer to must be placed above the database block you want to
6198 =head2 Plugin C<ovs_events>
6200 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6201 connected interfaces, dispatches the values to collectd and sends the
6202 notification whenever the link state change occurs. This plugin uses OVS
6203 database to get a link state change notification.
6207 <Plugin "ovs_events">
6210 Socket "/var/run/openvswitch/db.sock"
6211 Interfaces "br0" "veth0"
6212 SendNotification true
6213 DispatchValues false
6216 The plugin provides the following configuration options:
6220 =item B<Address> I<node>
6222 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6223 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6224 option. See L<ovsdb-server(1)> for more details. The option may be either
6225 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6226 format. Defaults to C<localhost>.
6228 =item B<Port> I<service>
6230 TCP-port to connect to. Either a service name or a port number may be given.
6231 Defaults to B<6640>.
6233 =item B<Socket> I<path>
6235 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6236 plugin. To enable the interface, the OVS DB daemon should be running with
6237 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6238 option is set, B<Address> and B<Port> options are ignored.
6240 =item B<Interfaces> [I<ifname> ...]
6242 List of interface names to be monitored by this plugin. If this option is not
6243 specified or is empty then all OVS connected interfaces on all bridges are
6246 Default: empty (all interfaces on all bridges are monitored)
6248 =item B<SendNotification> I<true|false>
6250 If set to true, OVS link notifications (interface status and OVS DB connection
6251 terminate) are sent to collectd. Default value is true.
6253 =item B<DispatchValues> I<true|false>
6255 Dispatch the OVS DB interface link status value with configured plugin interval.
6256 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6257 options are false, no OVS information will be provided by the plugin.
6261 B<Note:> By default, the global interval setting is used within which to
6262 retrieve the OVS link status. To configure a plugin-specific interval, please
6263 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6264 simple divide the time by 1000 for example if the desired interval is 50ms, set
6267 =head2 Plugin C<ovs_stats>
6269 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6270 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6271 statistics from OVSDB
6275 <Plugin "ovs_stats">
6278 Socket "/var/run/openvswitch/db.sock"
6279 Bridges "br0" "br_ext"
6282 The plugin provides the following configuration options:
6286 =item B<Address> I<node>
6288 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6289 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6290 option. See L<ovsdb-server(1)> for more details. The option may be either
6291 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6292 format. Defaults to C<localhost>.
6294 =item B<Port> I<service>
6296 TCP-port to connect to. Either a service name or a port number may be given.
6297 Defaults to B<6640>.
6299 =item B<Socket> I<path>
6301 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6302 plugin. To enable the interface, the OVS DB daemon should be running with
6303 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6304 option is set, B<Address> and B<Port> options are ignored.
6306 =item B<Bridges> [I<brname> ...]
6308 List of OVS bridge names to be monitored by this plugin. If this option is
6309 omitted or is empty then all OVS bridges will be monitored.
6311 Default: empty (monitor all bridges)
6315 =head2 Plugin C<perl>
6317 This plugin embeds a Perl-interpreter into collectd and provides an interface
6318 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6320 =head2 Plugin C<pinba>
6322 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6323 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6324 PHP-based webpage has been delivered, the extension will send a UDP packet
6325 containing timing information, peak memory usage and so on. The plugin will
6326 wait for such packets, parse them and account the provided information, which
6327 is then dispatched to the daemon once per interval.
6334 # Overall statistics for the website.
6336 Server "www.example.com"
6338 # Statistics for www-a only
6340 Host "www-a.example.com"
6341 Server "www.example.com"
6343 # Statistics for www-b only
6345 Host "www-b.example.com"
6346 Server "www.example.com"
6350 The plugin provides the following configuration options:
6354 =item B<Address> I<Node>
6356 Configures the address used to open a listening socket. By default, plugin will
6357 bind to the I<any> address C<::0>.
6359 =item B<Port> I<Service>
6361 Configures the port (service) to bind to. By default the default Pinba port
6362 "30002" will be used. The option accepts service names in addition to port
6363 numbers and thus requires a I<string> argument.
6365 =item E<lt>B<View> I<Name>E<gt> block
6367 The packets sent by the Pinba extension include the hostname of the server, the
6368 server name (the name of the virtual host) and the script that was executed.
6369 Using B<View> blocks it is possible to separate the data into multiple groups
6370 to get more meaningful statistics. Each packet is added to all matching groups,
6371 so that a packet may be accounted for more than once.
6375 =item B<Host> I<Host>
6377 Matches the hostname of the system the webserver / script is running on. This
6378 will contain the result of the L<gethostname(2)> system call. If not
6379 configured, all hostnames will be accepted.
6381 =item B<Server> I<Server>
6383 Matches the name of the I<virtual host>, i.e. the contents of the
6384 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6385 server names will be accepted.
6387 =item B<Script> I<Script>
6389 Matches the name of the I<script name>, i.e. the contents of the
6390 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6391 script names will be accepted.
6397 =head2 Plugin C<ping>
6399 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6400 configured hosts periodically and measures the network latency. Whenever the
6401 C<read> function of the plugin is called, it submits the average latency, the
6402 standard deviation and the drop rate for each host.
6404 Available configuration options:
6408 =item B<Host> I<IP-address>
6410 Host to ping periodically. This option may be repeated several times to ping
6413 =item B<Interval> I<Seconds>
6415 Sets the interval in which to send ICMP echo packets to the configured hosts.
6416 This is B<not> the interval in which metrics are read from the plugin but the
6417 interval in which the hosts are "pinged". Therefore, the setting here should be
6418 smaller than or equal to the global B<Interval> setting. Fractional times, such
6419 as "1.24" are allowed.
6423 =item B<Timeout> I<Seconds>
6425 Time to wait for a response from the host to which an ICMP packet had been
6426 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6427 to be down or the packet to be dropped. This setting must be smaller than the
6428 B<Interval> setting above for the plugin to work correctly. Fractional
6429 arguments are accepted.
6433 =item B<TTL> I<0-255>
6435 Sets the Time-To-Live of generated ICMP packets.
6437 =item B<Size> I<size>
6439 Sets the size of the data payload in ICMP packet to specified I<size> (it
6440 will be filled with regular ASCII pattern). If not set, default 56 byte
6441 long string is used so that the packet size of an ICMPv4 packet is exactly
6442 64 bytes, similar to the behaviour of normal ping(1) command.
6444 =item B<SourceAddress> I<host>
6446 Sets the source address to use. I<host> may either be a numerical network
6447 address or a network hostname.
6449 =item B<AddressFamily> I<af>
6451 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6452 option will be ignored if you set a B<SourceAddress>.
6454 =item B<Device> I<name>
6456 Sets the outgoing network device to be used. I<name> has to specify an
6457 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6460 =item B<MaxMissed> I<Packets>
6462 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6463 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6465 Default: B<-1> (disabled)
6469 =head2 Plugin C<postgresql>
6471 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6472 keeps a persistent connection to all configured databases and tries to
6473 reconnect if the connection has been interrupted. A database is configured by
6474 specifying a B<Database> block as described below. The default statistics are
6475 collected from PostgreSQL's B<statistics collector> which thus has to be
6476 enabled for this plugin to work correctly. This should usually be the case by
6477 default. See the section "The Statistics Collector" of the B<PostgreSQL
6478 Documentation> for details.
6480 By specifying custom database queries using a B<Query> block as described
6481 below, you may collect any data that is available from some PostgreSQL
6482 database. This way, you are able to access statistics of external daemons
6483 which are available in a PostgreSQL database or use future or special
6484 statistics provided by PostgreSQL without the need to upgrade your collectd
6487 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6488 PostgreSQL databases as well. This has been implemented in a generic way. You
6489 need to specify an SQL statement which will then be executed by collectd in
6490 order to write the data (see below for details). The benefit of that approach
6491 is that there is no fixed database layout. Rather, the layout may be optimized
6492 for the current setup.
6494 The B<PostgreSQL Documentation> manual can be found at
6495 L<http://www.postgresql.org/docs/manuals/>.
6499 Statement "SELECT magic FROM wizard WHERE host = $1;"
6503 InstancePrefix "magic"
6508 <Query rt36_tickets>
6509 Statement "SELECT COUNT(type) AS count, type \
6511 WHEN resolved = 'epoch' THEN 'open' \
6512 ELSE 'resolved' END AS type \
6513 FROM tickets) type \
6517 InstancePrefix "rt36_tickets"
6518 InstancesFrom "type"
6524 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6535 KRBSrvName "kerberos_service_name"
6541 Service "service_name"
6542 Query backends # predefined
6553 The B<Query> block defines one database query which may later be used by a
6554 database definition. It accepts a single mandatory argument which specifies
6555 the name of the query. The names of all queries have to be unique (see the
6556 B<MinVersion> and B<MaxVersion> options below for an exception to this
6559 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6560 B<Result> blocks may be used to extract multiple values from a single query.
6562 The following configuration options are available to define the query:
6566 =item B<Statement> I<sql query statement>
6568 Specify the I<sql query statement> which the plugin should execute. The string
6569 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6570 first, second, etc. parameter. The value of the parameters is specified by the
6571 B<Param> configuration option - see below for details. To include a literal
6572 B<$> character followed by a number, surround it with single quotes (B<'>).
6574 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6575 allowed. Note, however, that only a single command may be used. Semicolons are
6576 allowed as long as a single non-empty command has been specified only.
6578 The returned lines will be handled separately one after another.
6580 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6582 Specify the parameters which should be passed to the SQL query. The parameters
6583 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6584 they appear in the configuration file. The value of the parameter is
6585 determined depending on the value of the B<Param> option as follows:
6591 The configured hostname of the database connection. If a UNIX domain socket is
6592 used, the parameter expands to "localhost".
6596 The name of the database of the current connection.
6600 The name of the database plugin instance. See the B<Instance> option of the
6601 database specification below for details.
6605 The username used to connect to the database.
6609 The interval with which this database is queried (as specified by the database
6610 specific or global B<Interval> options).
6614 Please note that parameters are only supported by PostgreSQL's protocol
6615 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6617 =item B<PluginInstanceFrom> I<column>
6619 Specify how to create the "PluginInstance" for reporting this query results.
6620 Only one column is supported. You may concatenate fields and string values in
6621 the query statement to get the required results.
6623 =item B<MinVersion> I<version>
6625 =item B<MaxVersion> I<version>
6627 Specify the minimum or maximum version of PostgreSQL that this query should be
6628 used with. Some statistics might only be available with certain versions of
6629 PostgreSQL. This allows you to specify multiple queries with the same name but
6630 which apply to different versions, thus allowing you to use the same
6631 configuration in a heterogeneous environment.
6633 The I<version> has to be specified as the concatenation of the major, minor
6634 and patch-level versions, each represented as two-decimal-digit numbers. For
6635 example, version 8.2.3 will become 80203.
6639 The B<Result> block defines how to handle the values returned from the query.
6640 It defines which column holds which value and how to dispatch that value to
6645 =item B<Type> I<type>
6647 The I<type> name to be used when dispatching the values. The type describes
6648 how to handle the data and where to store it. See L<types.db(5)> for more
6649 details on types and their configuration. The number and type of values (as
6650 selected by the B<ValuesFrom> option) has to match the type of the given name.
6652 This option is mandatory.
6654 =item B<InstancePrefix> I<prefix>
6656 =item B<InstancesFrom> I<column0> [I<column1> ...]
6658 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6659 B<InstancePrefix> defines a static prefix that will be prepended to all type
6660 instances. B<InstancesFrom> defines the column names whose values will be used
6661 to create the type instance. Multiple values will be joined together using the
6662 hyphen (C<->) as separation character.
6664 The plugin itself does not check whether or not all built instances are
6665 different. It is your responsibility to assure that each is unique.
6667 Both options are optional. If none is specified, the type instance will be
6670 =item B<ValuesFrom> I<column0> [I<column1> ...]
6672 Names the columns whose content is used as the actual data for the data sets
6673 that are dispatched to the daemon. How many such columns you need is
6674 determined by the B<Type> setting as explained above. If you specify too many
6675 or not enough columns, the plugin will complain about that and no data will be
6676 submitted to the daemon.
6678 The actual data type, as seen by PostgreSQL, is not that important as long as
6679 it represents numbers. The plugin will automatically cast the values to the
6680 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6681 L<strtod(3)> functions, so anything supported by those functions is supported
6682 by the plugin as well.
6684 This option is required inside a B<Result> block and may be specified multiple
6685 times. If multiple B<ValuesFrom> options are specified, the columns are read
6690 The following predefined queries are available (the definitions can be found
6691 in the F<postgresql_default.conf> file which, by default, is available at
6692 C<I<prefix>/share/collectd/>):
6698 This query collects the number of backends, i.E<nbsp>e. the number of
6701 =item B<transactions>
6703 This query collects the numbers of committed and rolled-back transactions of
6708 This query collects the numbers of various table modifications (i.E<nbsp>e.
6709 insertions, updates, deletions) of the user tables.
6711 =item B<query_plans>
6713 This query collects the numbers of various table scans and returned tuples of
6716 =item B<table_states>
6718 This query collects the numbers of live and dead rows in the user tables.
6722 This query collects disk block access counts for user tables.
6726 This query collects the on-disk size of the database in bytes.
6730 In addition, the following detailed queries are available by default. Please
6731 note that each of those queries collects information B<by table>, thus,
6732 potentially producing B<a lot> of data. For details see the description of the
6733 non-by_table queries above.
6737 =item B<queries_by_table>
6739 =item B<query_plans_by_table>
6741 =item B<table_states_by_table>
6743 =item B<disk_io_by_table>
6747 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6748 mandatory argument specifying the name of the writer. This will then be used
6749 in the B<Database> specification in order to activate the writer instance. The
6750 names of all writers have to be unique. The following options may be
6755 =item B<Statement> I<sql statement>
6757 This mandatory option specifies the SQL statement that will be executed for
6758 each submitted value. A single SQL statement is allowed only. Anything after
6759 the first semicolon will be ignored.
6761 Nine parameters will be passed to the statement and should be specified as
6762 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6763 values are made available through those parameters:
6769 The timestamp of the queried value as an RFC 3339-formatted local time.
6773 The hostname of the queried value.
6777 The plugin name of the queried value.
6781 The plugin instance of the queried value. This value may be B<NULL> if there
6782 is no plugin instance.
6786 The type of the queried value (cf. L<types.db(5)>).
6790 The type instance of the queried value. This value may be B<NULL> if there is
6795 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6796 sources of the submitted value-list).
6800 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6801 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6802 B<StoreRates> is enabled (which is the default, see below), all types will be
6807 An array of the submitted values. The dimensions of the value name and value
6812 In general, it is advisable to create and call a custom function in the
6813 PostgreSQL database for this purpose. Any procedural language supported by
6814 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6817 =item B<StoreRates> B<false>|B<true>
6819 If set to B<true> (the default), convert counter values to rates. If set to
6820 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6825 The B<Database> block defines one PostgreSQL database for which to collect
6826 statistics. It accepts a single mandatory argument which specifies the
6827 database name. None of the other options are required. PostgreSQL will use
6828 default values as documented in the section "CONNECTING TO A DATABASE" in the
6829 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6830 the user collectd is run as and special environment variables. See the manpage
6835 =item B<Interval> I<seconds>
6837 Specify the interval with which the database should be queried. The default is
6838 to use the global B<Interval> setting.
6840 =item B<CommitInterval> I<seconds>
6842 This option may be used for database connections which have "writers" assigned
6843 (see above). If specified, it causes a writer to put several updates into a
6844 single transaction. This transaction will last for the specified amount of
6845 time. By default, each update will be executed in a separate transaction. Each
6846 transaction generates a fair amount of overhead which can, thus, be reduced by
6847 activating this option. The draw-back is, that data covering the specified
6848 amount of time will be lost, for example, if a single statement within the
6849 transaction fails or if the database server crashes.
6851 =item B<Plugin> I<Plugin>
6853 Use I<Plugin> as the plugin name when submitting query results from
6854 this B<Database>. Defaults to C<postgresql>.
6856 =item B<Instance> I<name>
6858 Specify the plugin instance name that should be used instead of the database
6859 name (which is the default, if this option has not been specified). This
6860 allows one to query multiple databases of the same name on the same host (e.g.
6861 when running multiple database server versions in parallel).
6862 The plugin instance name can also be set from the query result using
6863 the B<PluginInstanceFrom> option in B<Query> block.
6865 =item B<Host> I<hostname>
6867 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6868 value begins with a slash, it is interpreted as the directory name in which to
6869 look for the UNIX domain socket.
6871 This option is also used to determine the hostname that is associated with a
6872 collected data set. If it has been omitted or either begins with with a slash
6873 or equals B<localhost> it will be replaced with the global hostname definition
6874 of collectd. Any other value will be passed literally to collectd when
6875 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6877 =item B<Port> I<port>
6879 Specify the TCP port or the local UNIX domain socket file extension of the
6882 =item B<User> I<username>
6884 Specify the username to be used when connecting to the server.
6886 =item B<Password> I<password>
6888 Specify the password to be used when connecting to the server.
6890 =item B<ExpireDelay> I<delay>
6892 Skip expired values in query output.
6894 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6896 Specify whether to use an SSL connection when contacting the server. The
6897 following modes are supported:
6903 Do not use SSL at all.
6907 First, try to connect without using SSL. If that fails, try using SSL.
6909 =item I<prefer> (default)
6911 First, try to connect using SSL. If that fails, try without using SSL.
6919 =item B<Instance> I<name>
6921 Specify the plugin instance name that should be used instead of the database
6922 name (which is the default, if this option has not been specified). This
6923 allows one to query multiple databases of the same name on the same host (e.g.
6924 when running multiple database server versions in parallel).
6926 =item B<KRBSrvName> I<kerberos_service_name>
6928 Specify the Kerberos service name to use when authenticating with Kerberos 5
6929 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6930 B<PostgreSQL Documentation> for details.
6932 =item B<Service> I<service_name>
6934 Specify the PostgreSQL service name to use for additional parameters. That
6935 service has to be defined in F<pg_service.conf> and holds additional
6936 connection parameters. See the section "The Connection Service File" in the
6937 B<PostgreSQL Documentation> for details.
6939 =item B<Query> I<query>
6941 Specifies a I<query> which should be executed in the context of the database
6942 connection. This may be any of the predefined or user-defined queries. If no
6943 such option is given, it defaults to "backends", "transactions", "queries",
6944 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6945 has been specified). Else, the specified queries are used only.
6947 =item B<Writer> I<writer>
6949 Assigns the specified I<writer> backend to the database connection. This
6950 causes all collected data to be send to the database using the settings
6951 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6952 below for details on how to selectively send data to certain plugins).
6954 Each writer will register a flush callback which may be used when having long
6955 transactions enabled (see the B<CommitInterval> option above). When issuing
6956 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6957 transaction will be committed right away. Two different kinds of flush
6958 callbacks are available with the C<postgresql> plugin:
6964 Flush all writer backends.
6966 =item B<postgresql->I<database>
6968 Flush all writers of the specified I<database> only.
6974 =head2 Plugin C<powerdns>
6976 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6977 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6978 values, many of which are probably meaningless to most users, but may be useful
6979 for some. So you may chose which values to collect, but if you don't, some
6980 reasonable defaults will be collected.
6983 <Server "server_name">
6985 Collect "udp-answers" "udp-queries"
6986 Socket "/var/run/pdns.controlsocket"
6988 <Recursor "recursor_name">
6990 Collect "cache-hits" "cache-misses"
6991 Socket "/var/run/pdns_recursor.controlsocket"
6993 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6998 =item B<Server> and B<Recursor> block
7000 The B<Server> block defines one authoritative server to query, the B<Recursor>
7001 does the same for an recursing server. The possible options in both blocks are
7002 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7007 =item B<Collect> I<Field>
7009 Using the B<Collect> statement you can select which values to collect. Here,
7010 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7011 C<dlg-only-drops>, C<answers10-100>.
7013 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7014 When querying the server a C<SHOW *> command is issued in any case, because
7015 that's the only way of getting multiple values out of the server at once.
7016 collectd then picks out the values you have selected. When querying the
7017 recursor, a command is generated to query exactly these values. So if you
7018 specify invalid fields when querying the recursor, a syntax error may be
7019 returned by the daemon and collectd may not collect any values at all.
7021 If no B<Collect> statement is given, the following B<Server> values will be
7028 =item packetcache-hit
7030 =item packetcache-miss
7032 =item packetcache-size
7034 =item query-cache-hit
7036 =item query-cache-miss
7038 =item recursing-answers
7040 =item recursing-questions
7052 The following B<Recursor> values will be collected by default:
7056 =item noerror-answers
7058 =item nxdomain-answers
7060 =item servfail-answers
7078 Please note that up to that point collectd doesn't know what values are
7079 available on the server and values that are added do not need a change of the
7080 mechanism so far. However, the values must be mapped to collectd's naming
7081 scheme, which is done using a lookup table that lists all known values. If
7082 values are added in the future and collectd does not know about them, you will
7083 get an error much like this:
7085 powerdns plugin: submit: Not found in lookup table: foobar = 42
7087 In this case please file a bug report with the collectd team.
7089 =item B<Socket> I<Path>
7091 Configures the path to the UNIX domain socket to be used when connecting to the
7092 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7093 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7094 will be used for the recursor.
7098 =item B<LocalSocket> I<Path>
7100 Querying the recursor is done using UDP. When using UDP over UNIX domain
7101 sockets, the client socket needs a name in the file system, too. You can set
7102 this local name to I<Path> using the B<LocalSocket> option. The default is
7103 C<I<prefix>/var/run/collectd-powerdns>.
7107 =head2 Plugin C<processes>
7109 Collects information about processes of local system.
7111 By default, with no process matches configured, only general statistics is
7112 collected: the number of processes in each state and fork rate.
7114 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7115 These may also be a block in which further options may be specified.
7117 The statistics collected for matched processes are:
7118 - size of the resident segment size (RSS)
7119 - user- and system-time used
7120 - number of processes
7122 - number of open files (under Linux)
7123 - number of memory mapped files (under Linux)
7124 - io data (where available)
7125 - context switches (under Linux)
7126 - minor and major pagefaults
7127 - Delay Accounting information (Linux only, requires libmnl)
7132 CollectFileDescriptor true
7133 CollectContextSwitch true
7134 CollectDelayAccounting false
7136 ProcessMatch "name" "regex"
7137 <Process "collectd">
7138 CollectFileDescriptor false
7139 CollectContextSwitch false
7140 CollectDelayAccounting true
7142 <ProcessMatch "name" "regex">
7143 CollectFileDescriptor false
7144 CollectContextSwitch true
7150 =item B<Process> I<Name>
7152 Select more detailed statistics of processes matching this name.
7154 Some platforms have a limit on the length of process names.
7155 I<Name> must stay below this limit.
7157 =item B<ProcessMatch> I<name> I<regex>
7159 Select more detailed statistics of processes matching the specified I<regex>
7160 (see L<regex(7)> for details). The statistics of all matching processes are
7161 summed up and dispatched to the daemon using the specified I<name> as an
7162 identifier. This allows one to "group" several processes together.
7163 I<name> must not contain slashes.
7165 =item B<CollectContextSwitch> I<Boolean>
7167 Collect the number of context switches for matched processes.
7168 Disabled by default.
7170 =item B<CollectDelayAccounting> I<Boolean>
7172 If enabled, collect Linux Delay Accounding information for matching processes.
7173 Delay Accounting provides the time processes wait for the CPU to become
7174 available, for I/O operations to finish, for pages to be swapped in and for
7175 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7176 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7177 Disabled by default.
7179 This option is only available on Linux, requires the C<libmnl> library and
7180 requires the C<CAP_NET_ADMIN> capability at runtime.
7182 =item B<CollectFileDescriptor> I<Boolean>
7184 Collect number of file descriptors of matched processes.
7185 Disabled by default.
7187 =item B<CollectMemoryMaps> I<Boolean>
7189 Collect the number of memory mapped files of the process.
7190 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7195 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7196 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7197 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7198 reporting the corresponding processes only. Outside of B<Process> and
7199 B<ProcessMatch> blocks these options set the default value for subsequent
7202 =head2 Plugin C<protocols>
7204 Collects a lot of information about various network protocols, such as I<IP>,
7205 I<TCP>, I<UDP>, etc.
7207 Available configuration options:
7211 =item B<Value> I<Selector>
7213 Selects whether or not to select a specific value. The string being matched is
7214 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7215 plugin instance and I<ValueName> will be used as type instance. An example of
7216 the string being used would be C<Tcp:RetransSegs>.
7218 You can use regular expressions to match a large number of values with just one
7219 configuration option. To select all "extended" I<TCP> values, you could use the
7220 following statement:
7224 Whether only matched values are selected or all matched values are ignored
7225 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7226 If no value is configured at all, all values will be selected.
7228 See F</"IGNORELISTS"> for details.
7230 =item B<IgnoreSelected> B<true>|B<false>
7232 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7233 matching values will be ignored.
7237 =head2 Plugin C<python>
7239 This plugin embeds a Python-interpreter into collectd and provides an interface
7240 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7242 =head2 Plugin C<routeros>
7244 The C<routeros> plugin connects to a device running I<RouterOS>, the
7245 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7246 I<librouteros> to connect and reads information about the interfaces and
7247 wireless connections of the device. The configuration supports querying
7252 Host "router0.example.com"
7255 CollectInterface true
7260 Host "router1.example.com"
7263 CollectInterface true
7264 CollectRegistrationTable true
7270 As you can see above, the configuration of the I<routeros> plugin consists of
7271 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7272 options are understood:
7276 =item B<Host> I<Host>
7278 Hostname or IP-address of the router to connect to.
7280 =item B<Port> I<Port>
7282 Port name or port number used when connecting. If left unspecified, the default
7283 will be chosen by I<librouteros>, currently "8728". This option expects a
7284 string argument, even when a numeric port number is given.
7286 =item B<User> I<User>
7288 Use the user name I<User> to authenticate. Defaults to "admin".
7290 =item B<Password> I<Password>
7292 Set the password used to authenticate.
7294 =item B<CollectInterface> B<true>|B<false>
7296 When set to B<true>, interface statistics will be collected for all interfaces
7297 present on the device. Defaults to B<false>.
7299 =item B<CollectRegistrationTable> B<true>|B<false>
7301 When set to B<true>, information about wireless LAN connections will be
7302 collected. Defaults to B<false>.
7304 =item B<CollectCPULoad> B<true>|B<false>
7306 When set to B<true>, information about the CPU usage will be collected. The
7307 number is a dimensionless value where zero indicates no CPU usage at all.
7308 Defaults to B<false>.
7310 =item B<CollectMemory> B<true>|B<false>
7312 When enabled, the amount of used and free memory will be collected. How used
7313 memory is calculated is unknown, for example whether or not caches are counted
7315 Defaults to B<false>.
7317 =item B<CollectDF> B<true>|B<false>
7319 When enabled, the amount of used and free disk space will be collected.
7320 Defaults to B<false>.
7322 =item B<CollectDisk> B<true>|B<false>
7324 When enabled, the number of sectors written and bad blocks will be collected.
7325 Defaults to B<false>.
7329 =head2 Plugin C<redis>
7331 The I<Redis plugin> connects to one or more Redis servers, gathers
7332 information about each server's state and executes user-defined queries.
7333 For each server there is a I<Node> block which configures the connection
7334 parameters and set of user-defined queries for this node.
7341 ReportCommandStats false
7343 <Query "LLEN myqueue">
7353 =item B<Node> I<Nodename>
7355 The B<Node> block identifies a new Redis node, that is a new Redis instance
7356 running in an specified host and port. The name for node is a canonical
7357 identifier which is used as I<plugin instance>. It is limited to
7358 128E<nbsp>characters in length.
7360 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7362 =item B<Host> I<Hostname>
7364 The B<Host> option is the hostname or IP-address where the Redis instance is
7367 =item B<Port> I<Port>
7369 The B<Port> option is the TCP port on which the Redis instance accepts
7370 connections. Either a service name of a port number may be given. Please note
7371 that numerical port numbers must be given as a string, too.
7373 =item B<Password> I<Password>
7375 Use I<Password> to authenticate when connecting to I<Redis>.
7377 =item B<Timeout> I<Milliseconds>
7379 The B<Timeout> option set the socket timeout for node response. Since the Redis
7380 read function is blocking, you should keep this value as low as possible.
7381 It is expected what B<Timeout> values should be lower than B<Interval> defined
7384 Defaults to 2000 (2 seconds).
7386 =item B<ReportCommandStats> B<false>|B<true>
7388 Enables or disables reporting of statistics based on the command type, including
7389 rate of command calls and average CPU time consumed by command processing.
7390 Defaults to B<false>.
7392 =item B<ReportCpuUsage> B<true>|B<false>
7394 Enables or disables reporting of CPU consumption statistics.
7395 Defaults to B<true>.
7397 =item B<Query> I<Querystring>
7399 The B<Query> block identifies a query to execute against the redis server.
7400 There may be an arbitrary number of queries to execute. Each query should
7401 return single string or integer.
7403 =item B<Type> I<Collectd type>
7405 Within a query definition, a valid I<collectd type> to use as when submitting
7406 the result of the query. When not supplied, will default to B<gauge>.
7408 Currently only types with one datasource are supported.
7409 See L<types.db(5)> for more details on types and their configuration.
7411 =item B<Instance> I<Type instance>
7413 Within a query definition, an optional type instance to use when submitting
7414 the result of the query. When not supplied will default to the escaped
7415 command, up to 128 chars.
7417 =item B<Database> I<Index>
7419 This index selects the Redis logical database to use for query. Defaults
7424 =head2 Plugin C<rrdcached>
7426 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7427 to store values to RRD files in an efficient manner. The combination of the
7428 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7429 way the C<rrdtool> plugin works (see below). The added abstraction layer
7430 provides a number of benefits, though: Because the cache is not within
7431 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7432 restarted. This results in much shorter (if any) gaps in graphs, especially
7433 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7434 daemon so that it can flush values to disk automatically when needed. This
7435 allows one to integrate automated flushing of values into graphing solutions
7438 There are disadvantages, though: The daemon may reside on a different host, so
7439 it may not be possible for C<collectd> to create the appropriate RRD files
7440 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7441 different base directory, so relative paths may do weird stuff if you're not
7444 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7445 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7446 setting should be set to an absolute path, so that a changed base directory
7447 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7451 =item B<DaemonAddress> I<Address>
7453 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7454 library. See L<rrdcached(1)> for details. Example:
7456 <Plugin "rrdcached">
7457 DaemonAddress "unix:/var/run/rrdcached.sock"
7460 =item B<DataDir> I<Directory>
7462 Set the base directory in which the RRD files reside. If this is a relative
7463 path, it is relative to the working base directory of the C<rrdcached> daemon!
7464 Use of an absolute path is recommended.
7466 =item B<CreateFiles> B<true>|B<false>
7468 Enables or disables the creation of RRD files. If the daemon is not running
7469 locally, or B<DataDir> is set to a relative path, this will not work as
7470 expected. Default is B<true>.
7472 =item B<CreateFilesAsync> B<false>|B<true>
7474 When enabled, new RRD files are enabled asynchronously, using a separate thread
7475 that runs in the background. This prevents writes to block, which is a problem
7476 especially when many hundreds of files need to be created at once. However,
7477 since the purpose of creating the files asynchronously is I<not> to block until
7478 the file is available, values before the file is available will be discarded.
7479 When disabled (the default) files are created synchronously, blocking for a
7480 short while, while the file is being written.
7482 =item B<StepSize> I<Seconds>
7484 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7485 this setting is unset and the stepsize is set to the interval in which the data
7486 is collected. Do not use this option unless you absolutely have to for some
7487 reason. Setting this option may cause problems with the C<snmp plugin>, the
7488 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7490 =item B<HeartBeat> I<Seconds>
7492 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7493 in which case the heartbeat is set to twice the B<StepSize> which should equal
7494 the interval in which data is collected. Do not set this option unless you have
7495 a very good reason to do so.
7497 =item B<RRARows> I<NumRows>
7499 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7500 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7501 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7502 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7503 week, one month, and one year.
7505 So for each timespan, it calculates how many PDPs need to be consolidated into
7506 one CDP by calculating:
7507 number of PDPs = timespan / (stepsize * rrarows)
7509 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7512 =item B<RRATimespan> I<Seconds>
7514 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7515 more then one RRA. If this option is never used, the built-in default of (3600,
7516 86400, 604800, 2678400, 31622400) is used.
7518 For more information on how RRA-sizes are calculated see B<RRARows> above.
7520 =item B<XFF> I<Factor>
7522 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7523 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7526 =item B<CollectStatistics> B<false>|B<true>
7528 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7529 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7531 Statistics are read via I<rrdcached>s socket using the STATS command.
7532 See L<rrdcached(1)> for details.
7536 =head2 Plugin C<rrdtool>
7538 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7539 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7540 using these settings. If you don't want to dive into the depths of RRDtool, you
7541 can safely ignore these settings.
7545 =item B<DataDir> I<Directory>
7547 Set the directory to store RRD files under. By default RRD files are generated
7548 beneath the daemon's working directory, i.e. the B<BaseDir>.
7550 =item B<CreateFilesAsync> B<false>|B<true>
7552 When enabled, new RRD files are enabled asynchronously, using a separate thread
7553 that runs in the background. This prevents writes to block, which is a problem
7554 especially when many hundreds of files need to be created at once. However,
7555 since the purpose of creating the files asynchronously is I<not> to block until
7556 the file is available, values before the file is available will be discarded.
7557 When disabled (the default) files are created synchronously, blocking for a
7558 short while, while the file is being written.
7560 =item B<StepSize> I<Seconds>
7562 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7563 this setting is unset and the stepsize is set to the interval in which the data
7564 is collected. Do not use this option unless you absolutely have to for some
7565 reason. Setting this option may cause problems with the C<snmp plugin>, the
7566 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7568 =item B<HeartBeat> I<Seconds>
7570 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7571 in which case the heartbeat is set to twice the B<StepSize> which should equal
7572 the interval in which data is collected. Do not set this option unless you have
7573 a very good reason to do so.
7575 =item B<RRARows> I<NumRows>
7577 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7578 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7579 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7580 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7581 week, one month, and one year.
7583 So for each timespan, it calculates how many PDPs need to be consolidated into
7584 one CDP by calculating:
7585 number of PDPs = timespan / (stepsize * rrarows)
7587 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7590 =item B<RRATimespan> I<Seconds>
7592 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7593 more then one RRA. If this option is never used, the built-in default of (3600,
7594 86400, 604800, 2678400, 31622400) is used.
7596 For more information on how RRA-sizes are calculated see B<RRARows> above.
7598 =item B<XFF> I<Factor>
7600 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7601 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7604 =item B<CacheFlush> I<Seconds>
7606 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7607 it writes all values for a certain RRD-file if the oldest value is older than
7608 (or equal to) the number of seconds specified by B<CacheTimeout>.
7609 That check happens on new values arriwal. If some RRD-file is not updated
7610 anymore for some reason (the computer was shut down, the network is broken,
7611 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7612 every I<Seconds> seconds the entire cache is searched for entries older than
7613 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7614 disk. Since scanning the entire cache is kind of expensive and does nothing
7615 under normal circumstances, this value should not be too small. 900 seconds
7616 might be a good value, though setting this to 7200 seconds doesn't normally
7617 do much harm either.
7619 Defaults to 10x B<CacheTimeout>.
7620 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7621 above default is used.
7623 =item B<CacheTimeout> I<Seconds>
7625 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7626 save values in a cache, as described above. Writing multiple values at once
7627 reduces IO-operations and thus lessens the load produced by updating the files.
7628 The trade off is that the graphs kind of "drag behind" and that more memory is
7631 =item B<WritesPerSecond> I<Updates>
7633 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7634 will run serious performance problems. The B<CacheFlush> setting and the
7635 internal update queue assert that collectd continues to work just fine even
7636 under heavy load, but the system may become very unresponsive and slow. This is
7637 a problem especially if you create graphs from the RRD files on the same
7638 machine, for example using the C<graph.cgi> script included in the
7639 C<contrib/collection3/> directory.
7641 This setting is designed for very large setups. Setting this option to a value
7642 between 25 and 80 updates per second, depending on your hardware, will leave
7643 the server responsive enough to draw graphs even while all the cached values
7644 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7645 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7646 written as fast as possible, so that web frontends have up to date data when
7649 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7650 updates per second, writing all values to disk will take approximately
7651 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7652 "collection3" you'll end up with a responsive and fast system, up to date
7653 graphs and basically a "backup" of your values every hour.
7655 =item B<RandomTimeout> I<Seconds>
7657 When set, the actual timeout for each value is chosen randomly between
7658 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7659 intention is to avoid high load situations that appear when many values timeout
7660 at the same time. This is especially a problem shortly after the daemon starts,
7661 because all values were added to the internal cache at roughly the same time.
7665 =head2 Plugin C<sensors>
7667 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7668 that all the needed modules have to be loaded and lm_sensors has to be
7669 configured (most likely by editing F</etc/sensors.conf>. Read
7670 L<sensors.conf(5)> for details.
7672 The B<lm_sensors> homepage can be found at
7673 L<http://secure.netroedge.com/~lm78/>.
7677 =item B<SensorConfigFile> I<File>
7679 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7680 the library's default will be used.
7682 =item B<Sensor> I<chip-bus-address/type-feature>
7684 Selects the name of the sensor which you want to collect or ignore, depending
7685 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7686 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7687 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7689 See F</"IGNORELISTS"> for details.
7691 =item B<IgnoreSelected> I<true>|I<false>
7693 If no configuration if given, the B<sensors>-plugin will collect data from all
7694 sensors. This may not be practical, especially for uninteresting sensors.
7695 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7696 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7697 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7698 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7699 and all other sensors are collected.
7701 =item B<UseLabels> I<true>|I<false>
7703 Configures how sensor readings are reported. When set to I<true>, sensor
7704 readings are reported using their descriptive label (e.g. "VCore"). When set to
7705 I<false> (the default) the sensor name is used ("in0").
7709 =head2 Plugin C<sigrok>
7711 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7712 supported by the L<sigrok|http://sigrok.org/> project.
7718 <Device "AC Voltage">
7723 <Device "Sound Level">
7724 Driver "cem-dt-885x"
7731 =item B<LogLevel> B<0-5>
7733 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7734 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7735 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7736 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7737 their level, are always submitted to I<collectd> at its INFO log level.
7739 =item E<lt>B<Device> I<Name>E<gt>
7741 A sigrok-supported device, uniquely identified by this section's options. The
7742 I<Name> is passed to I<collectd> as the I<plugin instance>.
7744 =item B<Driver> I<DriverName>
7746 The sigrok driver to use for this device.
7748 =item B<Conn> I<ConnectionSpec>
7750 If the device cannot be auto-discovered, or more than one might be discovered
7751 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7752 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7753 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7754 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7755 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7757 =item B<SerialComm> I<SerialSpec>
7759 For serial devices with non-standard port settings, this option can be used
7760 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7761 This should not be necessary; drivers know how to communicate with devices they
7764 =item B<MinimumInterval> I<Seconds>
7766 Specifies the minimum time between measurement dispatches to I<collectd>, in
7767 seconds. Since some I<sigrok> supported devices can acquire measurements many
7768 times per second, it may be necessary to throttle these. For example, the
7769 I<RRD plugin> cannot process writes more than once per second.
7771 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7772 device are always dispatched to I<collectd>. When throttled, unused
7773 measurements are discarded.
7777 =head2 Plugin C<smart>
7779 The C<smart> plugin collects SMART information from physical
7780 disks. Values collectd include temperature, power cycle count, poweron
7781 time and bad sectors. Also, all SMART attributes are collected along
7782 with the normalized current value, the worst value, the threshold and
7783 a human readable value.
7785 Using the following two options you can ignore some disks or configure the
7786 collection only of specific disks.
7790 =item B<Disk> I<Name>
7792 Select the disk I<Name>. Whether it is collected or ignored depends on the
7793 B<IgnoreSelected> setting, see below. As with other plugins that use the
7794 daemon's ignorelist functionality, a string that starts and ends with a slash
7795 is interpreted as a regular expression. Examples:
7800 See F</"IGNORELISTS"> for details.
7802 =item B<IgnoreSelected> B<true>|B<false>
7804 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7805 statements, are ignored or if all other disks are ignored. The behavior
7806 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7807 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7808 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7809 is set to B<true>, all disks are collected B<except> the ones matched.
7811 =item B<IgnoreSleepMode> B<true>|B<false>
7813 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7814 This option disables the sleep mode check and allows the plugin to collect data
7815 from these disks anyway. This is useful in cases where libatasmart mistakenly
7816 reports disks as asleep because it has not been updated to incorporate support
7817 for newer idle states in the ATA spec.
7819 =item B<UseSerial> B<true>|B<false>
7821 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7822 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7823 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7824 storing data. This ensures that the data for a given disk will be kept together
7825 even if the kernel name changes.
7829 =head2 Plugin C<snmp>
7831 Since the configuration of the C<snmp plugin> is a little more complicated than
7832 other plugins, its documentation has been moved to an own manpage,
7833 L<collectd-snmp(5)>. Please see there for details.
7835 =head2 Plugin C<snmp_agent>
7837 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7838 from SNMP master agent and returns the data collected by read plugins.
7839 The I<snmp_agent> plugin handles requests only for OIDs specified in
7840 configuration file. To handle SNMP queries the plugin gets data from collectd
7841 and translates requested values from collectd's internal format to SNMP format.
7842 This plugin is a generic plugin and cannot work without configuration.
7843 For more details on AgentX subagent see
7844 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7849 <Data "memAvailReal">
7851 #PluginInstance "some"
7854 OIDs "1.3.6.1.4.1.2021.4.6.0"
7857 IndexOID "IF-MIB::ifIndex"
7858 SizeOID "IF-MIB::ifNumber"
7861 Source "PluginInstance"
7864 OIDs "IF-MIB::ifDescr"
7870 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7873 <Table "CPUAffinityTable">
7876 Source "PluginInstance"
7879 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
7884 Source "TypeInstance"
7885 Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
7888 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
7893 Source "TypeInstance"
7894 Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
7897 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
7899 <Data "CPUAffinity">
7902 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
7907 There are two types of blocks that can be contained in the
7908 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7910 =head3 B<Data> block
7912 The B<Data> block defines a list OIDs that are to be handled. This block can
7913 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7914 block it reperesents table OIDs.
7915 The following options can be set:
7919 =item B<IndexKey> block
7921 B<IndexKey> block contains all data needed for proper index build of snmp table.
7923 one table B<Data> block has B<IndexKey> block present then multiple key index is
7924 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
7929 =item B<Source> I<String>
7931 B<Source> can be set to one of the following values: "Hostname", "Plugin",
7932 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
7933 corresponding collectd metric is taken as a SNMP table index.
7935 =item B<Regex> I<String>
7937 B<Regex> option can also be used to parse strings or numbers out of
7938 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
7939 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
7942 =item B<Group> I<Number>
7944 B<Group> number can be specified in case groups are used in regex.
7948 =item B<Plugin> I<String>
7950 Read plugin name whose collected data will be mapped to specified OIDs.
7952 =item B<PluginInstance> I<String>
7954 Read plugin instance whose collected data will be mapped to specified OIDs.
7955 The field is optional and by default there is no plugin instance check.
7956 Allowed only if B<Data> block defines scalar data type.
7958 =item B<Type> I<String>
7960 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7961 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7963 =item B<TypeInstance> I<String>
7965 Collectd's type-instance that is to be used for specified OID.
7967 =item B<OIDs> I<OID> [I<OID> ...]
7969 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7970 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7971 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7972 configured should correspond to number of values in specified B<Type>.
7973 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7974 "rx" and "tx" values of "if_octets" type.
7976 =item B<Scale> I<Value>
7978 The values taken from collectd are multiplied by I<Value>. The field is optional
7979 and the default is B<1.0>.
7981 =item B<Shift> I<Value>
7983 I<Value> is added to values from collectd after they have been multiplied by
7984 B<Scale> value. The field is optional and the default value is B<0.0>.
7988 =head3 The B<Table> block
7990 The B<Table> block defines a collection of B<Data> blocks that belong to one
7991 snmp table. In addition to multiple B<Data> blocks the following options can be
7996 =item B<IndexOID> I<OID>
7998 OID that is handled by the plugin and is mapped to numerical index value that is
7999 generated by the plugin for each table record.
8001 =item B<SizeOID> I<OID>
8003 OID that is handled by the plugin. Returned value is the number of records in
8004 the table. The field is optional.
8008 =head2 Plugin C<statsd>
8010 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8011 protocol and dispatches rates or other aggregates of these numbers
8014 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8015 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8016 C<objects> respectively.
8018 The following configuration options are valid:
8022 =item B<Host> I<Host>
8024 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8025 "any" address, i.e. accept packets sent to any of the hosts addresses.
8027 =item B<Port> I<Port>
8029 UDP port to listen to. This can be either a service name or a port number.
8030 Defaults to C<8125>.
8032 =item B<DeleteCounters> B<false>|B<true>
8034 =item B<DeleteTimers> B<false>|B<true>
8036 =item B<DeleteGauges> B<false>|B<true>
8038 =item B<DeleteSets> B<false>|B<true>
8040 These options control what happens if metrics are not updated in an interval.
8041 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8042 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8043 are unchanged. If set to B<True>, the such metrics are not dispatched and
8044 removed from the internal cache.
8046 =item B<CounterSum> B<false>|B<true>
8048 When enabled, creates a C<count> metric which reports the change since the last
8049 read. This option primarily exists for compatibility with the I<statsd>
8050 implementation by Etsy.
8052 =item B<TimerPercentile> I<Percent>
8054 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8055 that I<Percent> of all reported timers are smaller than or equal to the
8056 computed latency. This is useful for cutting off the long tail latency, as it's
8057 often done in I<Service Level Agreements> (SLAs).
8059 Different percentiles can be calculated by setting this option several times.
8060 If none are specified, no percentiles are calculated / dispatched.
8062 =item B<TimerLower> B<false>|B<true>
8064 =item B<TimerUpper> B<false>|B<true>
8066 =item B<TimerSum> B<false>|B<true>
8068 =item B<TimerCount> B<false>|B<true>
8070 Calculate and dispatch various values out of I<Timer> metrics received during
8071 an interval. If set to B<False>, the default, these values aren't calculated /
8074 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8078 =head2 Plugin C<swap>
8080 The I<Swap plugin> collects information about used and available swap space. On
8081 I<Linux> and I<Solaris>, the following options are available:
8085 =item B<ReportByDevice> B<false>|B<true>
8087 Configures how to report physical swap devices. If set to B<false> (the
8088 default), the summary over all swap devices is reported only, i.e. the globally
8089 used and available space over all devices. If B<true> is configured, the used
8090 and available space of each device will be reported separately.
8092 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8093 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8095 =item B<ReportBytes> B<false>|B<true>
8097 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8098 I<swap I/O> is reported in pages. This option is available under Linux only.
8100 =item B<ValuesAbsolute> B<true>|B<false>
8102 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8103 available and used. Defaults to B<true>.
8105 =item B<ValuesPercentage> B<false>|B<true>
8107 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8108 available and free. Defaults to B<false>.
8110 This is useful for deploying I<collectd> in a heterogeneous environment, where
8111 swap sizes differ and you want to specify generic thresholds or similar.
8113 =item B<ReportIO> B<true>|B<false>
8115 Enables or disables reporting swap IO. Defaults to B<true>.
8117 This is useful for the cases when swap IO is not neccessary, is not available,
8122 =head2 Plugin C<syslog>
8126 =item B<LogLevel> B<debug|info|notice|warning|err>
8128 Sets the log-level. If, for example, set to B<notice>, then all events with
8129 severity B<notice>, B<warning>, or B<err> will be submitted to the
8132 Please note that B<debug> is only available if collectd has been compiled with
8135 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8137 Controls which notifications should be sent to syslog. The default behaviour is
8138 not to send any. Less severe notifications always imply logging more severe
8139 notifications: Setting this to B<OKAY> means all notifications will be sent to
8140 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8141 notifications but will dismiss B<OKAY> notifications. Setting this option to
8142 B<FAILURE> will only send failures to syslog.
8146 =head2 Plugin C<table>
8148 The C<table plugin> provides generic means to parse tabular data and dispatch
8149 user specified values. Values are selected based on column numbers. For
8150 example, this plugin may be used to get values from the Linux L<proc(5)>
8151 filesystem or CSV (comma separated values) files.
8154 <Table "/proc/slabinfo">
8160 InstancePrefix "active_objs"
8166 InstancePrefix "objperslab"
8173 The configuration consists of one or more B<Table> blocks, each of which
8174 configures one file to parse. Within each B<Table> block, there are one or
8175 more B<Result> blocks, which configure which data to select and how to
8178 The following options are available inside a B<Table> block:
8182 =item B<Plugin> I<Plugin>
8184 If specified, I<Plugin> is used as the plugin name when submitting values.
8185 Defaults to B<table>.
8187 =item B<Instance> I<instance>
8189 If specified, I<instance> is used as the plugin instance. If omitted, the
8190 filename of the table is used instead, with all special characters replaced
8191 with an underscore (C<_>).
8193 =item B<Separator> I<string>
8195 Any character of I<string> is interpreted as a delimiter between the different
8196 columns of the table. A sequence of two or more contiguous delimiters in the
8197 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8198 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8199 of a table - see its documentation for more details. This option is mandatory.
8201 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8202 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8203 required because of collectd's config parsing.
8207 The following options are available inside a B<Result> block:
8211 =item B<Type> I<type>
8213 Sets the type used to dispatch the values to the daemon. Detailed information
8214 about types and their configuration can be found in L<types.db(5)>. This
8215 option is mandatory.
8217 =item B<InstancePrefix> I<prefix>
8219 If specified, prepend I<prefix> to the type instance. If omitted, only the
8220 B<InstancesFrom> option is considered for the type instance.
8222 =item B<InstancesFrom> I<column0> [I<column1> ...]
8224 If specified, the content of the given columns (identified by the column
8225 number starting at zero) will be used to create the type instance for each
8226 row. Multiple values (and the instance prefix) will be joined together with
8227 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8228 option is considered for the type instance.
8230 The plugin itself does not check whether or not all built instances are
8231 different. It’s your responsibility to assure that each is unique. This is
8232 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8233 sure that the table only contains one row.
8235 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8238 =item B<ValuesFrom> I<column0> [I<column1> ...]
8240 Specifies the columns (identified by the column numbers starting at zero)
8241 whose content is used as the actual data for the data sets that are dispatched
8242 to the daemon. How many such columns you need is determined by the B<Type>
8243 setting above. If you specify too many or not enough columns, the plugin will
8244 complain about that and no data will be submitted to the daemon. The plugin
8245 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8246 respectively, so anything supported by those functions is supported by the
8247 plugin as well. This option is mandatory.
8251 =head2 Plugin C<tail>
8253 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8254 each line and dispatches found values. What is matched can be configured by the
8255 user using (extended) regular expressions, as described in L<regex(7)>.
8258 <File "/var/log/exim4/mainlog">
8263 Regex "S=([1-9][0-9]*)"
8269 Regex "\\<R=local_user\\>"
8270 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8273 Instance "local_user"
8276 Regex "l=([0-9]*\\.[0-9]*)"
8277 <DSType "Distribution">
8280 #BucketType "bucket"
8288 The config consists of one or more B<File> blocks, each of which configures one
8289 logfile to parse. Within each B<File> block, there are one or more B<Match>
8290 blocks, which configure a regular expression to search for.
8292 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8293 the plugin name and instance respectively. So in the above example the plugin name
8294 C<mail-exim> would be used.
8296 These options are applied for all B<Match> blocks that B<follow> it, until the
8297 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8298 instances from one logfile, handy when parsing syslog and the like.
8300 The B<Interval> option allows you to define the length of time between reads. If
8301 this is not set, the default Interval will be used.
8303 Each B<Match> block has the following options to describe how the match should
8308 =item B<Regex> I<regex>
8310 Sets the regular expression to use for matching against a line. The first
8311 subexpression has to match something that can be turned into a number by
8312 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8313 below. Because B<extended> regular expressions are used, you do not need to use
8314 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8315 collectd's config parsing you need to escape backslashes, though. So if you
8316 want to match literal parentheses you need to do the following:
8318 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8320 =item B<ExcludeRegex> I<regex>
8322 Sets an optional regular expression to use for excluding lines from the match.
8323 An example which excludes all connections from localhost from the match:
8325 ExcludeRegex "127\\.0\\.0\\.1"
8327 =item B<DSType> I<Type>
8329 Sets how the values are cumulated. I<Type> is one of:
8333 =item B<GaugeAverage>
8335 Calculate the average.
8339 Use the smallest number only.
8343 Use the greatest number only.
8347 Use the last number found.
8349 =item B<GaugePersist>
8351 Use the last number found. The number is not reset at the end of an interval.
8352 It is continously reported until another number is matched. This is intended
8353 for cases in which only state changes are reported, for example a thermometer
8354 that only reports the temperature when it changes.
8360 =item B<AbsoluteSet>
8362 The matched number is a counter. Simply I<sets> the internal counter to this
8363 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8371 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8372 matched number may be negative, which will effectively subtract from the
8381 Increase the internal counter by one. These B<DSType> are the only ones that do
8382 not use the matched subexpression, but simply count the number of matched
8383 lines. Thus, you may use a regular expression without submatch in this case.
8385 =item B<Distribution>
8387 Type to do calculations based on the distribution of values, primarily
8388 calculating percentiles. This is primarily geared towards latency, but can be
8389 used for other metrics as well. The range of values tracked with this setting
8390 must be in the range (0–2^34) and can be fractional. Please note that neither
8391 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8394 This option must be used together with the B<Percentile> and/or B<Bucket>
8399 <DSType "Distribution">
8407 =item B<Percentile> I<Percent>
8409 Calculate and dispatch the configured percentile, i.e. compute the value, so
8410 that I<Percent> of all matched values are smaller than or equal to the computed
8413 Metrics are reported with the I<type> B<Type> (the value of the above option)
8414 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8416 This option may be repeated to calculate more than one percentile.
8418 =item B<Bucket> I<lower_bound> I<upper_bound>
8420 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8421 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8422 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8423 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8424 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8427 To export the entire (0–inf) range without overlap, use the upper bound of the
8428 previous range as the lower bound of the following range. In other words, use
8429 the following schema:
8439 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8440 by default) and the I<type instance>
8441 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8443 This option may be repeated to calculate more than one rate.
8445 =item B<BucketType> I<Type>
8447 Sets the type used to dispatch B<Bucket> metrics.
8448 Optional, by default C<bucket> will be used.
8454 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8455 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8456 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8457 B<Derive*> types interpret the submatch as a signed integer using
8458 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8459 and it may be omitted in this case.
8461 =item B<Type> I<Type>
8463 Sets the type used to dispatch this value. Detailed information about types and
8464 their configuration can be found in L<types.db(5)>.
8466 =item B<Instance> I<TypeInstance>
8468 This optional setting sets the type instance to use.
8472 =head2 Plugin C<tail_csv>
8474 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8475 written by I<Snort>.
8480 <Metric "snort-dropped">
8485 <File "/var/log/snort/snort.stats">
8489 Collect "snort-dropped"
8493 The configuration consists of one or more B<Metric> blocks that define an index
8494 into the line of the CSV file and how this value is mapped to I<collectd's>
8495 internal representation. These are followed by one or more B<Instance> blocks
8496 which configure which file to read, in which interval and which metrics to
8501 =item E<lt>B<Metric> I<Name>E<gt>
8503 The B<Metric> block configures a new metric to be extracted from the statistics
8504 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8505 only used inside the B<Instance> blocks to refer to this block, so you can use
8506 one B<Metric> block for multiple CSV files.
8510 =item B<Type> I<Type>
8512 Configures which I<Type> to use when dispatching this metric. Types are defined
8513 in the L<types.db(5)> file, see the appropriate manual page for more
8514 information on specifying types. Only types with a single I<data source> are
8515 supported by the I<tail_csv plugin>. The information whether the value is an
8516 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8517 I<Type's> definition.
8519 =item B<Instance> I<TypeInstance>
8521 If set, I<TypeInstance> is used to populate the type instance field of the
8522 created value lists. Otherwise, no type instance is used.
8524 =item B<ValueFrom> I<Index>
8526 Configure to read the value from the field with the zero-based index I<Index>.
8527 If the value is parsed as signed integer, unsigned integer or double depends on
8528 the B<Type> setting, see above.
8532 =item E<lt>B<File> I<Path>E<gt>
8534 Each B<File> block represents one CSV file to read. There must be at least one
8535 I<File> block but there can be multiple if you have multiple CSV files.
8539 =item B<Plugin> I<Plugin>
8541 Use I<Plugin> as the plugin name when submitting values.
8542 Defaults to C<tail_csv>.
8544 =item B<Instance> I<PluginInstance>
8546 Sets the I<plugin instance> used when dispatching the values.
8548 =item B<Collect> I<Metric>
8550 Specifies which I<Metric> to collect. This option must be specified at least
8551 once, and you can use this option multiple times to specify more than one
8552 metric to be extracted from this statistic file.
8554 =item B<Interval> I<Seconds>
8556 Configures the interval in which to read values from this instance / file.
8557 Defaults to the plugin's default interval.
8559 =item B<TimeFrom> I<Index>
8561 Rather than using the local time when dispatching a value, read the timestamp
8562 from the field with the zero-based index I<Index>. The value is interpreted as
8563 seconds since epoch. The value is parsed as a double and may be factional.
8569 =head2 Plugin C<teamspeak2>
8571 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8572 polls interesting global and virtual server data. The plugin can query only one
8573 physical server but unlimited virtual servers. You can use the following
8574 options to configure it:
8578 =item B<Host> I<hostname/ip>
8580 The hostname or ip which identifies the physical server.
8583 =item B<Port> I<port>
8585 The query port of the physical server. This needs to be a string.
8588 =item B<Server> I<port>
8590 This option has to be added once for every virtual server the plugin should
8591 query. If you want to query the virtual server on port 8767 this is what the
8592 option would look like:
8596 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8597 use quotes around it! If no such statement is given only global information
8602 =head2 Plugin C<ted>
8604 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8605 measure power consumption. These devices are usually connected to a serial
8606 (RS232) or USB port. The plugin opens a configured device and tries to read the
8607 current energy readings. For more information on TED, visit
8608 L<http://www.theenergydetective.com/>.
8610 Available configuration options:
8614 =item B<Device> I<Path>
8616 Path to the device on which TED is connected. collectd will need read and write
8617 permissions on that file.
8619 Default: B</dev/ttyUSB0>
8621 =item B<Retries> I<Num>
8623 Apparently reading from TED is not that reliable. You can therefore configure a
8624 number of retries here. You only configure the I<retries> here, to if you
8625 specify zero, one reading will be performed (but no retries if that fails); if
8626 you specify three, a maximum of four readings are performed. Negative values
8633 =head2 Plugin C<tcpconns>
8635 The C<tcpconns plugin> counts the number of currently established TCP
8636 connections based on the local port and/or the remote port. Since there may be
8637 a lot of connections the default if to count all connections with a local port,
8638 for which a listening socket is opened. You can use the following options to
8639 fine-tune the ports you are interested in:
8643 =item B<ListeningPorts> I<true>|I<false>
8645 If this option is set to I<true>, statistics for all local ports for which a
8646 listening socket exists are collected. The default depends on B<LocalPort> and
8647 B<RemotePort> (see below): If no port at all is specifically selected, the
8648 default is to collect listening ports. If specific ports (no matter if local or
8649 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8650 the selected ports will be collected unless this option is set to I<true>
8653 =item B<LocalPort> I<Port>
8655 Count the connections to a specific local port. This can be used to see how
8656 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8657 You have to specify the port in numeric form, so for the mailserver example
8658 you'd need to set B<25>.
8660 =item B<RemotePort> I<Port>
8662 Count the connections to a specific remote port. This is useful to see how
8663 much a remote service is used. This is most useful if you want to know how many
8664 connections a local service has opened to remote services, e.E<nbsp>g. how many
8665 connections a mail server or news server has to other mail or news servers, or
8666 how many connections a web proxy holds to web servers. You have to give the
8667 port in numeric form.
8669 =item B<AllPortsSummary> I<true>|I<false>
8671 If this option is set to I<true> a summary of statistics from all connections
8672 are collected. This option defaults to I<false>.
8676 =head2 Plugin C<thermal>
8680 =item B<ForceUseProcfs> I<true>|I<false>
8682 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8683 C<sysfs> interface. If that is not available, the plugin falls back to the
8684 C<procfs> interface. By setting this option to I<true>, you can force the
8685 plugin to use the latter. This option defaults to I<false>.
8687 =item B<Device> I<Device>
8689 Selects the name of the thermal device that you want to collect or ignore,
8690 depending on the value of the B<IgnoreSelected> option. This option may be
8691 used multiple times to specify a list of devices.
8693 See F</"IGNORELISTS"> for details.
8695 =item B<IgnoreSelected> I<true>|I<false>
8697 Invert the selection: If set to true, all devices B<except> the ones that
8698 match the device names specified by the B<Device> option are collected. By
8699 default only selected devices are collected if a selection is made. If no
8700 selection is configured at all, B<all> devices are selected.
8704 =head2 Plugin C<threshold>
8706 The I<Threshold plugin> checks values collected or received by I<collectd>
8707 against a configurable I<threshold> and issues I<notifications> if values are
8710 Documentation for this plugin is available in the L<collectd-threshold(5)>
8713 =head2 Plugin C<tokyotyrant>
8715 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8716 couple metrics: number of records, and database size on disk.
8720 =item B<Host> I<Hostname/IP>
8722 The hostname or IP which identifies the server.
8723 Default: B<127.0.0.1>
8725 =item B<Port> I<Service/Port>
8727 The query port of the server. This needs to be a string, even if the port is
8728 given in its numeric form.
8733 =head2 Plugin C<turbostat>
8735 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8736 Intel processors by using I<Model Specific Registers>.
8740 =item B<CoreCstates> I<Bitmask(Integer)>
8742 Bit mask of the list of core C-states supported by the processor.
8743 This option should only be used if the automated detection fails.
8744 Default value extracted from the CPU model and family.
8746 Currently supported C-states (by this plugin): 3, 6, 7
8750 All states (3, 6 and 7):
8751 (1<<3) + (1<<6) + (1<<7) = 392
8753 =item B<PackageCstates> I<Bitmask(Integer)>
8755 Bit mask of the list of packages C-states supported by the processor. This
8756 option should only be used if the automated detection fails. Default value
8757 extracted from the CPU model and family.
8759 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8763 States 2, 3, 6 and 7:
8764 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8766 =item B<SystemManagementInterrupt> I<true>|I<false>
8768 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8769 This option should only be used if the automated detection fails or if you want
8770 to disable this feature.
8772 =item B<DigitalTemperatureSensor> I<true>|I<false>
8774 Boolean enabling the collection of the temperature of each core. This option
8775 should only be used if the automated detection fails or if you want to disable
8778 =item B<TCCActivationTemp> I<Temperature>
8780 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8781 temperature is used when collecting the temperature of cores or packages. This
8782 option should only be used if the automated detection fails. Default value
8783 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8785 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8787 Bit mask of the list of elements to be thermally monitored. This option should
8788 only be used if the automated detection fails or if you want to disable some
8789 collections. The different bits of this bit mask accepted by this plugin are:
8793 =item 0 ('1'): Package
8797 =item 2 ('4'): Cores
8799 =item 3 ('8'): Embedded graphic device
8803 =item B<LogicalCoreNames> I<true>|I<false>
8805 Boolean enabling the use of logical core numbering for per core statistics.
8806 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8807 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8808 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8809 more than one, where I<n> is the n-th core of package I<m>.
8813 =head2 Plugin C<unixsock>
8817 =item B<SocketFile> I<Path>
8819 Sets the socket-file which is to be created.
8821 =item B<SocketGroup> I<Group>
8823 If running as root change the group of the UNIX-socket after it has been
8824 created. Defaults to B<collectd>.
8826 =item B<SocketPerms> I<Permissions>
8828 Change the file permissions of the UNIX-socket after it has been created. The
8829 permissions must be given as a numeric, octal value as you would pass to
8830 L<chmod(1)>. Defaults to B<0770>.
8832 =item B<DeleteSocket> B<false>|B<true>
8834 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8835 with the given name already exists. If I<collectd> crashes a socket file may be
8836 left over, preventing the daemon from opening a new socket when restarted.
8837 Since this is potentially dangerous, this defaults to B<false>.
8841 =head2 Plugin C<uuid>
8843 This plugin, if loaded, causes the Hostname to be taken from the machine's
8844 UUID. The UUID is a universally unique designation for the machine, usually
8845 taken from the machine's BIOS. This is most useful if the machine is running in
8846 a virtual environment such as Xen, in which case the UUID is preserved across
8847 shutdowns and migration.
8849 The following methods are used to find the machine's UUID, in order:
8855 Check I</etc/uuid> (or I<UUIDFile>).
8859 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8864 Check for UUID from C<dmidecode> / SMBIOS.
8868 Check for UUID from Xen hypervisor.
8872 If no UUID can be found then the hostname is not modified.
8876 =item B<UUIDFile> I<Path>
8878 Take the UUID from the given file (default I</etc/uuid>).
8882 =head2 Plugin C<varnish>
8884 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8885 It collects a subset of the values displayed by L<varnishstat(1)>, and
8886 organizes them in categories which can be enabled or disabled. Currently only
8887 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8888 meaning of each metric can be found in L<varnish-counters(7)>.
8893 <Instance "example">
8897 CollectConnections true
8898 CollectDirectorDNS false
8902 CollectObjects false
8904 CollectSession false
8914 CollectWorkers false
8916 CollectMempool false
8917 CollectManagement false
8924 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8925 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8926 will collectd statistics from the default "varnishd" instance (this should work
8927 fine in most cases).
8929 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8933 =item B<CollectBackend> B<true>|B<false>
8935 Back-end connection statistics, such as successful, reused,
8936 and closed connections. True by default.
8938 =item B<CollectBan> B<true>|B<false>
8940 Statistics about ban operations, such as number of bans added, retired, and
8941 number of objects tested against ban operations. Only available with Varnish
8942 3.x and above. False by default.
8944 =item B<CollectCache> B<true>|B<false>
8946 Cache hits and misses. True by default.
8948 =item B<CollectConnections> B<true>|B<false>
8950 Number of client connections received, accepted and dropped. True by default.
8952 =item B<CollectDirectorDNS> B<true>|B<false>
8954 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8957 =item B<CollectESI> B<true>|B<false>
8959 Edge Side Includes (ESI) parse statistics. False by default.
8961 =item B<CollectFetch> B<true>|B<false>
8963 Statistics about fetches (HTTP requests sent to the backend). False by default.
8965 =item B<CollectHCB> B<true>|B<false>
8967 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8968 divided into locked and unlocked look-ups. False by default.
8970 =item B<CollectObjects> B<true>|B<false>
8972 Statistics on cached objects: number of objects expired, nuked (prematurely
8973 expired), saved, moved, etc. False by default.
8975 =item B<CollectPurge> B<true>|B<false>
8977 Statistics about purge operations, such as number of purges added, retired, and
8978 number of objects tested against purge operations. Only available with Varnish
8979 2.x. False by default.
8981 =item B<CollectSession> B<true>|B<false>
8983 Client session statistics. Number of past and current sessions, session herd and
8984 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8985 metrics found in the Connections and Threads sections with previous versions of
8986 Varnish have been moved here.
8988 =item B<CollectSHM> B<true>|B<false>
8990 Statistics about the shared memory log, a memory region to store
8991 log messages which is flushed to disk when full. True by default.
8993 =item B<CollectSMA> B<true>|B<false>
8995 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8996 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
8997 only the one used by the Varnish instance. Only available with Varnish 2.x.
9000 =item B<CollectSMS> B<true>|B<false>
9002 synth (synthetic content) storage statistics. This storage
9003 component is used internally only. False by default.
9005 =item B<CollectSM> B<true>|B<false>
9007 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9008 in varnish 4.x. use CollectSMF.
9011 =item B<CollectStruct> B<true>|B<false>
9013 Current varnish internal state statistics. Number of current sessions, objects
9014 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9017 =item B<CollectTotals> B<true>|B<false>
9019 Collects overview counters, such as the number of sessions created,
9020 the number of requests and bytes transferred. False by default.
9022 =item B<CollectUptime> B<true>|B<false>
9024 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9026 =item B<CollectVCL> B<true>|B<false>
9028 Number of total (available + discarded) VCL (config files). False by default.
9030 =item B<CollectVSM> B<true>|B<false>
9032 Collect statistics about Varnish's shared memory usage (used by the logging and
9033 statistics subsystems). Only available with Varnish 4.x. False by default.
9035 =item B<CollectWorkers> B<true>|B<false>
9037 Collect statistics about worker threads. False by default.
9039 =item B<CollectVBE> B<true>|B<false>
9041 Backend counters. Only available with Varnish 4.x. False by default.
9043 =item B<CollectSMF> B<true>|B<false>
9045 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9046 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9047 instance. Used to be called SM in Varnish 2.x. False by default.
9049 =item B<CollectManagement> B<true>|B<false>
9051 Management process counters. Only available with Varnish 4.x. False by default.
9053 =item B<CollectLock> B<true>|B<false>
9055 Lock counters. Only available with Varnish 4.x. False by default.
9057 =item B<CollectMempool> B<true>|B<false>
9059 Memory pool counters. Only available with Varnish 4.x. False by default.
9061 =item B<CollectMSE> B<true>|B<false>
9063 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9064 Varnish, replacing the traditional malloc and file storages. Only available
9065 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9066 one used by the Varnish instance. False by default.
9070 =head2 Plugin C<virt>
9072 This plugin allows CPU, disk, network load and other metrics to be collected for
9073 virtualized guests on the machine. The statistics are collected through libvirt
9074 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9075 installing any additional software on guests, especially I<collectd>, which runs
9076 only on the host system.
9078 Only I<Connection> is required.
9082 =item B<Connection> I<uri>
9084 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9086 Connection "xen:///"
9088 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9090 =item B<RefreshInterval> I<seconds>
9092 Refresh the list of domains and devices every I<seconds>. The default is 60
9093 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9094 the list of domains and devices to be refreshed on every iteration.
9096 Refreshing the devices in particular is quite a costly operation, so if your
9097 virtualization setup is static you might consider increasing this. If this
9098 option is set to 0, refreshing is disabled completely.
9100 =item B<Domain> I<name>
9102 =item B<BlockDevice> I<name:dev>
9104 =item B<InterfaceDevice> I<name:dev>
9106 =item B<IgnoreSelected> B<true>|B<false>
9108 Select which domains and devices are collected.
9110 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9111 disk/network devices are collected.
9113 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9114 domains and disk/network devices are ignored, while the rest are collected.
9116 The domain name and device names may use a regular expression, if the name is
9117 surrounded by I</.../> and collectd was compiled with support for regexps.
9119 The default is to collect statistics for all domains and all their devices.
9123 BlockDevice "/:hdb/"
9124 IgnoreSelected "true"
9126 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9129 =item B<BlockDeviceFormat> B<target>|B<source>
9131 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9132 seen by the guest will be used for reporting metrics.
9133 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9136 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9137 using the path of the source, e.g. an image file.
9138 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9143 If the domain XML have the following device defined:
9145 <disk type='block' device='disk'>
9146 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9147 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9148 <target dev='sda' bus='scsi'/>
9150 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9153 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9155 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9156 to C<var_lib_libvirt_images_image1.qcow2>.
9158 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9160 The B<BlockDeviceFormatBasename> controls whether the full path or the
9161 L<basename(1)> of the source is being used as the I<type instance> when
9162 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9166 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9167 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9168 be set to C<var_lib_libvirt_images_image1.qcow2>.
9169 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9170 set to C<image1.qcow2>.
9172 =item B<HostnameFormat> B<name|uuid|hostname|...>
9174 When the virt plugin logs data, it sets the hostname of the collected data
9175 according to this setting. The default is to use the guest name as provided by
9176 the hypervisor, which is equal to setting B<name>.
9178 B<uuid> means use the guest's UUID. This is useful if you want to track the
9179 same guest across migrations.
9181 B<hostname> means to use the global B<Hostname> setting, which is probably not
9182 useful on its own because all guests will appear to have the same name.
9184 You can also specify combinations of these fields. For example B<name uuid>
9185 means to concatenate the guest name and UUID (with a literal colon character
9186 between, thus I<"foo:1234-1234-1234-1234">).
9188 At the moment of writing (collectd-5.5), hostname string is limited to 62
9189 characters. In case when combination of fields exceeds 62 characters,
9190 hostname will be truncated without a warning.
9192 =item B<InterfaceFormat> B<name>|B<address>
9194 When the virt plugin logs interface data, it sets the name of the collected
9195 data according to this setting. The default is to use the path as provided by
9196 the hypervisor (the "dev" property of the target node), which is equal to
9199 B<address> means use the interface's mac address. This is useful since the
9200 interface path might change between reboots of a guest or across migrations.
9202 =item B<PluginInstanceFormat> B<name|uuid|none>
9204 When the virt plugin logs data, it sets the plugin_instance of the collected
9205 data according to this setting. The default is to not set the plugin_instance.
9207 B<name> means use the guest's name as provided by the hypervisor.
9208 B<uuid> means use the guest's UUID.
9210 You can also specify combinations of the B<name> and B<uuid> fields.
9211 For example B<name uuid> means to concatenate the guest name and UUID
9212 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9214 =item B<Instances> B<integer>
9216 How many read instances you want to use for this plugin. The default is one,
9217 and the sensible setting is a multiple of the B<ReadThreads> value.
9218 If you are not sure, just use the default setting.
9220 =item B<ExtraStats> B<string>
9222 Report additional extra statistics. The default is no extra statistics, preserving
9223 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9224 allows the plugin to reported more detailed statistics about the behaviour of
9225 Virtual Machines. The argument is a space-separated list of selectors.
9227 Currently supported selectors are:
9231 =item B<cpu_util>: report CPU utilization per domain in percentage.
9233 =item B<disk>: report extra statistics like number of flush operations and total
9234 service time for read, write and flush operations. Requires libvirt API version
9237 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9240 =item B<domain_state>: report domain state and reason in human-readable format as
9241 a notification. If libvirt API version I<0.9.2> or later is available, domain
9242 reason will be included in notification.
9244 =item B<fs_info>: report file system information as a notification. Requires
9245 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9246 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9247 version supports retrieving file system information.
9249 =item B<job_stats_background>: report statistics about progress of a background
9250 job on a domain. Only one type of job statistics can be collected at the same time.
9251 Requires libvirt API version I<1.2.9> or later.
9253 =item B<job_stats_completed>: report statistics about a recently completed job on
9254 a domain. Only one type of job statistics can be collected at the same time.
9255 Requires libvirt API version I<1.2.9> or later.
9257 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9258 Requires libvirt API version I<0.9.11> or later.
9260 =item B<perf>: report performance monitoring events. To collect performance
9261 metrics they must be enabled for domain and supported by the platform. Requires
9262 libvirt API version I<1.3.3> or later.
9263 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9265 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9269 =item B<PersistentNotification> B<true>|B<false>
9270 Override default configuration to only send notifications when there is a change
9271 in the lifecycle state of a domain. When set to true notifications will be sent
9272 for every read cycle. Default is false. Does not affect the stats being
9277 =head2 Plugin C<vmem>
9279 The C<vmem> plugin collects information about the usage of virtual memory.
9280 Since the statistics provided by the Linux kernel are very detailed, they are
9281 collected very detailed. However, to get all the details, you have to switch
9282 them on manually. Most people just want an overview over, such as the number of
9283 pages read from swap space.
9287 =item B<Verbose> B<true>|B<false>
9289 Enables verbose collection of information. This will start collecting page
9290 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9291 Part of these statistics are collected on a "per zone" basis.
9295 =head2 Plugin C<vserver>
9297 This plugin doesn't have any options. B<VServer> support is only available for
9298 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9299 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9300 need to apply the patches and compile your own kernel, which will then provide
9301 the F</proc/virtual> filesystem that is required by this plugin.
9303 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9305 B<Note>: The traffic collected by this plugin accounts for the amount of
9306 traffic passing a socket which might be a lot less than the actual on-wire
9307 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9308 collect on-wire traffic you could, for example, use the logging facilities of
9309 iptables to feed data for the guest IPs into the iptables plugin.
9311 =head2 Plugin C<write_graphite>
9313 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9314 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9315 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9316 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9317 of at most 1428 bytes to minimize the number of network packets.
9321 <Plugin write_graphite>
9331 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9332 blocks. Inside the B<Node> blocks, the following options are recognized:
9336 =item B<Host> I<Address>
9338 Hostname or address to connect to. Defaults to C<localhost>.
9340 =item B<Port> I<Service>
9342 Service name or port number to connect to. Defaults to C<2003>.
9344 =item B<Protocol> I<String>
9346 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9348 =item B<ReconnectInterval> I<Seconds>
9350 When set to non-zero, forces the connection to the Graphite backend to be
9351 closed and re-opend periodically. This behavior is desirable in environments
9352 where the connection to the Graphite backend is done through load balancers,
9353 for example. When set to zero, the default, the connetion is kept open for as
9356 =item B<LogSendErrors> B<false>|B<true>
9358 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9359 If set to B<false>, it will not log the errors. This is especially useful when
9360 using Protocol UDP since many times we want to use the "fire-and-forget"
9361 approach and logging errors fills syslog with unneeded messages.
9363 =item B<Prefix> I<String>
9365 When set, I<String> is added in front of the host name. Dots and whitespace are
9366 I<not> escaped in this string (see B<EscapeCharacter> below).
9368 =item B<Postfix> I<String>
9370 When set, I<String> is appended to the host name. Dots and whitespace are
9371 I<not> escaped in this string (see B<EscapeCharacter> below).
9373 =item B<EscapeCharacter> I<Char>
9375 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9376 in the identifier. The B<EscapeCharacter> option determines which character
9377 dots, whitespace and control characters are replaced with. Defaults to
9380 =item B<StoreRates> B<false>|B<true>
9382 If set to B<true> (the default), convert counter values to rates. If set to
9383 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9386 =item B<SeparateInstances> B<false>|B<true>
9388 If set to B<true>, the plugin instance and type instance will be in their own
9389 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9390 default), the plugin and plugin instance (and likewise the type and type
9391 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9393 =item B<AlwaysAppendDS> B<false>|B<true>
9395 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9396 identifier. If set to B<false> (the default), this is only done when there is
9399 =item B<PreserveSeparator> B<false>|B<true>
9401 If set to B<false> (the default) the C<.> (dot) character is replaced with
9402 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9403 is preserved, i.e. passed through.
9405 =item B<DropDuplicateFields> B<false>|B<true>
9407 If set to B<true>, detect and remove duplicate components in Graphite metric
9408 names. For example, the metric name C<host.load.load.shortterm> will
9409 be shortened to C<host.load.shortterm>.
9413 =head2 Plugin C<write_log>
9415 The C<write_log> plugin writes metrics as INFO log messages.
9417 This plugin supports two output formats: I<Graphite> and I<JSON>.
9427 =item B<Format> I<Format>
9429 The output format to use. Can be one of C<Graphite> or C<JSON>.
9433 =head2 Plugin C<write_tsdb>
9435 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9436 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9437 state daemon that ingests metrics and stores them in HBase. The plugin uses
9438 I<TCP> over the "line based" protocol with a default port 4242. The data will
9439 be sent in blocks of at most 1428 bytes to minimize the number of network
9448 Host "tsd-1.my.domain"
9450 HostTags "status=production"
9454 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9455 blocks and global directives.
9457 Global directives are:
9461 =item B<ResolveInterval> I<seconds>
9463 =item B<ResolveJitter> I<seconds>
9465 When I<collectd> connects to a TSDB node, it will request the hostname from
9466 DNS. This can become a problem if the TSDB node is unavailable or badly
9467 configured because collectd will request DNS in order to reconnect for every
9468 metric, which can flood your DNS. So you can cache the last value for
9469 I<ResolveInterval> seconds.
9470 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9472 You can also define a jitter, a random interval to wait in addition to
9473 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9474 hostname at the same time when the connection fails.
9475 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9477 B<Note:> If the DNS resolution has already been successful when the socket
9478 closes, the plugin will try to reconnect immediately with the cached
9479 information. DNS is queried only when the socket is closed for a longer than
9480 I<ResolveInterval> + I<ResolveJitter> seconds.
9484 Inside the B<Node> blocks, the following options are recognized:
9488 =item B<Host> I<Address>
9490 Hostname or address to connect to. Defaults to C<localhost>.
9492 =item B<Port> I<Service>
9494 Service name or port number to connect to. Defaults to C<4242>.
9497 =item B<HostTags> I<String>
9499 When set, I<HostTags> is added to the end of the metric. It is intended to be
9500 used for name=value pairs that the TSD will tag the metric with. Dots and
9501 whitespace are I<not> escaped in this string.
9503 =item B<StoreRates> B<false>|B<true>
9505 If set to B<true>, convert counter values to rates. If set to B<false>
9506 (the default) counter values are stored as is, as an increasing
9509 =item B<AlwaysAppendDS> B<false>|B<true>
9511 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9512 identifier. If set to B<false> (the default), this is only done when there is
9517 =head2 Plugin C<write_mongodb>
9519 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9524 <Plugin "write_mongodb">
9533 The plugin can send values to multiple instances of I<MongoDB> by specifying
9534 one B<Node> block for each instance. Within the B<Node> blocks, the following
9535 options are available:
9539 =item B<Host> I<Address>
9541 Hostname or address to connect to. Defaults to C<localhost>.
9543 =item B<Port> I<Service>
9545 Service name or port number to connect to. Defaults to C<27017>.
9547 =item B<Timeout> I<Milliseconds>
9549 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9550 Setting this option to zero means no timeout, which is the default.
9552 =item B<StoreRates> B<false>|B<true>
9554 If set to B<true> (the default), convert counter values to rates. If set to
9555 B<false> counter values are stored as is, i.e. as an increasing integer
9558 =item B<Database> I<Database>
9560 =item B<User> I<User>
9562 =item B<Password> I<Password>
9564 Sets the information used when authenticating to a I<MongoDB> database. The
9565 fields are optional (in which case no authentication is attempted), but if you
9566 want to use authentication all three fields must be set.
9570 =head2 Plugin C<write_prometheus>
9572 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9573 using I<Prometheus>.
9579 =item B<Port> I<Port>
9581 Port the embedded webserver should listen on. Defaults to B<9103>.
9583 =item B<StalenessDelta> I<Seconds>
9585 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9586 hasn't seen any update for it. This value must match the setting in Prometheus.
9587 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9591 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9592 which time a metric without updates is considered "stale". This setting
9593 effectively puts an upper limit on the interval in which metrics are reported.
9595 When the I<write_prometheus plugin> encounters a metric with an interval
9596 exceeding this limit, it will inform you, the user, and provide the metric to
9597 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9598 metric "fresh" each time it is scraped, with the time of the scrape being
9599 considered the time of the update. The result is that there appear more
9600 datapoints in I<Prometheus> than were actually created, but at least the metric
9601 doesn't disappear periodically.
9605 =head2 Plugin C<write_http>
9607 This output plugin submits values to an HTTP server using POST requests and
9608 encoding metrics with JSON or using the C<PUTVAL> command described in
9609 L<collectd-unixsock(5)>.
9613 <Plugin "write_http">
9615 URL "http://example.com/post-collectd"
9622 The plugin can send values to multiple HTTP servers by specifying one
9623 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9624 block, the following options are available:
9630 URL to which the values are submitted to. Mandatory.
9632 =item B<User> I<Username>
9634 Optional user name needed for authentication.
9636 =item B<Password> I<Password>
9638 Optional password needed for authentication.
9640 =item B<VerifyPeer> B<true>|B<false>
9642 Enable or disable peer SSL certificate verification. See
9643 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9645 =item B<VerifyHost> B<true|false>
9647 Enable or disable peer host name verification. If enabled, the plugin checks if
9648 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9649 matches the host name provided by the B<URL> option. If this identity check
9650 fails, the connection is aborted. Obviously, only works when connecting to a
9651 SSL enabled server. Enabled by default.
9653 =item B<CACert> I<File>
9655 File that holds one or more SSL certificates. If you want to use HTTPS you will
9656 possibly need this option. What CA certificates come bundled with C<libcurl>
9657 and are checked by default depends on the distribution you use.
9659 =item B<CAPath> I<Directory>
9661 Directory holding one or more CA certificate files. You can use this if for
9662 some reason all the needed CA certificates aren't in the same file and can't be
9663 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9666 =item B<ClientKey> I<File>
9668 File that holds the private key in PEM format to be used for certificate-based
9671 =item B<ClientCert> I<File>
9673 File that holds the SSL certificate to be used for certificate-based
9676 =item B<ClientKeyPass> I<Password>
9678 Password required to load the private key in B<ClientKey>.
9680 =item B<Header> I<Header>
9682 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9684 Header "X-Custom-Header: custom_value"
9686 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9688 Define which SSL protocol version must be used. By default C<libcurl> will
9689 attempt to figure out the remote SSL protocol version. See
9690 L<curl_easy_setopt(3)> for more details.
9692 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9694 Format of the output to generate. If set to B<Command>, will create output that
9695 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9696 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9697 , will create output in the KairosDB format.
9699 Defaults to B<Command>.
9701 =item B<Attribute> I<String> I<String>
9703 Only available for the KAIROSDB output format.
9705 Consider the two given strings to be the key and value of an additional tag for
9706 each metric being sent out.
9708 You can add multiple B<Attribute>.
9712 Only available for the KAIROSDB output format.
9714 Sets the Cassandra ttl for the data points.
9716 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9718 =item B<Prefix> I<String>
9720 Only available for the KAIROSDB output format.
9722 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9724 =item B<Metrics> B<true>|B<false>
9726 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9728 =item B<Notifications> B<false>|B<true>
9730 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9732 =item B<StoreRates> B<true|false>
9734 If set to B<true>, convert counter values to rates. If set to B<false> (the
9735 default) counter values are stored as is, i.e. as an increasing integer number.
9737 =item B<BufferSize> I<Bytes>
9739 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9740 requests will be generated, but more metrics will be batched / metrics are
9741 cached for longer before being sent, introducing additional delay until they
9742 are available on the server side. I<Bytes> must be at least 1024 and cannot
9743 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9744 Defaults to C<4096>.
9746 =item B<LowSpeedLimit> I<Bytes per Second>
9748 Sets the minimal transfer rate in I<Bytes per Second> below which the
9749 connection with the HTTP server will be considered too slow and aborted. All
9750 the data submitted over this connection will probably be lost. Defaults to 0,
9751 which means no minimum transfer rate is enforced.
9753 =item B<Timeout> I<Timeout>
9755 Sets the maximum time in milliseconds given for HTTP POST operations to
9756 complete. When this limit is reached, the POST operation will be aborted, and
9757 all the data in the current send buffer will probably be lost. Defaults to 0,
9758 which means the connection never times out.
9760 =item B<LogHttpError> B<false>|B<true>
9762 Enables printing of HTTP error code to log. Turned off by default.
9764 The C<write_http> plugin regularly submits the collected values to the HTTP
9765 server. How frequently this happens depends on how much data you are collecting
9766 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9767 slightly below this interval, which you can estimate by monitoring the network
9768 traffic between collectd and the HTTP server.
9772 =head2 Plugin C<write_kafka>
9774 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9778 <Plugin "write_kafka">
9779 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9785 The following options are understood by the I<write_kafka plugin>:
9789 =item E<lt>B<Topic> I<Name>E<gt>
9791 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9792 is given a unique I<Name> and specifies one kafka producer.
9793 Inside the B<Topic> block, the following per-topic options are
9798 =item B<Property> I<String> I<String>
9800 Configure the named property for the current topic. Properties are
9801 forwarded to the kafka producer library B<librdkafka>.
9803 =item B<Key> I<String>
9805 Use the specified string as a partitioning key for the topic. Kafka breaks
9806 topic into partitions and guarantees that for a given topology, the same
9807 consumer will be used for a specific key. The special (case insensitive)
9808 string B<Random> can be used to specify that an arbitrary partition should
9811 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9813 Selects the format in which messages are sent to the broker. If set to
9814 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9815 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9817 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9818 an easy and straight forward exchange format.
9820 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9821 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9823 =item B<StoreRates> B<true>|B<false>
9825 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9826 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9827 default), no conversion is performed. Otherwise the conversion is performed
9828 using the internal value cache.
9830 Please note that currently this option is only used if the B<Format> option has
9831 been set to B<JSON>.
9833 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9835 A prefix can be added in the metric name when outputting in the I<Graphite>
9836 format. It's added before the I<Host> name.
9838 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>>
9840 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9842 A postfix can be added in the metric name when outputting in the I<Graphite>
9843 format. It's added after the I<Host> name.
9845 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>>
9847 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9849 Specify a character to replace dots (.) in the host part of the metric name.
9850 In I<Graphite> metric name, dots are used as separators between different
9851 metric parts (host, plugin, type).
9852 Default is C<_> (I<Underscore>).
9854 =item B<GraphiteSeparateInstances> B<false>|B<true>
9856 If set to B<true>, the plugin instance and type instance will be in their own
9857 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9858 default), the plugin and plugin instance (and likewise the type and type
9859 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9861 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9863 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9864 identifier. If set to B<false> (the default), this is only done when there is
9867 =item B<GraphitePreserveSeparator> B<false>|B<true>
9869 If set to B<false> (the default) the C<.> (dot) character is replaced with
9870 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9871 is preserved, i.e. passed through.
9873 =item B<StoreRates> B<true>|B<false>
9875 If set to B<true> (the default), convert counter values to rates. If set to
9876 B<false> counter values are stored as is, i.e. as an increasing integer number.
9878 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9879 converted values will have "rate" appended to the data source type, e.g.
9880 C<ds_type:derive:rate>.
9884 =item B<Property> I<String> I<String>
9886 Configure the kafka producer through properties, you almost always will
9887 want to set B<metadata.broker.list> to your Kafka broker list.
9891 =head2 Plugin C<write_redis>
9893 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9897 <Plugin "write_redis">
9910 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9911 the timestamp as the score. Retrieving a date range can then be done using the
9912 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9913 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9914 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9915 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9916 with the B<Database> parameter (default is C<0>). See
9917 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9920 The information shown in the synopsis above is the I<default configuration>
9921 which is used by the plugin if no configuration is present.
9923 The plugin can send values to multiple instances of I<Redis> by specifying
9924 one B<Node> block for each instance. Within the B<Node> blocks, the following
9925 options are available:
9929 =item B<Node> I<Nodename>
9931 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9932 instance running on a specified host and port. The node name is a
9933 canonical identifier which is used as I<plugin instance>. It is limited to
9934 51E<nbsp>characters in length.
9936 =item B<Host> I<Hostname>
9938 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9941 =item B<Port> I<Port>
9943 The B<Port> option is the TCP port on which the Redis instance accepts
9944 connections. Either a service name of a port number may be given. Please note
9945 that numerical port numbers must be given as a string, too.
9947 =item B<Timeout> I<Milliseconds>
9949 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9951 =item B<Prefix> I<Prefix>
9953 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9954 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9955 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9956 is recommended but not required to include a trailing slash in I<Prefix>.
9958 =item B<Database> I<Index>
9960 This index selects the redis database to use for writing operations. Defaults
9963 =item B<MaxSetSize> I<Items>
9965 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9966 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9968 =item B<MaxSetDuration> I<Seconds>
9970 The B<MaxSetDuration> option limits the duration of items that the
9971 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9972 is the default behavior.
9974 =item B<StoreRates> B<true>|B<false>
9976 If set to B<true> (the default), convert counter values to rates. If set to
9977 B<false> counter values are stored as is, i.e. as an increasing integer number.
9981 =head2 Plugin C<write_riemann>
9983 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9984 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9985 I<Riemann> using UDP packets.
9989 <Plugin "write_riemann">
9995 AlwaysAppendDS false
9999 Attribute "foo" "bar"
10002 The following options are understood by the I<write_riemann plugin>:
10006 =item E<lt>B<Node> I<Name>E<gt>
10008 The plugin's configuration consists of one or more B<Node> blocks. Each block
10009 is given a unique I<Name> and specifies one connection to an instance of
10010 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10015 =item B<Host> I<Address>
10017 Hostname or address to connect to. Defaults to C<localhost>.
10019 =item B<Port> I<Service>
10021 Service name or port number to connect to. Defaults to C<5555>.
10023 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10025 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10028 =item B<TLSCertFile> I<Path>
10030 When using the B<TLS> protocol, path to a PEM certificate to present
10033 =item B<TLSCAFile> I<Path>
10035 When using the B<TLS> protocol, path to a PEM CA certificate to
10036 use to validate the remote hosts's identity.
10038 =item B<TLSKeyFile> I<Path>
10040 When using the B<TLS> protocol, path to a PEM private key associated
10041 with the certificate defined by B<TLSCertFile>.
10043 =item B<Batch> B<true>|B<false>
10045 If set to B<true> and B<Protocol> is set to B<TCP>,
10046 events will be batched in memory and flushed at
10047 regular intervals or when B<BatchMaxSize> is exceeded.
10049 Notifications are not batched and sent as soon as possible.
10051 When enabled, it can occur that events get processed by the Riemann server
10052 close to or after their expiration time. Tune the B<TTLFactor> and
10053 B<BatchMaxSize> settings according to the amount of values collected, if this
10058 =item B<BatchMaxSize> I<size>
10060 Maximum payload size for a riemann packet. Defaults to 8192
10062 =item B<BatchFlushTimeout> I<seconds>
10064 Maximum amount of seconds to wait in between to batch flushes.
10065 No timeout by default.
10067 =item B<StoreRates> B<true>|B<false>
10069 If set to B<true> (the default), convert counter values to rates. If set to
10070 B<false> counter values are stored as is, i.e. as an increasing integer number.
10072 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10073 converted values will have "rate" appended to the data source type, e.g.
10074 C<ds_type:derive:rate>.
10076 =item B<AlwaysAppendDS> B<false>|B<true>
10078 If set to B<true>, append the name of the I<Data Source> (DS) to the
10079 "service", i.e. the field that, together with the "host" field, uniquely
10080 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10081 only done when there is more than one DS.
10083 =item B<TTLFactor> I<Factor>
10085 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10086 event is considered active. I<collectd> populates this field based on the
10087 metrics interval setting. This setting controls the factor with which the
10088 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10089 know exactly what you're doing, you should only increase this setting from its
10092 =item B<Notifications> B<false>|B<true>
10094 If set to B<true>, create riemann events for notifications. This is B<true>
10095 by default. When processing thresholds from write_riemann, it might prove
10096 useful to avoid getting notification events.
10098 =item B<CheckThresholds> B<false>|B<true>
10100 If set to B<true>, attach state to events based on thresholds defined
10101 in the B<Threshold> plugin. Defaults to B<false>.
10103 =item B<EventServicePrefix> I<String>
10105 Add the given string as a prefix to the event service name.
10106 If B<EventServicePrefix> not set or set to an empty string (""),
10107 no prefix will be used.
10111 =item B<Tag> I<String>
10113 Add the given string as an additional tag to the metric being sent to
10116 =item B<Attribute> I<String> I<String>
10118 Consider the two given strings to be the key and value of an additional
10119 attribute for each metric being sent out to I<Riemann>.
10123 =head2 Plugin C<write_sensu>
10125 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10126 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10127 a local I<Sensu> client using a TCP socket.
10129 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10130 parameter so it is not possible to use one collectd instance as a gateway for
10131 others. Each collectd host must pair with one I<Sensu> client.
10135 <Plugin "write_sensu">
10140 AlwaysAppendDS false
10141 MetricHandler "influx"
10142 MetricHandler "default"
10143 NotificationHandler "flapjack"
10144 NotificationHandler "howling_monkey"
10148 Attribute "foo" "bar"
10151 The following options are understood by the I<write_sensu plugin>:
10155 =item E<lt>B<Node> I<Name>E<gt>
10157 The plugin's configuration consists of one or more B<Node> blocks. Each block
10158 is given a unique I<Name> and specifies one connection to an instance of
10159 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10164 =item B<Host> I<Address>
10166 Hostname or address to connect to. Defaults to C<localhost>.
10168 =item B<Port> I<Service>
10170 Service name or port number to connect to. Defaults to C<3030>.
10172 =item B<StoreRates> B<true>|B<false>
10174 If set to B<true> (the default), convert counter values to rates. If set to
10175 B<false> counter values are stored as is, i.e. as an increasing integer number.
10177 This will be reflected in the C<collectd_data_source_type> tag: If
10178 B<StoreRates> is enabled, converted values will have "rate" appended to the
10179 data source type, e.g. C<collectd_data_source_type:derive:rate>.
10181 =item B<AlwaysAppendDS> B<false>|B<true>
10183 If set the B<true>, append the name of the I<Data Source> (DS) to the
10184 "service", i.e. the field that, together with the "host" field, uniquely
10185 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10186 only done when there is more than one DS.
10188 =item B<Notifications> B<false>|B<true>
10190 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10191 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10193 =item B<Metrics> B<false>|B<true>
10195 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10196 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10199 =item B<Separator> I<String>
10201 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10203 =item B<MetricHandler> I<String>
10205 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10206 several of them, one per line. Defaults to no handler.
10208 =item B<NotificationHandler> I<String>
10210 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10211 add several of them, one per line. Defaults to no handler.
10213 =item B<EventServicePrefix> I<String>
10215 Add the given string as a prefix to the event service name.
10216 If B<EventServicePrefix> not set or set to an empty string (""),
10217 no prefix will be used.
10221 =item B<Tag> I<String>
10223 Add the given string as an additional tag to the metric being sent to
10226 =item B<Attribute> I<String> I<String>
10228 Consider the two given strings to be the key and value of an additional
10229 attribute for each metric being sent out to I<Sensu>.
10233 =head2 Plugin C<xencpu>
10235 This plugin collects metrics of hardware CPU load for machine running Xen
10236 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10237 Result is reported using the C<percent> type, for each CPU (core).
10239 This plugin doesn't have any options (yet).
10241 =head2 Plugin C<zookeeper>
10243 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10244 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
10249 <Plugin "zookeeper">
10256 =item B<Host> I<Address>
10258 Hostname or address to connect to. Defaults to C<localhost>.
10260 =item B<Port> I<Service>
10262 Service name or port number to connect to. Defaults to C<2181>.
10266 =head1 THRESHOLD CONFIGURATION
10268 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
10269 we mean that the values are not only stored or sent somewhere, but that they
10270 are judged and, if a problem is recognized, acted upon. The only action
10271 collectd takes itself is to generate and dispatch a "notification". Plugins can
10272 register to receive notifications and perform appropriate further actions.
10274 Since systems and what you expect them to do differ a lot, you can configure
10275 B<thresholds> for your values freely. This gives you a lot of flexibility but
10276 also a lot of responsibility.
10278 Every time a value is out of range a notification is dispatched. This means
10279 that the idle percentage of your CPU needs to be less then the configured
10280 threshold only once for a notification to be generated. There's no such thing
10281 as a moving average or similar - at least not now.
10283 Also, all values that match a threshold are considered to be relevant or
10284 "interesting". As a consequence collectd will issue a notification if they are
10285 not received for B<Timeout> iterations. The B<Timeout> configuration option is
10286 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
10287 "2" (the default) and some hosts sends it's CPU statistics to the server every
10288 60 seconds, a notification will be dispatched after about 120 seconds. It may
10289 take a little longer because the timeout is checked only once each B<Interval>
10292 When a value comes within range again or is received after it was missing, an
10293 "OKAY-notification" is dispatched.
10295 Here is a configuration example to get you started. Read below for more
10308 <Plugin "interface">
10311 FailureMax 10000000
10325 WarningMin 100000000
10331 There are basically two types of configuration statements: The C<Host>,
10332 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10333 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10334 C<Instance> option. You can combine the block by nesting the blocks, though
10335 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10336 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10337 C<Type> may not contain other blocks. If multiple blocks apply to the same
10338 value the most specific block is used.
10340 The other statements specify the threshold to configure. They B<must> be
10341 included in a C<Type> block. Currently the following statements are recognized:
10345 =item B<FailureMax> I<Value>
10347 =item B<WarningMax> I<Value>
10349 Sets the upper bound of acceptable values. If unset defaults to positive
10350 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10351 will be created. If the value is greater than B<WarningMax> but less than (or
10352 equal to) B<FailureMax> a B<WARNING> notification will be created.
10354 =item B<FailureMin> I<Value>
10356 =item B<WarningMin> I<Value>
10358 Sets the lower bound of acceptable values. If unset defaults to negative
10359 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10360 be created. If the value is less than B<WarningMin> but greater than (or equal
10361 to) B<FailureMin> a B<WARNING> notification will be created.
10363 =item B<DataSource> I<DSName>
10365 Some data sets have more than one "data source". Interesting examples are the
10366 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10367 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10368 system load data set, C<load>, even has three data sources: C<shortterm>,
10369 C<midterm>, and C<longterm>.
10371 Normally, all data sources are checked against a configured threshold. If this
10372 is undesirable, or if you want to specify different limits for each data
10373 source, you can use the B<DataSource> option to have a threshold apply only to
10376 =item B<Invert> B<true>|B<false>
10378 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10379 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10380 B<WarningMax>) are not okay. Defaults to B<false>.
10382 =item B<Persist> B<true>|B<false>
10384 Sets how often notifications are generated. If set to B<true> one notification
10385 will be generated for each value that is out of the acceptable range. If set to
10386 B<false> (the default) then a notification is only generated if a value is out
10387 of range but the previous value was okay.
10389 This applies to missing values, too: If set to B<true> a notification about a
10390 missing value is generated once every B<Interval> seconds. If set to B<false>
10391 only one such notification is generated until the value appears again.
10393 =item B<Percentage> B<true>|B<false>
10395 If set to B<true>, the minimum and maximum values given are interpreted as
10396 percentage value, relative to the other data sources. This is helpful for
10397 example for the "df" type, where you may want to issue a warning when less than
10398 5E<nbsp>% of the total space is available. Defaults to B<false>.
10400 =item B<Hits> I<Number>
10402 Delay creating the notification until the threshold has been passed I<Number>
10403 times. When a notification has been generated, or when a subsequent value is
10404 inside the threshold, the counter is reset. If, for example, a value is
10405 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10406 will be dispatched at most once every 30E<nbsp>seconds.
10408 This is useful when short bursts are not a problem. If, for example, 100% CPU
10409 usage for up to a minute is normal (and data is collected every
10410 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10412 =item B<Hysteresis> I<Number>
10414 When set to non-zero, a hysteresis value is applied when checking minimum and
10415 maximum bounds. This is useful for values that increase slowly and fluctuate a
10416 bit while doing so. When these values come close to the threshold, they may
10417 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10419 If, for example, the threshold is configures as
10424 then a I<Warning> notification is created when the value exceeds I<101> and the
10425 corresponding I<Okay> notification is only created once the value falls below
10426 I<99>, thus avoiding the "flapping".
10430 =head1 FILTER CONFIGURATION
10432 Starting with collectd 4.6 there is a powerful filtering infrastructure
10433 implemented in the daemon. The concept has mostly been copied from
10434 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10435 terminology, so that users that are familiar with iptables feel right at home.
10439 The following are the terms used in the remainder of the filter configuration
10440 documentation. For an ASCII-art schema of the mechanism, see
10441 L<"General structure"> below.
10447 A I<match> is a criteria to select specific values. Examples are, of course, the
10448 name of the value or it's current value.
10450 Matches are implemented in plugins which you have to load prior to using the
10451 match. The name of such plugins starts with the "match_" prefix.
10455 A I<target> is some action that is to be performed with data. Such actions
10456 could, for example, be to change part of the value's identifier or to ignore
10457 the value completely.
10459 Some of these targets are built into the daemon, see L<"Built-in targets">
10460 below. Other targets are implemented in plugins which you have to load prior to
10461 using the target. The name of such plugins starts with the "target_" prefix.
10465 The combination of any number of matches and at least one target is called a
10466 I<rule>. The target actions will be performed for all values for which B<all>
10467 matches apply. If the rule does not have any matches associated with it, the
10468 target action will be performed for all values.
10472 A I<chain> is a list of rules and possibly default targets. The rules are tried
10473 in order and if one matches, the associated target will be called. If a value
10474 is handled by a rule, it depends on the target whether or not any subsequent
10475 rules are considered or if traversal of the chain is aborted, see
10476 L<"Flow control"> below. After all rules have been checked, the default targets
10481 =head2 General structure
10483 The following shows the resulting structure:
10490 +---------+ +---------+ +---------+ +---------+
10491 ! Rule !->! Match !->! Match !->! Target !
10492 +---------+ +---------+ +---------+ +---------+
10495 +---------+ +---------+ +---------+
10496 ! Rule !->! Target !->! Target !
10497 +---------+ +---------+ +---------+
10504 +---------+ +---------+ +---------+
10505 ! Rule !->! Match !->! Target !
10506 +---------+ +---------+ +---------+
10514 =head2 Flow control
10516 There are four ways to control which way a value takes through the filter
10523 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10524 process the value with another chain. When the called chain finishes, usually
10525 the next target or rule after the jump is executed.
10529 The stop condition, signaled for example by the built-in target B<stop>, causes
10530 all processing of the value to be stopped immediately.
10534 Causes processing in the current chain to be aborted, but processing of the
10535 value generally will continue. This means that if the chain was called via
10536 B<Jump>, the next target or rule after the jump will be executed. If the chain
10537 was not called by another chain, control will be returned to the daemon and it
10538 may pass the value to another chain.
10542 Most targets will signal the B<continue> condition, meaning that processing
10543 should continue normally. There is no special built-in target for this
10550 The configuration reflects this structure directly:
10552 PostCacheChain "PostCache"
10553 <Chain "PostCache">
10554 <Rule "ignore_mysql_show">
10557 Type "^mysql_command$"
10558 TypeInstance "^show_"
10568 The above configuration example will ignore all values where the plugin field
10569 is "mysql", the type is "mysql_command" and the type instance begins with
10570 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10571 default target of the chain. Since this chain is run after the value has been
10572 added to the cache, the MySQL C<show_*> command statistics will be available
10573 via the C<unixsock> plugin.
10575 =head2 List of configuration options
10579 =item B<PreCacheChain> I<ChainName>
10581 =item B<PostCacheChain> I<ChainName>
10583 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10584 argument is the name of a I<chain> that should be executed before and/or after
10585 the values have been added to the cache.
10587 To understand the implications, it's important you know what is going on inside
10588 I<collectd>. The following diagram shows how values are passed from the
10589 read-plugins to the write-plugins:
10595 + - - - - V - - - - +
10596 : +---------------+ :
10599 : +-------+-------+ :
10602 : +-------+-------+ : +---------------+
10603 : ! Cache !--->! Value Cache !
10604 : ! insert ! : +---+---+-------+
10605 : +-------+-------+ : ! !
10606 : ! ,------------' !
10608 : +-------+---+---+ : +-------+-------+
10609 : ! Post-Cache +--->! Write-Plugins !
10610 : ! Chain ! : +---------------+
10611 : +---------------+ :
10613 : dispatch values :
10614 + - - - - - - - - - +
10616 After the values are passed from the "read" plugins to the dispatch functions,
10617 the pre-cache chain is run first. The values are added to the internal cache
10618 afterwards. The post-cache chain is run after the values have been added to the
10619 cache. So why is it such a huge deal if chains are run before or after the
10620 values have been added to this cache?
10622 Targets that change the identifier of a value list should be executed before
10623 the values are added to the cache, so that the name in the cache matches the
10624 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10625 this cache to receive a list of all available values. If you change the
10626 identifier after the value list has been added to the cache, this may easily
10627 lead to confusion, but it's not forbidden of course.
10629 The cache is also used to convert counter values to rates. These rates are, for
10630 example, used by the C<value> match (see below). If you use the rate stored in
10631 the cache B<before> the new value is added, you will use the old, B<previous>
10632 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10633 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10636 Last but not last, the B<stop> target makes a difference: If the pre-cache
10637 chain returns the stop condition, the value will not be added to the cache and
10638 the post-cache chain will not be run.
10640 =item B<Chain> I<Name>
10642 Adds a new chain with a certain name. This name can be used to refer to a
10643 specific chain, for example to jump to it.
10645 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10647 =item B<Rule> [I<Name>]
10649 Adds a new rule to the current chain. The name of the rule is optional and
10650 currently has no meaning for the daemon.
10652 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10653 must be at least one B<Target> block.
10655 =item B<Match> I<Name>
10657 Adds a match to a B<Rule> block. The name specifies what kind of match should
10658 be performed. Available matches depend on the plugins that have been loaded.
10660 The arguments inside the B<Match> block are passed to the plugin implementing
10661 the match, so which arguments are valid here depends on the plugin being used.
10662 If you do not need any to pass any arguments to a match, you can use the
10667 Which is equivalent to:
10672 =item B<Target> I<Name>
10674 Add a target to a rule or a default target to a chain. The name specifies what
10675 kind of target is to be added. Which targets are available depends on the
10676 plugins being loaded.
10678 The arguments inside the B<Target> block are passed to the plugin implementing
10679 the target, so which arguments are valid here depends on the plugin being used.
10680 If you do not need any to pass any arguments to a target, you can use the
10685 This is the same as writing:
10692 =head2 Built-in targets
10694 The following targets are built into the core daemon and therefore need no
10695 plugins to be loaded:
10701 Signals the "return" condition, see the L<"Flow control"> section above. This
10702 causes the current chain to stop processing the value and returns control to
10703 the calling chain. The calling chain will continue processing targets and rules
10704 just after the B<jump> target (see below). This is very similar to the
10705 B<RETURN> target of iptables, see L<iptables(8)>.
10707 This target does not have any options.
10715 Signals the "stop" condition, see the L<"Flow control"> section above. This
10716 causes processing of the value to be aborted immediately. This is similar to
10717 the B<DROP> target of iptables, see L<iptables(8)>.
10719 This target does not have any options.
10727 Sends the value to "write" plugins.
10733 =item B<Plugin> I<Name>
10735 Name of the write plugin to which the data should be sent. This option may be
10736 given multiple times to send the data to more than one write plugin. If the
10737 plugin supports multiple instances, the plugin's instance(s) must also be
10742 If no plugin is explicitly specified, the values will be sent to all available
10745 Single-instance plugin example:
10751 Multi-instance plugin example:
10753 <Plugin "write_graphite">
10763 Plugin "write_graphite/foo"
10768 Starts processing the rules of another chain, see L<"Flow control"> above. If
10769 the end of that chain is reached, or a stop condition is encountered,
10770 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10771 next target or the next rule. This is similar to the B<-j> command line option
10772 of iptables, see L<iptables(8)>.
10778 =item B<Chain> I<Name>
10780 Jumps to the chain I<Name>. This argument is required and may appear only once.
10792 =head2 Available matches
10798 Matches a value using regular expressions.
10804 =item B<Host> I<Regex>
10806 =item B<Plugin> I<Regex>
10808 =item B<PluginInstance> I<Regex>
10810 =item B<Type> I<Regex>
10812 =item B<TypeInstance> I<Regex>
10814 =item B<MetaData> I<String> I<Regex>
10816 Match values where the given regular expressions match the various fields of
10817 the identifier of a value. If multiple regular expressions are given, B<all>
10818 regexen must match for a value to match.
10820 =item B<Invert> B<false>|B<true>
10822 When set to B<true>, the result of the match is inverted, i.e. all value lists
10823 where all regular expressions apply are not matched, all other value lists are
10824 matched. Defaults to B<false>.
10831 Host "customer[0-9]+"
10837 Matches values that have a time which differs from the time on the server.
10839 This match is mainly intended for servers that receive values over the
10840 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10841 is very sensitive to the timestamp used when updating the RRD files. In
10842 particular, the time must be ever increasing. If a misbehaving client sends one
10843 packet with a timestamp far in the future, all further packets with a correct
10844 time will be ignored because of that one packet. What's worse, such corrupted
10845 RRD files are hard to fix.
10847 This match lets one match all values B<outside> a specified time range
10848 (relative to the server's time), so you can use the B<stop> target (see below)
10849 to ignore the value, for example.
10855 =item B<Future> I<Seconds>
10857 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10858 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10861 =item B<Past> I<Seconds>
10863 Matches all values that are I<behind> of the server's time by I<Seconds> or
10864 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10876 This example matches all values that are five minutes or more ahead of the
10877 server or one hour (or more) lagging behind.
10881 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10882 values. If a data-set consists of more than one data-source, all data-sources
10883 must match the specified ranges for a positive match.
10889 =item B<Min> I<Value>
10891 Sets the smallest value which still results in a match. If unset, behaves like
10894 =item B<Max> I<Value>
10896 Sets the largest value which still results in a match. If unset, behaves like
10899 =item B<Invert> B<true>|B<false>
10901 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10902 no-match is returned and vice versa. Please note that the B<Invert> setting
10903 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10904 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10906 =item B<DataSource> I<DSName> [I<DSName> ...]
10908 Select one or more of the data sources. If no data source is configured, all
10909 data sources will be checked. If the type handled by the match does not have a
10910 data source of the specified name(s), this will always result in no match
10911 (independent of the B<Invert> setting).
10913 =item B<Satisfy> B<Any>|B<All>
10915 Specifies how checking with several data sources is performed. If set to
10916 B<Any>, the match succeeds if one of the data sources is in the configured
10917 range. If set to B<All> the match only succeeds if all data sources are within
10918 the configured range. Default is B<All>.
10920 Usually B<All> is used for positive matches, B<Any> is used for negative
10921 matches. This means that with B<All> you usually check that all values are in a
10922 "good" range, while with B<Any> you check if any value is within a "bad" range
10923 (or outside the "good" range).
10927 Either B<Min> or B<Max>, but not both, may be unset.
10931 # Match all values smaller than or equal to 100. Matches only if all data
10932 # sources are below 100.
10938 # Match if the value of any data source is outside the range of 0 - 100.
10946 =item B<empty_counter>
10948 Matches all values with one or more data sources of type B<COUNTER> and where
10949 all counter values are zero. These counters usually I<never> increased since
10950 they started existing (and are therefore uninteresting), or got reset recently
10951 or overflowed and you had really, I<really> bad luck.
10953 Please keep in mind that ignoring such counters can result in confusing
10954 behavior: Counters which hardly ever increase will be zero for long periods of
10955 time. If the counter is reset for some reason (machine or service restarted,
10956 usually), the graph will be empty (NAN) for a long time. People may not
10961 Calculates a hash value of the host name and matches values according to that
10962 hash value. This makes it possible to divide all hosts into groups and match
10963 only values that are in a specific group. The intended use is in load
10964 balancing, where you want to handle only part of all data and leave the rest
10967 The hashing function used tries to distribute the hosts evenly. First, it
10968 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10971 for (i = 0; host[i] != 0; i++)
10972 hash_value = (hash_value * 251) + host[i];
10974 The constant 251 is a prime number which is supposed to make this hash value
10975 more random. The code then checks the group for this host according to the
10976 I<Total> and I<Match> arguments:
10978 if ((hash_value % Total) == Match)
10983 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10984 groups), then the least significant bit of the hash value will be the XOR of
10985 all least significant bits in the host name. One consequence is that when you
10986 have two hosts, "server0.example.com" and "server1.example.com", where the host
10987 name differs in one digit only and the digits differ by one, those hosts will
10988 never end up in the same group.
10994 =item B<Match> I<Match> I<Total>
10996 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10997 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10998 be smaller than I<Total>. I<Total> must be at least one, although only values
10999 greater than one really do make any sense.
11001 You can repeat this option to match multiple groups, for example:
11006 The above config will divide the data into seven groups and match groups three
11007 and five. One use would be to keep every value on two hosts so that if one
11008 fails the missing data can later be reconstructed from the second host.
11014 # Operate on the pre-cache chain, so that ignored values are not even in the
11019 # Divide all received hosts in seven groups and accept all hosts in
11023 # If matched: Return and continue.
11026 # If not matched: Return and stop.
11032 =head2 Available targets
11036 =item B<notification>
11038 Creates and dispatches a notification.
11044 =item B<Message> I<String>
11046 This required option sets the message of the notification. The following
11047 placeholders will be replaced by an appropriate value:
11055 =item B<%{plugin_instance}>
11059 =item B<%{type_instance}>
11061 These placeholders are replaced by the identifier field of the same name.
11063 =item B<%{ds:>I<name>B<}>
11065 These placeholders are replaced by a (hopefully) human readable representation
11066 of the current rate of this data source. If you changed the instance name
11067 (using the B<set> or B<replace> targets, see below), it may not be possible to
11068 convert counter values to rates.
11072 Please note that these placeholders are B<case sensitive>!
11074 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11076 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11083 <Target "notification">
11084 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11090 Replaces parts of the identifier using regular expressions.
11096 =item B<Host> I<Regex> I<Replacement>
11098 =item B<Plugin> I<Regex> I<Replacement>
11100 =item B<PluginInstance> I<Regex> I<Replacement>
11102 =item B<TypeInstance> I<Regex> I<Replacement>
11104 =item B<MetaData> I<String> I<Regex> I<Replacement>
11106 =item B<DeleteMetaData> I<String> I<Regex>
11108 Match the appropriate field with the given regular expression I<Regex>. If the
11109 regular expression matches, that part that matches is replaced with
11110 I<Replacement>. If multiple places of the input buffer match a given regular
11111 expression, only the first occurrence will be replaced.
11113 You can specify each option multiple times to use multiple regular expressions
11121 # Replace "example.net" with "example.com"
11122 Host "\\<example.net\\>" "example.com"
11124 # Strip "www." from hostnames
11125 Host "\\<www\\." ""
11130 Sets part of the identifier of a value to a given string.
11136 =item B<Host> I<String>
11138 =item B<Plugin> I<String>
11140 =item B<PluginInstance> I<String>
11142 =item B<TypeInstance> I<String>
11144 =item B<MetaData> I<String> I<String>
11146 Set the appropriate field to the given string. The strings for plugin instance,
11147 type instance, and meta data may be empty, the strings for host and plugin may
11148 not be empty. It's currently not possible to set the type of a value this way.
11150 The following placeholders will be replaced by an appropriate value:
11158 =item B<%{plugin_instance}>
11162 =item B<%{type_instance}>
11164 These placeholders are replaced by the identifier field of the same name.
11166 =item B<%{meta:>I<name>B<}>
11168 These placeholders are replaced by the meta data value with the given name.
11172 Please note that these placeholders are B<case sensitive>!
11174 =item B<DeleteMetaData> I<String>
11176 Delete the named meta data field.
11183 PluginInstance "coretemp"
11184 TypeInstance "core3"
11189 =head2 Backwards compatibility
11191 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11192 B<Chain> block, it will behave as it used to. This is equivalent to the
11193 following configuration:
11195 <Chain "PostCache">
11199 If you specify a B<PostCacheChain>, the B<write> target will not be added
11200 anywhere and you will have to make sure that it is called where appropriate. We
11201 suggest to add the above snippet as default target to your "PostCache" chain.
11205 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11220 B<Ignorelists> are a generic framework to either ignore some metrics or report
11221 specific metircs only. Plugins usually provide one or more options to specify
11222 the items (mounts points, devices, ...) and the boolean option
11227 =item B<Select> I<String>
11229 Selects the item I<String>. This option often has a plugin specific name, e.g.
11230 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11231 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11232 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11234 By default, this option is doing a case-sensitive full-string match. The
11235 following config will match C<foo>, but not C<Foo>:
11239 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11240 I<regular expression>. For example, so match all item starting with C<foo>, use
11241 could use the following syntax:
11245 The regular expression is I<not> anchored, i.e. the following config will match
11246 C<foobar>, C<barfoo> and C<AfooZ>:
11250 The B<Select> option may be repeated to select multiple items.
11252 =item B<IgnoreSelected> B<true>|B<false>
11254 If set to B<true>, matching metrics are I<ignored> and all other metrics are
11255 collected. If set to B<false>, matching metrics are I<collected> and all other
11256 metrics are ignored.
11263 L<collectd-exec(5)>,
11264 L<collectd-perl(5)>,
11265 L<collectd-unixsock(5)>,
11278 Florian Forster E<lt>octo@collectd.orgE<gt>