5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/var/lib/collectd"
10 PIDFile "/run/collectd.pid"
31 This config file controls how the system statistics collection daemon
32 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
33 controls which plugins to load. These plugins ultimately define collectd's
34 behavior. If the B<AutoLoadPlugin> option has been enabled, the explicit
35 B<LoadPlugin> lines may be omitted for all plugins with a configuration block,
36 i.e. a C<E<lt>PluginE<nbsp>...E<gt>> block.
38 The syntax of this config file is similar to the config file of the famous
39 I<Apache> webserver. Each line contains either an option (a key and a list of
40 one or more values) or a section-start or -end. Empty lines and everything
41 after a non-quoted hash-symbol (C<#>) are ignored. I<Keys> are unquoted
42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
43 character. Keys are handled case insensitive by I<collectd> itself and all
44 plugins included with it. I<Values> can either be an I<unquoted string>, a
45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
46 expression. I<Unquoted strings> consist of only alphanumeric characters and
47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
49 to include double quotes as part of the string. I<Numbers> can be specified in
50 decimal and floating point format (using a dot C<.> as decimal separator),
51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
52 I<Boolean> values are either B<true> or B<false>.
54 Lines may be wrapped by using C<\> as the last character before the newline.
55 This allows long lines to be split into multiple lines. Quoted strings may be
56 wrapped as well. However, those are treated special in that whitespace at the
57 beginning of the following lines will be ignored, which allows for nicely
58 indenting the wrapped lines.
60 The configuration is read and processed in order, i.e. from top to bottom. So
61 the plugins are loaded in the order listed in this config file. It is a good
62 idea to load any logging plugins first in order to catch messages from plugins
63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
64 B<LoadPlugin> option I<must> occur I<before> the appropriate
65 C<E<lt>B<Plugin> ...E<gt>> block.
71 =item B<BaseDir> I<Directory>
73 Sets the base directory. This is the directory beneath which all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
77 =item B<LoadPlugin> I<Plugin>
79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
81 I<collectd> will be mostly useless.
83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
84 effect. This is useful when you want to split up the configuration into smaller
85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
86 block I<and> the appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
93 statement looks like this:
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
104 The following options are valid inside B<LoadPlugin> blocks:
108 =item B<Globals> B<true|false>
110 If enabled, collectd will export all global symbols of the plugin (and of all
111 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
112 available for resolving unresolved symbols in subsequently loaded plugins if
113 that is supported by your system.
115 This is useful (or possibly even required), e.g., when loading a plugin that
116 embeds some scripting language into the daemon (e.g. the I<Perl> and
117 I<Python plugins>). Scripting languages usually provide means to load
118 extensions written in C. Those extensions require symbols provided by the
119 interpreter, which is loaded as a dependency of the respective collectd plugin.
120 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
121 L<collectd-python(5)>) for details.
123 By default, this is disabled. As a special exception, if the plugin name is
124 either C<perl> or C<python>, the default is changed to enabled in order to keep
125 the average user from ever having to deal with this low level linking stuff.
127 =item B<Interval> I<Seconds>
129 Sets a plugin-specific interval for collecting metrics. This overrides the
130 global B<Interval> setting. If a plugin provides its own support for specifying
131 an interval, that setting will take precedence.
133 =item B<FlushInterval> I<Seconds>
135 Specifies the interval, in seconds, to call the flush callback if it's
136 defined in this plugin. By default, this is disabled.
138 =item B<FlushTimeout> I<Seconds>
140 Specifies the value of the timeout argument of the flush callback.
144 =item B<AutoLoadPlugin> B<false>|B<true>
146 When set to B<false> (the default), each plugin needs to be loaded explicitly,
147 using the B<LoadPlugin> statement documented above. If a
148 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
149 handling callback for this plugin has been registered, a warning is logged and
150 the block is ignored.
152 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
153 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
154 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
155 plugins that don't provide any configuration, e.g. the I<Load plugin>.
157 =item B<CollectInternalStats> B<false>|B<true>
159 When set to B<true>, various statistics about the I<collectd> daemon will be
160 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
162 The following metrics are reported:
166 =item C<collectd-write_queue/queue_length>
168 The number of metrics currently in the write queue. You can limit the queue
169 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
171 =item C<collectd-write_queue/derive-dropped>
173 The number of metrics dropped due to a queue length limitation.
174 If this value is non-zero, your system can't handle all incoming metrics and
175 protects itself against overload by dropping metrics.
177 =item C<collectd-cache/cache_size>
179 The number of elements in the metric cache (the cache you can interact with
180 using L<collectd-unixsock(5)>).
184 =item B<Include> I<Path> [I<pattern>]
186 If I<Path> points to a file, includes that file. If I<Path> points to a
187 directory, recursively includes all files within that directory and its
188 subdirectories. If the C<wordexp> function is available on your system,
189 shell-like wildcards are expanded before files are included. This means you can
190 use statements like the following:
192 Include "/etc/collectd.d/*.conf"
194 Starting with version 5.3, this may also be a block in which further options
195 affecting the behavior of B<Include> may be specified. The following option is
198 <Include "/etc/collectd.d">
204 =item B<Filter> I<pattern>
206 If the C<fnmatch> function is available on your system, a shell-like wildcard
207 I<pattern> may be specified to filter which files to include. This may be used
208 in combination with recursively including a directory to easily be able to
209 arbitrarily mix configuration files and other documents (e.g. README files).
210 The given example is similar to the first example above but includes all files
211 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
215 If more than one file is included by a single B<Include> option, the files
216 will be included in lexicographical order (as defined by the C<strcmp>
217 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
218 order in which the files are loaded.
220 To prevent loops and shooting yourself in the foot in interesting ways the
221 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
222 most uses. Since symlinks are followed it is still possible to crash the daemon
223 by looping symlinks. In our opinion significant stupidity should result in an
224 appropriate amount of pain.
226 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
227 file, but you cannot include files from within blocks.
229 =item B<PIDFile> I<File>
231 Sets where to write the PID file to. This file is overwritten when it exists
232 and deleted when the program is stopped. Some init-scripts might override this
233 setting using the B<-P> command-line option.
235 =item B<PluginDir> I<Directory>
237 Path to the plugins (shared objects) of collectd.
239 =item B<TypesDB> I<File> [I<File> ...]
241 Set one or more files that contain the data-set descriptions. See
242 L<types.db(5)> for a description of the format of this file.
244 If this option is not specified, a default file is read. If you need to define
245 custom types in addition to the types defined in the default file, you need to
246 explicitly load both. In other words, if the B<TypesDB> option is encountered
247 the default behavior is disabled and if you need the default types you have to
248 also explicitly load them.
250 =item B<Interval> I<Seconds>
252 Configures the interval in which to query the read plugins. Obviously smaller
253 values lead to a higher system load produced by collectd, while higher values
254 lead to more coarse statistics.
256 B<Warning:> You should set this once and then never touch it again. If you do,
257 I<you will have to delete all your RRD files> or know some serious RRDtool
258 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
260 =item B<MaxReadInterval> I<Seconds>
262 A read plugin doubles the interval between queries after each failed attempt
265 This options limits the maximum value of the interval. The default value is
268 =item B<Timeout> I<Iterations>
270 Consider a value list "missing" when no update has been read or received for
271 I<Iterations> iterations. By default, I<collectd> considers a value list
272 missing when no update has been received for twice the update interval. Since
273 this setting uses iterations, the maximum allowed time without update depends
274 on the I<Interval> information contained in each value list. This is used in
275 the I<Threshold> configuration to dispatch notifications about missing values,
276 see L<collectd-threshold(5)> for details.
278 =item B<ReadThreads> I<Num>
280 Number of threads to start for reading plugins. The default value is B<5>, but
281 you may want to increase this if you have more than five plugins that take a
282 long time to read. Mostly those are plugins that do network-IO. Setting this to
283 a value higher than the number of registered read callbacks is not recommended.
285 =item B<WriteThreads> I<Num>
287 Number of threads to start for dispatching value lists to write plugins. The
288 default value is B<5>, but you may want to increase this if you have more than
289 five plugins that may take relatively long to write to.
291 =item B<WriteQueueLimitHigh> I<HighNum>
293 =item B<WriteQueueLimitLow> I<LowNum>
295 Metrics are read by the I<read threads> and then put into a queue to be handled
296 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
297 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
298 running into memory issues in such a case, you can limit the size of this
301 By default, there is no limit and memory may grow indefinitely. This is most
302 likely not an issue for clients, i.e. instances that only handle the local
303 metrics. For servers it is recommended to set this to a non-zero value, though.
305 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
306 Each of them takes a numerical argument which is the number of metrics in the
307 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
308 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
309 I<will> be enqueued. If the number of metrics currently in the queue is between
310 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
311 proportional to the number of metrics in the queue (i.e. it increases linearly
312 until it reaches 100%.)
314 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
315 unset, the latter will default to half of B<WriteQueueLimitHigh>.
317 If you do not want to randomly drop values when the queue size is between
318 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
321 Enabling the B<CollectInternalStats> option is of great help to figure out the
322 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
324 =item B<Hostname> I<Name>
326 Sets the hostname that identifies a host. If you omit this setting, the
327 hostname will be determined using the L<gethostname(2)> system call.
329 =item B<FQDNLookup> B<true|false>
331 If B<Hostname> is determined automatically this setting controls whether or not
332 the daemon should try to figure out the "fully qualified domain name", FQDN.
333 This is done using a lookup of the name returned by C<gethostname>. This option
334 is enabled by default.
336 =item B<PreCacheChain> I<ChainName>
338 =item B<PostCacheChain> I<ChainName>
340 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
341 see L</"FILTER CONFIGURATION"> below on information on chains and how these
342 setting change the daemon's behavior.
346 =head1 PLUGIN OPTIONS
348 Some plugins may register own options. These options must be enclosed in a
349 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
350 require external configuration, too. The C<apache plugin>, for example,
351 required C<mod_status> to be configured in the webserver you're going to
352 collect data from. These plugins are listed below as well, even if they don't
353 require any configuration within collectd's configuration file.
355 A list of all plugins and a short summary for each plugin can be found in the
356 F<README> file shipped with the sourcecode and hopefully binary packets as
359 =head2 Plugin C<aggregation>
361 The I<Aggregation plugin> makes it possible to aggregate several values into
362 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
363 This can be put to a wide variety of uses, e.g. average and total CPU
364 statistics for your entire fleet.
366 The grouping is powerful but, as with many powerful tools, may be a bit
367 difficult to wrap your head around. The grouping will therefore be
368 demonstrated using an example: The average and sum of the CPU usage across
369 all CPUs of each host is to be calculated.
371 To select all the affected values for our example, set C<Plugin cpu> and
372 C<Type cpu>. The other values are left unspecified, meaning "all values". The
373 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
374 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
380 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
381 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
382 example, the intention is to have a new value for each host / type instance
383 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
384 It can be specified multiple times to group by more than one field.
387 GroupBy "TypeInstance"
389 We do neither specify nor group by I<plugin instance> (the CPU number), so all
390 metrics that differ in the CPU number only will be aggregated. Each
391 aggregation needs I<at least one> such field, otherwise no aggregation would
394 The full example configuration looks like this:
396 <Plugin "aggregation">
402 GroupBy "TypeInstance"
405 CalculateAverage true
409 There are a couple of limitations you should be aware of:
415 The I<Type> cannot be left unspecified, because it is not reasonable to add
416 apples to oranges. Also, the internal lookup structure won't work if you try
421 There must be at least one unspecified, ungrouped field. Otherwise nothing
426 As you can see in the example above, each aggregation has its own
427 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
428 blocks may match the same values, i.e. one value list can update multiple
429 aggregations. The following options are valid inside B<Aggregation> blocks:
433 =item B<Host> I<Host>
435 =item B<Plugin> I<Plugin>
437 =item B<PluginInstance> I<PluginInstance>
439 =item B<Type> I<Type>
441 =item B<TypeInstance> I<TypeInstance>
443 Selects the value lists to be added to this aggregation. B<Type> must be a
444 valid data set name, see L<types.db(5)> for details.
446 If the string starts with and ends with a slash (C</>), the string is
447 interpreted as a I<regular expression>. The regex flavor used are POSIX
448 extended regular expressions as described in L<regex(7)>. Example usage:
450 Host "/^db[0-9]\\.example\\.com$/"
452 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
454 Group valued by the specified field. The B<GroupBy> option may be repeated to
455 group by multiple fields.
457 =item B<SetHost> I<Host>
459 =item B<SetPlugin> I<Plugin>
461 =item B<SetPluginInstance> I<PluginInstance>
463 =item B<SetTypeInstance> I<TypeInstance>
465 Sets the appropriate part of the identifier to the provided string.
467 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
468 will be replaced with the aggregation function, e.g. "average". Not including
469 the placeholder will result in duplication warnings and/or messed up values if
470 more than one aggregation function are enabled.
472 The following example calculates the average usage of all "even" CPUs:
474 <Plugin "aggregation">
477 PluginInstance "/[0,2,4,6,8]$/"
481 SetPluginInstance "even-%{aggregation}"
484 GroupBy "TypeInstance"
486 CalculateAverage true
490 This will create the files:
496 foo.example.com/cpu-even-average/cpu-idle
500 foo.example.com/cpu-even-average/cpu-system
504 foo.example.com/cpu-even-average/cpu-user
512 =item B<CalculateNum> B<true>|B<false>
514 =item B<CalculateSum> B<true>|B<false>
516 =item B<CalculateAverage> B<true>|B<false>
518 =item B<CalculateMinimum> B<true>|B<false>
520 =item B<CalculateMaximum> B<true>|B<false>
522 =item B<CalculateStddev> B<true>|B<false>
524 Boolean options for enabling calculation of the number of value lists, their
525 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
526 are disabled by default.
530 =head2 Plugin C<amqp>
532 The I<AMQP plugin> can be used to communicate with other instances of
533 I<collectd> or third party applications using an AMQP 0.9.1 message broker.
534 Values are sent to or received from the broker, which handles routing,
535 queueing and possibly filtering out messages.
540 # Send values to an AMQP broker
541 <Publish "some_name">
547 Exchange "amq.fanout"
548 # ExchangeType "fanout"
549 # RoutingKey "collectd"
551 # ConnectionRetryDelay 0
554 # GraphitePrefix "collectd."
555 # GraphiteEscapeChar "_"
556 # GraphiteSeparateInstances false
557 # GraphiteAlwaysAppendDS false
558 # GraphitePreserveSeparator false
561 # Receive values from an AMQP broker
562 <Subscribe "some_name">
568 Exchange "amq.fanout"
569 # ExchangeType "fanout"
572 # QueueAutoDelete true
573 # RoutingKey "collectd.#"
574 # ConnectionRetryDelay 0
578 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
579 blocks, which configure sending and receiving of values respectively. The two
580 blocks are very similar, so unless otherwise noted, an option can be used in
581 either block. The name given in the blocks starting tag is only used for
582 reporting messages, but may be used to support I<flushing> of certain
583 I<Publish> blocks in the future.
587 =item B<Host> I<Host>
589 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
590 the underlying communications library, I<rabbitmq-c>, which is "localhost".
592 =item B<Port> I<Port>
594 Service name or port number on which the AMQP broker accepts connections. This
595 argument must be a string, even if the numeric form is used. Defaults to
598 =item B<VHost> I<VHost>
600 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
602 =item B<User> I<User>
604 =item B<Password> I<Password>
606 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
609 =item B<Exchange> I<Exchange>
611 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
612 By default, "amq.fanout" will be used.
614 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
615 the given exchange and the I<queue> is created, using the I<routing key> if
616 configured. See the B<Queue> and B<RoutingKey> options below.
618 =item B<ExchangeType> I<Type>
620 If given, the plugin will try to create the configured I<exchange> with this
621 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
622 be bound to this exchange.
624 =item B<Queue> I<Queue> (Subscribe only)
626 Configures the I<queue> name to subscribe to. If no queue name was configured
627 explicitly, a unique queue name will be created by the broker.
629 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
631 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
632 or transient (will disappear if the AMQP broker is restarted). Defaults to
635 This option should be used in conjunction with the I<Persistent> option on the
638 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
640 Defines if the I<queue> subscribed to will be deleted once the last consumer
641 unsubscribes. Defaults to "true".
643 =item B<RoutingKey> I<Key>
645 In I<Publish> blocks, this configures the routing key to set on all outgoing
646 messages. If not given, the routing key will be computed from the I<identifier>
647 of the value. The host, plugin, type and the two instances are concatenated
648 together using dots as the separator and all containing dots replaced with
649 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
650 possible to receive only specific values using a "topic" exchange.
652 In I<Subscribe> blocks, configures the I<routing key> used when creating a
653 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
654 used to filter messages when using a "topic" exchange. If you're only
655 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
658 =item B<Persistent> B<true>|B<false> (Publish only)
660 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
661 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
662 default), the I<transient> delivery mode will be used, i.e. messages may be
663 lost due to high load, overflowing queues or similar issues.
665 =item B<ConnectionRetryDelay> I<Delay>
667 When the connection to the AMQP broker is lost, defines the time in seconds to
668 wait before attempting to reconnect. Defaults to 0, which implies collectd will
669 attempt to reconnect at each read interval (in Subscribe mode) or each time
670 values are ready for submission (in Publish mode).
672 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
674 Selects the format in which messages are sent to the broker. If set to
675 B<Command> (the default), values are sent as C<PUTVAL> commands which are
676 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
677 case, the C<Content-Type> header field will be set to C<text/collectd>.
679 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
680 an easy and straight forward exchange format. The C<Content-Type> header field
681 will be set to C<application/json>.
683 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
684 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
687 A subscribing client I<should> use the C<Content-Type> header field to
688 determine how to decode the values. Currently, the I<AMQP plugin> itself can
689 only decode the B<Command> format.
691 =item B<StoreRates> B<true>|B<false> (Publish only)
693 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
694 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
695 default), no conversion is performed. Otherwise the conversion is performed
696 using the internal value cache.
698 Please note that currently this option is only used if the B<Format> option has
701 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
703 A prefix can be added in the metric name when outputting in the I<Graphite> format.
704 It's added before the I<Host> name.
705 Metric name will be "<prefix><host><postfix><plugin><type><name>"
707 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
709 A postfix can be added in the metric name when outputting in the I<Graphite> format.
710 It's added after the I<Host> name.
711 Metric name will be "<prefix><host><postfix><plugin><type><name>"
713 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
715 Specify a character to replace dots (.) in the host part of the metric name.
716 In I<Graphite> metric name, dots are used as separators between different
717 metric parts (host, plugin, type).
718 Default is "_" (I<Underscore>).
720 =item B<GraphiteSeparateInstances> B<true>|B<false>
722 If set to B<true>, the plugin instance and type instance will be in their own
723 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
724 default), the plugin and plugin instance (and likewise the type and type
725 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
727 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
729 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
730 identifier. If set to B<false> (the default), this is only done when there is
733 =item B<GraphitePreserveSeparator> B<false>|B<true>
735 If set to B<false> (the default) the C<.> (dot) character is replaced with
736 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
737 is preserved, i.e. passed through.
741 =head2 Plugin C<amqp1>
743 The I<AMQP1 plugin> can be used to communicate with other instances of
744 I<collectd> or third party applications using an AMQP 1.0 message
745 intermediary. Metric values or notifications are sent to the
746 messaging intermediary which may handle direct messaging or
747 queue based transfer.
752 # Send values to an AMQP 1.0 intermediary
760 <Instance "some_name">
765 # GraphitePrefix "collectd."
766 # GraphiteEscapeChar "_"
767 # GraphiteSeparateInstances false
768 # GraphiteAlwaysAppendDS false
769 # GraphitePreserveSeparator false
774 The plugin's configuration consists of a I<Transport> that configures
775 communications to the AMQP 1.0 messaging bus and one or more I<Instance>
776 corresponding to metric or event publishers to the messaging system.
778 The address in the I<Transport> block concatenated with the name given in the
779 I<Instance> block starting tag will be used as the send-to address for
780 communications over the messaging link.
782 The following options are accepted within each I<Transport> block:
786 =item B<Host> I<Host>
788 Hostname or IP-address of the AMQP 1.0 intermediary. Defaults to the
789 default behavior of the underlying communications library,
790 I<libqpid-proton>, which is "localhost".
792 =item B<Port> I<Port>
794 Service name or port number on which the AMQP 1.0 intermediary accepts
795 connections. This argument must be a string, even if the numeric form
796 is used. Defaults to "5672".
798 =item B<User> I<User>
800 =item B<Password> I<Password>
802 Credentials used to authenticate to the AMQP 1.0 intermediary. By
803 default "guest"/"guest" is used.
805 =item B<Address> I<Address>
807 This option specifies the prefix for the send-to value in the message.
808 By default, "collectd" will be used.
810 =item B<RetryDelay> I<RetryDelay>
812 When the AMQP1 connection is lost, defines the time in seconds to wait
813 before attempting to reconnect. Defaults to 1, which implies attempt
814 to reconnect at 1 second intervals.
818 The following options are accepted within each I<Instance> block:
822 =item B<Format> B<Command>|B<JSON>|B<Graphite>
824 Selects the format in which messages are sent to the intermediary. If set to
825 B<Command> (the default), values are sent as C<PUTVAL> commands which are
826 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
827 case, the C<Content-Type> header field will be set to C<text/collectd>.
829 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
830 an easy and straight forward exchange format. The C<Content-Type> header field
831 will be set to C<application/json>.
833 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
834 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
837 A subscribing client I<should> use the C<Content-Type> header field to
838 determine how to decode the values.
840 =item B<PreSettle> B<true>|B<false>
842 If set to B<false> (the default), the plugin will wait for a message
843 acknowledgement from the messaging bus before sending the next
844 message. This indicates transfer of ownership to the messaging
845 system. If set to B<true>, the plugin will not wait for a message
846 acknowledgement and the message may be dropped prior to transfer of
849 =item B<Notify> B<true>|B<false>
851 If set to B<false> (the default), the plugin will service the
852 instance write call back as a value list. If set to B<true> the
853 plugin will service the instance as a write notification callback
854 for alert formatting.
856 =item B<StoreRates> B<true>|B<false>
858 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
859 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
860 default), no conversion is performed. Otherwise the conversion is performed
861 using the internal value cache.
863 Please note that currently this option is only used if the B<Format> option has
866 =item B<GraphitePrefix>
868 A prefix can be added in the metric name when outputting in the I<Graphite> format.
869 It's added before the I<Host> name.
870 Metric name will be "<prefix><host><postfix><plugin><type><name>"
872 =item B<GraphitePostfix>
874 A postfix can be added in the metric name when outputting in the I<Graphite> format.
875 It's added after the I<Host> name.
876 Metric name will be "<prefix><host><postfix><plugin><type><name>"
878 =item B<GraphiteEscapeChar>
880 Specify a character to replace dots (.) in the host part of the metric name.
881 In I<Graphite> metric name, dots are used as separators between different
882 metric parts (host, plugin, type).
883 Default is "_" (I<Underscore>).
885 =item B<GraphiteSeparateInstances> B<true>|B<false>
887 If set to B<true>, the plugin instance and type instance will be in their own
888 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
889 default), the plugin and plugin instance (and likewise the type and type
890 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
892 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
894 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
895 identifier. If set to B<false> (the default), this is only done when there is
898 =item B<GraphitePreserveSeparator> B<false>|B<true>
900 If set to B<false> (the default) the C<.> (dot) character is replaced with
901 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
902 is preserved, i.e. passed through.
906 =head2 Plugin C<apache>
908 To configure the C<apache>-plugin you first need to configure the Apache
909 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
910 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
911 the following snipped to base your Apache config upon:
914 <IfModule mod_status.c>
915 <Location /mod_status>
916 SetHandler server-status
920 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
921 also supported. It introduces a new field, called C<BusyServers>, to count the
922 number of currently connected clients. This field is also supported.
924 The configuration of the I<Apache> plugin consists of one or more
925 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
926 as the instance name. For example:
930 URL "http://www1.example.com/mod_status?auto"
933 URL "http://www2.example.com/mod_status?auto"
937 The instance name will be used as the I<plugin instance>. To emulate the old
938 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
939 plugin to work correctly, each instance name must be unique. This is not
940 enforced by the plugin and it is your responsibility to ensure it.
942 The following options are accepted within each I<Instance> block:
946 =item B<URL> I<http://host/mod_status?auto>
948 Sets the URL of the C<mod_status> output. This needs to be the output generated
949 by C<ExtendedStatus on> and it needs to be the machine readable output
950 generated by appending the C<?auto> argument. This option is I<mandatory>.
952 =item B<User> I<Username>
954 Optional user name needed for authentication.
956 =item B<Password> I<Password>
958 Optional password needed for authentication.
960 =item B<VerifyPeer> B<true|false>
962 Enable or disable peer SSL certificate verification. See
963 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
965 =item B<VerifyHost> B<true|false>
967 Enable or disable peer host name verification. If enabled, the plugin checks
968 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
969 certificate matches the host name provided by the B<URL> option. If this
970 identity check fails, the connection is aborted. Obviously, only works when
971 connecting to a SSL enabled server. Enabled by default.
973 =item B<CACert> I<File>
975 File that holds one or more SSL certificates. If you want to use HTTPS you will
976 possibly need this option. What CA certificates come bundled with C<libcurl>
977 and are checked by default depends on the distribution you use.
979 =item B<SSLCiphers> I<list of ciphers>
981 Specifies which ciphers to use in the connection. The list of ciphers
982 must specify valid ciphers. See
983 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
985 =item B<Timeout> I<Milliseconds>
987 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
988 milliseconds. By default, the configured B<Interval> is used to set the
993 =head2 Plugin C<apcups>
997 =item B<Host> I<Hostname>
999 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
1000 that IPv6 support has been disabled unless someone can confirm or decline that
1001 B<apcupsd> can handle it.
1003 =item B<Port> I<Port>
1005 TCP-Port to connect to. Defaults to B<3551>.
1007 =item B<ReportSeconds> B<true>|B<false>
1009 If set to B<true>, the time reported in the C<timeleft> metric will be
1010 converted to seconds. This is the recommended setting. If set to B<false>, the
1011 default for backwards compatibility, the time will be reported in minutes.
1013 =item B<PersistentConnection> B<true>|B<false>
1015 The plugin is designed to keep the connection to I<apcupsd> open between reads.
1016 If plugin poll interval is greater than 15 seconds (hardcoded socket close
1017 timeout in I<apcupsd> NIS), then this option is B<false> by default.
1019 You can instruct the plugin to close the connection after each read by setting
1020 this option to B<false> or force keeping the connection by setting it to B<true>.
1022 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
1023 the plugin will try to detect this problem and switch to an open-read-close mode.
1027 =head2 Plugin C<aquaero>
1029 This plugin collects the value of the available sensors in an
1030 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
1031 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
1032 connection for monitoring and configuration. The board can handle multiple
1033 temperature sensors, fans, water pumps and water level sensors and adjust the
1034 output settings such as fan voltage or power used by the water pump based on
1035 the available inputs using a configurable controller included in the board.
1036 This plugin collects all the available inputs as well as some of the output
1037 values chosen by this controller. The plugin is based on the I<libaquaero5>
1038 library provided by I<aquatools-ng>.
1042 =item B<Device> I<DevicePath>
1044 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
1045 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
1046 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
1050 =head2 Plugin C<ascent>
1052 This plugin collects information about an Ascent server, a free server for the
1053 "World of Warcraft" game. This plugin gathers the information by fetching the
1054 XML status page using C<libcurl> and parses it using C<libxml2>.
1056 The configuration options are the same as for the C<apache> plugin above:
1060 =item B<URL> I<http://localhost/ascent/status/>
1062 Sets the URL of the XML status output.
1064 =item B<User> I<Username>
1066 Optional user name needed for authentication.
1068 =item B<Password> I<Password>
1070 Optional password needed for authentication.
1072 =item B<VerifyPeer> B<true|false>
1074 Enable or disable peer SSL certificate verification. See
1075 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1077 =item B<VerifyHost> B<true|false>
1079 Enable or disable peer host name verification. If enabled, the plugin checks
1080 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1081 certificate matches the host name provided by the B<URL> option. If this
1082 identity check fails, the connection is aborted. Obviously, only works when
1083 connecting to a SSL enabled server. Enabled by default.
1085 =item B<CACert> I<File>
1087 File that holds one or more SSL certificates. If you want to use HTTPS you will
1088 possibly need this option. What CA certificates come bundled with C<libcurl>
1089 and are checked by default depends on the distribution you use.
1091 =item B<Timeout> I<Milliseconds>
1093 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1094 milliseconds. By default, the configured B<Interval> is used to set the
1099 =head2 Plugin C<barometer>
1101 This plugin reads absolute air pressure using digital barometer sensor on a I2C
1102 bus. Supported sensors are:
1106 =item I<MPL115A2> from Freescale,
1107 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
1110 =item I<MPL3115> from Freescale
1111 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
1114 =item I<BMP085> from Bosch Sensortec
1118 The sensor type - one of the above - is detected automatically by the plugin
1119 and indicated in the plugin_instance (you will see subdirectory
1120 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
1121 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
1122 (only one sensor can be used by the plugin).
1124 The plugin provides absolute barometric pressure, air pressure reduced to sea
1125 level (several possible approximations) and as an auxiliary value also internal
1126 sensor temperature. It uses (expects/provides) typical metric units - pressure
1127 in [hPa], temperature in [C], altitude in [m].
1129 It was developed and tested under Linux only. The only platform dependency is
1130 the standard Linux i2c-dev interface (the particular bus driver has to
1131 support the SM Bus command subset).
1133 The reduction or normalization to mean sea level pressure requires (depending
1134 on selected method/approximation) also altitude and reference to temperature
1135 sensor(s). When multiple temperature sensors are configured the minimum of
1136 their values is always used (expecting that the warmer ones are affected by
1137 e.g. direct sun light at that moment).
1141 <Plugin "barometer">
1142 Device "/dev/i2c-0";
1145 TemperatureOffset 0.0
1148 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
1153 =item B<Device> I<device>
1155 The only mandatory configuration parameter.
1157 Device name of the I2C bus to which the sensor is connected. Note that
1158 typically you need to have loaded the i2c-dev module.
1159 Using i2c-tools you can check/list i2c buses available on your system by:
1163 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1167 This way you should be able to verify that the pressure sensor (either type) is
1168 connected and detected on address 0x60.
1170 =item B<Oversampling> I<value>
1172 Optional parameter controlling the oversampling/accuracy. Default value
1173 is 1 providing fastest and least accurate reading.
1175 For I<MPL115> this is the size of the averaging window. To filter out sensor
1176 noise a simple averaging using floating window of this configurable size is
1177 used. The plugin will use average of the last C<value> measurements (value of 1
1178 means no averaging). Minimal size is 1, maximal 1024.
1180 For I<MPL3115> this is the oversampling value. The actual oversampling is
1181 performed by the sensor and the higher value the higher accuracy and longer
1182 conversion time (although nothing to worry about in the collectd context).
1183 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1184 adjusted by the plugin to the closest supported one.
1186 For I<BMP085> this is the oversampling value. The actual oversampling is
1187 performed by the sensor and the higher value the higher accuracy and longer
1188 conversion time (although nothing to worry about in the collectd context).
1189 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1190 the closest supported one.
1192 =item B<PressureOffset> I<offset>
1194 Optional parameter for MPL3115 only.
1196 You can further calibrate the sensor by supplying pressure and/or temperature
1197 offsets. This is added to the measured/caclulated value (i.e. if the measured
1198 value is too high then use negative offset).
1199 In hPa, default is 0.0.
1201 =item B<TemperatureOffset> I<offset>
1203 Optional parameter for MPL3115 only.
1205 You can further calibrate the sensor by supplying pressure and/or temperature
1206 offsets. This is added to the measured/caclulated value (i.e. if the measured
1207 value is too high then use negative offset).
1208 In C, default is 0.0.
1210 =item B<Normalization> I<method>
1212 Optional parameter, default value is 0.
1214 Normalization method - what approximation/model is used to compute the mean sea
1215 level pressure from the air absolute pressure.
1217 Supported values of the C<method> (integer between from 0 to 2) are:
1221 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1222 do not need to configure C<Altitude> or C<TemperatureSensor>.
1224 =item B<1> - international formula for conversion ,
1226 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1227 For this method you have to configure C<Altitude> but do not need
1228 C<TemperatureSensor> (uses fixed global temperature average instead).
1230 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1231 Meteorological Service).
1232 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1233 For this method you have to configure both C<Altitude> and
1234 C<TemperatureSensor>.
1239 =item B<Altitude> I<altitude>
1241 The altitude (in meters) of the location where you meassure the pressure.
1243 =item B<TemperatureSensor> I<reference>
1245 Temperature sensor(s) which should be used as a reference when normalizing the
1246 pressure using C<Normalization> method 2.
1247 When specified more sensors a minimum is found and used each time. The
1248 temperature reading directly from this pressure sensor/plugin is typically not
1249 suitable as the pressure sensor will be probably inside while we want outside
1250 temperature. The collectd reference name is something like
1251 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1252 (<type_instance> is usually omitted when there is just single value type). Or
1253 you can figure it out from the path of the output data files.
1257 =head2 Plugin C<battery>
1259 The I<battery plugin> reports the remaining capacity, power and voltage of
1264 =item B<ValuesPercentage> B<false>|B<true>
1266 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1267 capacity remaining". Otherwise the capacity is stored as reported by the
1268 battery, most likely in "Wh". This option does not work with all input methods,
1269 in particular when only C</proc/pmu> is available on an old Linux system.
1270 Defaults to B<false>.
1272 =item B<ReportDegraded> B<false>|B<true>
1274 Typical laptop batteries degrade over time, meaning the capacity decreases with
1275 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1276 "last full capacity" and used to determine that a battery is "fully charged".
1278 When this option is set to B<false>, the default, the I<battery plugin> will
1279 only report the remaining capacity. If the B<ValuesPercentage> option is
1280 enabled, the relative remaining capacity is calculated as the ratio of the
1281 "remaining capacity" and the "last full capacity". This is what most tools,
1282 such as the status bar of desktop environments, also do.
1284 When set to B<true>, the battery plugin will report three values: B<charged>
1285 (remaining capacity), B<discharged> (difference between "last full capacity"
1286 and "remaining capacity") and B<degraded> (difference between "design capacity"
1287 and "last full capacity").
1289 =item B<QueryStateFS> B<false>|B<true>
1291 When set to B<true>, the battery plugin will only read statistics
1292 related to battery performance as exposed by StateFS at
1293 /run/state. StateFS is used in Mer-based Sailfish OS, for
1298 =head2 Plugin C<bind>
1300 Starting with BIND 9.5.0, the most widely used DNS server software provides
1301 extensive statistics about queries, responses and lots of other information.
1302 The bind plugin retrieves this information that's encoded in XML and provided
1303 via HTTP and submits the values to collectd.
1305 To use this plugin, you first need to tell BIND to make this information
1306 available. This is done with the C<statistics-channels> configuration option:
1308 statistics-channels {
1309 inet localhost port 8053;
1312 The configuration follows the grouping that can be seen when looking at the
1313 data with an XSLT compatible viewer, such as a modern web browser. It's
1314 probably a good idea to make yourself familiar with the provided values, so you
1315 can understand what the collected statistics actually mean.
1320 URL "http://localhost:8053/"
1335 Zone "127.in-addr.arpa/IN"
1339 The bind plugin accepts the following configuration options:
1345 URL from which to retrieve the XML data. If not specified,
1346 C<http://localhost:8053/> will be used.
1348 =item B<ParseTime> B<true>|B<false>
1350 When set to B<true>, the time provided by BIND will be parsed and used to
1351 dispatch the values. When set to B<false>, the local time source is queried.
1353 This setting is set to B<true> by default for backwards compatibility; setting
1354 this to B<false> is I<recommended> to avoid problems with timezones and
1357 =item B<OpCodes> B<true>|B<false>
1359 When enabled, statistics about the I<"OpCodes">, for example the number of
1360 C<QUERY> packets, are collected.
1364 =item B<QTypes> B<true>|B<false>
1366 When enabled, the number of I<incoming> queries by query types (for example
1367 C<A>, C<MX>, C<AAAA>) is collected.
1371 =item B<ServerStats> B<true>|B<false>
1373 Collect global server statistics, such as requests received over IPv4 and IPv6,
1374 successful queries, and failed updates.
1378 =item B<ZoneMaintStats> B<true>|B<false>
1380 Collect zone maintenance statistics, mostly information about notifications
1381 (zone updates) and zone transfers.
1385 =item B<ResolverStats> B<true>|B<false>
1387 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1388 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1389 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1390 default. Use the B<ResolverStats> option within a B<View "_default"> block
1391 instead for the same functionality.
1395 =item B<MemoryStats>
1397 Collect global memory statistics.
1401 =item B<Timeout> I<Milliseconds>
1403 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1404 milliseconds. By default, the configured B<Interval> is used to set the
1407 =item B<View> I<Name>
1409 Collect statistics about a specific I<"view">. BIND can behave different,
1410 mostly depending on the source IP-address of the request. These different
1411 configurations are called "views". If you don't use this feature, you most
1412 likely are only interested in the C<_default> view.
1414 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1415 information you want to collect about a view. If no B<View> block is
1416 configured, no detailed view statistics will be collected.
1420 =item B<QTypes> B<true>|B<false>
1422 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1423 C<MX>) is collected.
1427 =item B<ResolverStats> B<true>|B<false>
1429 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1430 (e.E<nbsp>g. queries over IPv4, lame servers).
1434 =item B<CacheRRSets> B<true>|B<false>
1436 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1437 type is collected. Negative entries (queries which resulted in an error, for
1438 example names that do not exist) are reported with a leading exclamation mark,
1443 =item B<Zone> I<Name>
1445 When given, collect detailed information about the given zone in the view. The
1446 information collected if very similar to the global B<ServerStats> information
1449 You can repeat this option to collect detailed information about multiple
1452 By default no detailed zone information is collected.
1458 =head2 Plugin C<ceph>
1460 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1461 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1463 A separate B<Daemon> block must be configured for each ceph daemon to be
1464 monitored. The following example will read daemon statistics from four
1465 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1468 LongRunAvgLatency false
1469 ConvertSpecialMetricTypes true
1471 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1474 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1477 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1480 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1484 The ceph plugin accepts the following configuration options:
1488 =item B<LongRunAvgLatency> B<true>|B<false>
1490 If enabled, latency values(sum,count pairs) are calculated as the long run
1491 average - average since the ceph daemon was started = (sum / count).
1492 When disabled, latency values are calculated as the average since the last
1493 collection = (sum_now - sum_last) / (count_now - count_last).
1497 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1499 If enabled, special metrics (metrics that differ in type from similar counters)
1500 are converted to the type of those similar counters. This currently only
1501 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1502 ceph schema reports this metric type as a sum,count pair while similar counters
1503 are treated as derive types. When converted, the sum is used as the counter
1504 value and is treated as a derive type.
1505 When disabled, all metrics are treated as the types received from the ceph schema.
1511 Each B<Daemon> block must have a string argument for the plugin instance name.
1512 A B<SocketPath> is also required for each B<Daemon> block:
1516 =item B<Daemon> I<DaemonName>
1518 Name to be used as the instance name for this daemon.
1520 =item B<SocketPath> I<SocketPath>
1522 Specifies the path to the UNIX admin socket of the ceph daemon.
1526 =head2 Plugin C<cgroups>
1528 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1529 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1530 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1534 =item B<CGroup> I<Directory>
1536 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1537 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1540 See F</"IGNORELISTS"> for details.
1542 =item B<IgnoreSelected> B<true>|B<false>
1544 Invert the selection: If set to true, all cgroups I<except> the ones that
1545 match any one of the criteria are collected. By default only selected
1546 cgroups are collected if a selection is made. If no selection is configured
1547 at all, B<all> cgroups are selected.
1551 =head2 Plugin C<check_uptime>
1553 The I<check_uptime plugin> designed to check and notify about host or service
1554 status based on I<uptime> metric.
1556 When new metric of I<uptime> type appears in cache, OK notification is sent.
1557 When new value for metric is less than previous value, WARNING notification is
1558 sent about host/service restart.
1559 When no new updates comes for metric and cache entry expires, then FAILURE
1560 notification is sent about unreachable host or service.
1562 By default (when no explicit configuration), plugin checks for I<uptime> metric.
1566 <Plugin "check_uptime">
1568 Type "my_uptime_type"
1573 =item B<Type> I<Type>
1575 Metric type to check for status/values. The type should consist single GAUGE
1580 =head2 Plugin C<chrony>
1582 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1583 skew and per-peer stratum.
1585 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1588 Available configuration options for the C<chrony> plugin:
1592 =item B<Host> I<Hostname>
1594 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1596 =item B<Port> I<Port>
1598 UDP-Port to connect to. Defaults to B<323>.
1600 =item B<Timeout> I<Timeout>
1602 Connection timeout in seconds. Defaults to B<2>.
1606 =head2 Plugin Connectivity
1608 connectivity - Documentation of collectd's C<connectivity plugin>
1611 LoadPlugin connectivity
1613 <Plugin connectivity>
1617 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.
1618 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.
1620 This example shows C<connectivity plugin> monitoring all interfaces.
1621 LoadPlugin connectivity
1622 <Plugin connectivity>
1625 This example shows C<connectivity plugin> monitoring 2 interfaces, "eth0" and "eth1".
1626 LoadPlugin connectivity
1627 <Plugin connectivity>
1632 This example shows C<connectivity plugin> monitoring all interfaces except "eth1".
1633 LoadPlugin connectivity
1634 <Plugin connectivity>
1641 =item B<Interface> I<interface_name>
1643 interface(s) to monitor connect to.
1647 =head2 Plugin C<conntrack>
1649 This plugin collects IP conntrack statistics.
1655 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1656 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1660 =head2 Plugin C<cpu>
1662 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1663 as Jiffies, using the C<cpu> type. Two aggregations are available:
1669 Sum, per-state, over all CPUs installed in the system; and
1673 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1677 The two aggregations can be combined, leading to I<collectd> only emitting a
1678 single "active" metric for the entire system. As soon as one of these
1679 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1680 rather than Jiffies. In addition, you can request individual, per-state,
1681 per-CPU metrics to be reported as percentage.
1683 The following configuration options are available:
1687 =item B<ReportByState> B<true>|B<false>
1689 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1691 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1694 =item B<ReportByCpu> B<true>|B<false>
1696 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1697 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1698 global sum of CPU states is emitted.
1700 =item B<ValuesPercentage> B<false>|B<true>
1702 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1703 are set to B<true>. In this case, by default, metrics will be reported as
1704 Jiffies. By setting this option to B<true>, you can request percentage values
1705 in the un-aggregated (per-CPU, per-state) mode as well.
1707 =item B<ReportNumCpu> B<false>|B<true>
1709 When set to B<true>, reports the number of available CPUs.
1710 Defaults to B<false>.
1712 =item B<ReportGuestState> B<false>|B<true>
1714 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1715 Defaults to B<false>.
1717 =item B<SubtractGuestState> B<false>|B<true>
1719 This option is only considered when B<ReportGuestState> is set to B<true>.
1720 "guest" and "guest_nice" are included in respectively "user" and "nice".
1721 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1722 will be subtracted from "nice".
1723 Defaults to B<true>.
1727 =head2 Plugin C<cpufreq>
1729 This plugin is available on Linux and FreeBSD only. It doesn't have any
1730 options. On Linux it reads
1731 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1732 installed) to get the current CPU frequency. If this file does not exist make
1733 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1734 installed and an "cpu governor" (that's a kernel module) is loaded.
1736 On Linux, if the system has the I<cpufreq-stats> kernel module loaded, this
1737 plugin reports the rate of p-state (cpu frequency) transitions and the
1738 percentage of time spent in each p-state.
1740 On FreeBSD it does a sysctl dev.cpu.0.freq and submits this as instance 0.
1741 At this time FreeBSD only has one frequency setting for all cores.
1742 See the BUGS section in the FreeBSD man page for cpufreq(4) for more details.
1744 On FreeBSD the plugin checks the success of sysctl dev.cpu.0.freq and
1745 unregisters the plugin when this fails. A message will be logged to indicate
1748 =head2 Plugin C<cpusleep>
1750 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1751 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1752 BOOTTIME clock increments while device is suspended and MONOTONIC
1753 clock does not, the derivative of the difference between these clocks
1754 gives the relative amount of time the device has spent in suspend
1755 state. The recorded value is in milliseconds of sleep per seconds of
1758 =head2 Plugin C<csv>
1762 =item B<DataDir> I<Directory>
1764 Set the directory to store CSV-files under. Per default CSV-files are generated
1765 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1766 The special strings B<stdout> and B<stderr> can be used to write to the standard
1767 output and standard error channels, respectively. This, of course, only makes
1768 much sense when collectd is running in foreground- or non-daemon-mode.
1770 =item B<StoreRates> B<true|false>
1772 If set to B<true>, convert counter values to rates. If set to B<false> (the
1773 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1778 =head2 cURL Statistics
1780 All cURL-based plugins support collection of generic, request-based
1781 statistics. These are disabled by default and can be enabled selectively for
1782 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1783 the documentation of those plugins for specific information. This section
1784 describes the available metrics that can be configured for each plugin. All
1785 options are disabled by default.
1787 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1791 =item B<TotalTime> B<true|false>
1793 Total time of the transfer, including name resolving, TCP connect, etc.
1795 =item B<NamelookupTime> B<true|false>
1797 Time it took from the start until name resolving was completed.
1799 =item B<ConnectTime> B<true|false>
1801 Time it took from the start until the connect to the remote host (or proxy)
1804 =item B<AppconnectTime> B<true|false>
1806 Time it took from the start until the SSL/SSH connect/handshake to the remote
1809 =item B<PretransferTime> B<true|false>
1811 Time it took from the start until just before the transfer begins.
1813 =item B<StarttransferTime> B<true|false>
1815 Time it took from the start until the first byte was received.
1817 =item B<RedirectTime> B<true|false>
1819 Time it took for all redirection steps include name lookup, connect,
1820 pre-transfer and transfer before final transaction was started.
1822 =item B<RedirectCount> B<true|false>
1824 The total number of redirections that were actually followed.
1826 =item B<SizeUpload> B<true|false>
1828 The total amount of bytes that were uploaded.
1830 =item B<SizeDownload> B<true|false>
1832 The total amount of bytes that were downloaded.
1834 =item B<SpeedDownload> B<true|false>
1836 The average download speed that curl measured for the complete download.
1838 =item B<SpeedUpload> B<true|false>
1840 The average upload speed that curl measured for the complete upload.
1842 =item B<HeaderSize> B<true|false>
1844 The total size of all the headers received.
1846 =item B<RequestSize> B<true|false>
1848 The total size of the issued requests.
1850 =item B<ContentLengthDownload> B<true|false>
1852 The content-length of the download.
1854 =item B<ContentLengthUpload> B<true|false>
1856 The specified size of the upload.
1858 =item B<NumConnects> B<true|false>
1860 The number of new connections that were created to achieve the transfer.
1864 =head2 Plugin C<curl>
1866 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1867 and the match infrastructure (the same code used by the tail plugin) to use
1868 regular expressions with the received data.
1870 The following example will read the current value of AMD stock from Google's
1871 finance page and dispatch the value to collectd.
1874 <Page "stock_quotes">
1876 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1883 CACert "/path/to/ca.crt"
1884 Header "X-Custom-Header: foobar"
1887 MeasureResponseTime false
1888 MeasureResponseCode false
1891 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1892 DSType "GaugeAverage"
1893 # Note: `stock_value' is not a standard type.
1900 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1901 a web page and one or more "matches" to be performed on the returned data. The
1902 string argument to the B<Page> block is used as plugin instance.
1904 The following options are valid within B<Page> blocks:
1908 =item B<Plugin> I<Plugin>
1910 Use I<Plugin> as the plugin name when submitting values.
1911 Defaults to C<curl>.
1915 URL of the web site to retrieve. Since a regular expression will be used to
1916 extract information from this data, non-binary data is a big plus here ;)
1918 =item B<AddressFamily> I<Type>
1920 IP version to resolve URL to. Useful in cases when hostname in URL resolves
1921 to both IPv4 and IPv6 addresses, and you are interested in using one of them
1923 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
1924 default behavior of resolving addresses to all IP versions your system allows.
1925 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
1926 a warning and fallback to C<any>.
1927 If C<Type> cannot be parsed, a warning will be printed and the whole B<Page>
1928 block will be ignored.
1930 =item B<User> I<Name>
1932 Username to use if authorization is required to read the page.
1934 =item B<Password> I<Password>
1936 Password to use if authorization is required to read the page.
1938 =item B<Digest> B<true>|B<false>
1940 Enable HTTP digest authentication.
1942 =item B<VerifyPeer> B<true>|B<false>
1944 Enable or disable peer SSL certificate verification. See
1945 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1947 =item B<VerifyHost> B<true>|B<false>
1949 Enable or disable peer host name verification. If enabled, the plugin checks if
1950 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1951 matches the host name provided by the B<URL> option. If this identity check
1952 fails, the connection is aborted. Obviously, only works when connecting to a
1953 SSL enabled server. Enabled by default.
1955 =item B<CACert> I<file>
1957 File that holds one or more SSL certificates. If you want to use HTTPS you will
1958 possibly need this option. What CA certificates come bundled with C<libcurl>
1959 and are checked by default depends on the distribution you use.
1961 =item B<Header> I<Header>
1963 A HTTP header to add to the request. Multiple headers are added if this option
1964 is specified more than once.
1966 =item B<Post> I<Body>
1968 Specifies that the HTTP operation should be a POST instead of a GET. The
1969 complete data to be posted is given as the argument. This option will usually
1970 need to be accompanied by a B<Header> option to set an appropriate
1971 C<Content-Type> for the post body (e.g. to
1972 C<application/x-www-form-urlencoded>).
1974 =item B<MeasureResponseTime> B<true>|B<false>
1976 Measure response time for the request. If this setting is enabled, B<Match>
1977 blocks (see below) are optional. Disabled by default.
1979 Beware that requests will get aborted if they take too long to complete. Adjust
1980 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1983 This option is similar to enabling the B<TotalTime> statistic but it's
1984 measured by collectd instead of cURL.
1986 =item B<MeasureResponseCode> B<true>|B<false>
1988 Measure response code for the request. If this setting is enabled, B<Match>
1989 blocks (see below) are optional. Disabled by default.
1991 =item B<E<lt>StatisticsE<gt>>
1993 One B<Statistics> block can be used to specify cURL statistics to be collected
1994 for each request to the remote web site. See the section "cURL Statistics"
1995 above for details. If this setting is enabled, B<Match> blocks (see below) are
1998 =item B<E<lt>MatchE<gt>>
2000 One or more B<Match> blocks that define how to match information in the data
2001 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
2002 used by the C<tail> plugin, so please see the documentation of the C<tail>
2003 plugin below on how matches are defined. If the B<MeasureResponseTime> or
2004 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
2007 =item B<Interval> I<Interval>
2009 Sets the interval (in seconds) in which the values will be collected from this
2010 URL. By default the global B<Interval> setting will be used.
2012 =item B<Timeout> I<Milliseconds>
2014 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
2015 milliseconds. By default, the configured B<Interval> is used to set the
2016 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
2017 indefinitely. This legacy behaviour can be achieved by setting the value of
2020 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
2021 network connection will stall one read thread. Adjust the B<ReadThreads> global
2022 setting accordingly to prevent this from blocking other plugins.
2026 =head2 Plugin C<curl_json>
2028 The B<curl_json plugin> collects values from JSON data to be parsed by
2029 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
2030 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
2031 unix socket. The former can be used, for example, to collect values
2032 from CouchDB documents (which are stored JSON notation), and the
2033 latter to collect values from a uWSGI stats socket.
2035 The following example will collect several values from the built-in
2036 C<_stats> runtime statistics module of I<CouchDB>
2037 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
2040 <URL "http://localhost:5984/_stats">
2043 <Key "httpd/requests/count">
2044 Type "http_requests"
2047 <Key "httpd_request_methods/*/count">
2048 Type "http_request_methods"
2051 <Key "httpd_status_codes/*/count">
2052 Type "http_response_codes"
2057 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
2060 <Sock "/var/run/uwsgi.stats.sock">
2062 <Key "workers/*/requests">
2063 Type "http_requests"
2066 <Key "workers/*/apps/*/requests">
2067 Type "http_requests"
2072 In the B<Plugin> block, there may be one or more B<URL> blocks, each
2073 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
2074 blocks defining a unix socket to read JSON from directly. Each of
2075 these blocks may have one or more B<Key> blocks.
2077 The B<Key> string argument must be in a path format. Each component is
2078 used to match the key from a JSON map or the index of an JSON
2079 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
2080 values for all map keys or array indices will be collectd.
2082 The following options are valid within B<URL> blocks:
2086 =item B<AddressFamily> I<Type>
2088 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2089 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2091 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2092 default behavior of resolving addresses to all IP versions your system allows.
2093 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2094 a warning and fallback to C<any>.
2095 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2096 block will be ignored.
2098 =item B<Host> I<Name>
2100 Use I<Name> as the host name when submitting values. Defaults to the global
2103 =item B<Plugin> I<Plugin>
2105 Use I<Plugin> as the plugin name when submitting values.
2106 Defaults to C<curl_json>.
2108 =item B<Instance> I<Instance>
2110 Sets the plugin instance to I<Instance>.
2112 =item B<Interval> I<Interval>
2114 Sets the interval (in seconds) in which the values will be collected from this
2115 URL. By default the global B<Interval> setting will be used.
2117 =item B<User> I<Name>
2119 =item B<Password> I<Password>
2121 =item B<Digest> B<true>|B<false>
2123 =item B<VerifyPeer> B<true>|B<false>
2125 =item B<VerifyHost> B<true>|B<false>
2127 =item B<CACert> I<file>
2129 =item B<Header> I<Header>
2131 =item B<Post> I<Body>
2133 =item B<Timeout> I<Milliseconds>
2135 These options behave exactly equivalent to the appropriate options of the
2136 I<cURL> plugin. Please see there for a detailed description.
2138 =item B<E<lt>StatisticsE<gt>>
2140 One B<Statistics> block can be used to specify cURL statistics to be collected
2141 for each request to the remote URL. See the section "cURL Statistics" above
2146 The following options are valid within B<Key> blocks:
2150 =item B<Type> I<Type>
2152 Sets the type used to dispatch the values to the daemon. Detailed information
2153 about types and their configuration can be found in L<types.db(5)>. This
2154 option is mandatory.
2156 =item B<Instance> I<Instance>
2158 Type-instance to use. Defaults to the current map key or current string array element value.
2162 =head2 Plugin C<curl_xml>
2164 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2165 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2168 <URL "http://localhost/stats.xml">
2172 Instance "some_instance"
2177 CACert "/path/to/ca.crt"
2178 Header "X-Custom-Header: foobar"
2181 <XPath "table[@id=\"magic_level\"]/tr">
2183 #InstancePrefix "prefix-"
2184 InstanceFrom "td[1]"
2185 #PluginInstanceFrom "td[1]"
2186 ValuesFrom "td[2]/span[@class=\"level\"]"
2191 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2192 URL to be fetched using libcurl. Within each B<URL> block there are
2193 options which specify the connection parameters, for example authentication
2194 information, and one or more B<XPath> blocks.
2196 Each B<XPath> block specifies how to get one type of information. The
2197 string argument must be a valid XPath expression which returns a list
2198 of "base elements". One value is dispatched for each "base element". The
2199 I<type instance> and values are looked up using further I<XPath> expressions
2200 that should be relative to the base element.
2202 Within the B<URL> block the following options are accepted:
2206 =item B<AddressFamily> I<Type>
2208 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2209 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2211 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2212 default behavior of resolving addresses to all IP versions your system allows.
2213 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2214 a warning and fallback to C<any>.
2215 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2216 block will be ignored.
2218 =item B<Host> I<Name>
2220 Use I<Name> as the host name when submitting values. Defaults to the global
2223 =item B<Plugin> I<Plugin>
2225 Use I<Plugin> as the plugin name when submitting values.
2226 Defaults to 'curl_xml'.
2228 =item B<Instance> I<Instance>
2230 Use I<Instance> as the plugin instance when submitting values.
2231 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2232 Defaults to an empty string (no plugin instance).
2234 =item B<Interval> I<Interval>
2236 Sets the interval (in seconds) in which the values will be collected from this
2237 URL. By default the global B<Interval> setting will be used.
2239 =item B<Namespace> I<Prefix> I<URL>
2241 If an XPath expression references namespaces, they must be specified
2242 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2243 I<URL> is the "namespace name", an URI reference uniquely identifying the
2244 namespace. The option can be repeated to register multiple namespaces.
2248 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2249 Namespace "m" "http://www.w3.org/1998/Math/MathML"
2251 =item B<User> I<User>
2253 =item B<Password> I<Password>
2255 =item B<Digest> B<true>|B<false>
2257 =item B<VerifyPeer> B<true>|B<false>
2259 =item B<VerifyHost> B<true>|B<false>
2261 =item B<CACert> I<CA Cert File>
2263 =item B<Header> I<Header>
2265 =item B<Post> I<Body>
2267 =item B<Timeout> I<Milliseconds>
2269 These options behave exactly equivalent to the appropriate options of the
2270 I<cURL plugin>. Please see there for a detailed description.
2272 =item B<E<lt>StatisticsE<gt>>
2274 One B<Statistics> block can be used to specify cURL statistics to be collected
2275 for each request to the remote URL. See the section "cURL Statistics" above
2278 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2280 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2281 B<XPath> block specifies how to get one type of information. The string
2282 argument must be a valid XPath expression which returns a list of "base
2283 elements". One value is dispatched for each "base element".
2285 Within the B<XPath> block the following options are accepted:
2289 =item B<Type> I<Type>
2291 Specifies the I<Type> used for submitting patches. This determines the number
2292 of values that are required / expected and whether the strings are parsed as
2293 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2294 This option is required.
2296 =item B<InstancePrefix> I<InstancePrefix>
2298 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2299 concatenated together without any separator.
2300 This option is optional.
2302 =item B<InstanceFrom> I<InstanceFrom>
2304 Specifies a XPath expression to use for determining the I<type instance>. The
2305 XPath expression must return exactly one element. The element's value is then
2306 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2308 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2310 Specifies a XPath expression to use for determining the I<plugin instance>. The
2311 XPath expression must return exactly one element. The element's value is then
2312 used as I<plugin instance>.
2316 If the "base XPath expression" (the argument to the B<XPath> block) returns
2317 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2318 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2322 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2324 Specifies one or more XPath expression to use for reading the values. The
2325 number of XPath expressions must match the number of data sources in the
2326 I<type> specified with B<Type> (see above). Each XPath expression must return
2327 exactly one element. The element's value is then parsed as a number and used as
2328 value for the appropriate value in the value list dispatched to the daemon.
2329 This option is required.
2335 =head2 Plugin C<dbi>
2337 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2338 connect to various databases, execute I<SQL> statements and read back the
2339 results. I<dbi> is an acronym for "database interface" in case you were
2340 wondering about the name. You can configure how each column is to be
2341 interpreted and the plugin will generate one or more data sets from each row
2342 returned according to these rules.
2344 Because the plugin is very generic, the configuration is a little more complex
2345 than those of other plugins. It usually looks something like this:
2348 <Query "out_of_stock">
2349 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2350 # Use with MySQL 5.0.0 or later
2354 InstancePrefix "out_of_stock"
2355 InstancesFrom "category"
2359 <Database "product_information">
2363 DriverOption "host" "localhost"
2364 DriverOption "username" "collectd"
2365 DriverOption "password" "aZo6daiw"
2366 DriverOption "dbname" "prod_info"
2367 SelectDB "prod_info"
2368 Query "out_of_stock"
2372 The configuration above defines one query with one result and one database. The
2373 query is then linked to the database with the B<Query> option I<within> the
2374 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2375 and you can also use the B<Include> statement to split up the configuration
2376 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2377 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2380 The following is a complete list of options:
2382 =head3 B<Query> blocks
2384 Query blocks define I<SQL> statements and how the returned data should be
2385 interpreted. They are identified by the name that is given in the opening line
2386 of the block. Thus the name needs to be unique. Other than that, the name is
2387 not used in collectd.
2389 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2390 define which column holds which value or instance information. You can use
2391 multiple B<Result> blocks to create multiple values from one returned row. This
2392 is especially useful, when queries take a long time and sending almost the same
2393 query again and again is not desirable.
2397 <Query "environment">
2398 Statement "select station, temperature, humidity from environment"
2401 # InstancePrefix "foo"
2402 InstancesFrom "station"
2403 ValuesFrom "temperature"
2407 InstancesFrom "station"
2408 ValuesFrom "humidity"
2412 The following options are accepted:
2416 =item B<Statement> I<SQL>
2418 Sets the statement that should be executed on the server. This is B<not>
2419 interpreted by collectd, but simply passed to the database server. Therefore,
2420 the SQL dialect that's used depends on the server collectd is connected to.
2422 The query has to return at least two columns, one for the instance and one
2423 value. You cannot omit the instance, even if the statement is guaranteed to
2424 always return exactly one line. In that case, you can usually specify something
2427 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2429 (That works with MySQL but may not be valid SQL according to the spec. If you
2430 use a more strict database server, you may have to select from a dummy table or
2433 Please note that some databases, for example B<Oracle>, will fail if you
2434 include a semicolon at the end of the statement.
2436 =item B<MinVersion> I<Version>
2438 =item B<MaxVersion> I<Value>
2440 Only use this query for the specified database version. You can use these
2441 options to provide multiple queries with the same name but with a slightly
2442 different syntax. The plugin will use only those queries, where the specified
2443 minimum and maximum versions fit the version of the database in use.
2445 The database version is determined by C<dbi_conn_get_engine_version>, see the
2446 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2447 for details. Basically, each part of the version is assumed to be in the range
2448 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2449 "40102", version "5.0.42" becomes "50042".
2451 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2452 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2453 happen. Don't to it! A valid example would be something along these lines:
2464 In the above example, there are three ranges that don't overlap. The last one
2465 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2466 before "4.0.0" are not specified.
2468 =item B<Type> I<Type>
2470 The B<type> that's used for each line returned. See L<types.db(5)> for more
2471 details on how types are defined. In short: A type is a predefined layout of
2472 data and the number of values and type of values has to match the type
2475 If you specify "temperature" here, you need exactly one gauge column. If you
2476 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2479 There must be exactly one B<Type> option inside each B<Result> block.
2481 =item B<InstancePrefix> I<prefix>
2483 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2484 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2485 all strings returned in the appropriate columns are concatenated together,
2486 separated by dashes I<("-")>.
2488 =item B<InstancesFrom> I<column0> [I<column1> ...]
2490 Specifies the columns whose values will be used to create the "type-instance"
2491 for each row. If you specify more than one column, the value of all columns
2492 will be joined together with dashes I<("-")> as separation characters.
2494 The plugin itself does not check whether or not all built instances are
2495 different. It's your responsibility to assure that each is unique. This is
2496 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2497 sure that only one row is returned in this case.
2499 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2502 =item B<ValuesFrom> I<column0> [I<column1> ...]
2504 Names the columns whose content is used as the actual data for the data sets
2505 that are dispatched to the daemon. How many such columns you need is determined
2506 by the B<Type> setting above. If you specify too many or not enough columns,
2507 the plugin will complain about that and no data will be submitted to the
2510 The actual data type in the columns is not that important. The plugin will
2511 automatically cast the values to the right type if it know how to do that. So
2512 it should be able to handle integer an floating point types, as well as strings
2513 (if they include a number at the beginning).
2515 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2517 =item B<MetadataFrom> [I<column0> I<column1> ...]
2519 Names the columns whose content is used as metadata for the data sets
2520 that are dispatched to the daemon.
2522 The actual data type in the columns is not that important. The plugin will
2523 automatically cast the values to the right type if it know how to do that. So
2524 it should be able to handle integer an floating point types, as well as strings
2525 (if they include a number at the beginning).
2529 =head3 B<Database> blocks
2531 Database blocks define a connection to a database and which queries should be
2532 sent to that database. Since the used "dbi" library can handle a wide variety
2533 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2534 documentationE<nbsp>- we stick as close to the terminology used there.
2536 Each database needs a "name" as string argument in the starting tag of the
2537 block. This name will be used as "PluginInstance" in the values submitted to
2538 the daemon. Other than that, that name is not used.
2542 =item B<Plugin> I<Plugin>
2544 Use I<Plugin> as the plugin name when submitting query results from
2545 this B<Database>. Defaults to C<dbi>.
2547 =item B<Interval> I<Interval>
2549 Sets the interval (in seconds) in which the values will be collected from this
2550 database. By default the global B<Interval> setting will be used.
2552 =item B<Driver> I<Driver>
2554 Specifies the driver to use to connect to the database. In many cases those
2555 drivers are named after the database they can connect to, but this is not a
2556 technical necessity. These drivers are sometimes referred to as "DBD",
2557 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2558 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2559 project at L<http://libdbi-drivers.sourceforge.net/>.
2561 You need to give the driver name as expected by the "dbi" library here. You
2562 should be able to find that in the documentation for each driver. If you
2563 mistype the driver name, the plugin will dump a list of all known driver names
2566 =item B<DriverOption> I<Key> I<Value>
2568 Sets driver-specific options. What option a driver supports can be found in the
2569 documentation for each driver, somewhere at
2570 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2571 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2573 DBDs can register two types of options: String options and numeric options. The
2574 plugin will use the C<dbi_conn_set_option> function when the configuration
2575 provides a string and the C<dbi_conn_require_option_numeric> function when the
2576 configuration provides a number. So these two lines will actually result in
2577 different calls being used:
2579 DriverOption "Port" 1234 # numeric
2580 DriverOption "Port" "1234" # string
2582 Unfortunately, drivers are not too keen to report errors when an unknown option
2583 is passed to them, so invalid settings here may go unnoticed. This is not the
2584 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2585 the driver. If a driver complains about an option, the plugin will dump a
2586 complete list of all options understood by that driver to the log. There is no
2587 way to programmatically find out if an option expects a string or a numeric
2588 argument, so you will have to refer to the appropriate DBD's documentation to
2589 find this out. Sorry.
2591 =item B<SelectDB> I<Database>
2593 In some cases, the database name you connect with is not the database name you
2594 want to use for querying data. If this option is set, the plugin will "select"
2595 (switch to) that database after the connection is established.
2597 =item B<Query> I<QueryName>
2599 Associates the query named I<QueryName> with this database connection. The
2600 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2601 blocks you want to refer to must be placed above the database block you want to
2604 =item B<Host> I<Hostname>
2606 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2607 values. Defaults to the global hostname setting.
2615 =item B<Device> I<Device>
2617 Select partitions based on the devicename.
2619 See F</"IGNORELISTS"> for details.
2621 =item B<MountPoint> I<Directory>
2623 Select partitions based on the mountpoint.
2625 See F</"IGNORELISTS"> for details.
2627 =item B<FSType> I<FSType>
2629 Select partitions based on the filesystem type.
2631 See F</"IGNORELISTS"> for details.
2633 =item B<IgnoreSelected> B<true>|B<false>
2635 Invert the selection: If set to true, all partitions B<except> the ones that
2636 match any one of the criteria are collected. By default only selected
2637 partitions are collected if a selection is made. If no selection is configured
2638 at all, B<all> partitions are selected.
2640 =item B<ReportByDevice> B<true>|B<false>
2642 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2643 (the default), it will report a disk as "root", but with it I<true>, it will be
2644 "sda1" (or whichever).
2646 =item B<ReportInodes> B<true>|B<false>
2648 Enables or disables reporting of free, reserved and used inodes. Defaults to
2649 inode collection being disabled.
2651 Enable this option if inodes are a scarce resource for you, usually because
2652 many small files are stored on the disk. This is a usual scenario for mail
2653 transfer agents and web caches.
2655 =item B<ValuesAbsolute> B<true>|B<false>
2657 Enables or disables reporting of free and used disk space in 1K-blocks.
2658 Defaults to B<true>.
2660 =item B<ValuesPercentage> B<false>|B<true>
2662 Enables or disables reporting of free and used disk space in percentage.
2663 Defaults to B<false>.
2665 This is useful for deploying I<collectd> on the cloud, where machines with
2666 different disk size may exist. Then it is more practical to configure
2667 thresholds based on relative disk size.
2671 =head2 Plugin C<disk>
2673 The C<disk> plugin collects information about the usage of physical disks and
2674 logical disks (partitions). Values collected are the number of octets written
2675 to and read from a disk or partition, the number of read/write operations
2676 issued to the disk and a rather complex "time" it took for these commands to be
2679 Using the following two options you can ignore some disks or configure the
2680 collection only of specific disks.
2684 =item B<Disk> I<Name>
2686 Select the disk I<Name>. Whether it is collected or ignored depends on the
2687 B<IgnoreSelected> setting, see below. As with other plugins that use the
2688 daemon's ignorelist functionality, a string that starts and ends with a slash
2689 is interpreted as a regular expression. Examples:
2694 See F</"IGNORELISTS"> for details.
2696 =item B<IgnoreSelected> B<true>|B<false>
2698 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2699 statements, are ignored or if all other disks are ignored. The behavior
2700 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2701 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2702 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2703 is set to B<true>, all disks are collected B<except> the ones matched.
2705 =item B<UseBSDName> B<true>|B<false>
2707 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2708 default major/minor numbers. Requires collectd to be built with Apple's
2711 =item B<UdevNameAttr> I<Attribute>
2713 Attempt to override disk instance name with the value of a specified udev
2714 attribute when built with B<libudev>. If the attribute is not defined for the
2715 given device, the default name is used. Example:
2717 UdevNameAttr "DM_NAME"
2721 =head2 Plugin C<dns>
2725 =item B<Interface> I<Interface>
2727 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2728 option sets the interface that should be used. If this option is not set, or
2729 set to "any", the plugin will try to get packets from B<all> interfaces. This
2730 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2732 =item B<IgnoreSource> I<IP-address>
2734 Ignore packets that originate from this address.
2736 =item B<SelectNumericQueryTypes> B<true>|B<false>
2738 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2742 =head2 Plugin C<dpdkevents>
2744 The I<dpdkevents plugin> collects events from DPDK such as link status of
2745 network ports and Keep Alive status of DPDK logical cores.
2746 In order to get Keep Alive events following requirements must be met:
2748 - support for Keep Alive implemented in DPDK application. More details can
2749 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2753 <Plugin "dpdkevents">
2759 <Event "link_status">
2760 SendEventsOnUpdate true
2761 EnabledPortMask 0xffff
2762 PortName "interface1"
2763 PortName "interface2"
2764 SendNotification false
2766 <Event "keep_alive">
2767 SendEventsOnUpdate true
2769 KeepAliveShmName "/dpdk_keepalive_shm_name"
2770 SendNotification false
2777 =head3 The EAL block
2781 =item B<Coremask> I<Mask>
2783 =item B<Memorychannels> I<Channels>
2785 Number of memory channels per processor socket.
2787 =item B<FilePrefix> I<File>
2789 The prefix text used for hugepage filenames. The filename will be set to
2790 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2794 =head3 The Event block
2796 The B<Event> block defines configuration for specific event. It accepts a
2797 single argument which specifies the name of the event.
2799 =head4 Link Status event
2803 =item B<SendEventOnUpdate> I<true|false>
2805 If set to true link status value will be dispatched only when it is
2806 different from previously read value. This is an optional argument - default
2809 =item B<EnabledPortMask> I<Mask>
2811 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2812 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2813 that all ports will be enabled. This is an optional argument - by default
2814 all ports are enabled.
2816 =item B<PortName> I<Name>
2818 A string containing an optional name for the enabled DPDK ports. Each PortName
2819 option should contain only one port name; specify as many PortName options as
2820 desired. Default naming convention will be used if PortName is blank. If there
2821 are less PortName options than there are enabled ports, the default naming
2822 convention will be used for the additional ports.
2824 =item B<SendNotification> I<true|false>
2826 If set to true, link status notifications are sent, instead of link status
2827 being collected as a statistic. This is an optional argument - default
2832 =head4 Keep Alive event
2836 =item B<SendEventOnUpdate> I<true|false>
2838 If set to true keep alive value will be dispatched only when it is
2839 different from previously read value. This is an optional argument - default
2842 =item B<LCoreMask> I<Mask>
2844 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2846 =item B<KeepAliveShmName> I<Name>
2848 Shared memory name identifier that is used by secondary process to monitor
2849 the keep alive cores state.
2851 =item B<SendNotification> I<true|false>
2853 If set to true, keep alive notifications are sent, instead of keep alive
2854 information being collected as a statistic. This is an optional
2855 argument - default value is false.
2859 =head2 Plugin C<dpdkstat>
2861 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2862 extended NIC stats API in DPDK.
2873 RteDriverLibPath "/usr/lib/dpdk-pmd"
2875 SharedMemObj "dpdk_collectd_stats_0"
2876 EnabledPortMask 0xffff
2877 PortName "interface1"
2878 PortName "interface2"
2883 =head3 The EAL block
2887 =item B<Coremask> I<Mask>
2889 A string containing an hexadecimal bit mask of the cores to run on. Note that
2890 core numbering can change between platforms and should be determined beforehand.
2892 =item B<Memorychannels> I<Channels>
2894 A string containing a number of memory channels per processor socket.
2896 =item B<FilePrefix> I<File>
2898 The prefix text used for hugepage filenames. The filename will be set to
2899 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2901 =item B<SocketMemory> I<MB>
2903 A string containing amount of Memory to allocate from hugepages on specific
2904 sockets in MB. This is an optional value.
2906 =item B<LogLevel> I<LogLevel_number>
2908 A string containing log level number. This parameter is optional.
2909 If parameter is not present then default value "7" - (INFO) is used.
2910 Value "8" - (DEBUG) can be set to enable debug traces.
2912 =item B<RteDriverLibPath> I<Path>
2914 A string containing path to shared pmd driver lib or path to directory,
2915 where shared pmd driver libs are available. This parameter is optional.
2916 This parameter enable loading of shared pmd driver libs from defined path.
2917 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2918 or "/usr/lib/dpdk-pmd"
2924 =item B<SharedMemObj> I<Mask>
2926 A string containing the name of the shared memory object that should be used to
2927 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2928 Defaults to dpdk_collectd_stats if no other value is configured.
2930 =item B<EnabledPortMask> I<Mask>
2932 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2933 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2934 that all ports will be enabled. This is an optional argument - default
2935 is all ports enabled.
2937 =item B<PortName> I<Name>
2939 A string containing an optional name for the enabled DPDK ports. Each PortName
2940 option should contain only one port name; specify as many PortName options as
2941 desired. Default naming convention will be used if PortName is blank. If there
2942 are less PortName options than there are enabled ports, the default naming
2943 convention will be used for the additional ports.
2947 =head2 Plugin C<email>
2951 =item B<SocketFile> I<Path>
2953 Sets the socket-file which is to be created.
2955 =item B<SocketGroup> I<Group>
2957 If running as root change the group of the UNIX-socket after it has been
2958 created. Defaults to B<collectd>.
2960 =item B<SocketPerms> I<Permissions>
2962 Change the file permissions of the UNIX-socket after it has been created. The
2963 permissions must be given as a numeric, octal value as you would pass to
2964 L<chmod(1)>. Defaults to B<0770>.
2966 =item B<MaxConns> I<Number>
2968 Sets the maximum number of connections that can be handled in parallel. Since
2969 this many threads will be started immediately setting this to a very high
2970 value will waste valuable resources. Defaults to B<5> and will be forced to be
2971 at most B<16384> to prevent typos and dumb mistakes.
2975 =head2 Plugin C<ethstat>
2977 The I<ethstat plugin> collects information about network interface cards (NICs)
2978 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2984 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2985 Map "multicast" "if_multicast"
2992 =item B<Interface> I<Name>
2994 Collect statistical information about interface I<Name>.
2996 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2998 By default, the plugin will submit values as type C<derive> and I<type
2999 instance> set to I<Name>, the name of the metric as reported by the driver. If
3000 an appropriate B<Map> option exists, the given I<Type> and, optionally,
3001 I<TypeInstance> will be used.
3003 =item B<MappedOnly> B<true>|B<false>
3005 When set to B<true>, only metrics that can be mapped to a I<type> will be
3006 collected, all other metrics will be ignored. Defaults to B<false>.
3010 =head2 Plugin C<exec>
3012 Please make sure to read L<collectd-exec(5)> before using this plugin. It
3013 contains valuable information on when the executable is executed and the
3014 output that is expected from it.
3018 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
3020 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
3022 Execute the executable I<Executable> as user I<User>. If the user name is
3023 followed by a colon and a group name, the effective group is set to that group.
3024 The real group and saved-set group will be set to the default group of that
3025 user. If no group is given the effective group ID will be the same as the real
3028 Please note that in order to change the user and/or group the daemon needs
3029 superuser privileges. If the daemon is run as an unprivileged user you must
3030 specify the same user/group here. If the daemon is run with superuser
3031 privileges, you must supply a non-root user here.
3033 The executable may be followed by optional arguments that are passed to the
3034 program. Please note that due to the configuration parsing numbers and boolean
3035 values may be changed. If you want to be absolutely sure that something is
3036 passed as-is please enclose it in quotes.
3038 The B<Exec> and B<NotificationExec> statements change the semantics of the
3039 programs executed, i.E<nbsp>e. the data passed to them and the response
3040 expected from them. This is documented in great detail in L<collectd-exec(5)>.
3044 =head2 Plugin C<fhcount>
3046 The C<fhcount> plugin provides statistics about used, unused and total number of
3047 file handles on Linux.
3049 The I<fhcount plugin> provides the following configuration options:
3053 =item B<ValuesAbsolute> B<true>|B<false>
3055 Enables or disables reporting of file handles usage in absolute numbers,
3056 e.g. file handles used. Defaults to B<true>.
3058 =item B<ValuesPercentage> B<false>|B<true>
3060 Enables or disables reporting of file handles usage in percentages, e.g.
3061 percent of file handles used. Defaults to B<false>.
3065 =head2 Plugin C<filecount>
3067 The C<filecount> plugin counts the number of files in a certain directory (and
3068 its subdirectories) and their combined size. The configuration is very straight
3071 <Plugin "filecount">
3072 <Directory "/var/qmail/queue/mess">
3073 Instance "qmail-message"
3075 <Directory "/var/qmail/queue/todo">
3076 Instance "qmail-todo"
3078 <Directory "/var/lib/php5">
3079 Instance "php5-sessions"
3084 The example above counts the number of files in QMail's queue directories and
3085 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
3086 QMail has not yet looked at, the "message" queue holds the messages that were
3087 classified into "local" and "remote".
3089 As you can see, the configuration consists of one or more C<Directory> blocks,
3090 each of which specifies a directory in which to count the files. Within those
3091 blocks, the following options are recognized:
3095 =item B<Plugin> I<Plugin>
3097 Use I<Plugin> as the plugin name when submitting values.
3098 Defaults to B<filecount>.
3100 =item B<Instance> I<Instance>
3102 Sets the plugin instance to I<Instance>. If not given, the instance is set to
3103 the directory name with all slashes replaced by underscores and all leading
3104 underscores removed. Empty value is allowed.
3106 =item B<Name> I<Pattern>
3108 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
3109 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
3110 against the pattern, not the entire path. In case this makes it easier for you:
3111 This option has been named after the B<-name> parameter to L<find(1)>.
3113 =item B<MTime> I<Age>
3115 Count only files of a specific age: If I<Age> is greater than zero, only files
3116 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
3117 a negative number, this is inversed. For example, if B<-60> is specified, only
3118 files that have been modified in the last minute will be counted.
3120 The number can also be followed by a "multiplier" to easily specify a larger
3121 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3122 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3123 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3124 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3125 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3128 =item B<Size> I<Size>
3130 Count only files of a specific size. When I<Size> is a positive number, only
3131 files that are at least this big are counted. If I<Size> is a negative number,
3132 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3133 I<Size> are counted.
3135 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3136 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3137 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3138 note that there are 1000 bytes in a kilobyte, not 1024.
3140 =item B<Recursive> I<true>|I<false>
3142 Controls whether or not to recurse into subdirectories. Enabled by default.
3144 =item B<IncludeHidden> I<true>|I<false>
3146 Controls whether or not to include "hidden" files and directories in the count.
3147 "Hidden" files and directories are those, whose name begins with a dot.
3148 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3150 =item B<RegularOnly> I<true>|I<false>
3152 Controls whether or not to include only regular files in the count.
3153 Defaults to I<true>, i.e. by default non regular files are ignored.
3155 =item B<FilesSizeType> I<Type>
3157 Sets the type used to dispatch files combined size. Empty value ("") disables
3158 reporting. Defaults to B<bytes>.
3160 =item B<FilesCountType> I<Type>
3162 Sets the type used to dispatch number of files. Empty value ("") disables
3163 reporting. Defaults to B<files>.
3165 =item B<TypeInstance> I<Instance>
3167 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3168 (no plugin instance).
3172 =head2 Plugin C<GenericJMX>
3174 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3175 L<collectd-java(5)>.
3177 =head2 Plugin C<gmond>
3179 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3180 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3181 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3186 MCReceiveFrom "239.2.11.71" "8649"
3187 <Metric "swap_total">
3189 TypeInstance "total"
3192 <Metric "swap_free">
3199 The following metrics are built-in:
3205 load_one, load_five, load_fifteen
3209 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3213 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3225 Available configuration options:
3229 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3231 Sets sets the multicast group and UDP port to which to subscribe.
3233 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3235 =item E<lt>B<Metric> I<Name>E<gt>
3237 These blocks add a new metric conversion to the internal table. I<Name>, the
3238 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3242 =item B<Type> I<Type>
3244 Type to map this metric to. Required.
3246 =item B<TypeInstance> I<Instance>
3248 Type-instance to use. Optional.
3250 =item B<DataSource> I<Name>
3252 Data source to map this metric to. If the configured type has exactly one data
3253 source, this is optional. Otherwise the option is required.
3259 =head2 Plugin C<gps>
3261 The C<gps plugin> connects to gpsd on the host machine.
3262 The host, port, timeout and pause are configurable.
3264 This is useful if you run an NTP server using a GPS for source and you want to
3267 Mind your GPS must send $--GSA for having the data reported!
3269 The following elements are collected:
3275 Number of satellites used for fix (type instance "used") and in view (type
3276 instance "visible"). 0 means no GPS satellites are visible.
3278 =item B<dilution_of_precision>
3280 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3281 It should be between 0 and 3.
3282 Look at the documentation of your GPS to know more.
3290 # Connect to localhost on gpsd regular port:
3295 # PauseConnect of 5 sec. between connection attempts.
3299 Available configuration options:
3303 =item B<Host> I<Host>
3305 The host on which gpsd daemon runs. Defaults to B<localhost>.
3307 =item B<Port> I<Port>
3309 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3311 =item B<Timeout> I<Seconds>
3313 Timeout in seconds (default 0.015 sec).
3315 The GPS data stream is fetch by the plugin form the daemon.
3316 It waits for data to be available, if none arrives it times out
3317 and loop for another reading.
3318 Mind to put a low value gpsd expects value in the micro-seconds area
3319 (recommended is 500 us) since the waiting function is blocking.
3320 Value must be between 500 us and 5 sec., if outside that range the
3321 default value is applied.
3323 This only applies from gpsd release-2.95.
3325 =item B<PauseConnect> I<Seconds>
3327 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3331 =head2 Plugin C<gpu_nvidia>
3333 Efficiently collects various statistics from the system's NVIDIA GPUs using the
3334 NVML library. Currently collected are fan speed, core temperature, percent
3335 load, percent memory used, compute and memory frequencies, and power
3342 If one or more of these options is specified, only GPUs at that index (as
3343 determined by nvidia-utils through I<nvidia-smi>) have statistics collected.
3344 If no instance of this option is specified, all GPUs are monitored.
3346 =item B<IgnoreSelected>
3348 If set to true, all detected GPUs B<except> the ones at indices specified by
3349 B<GPUIndex> entries are collected. For greater clarity, setting IgnoreSelected
3350 without any GPUIndex directives will result in B<no> statistics being
3355 =head2 Plugin C<grpc>
3357 The I<grpc> plugin provides an RPC interface to submit values to or query
3358 values from collectd based on the open source gRPC framework. It exposes an
3359 end-point for dispatching values to the daemon.
3361 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3365 =item B<Server> I<Host> I<Port>
3367 The B<Server> statement sets the address of a server to which to send metrics
3368 via the C<DispatchValues> function.
3370 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3372 Optionally, B<Server> may be specified as a configuration block which supports
3373 the following options:
3377 =item B<EnableSSL> B<false>|B<true>
3379 Whether to require SSL for outgoing connections. Default: false.
3381 =item B<SSLCACertificateFile> I<Filename>
3383 =item B<SSLCertificateFile> I<Filename>
3385 =item B<SSLCertificateKeyFile> I<Filename>
3387 Filenames specifying SSL certificate and key material to be used with SSL
3392 =item B<Listen> I<Host> I<Port>
3394 The B<Listen> statement sets the network address to bind to. When multiple
3395 statements are specified, the daemon will bind to all of them. If none are
3396 specified, it defaults to B<0.0.0.0:50051>.
3398 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3400 Optionally, B<Listen> may be specified as a configuration block which
3401 supports the following options:
3405 =item B<EnableSSL> I<true>|I<false>
3407 Whether to enable SSL for incoming connections. Default: false.
3409 =item B<SSLCACertificateFile> I<Filename>
3411 =item B<SSLCertificateFile> I<Filename>
3413 =item B<SSLCertificateKeyFile> I<Filename>
3415 Filenames specifying SSL certificate and key material to be used with SSL
3418 =item B<VerifyPeer> B<true>|B<false>
3420 When enabled, a valid client certificate is required to connect to the server.
3421 When disabled, a client certifiacte is not requested and any unsolicited client
3422 certificate is accepted.
3429 =head2 Plugin C<hddtemp>
3431 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3432 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3433 default values, see below. C<hddtemp> has to be running to work correctly. If
3434 C<hddtemp> is not running timeouts may appear which may interfere with other
3437 The B<hddtemp> homepage can be found at
3438 L<http://www.guzu.net/linux/hddtemp.php>.
3442 =item B<Host> I<Hostname>
3444 Hostname to connect to. Defaults to B<127.0.0.1>.
3446 =item B<Port> I<Port>
3448 TCP-Port to connect to. Defaults to B<7634>.
3452 =head2 Plugin C<hugepages>
3454 To collect B<hugepages> information, collectd reads directories
3455 "/sys/devices/system/node/*/hugepages" and
3456 "/sys/kernel/mm/hugepages".
3457 Reading of these directories can be disabled by the following
3458 options (default is enabled).
3462 =item B<ReportPerNodeHP> B<true>|B<false>
3464 If enabled, information will be collected from the hugepage
3465 counters in "/sys/devices/system/node/*/hugepages".
3466 This is used to check the per-node hugepage statistics on
3469 =item B<ReportRootHP> B<true>|B<false>
3471 If enabled, information will be collected from the hugepage
3472 counters in "/sys/kernel/mm/hugepages".
3473 This can be used on both NUMA and non-NUMA systems to check
3474 the overall hugepage statistics.
3476 =item B<ValuesPages> B<true>|B<false>
3478 Whether to report hugepages metrics in number of pages.
3479 Defaults to B<true>.
3481 =item B<ValuesBytes> B<false>|B<true>
3483 Whether to report hugepages metrics in bytes.
3484 Defaults to B<false>.
3486 =item B<ValuesPercentage> B<false>|B<true>
3488 Whether to report hugepages metrics as percentage.
3489 Defaults to B<false>.
3493 =head2 Plugin C<intel_pmu>
3495 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3496 Linux perf interface. All events are reported on a per core basis.
3501 ReportHardwareCacheEvents true
3502 ReportKernelPMUEvents true
3503 ReportSoftwareEvents true
3504 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3505 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3506 Cores "0-3" "4,6" "[12-15]"
3513 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3515 Enable or disable measuring of hardware CPU cache events:
3517 - L1-dcache-load-misses
3519 - L1-dcache-store-misses
3520 - L1-dcache-prefetches
3521 - L1-dcache-prefetch-misses
3523 - L1-icache-load-misses
3524 - L1-icache-prefetches
3525 - L1-icache-prefetch-misses
3531 - LLC-prefetch-misses
3537 - dTLB-prefetch-misses
3541 - branch-load-misses
3543 =item B<ReportKernelPMUEvents> B<false>|B<true>
3545 Enable or disable measuring of the following events:
3554 =item B<ReportSoftwareEvents> B<false>|B<true>
3556 Enable or disable measuring of software events provided by kernel:
3567 =item B<EventList> I<filename>
3569 JSON performance counter event list file name. To be able to monitor all Intel
3570 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3571 event_download.py script to download event list for current CPU.
3573 =item B<HardwareEvents> I<events>
3575 This field is a list of event names or groups of comma separated event names.
3576 This option requires B<EventList> option to be configured.
3578 =item B<Cores> I<cores groups>
3580 All events are reported on a per core basis. Monitoring of the events can be
3581 configured for a group of cores (aggregated statistics). This field defines
3582 groups of cores on which to monitor supported events. The field is represented
3583 as list of strings with core group values. Each string represents a list of
3584 cores in a group. If a group is enclosed in square brackets each core is added
3585 individually to a separate group (that is statistics are not aggregated).
3586 Allowed formats are:
3592 If an empty string is provided as value for this field default cores
3593 configuration is applied - that is separate group is created for each core.
3597 =head2 Plugin C<intel_rdt>
3599 The I<intel_rdt> plugin collects information provided by monitoring features of
3600 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3601 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3602 information about utilization of shared resources. CMT monitors last level cache
3603 occupancy (LLC). MBM supports two types of events reporting local and remote
3604 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3605 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3606 reports the bandwidth of accessing the remote socket. Also this technology
3607 allows to monitor instructions per clock (IPC).
3608 Monitor events are hardware dependant. Monitoring capabilities are detected on
3609 plugin initialization and only supported events are monitored.
3611 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3612 require an additional capability to be enabled if collectd is run as a service.
3613 Please refer to I<contrib/systemd.collectd.service> file for more details.
3617 <Plugin "intel_rdt">
3618 Cores "0-2" "3,4,6" "8-10,15"
3619 Processes "sshd,qemu-system-x86" "bash"
3626 =item B<Interval> I<seconds>
3628 The interval within which to retrieve statistics on monitored events in seconds.
3629 For milliseconds divide the time by 1000 for example if the desired interval
3630 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3631 recommended to set interval higher than 1 sec.
3633 =item B<Cores> I<cores groups>
3635 Monitoring of the events can be configured for group of cores
3636 (aggregated statistics). This field defines groups of cores on which to monitor
3637 supported events. The field is represented as list of strings with core group
3638 values. Each string represents a list of cores in a group. Allowed formats are:
3643 If an empty string is provided as value for this field default cores
3644 configuration is applied - a separate group is created for each core.
3646 =item B<Processes> I<process names groups>
3648 Monitoring of the events can be configured for group of processes
3649 (aggregated statistics). This field defines groups of processes on which to
3650 monitor supported events. The field is represented as list of strings with
3651 process names group values. Each string represents a list of processes in a
3652 group. Allowed format is:
3657 B<Note:> By default global interval is used to retrieve statistics on monitored
3658 events. To configure a plugin specific interval use B<Interval> option of the
3659 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3660 example if the desired interval is 50ms, set interval to 0.05.
3661 Due to limited capacity of counters it is not recommended to set interval higher
3664 =head2 Plugin C<interface>
3668 =item B<Interface> I<Interface>
3670 Select this interface. By default these interfaces will then be collected. For
3671 a more detailed description see B<IgnoreSelected> below.
3673 See F</"IGNORELISTS"> for details.
3675 =item B<IgnoreSelected> I<true>|I<false>
3677 If no configuration is given, the B<interface>-plugin will collect data from
3678 all interfaces. This may not be practical, especially for loopback- and
3679 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3680 interfaces you're interested in. Sometimes, however, it's easier/preferred
3681 to collect all interfaces I<except> a few ones. This option enables you to
3682 do that: By setting B<IgnoreSelected> to I<true> the effect of
3683 B<Interface> is inverted: All selected interfaces are ignored and all
3684 other interfaces are collected.
3686 It is possible to use regular expressions to match interface names, if the
3687 name is surrounded by I</.../> and collectd was compiled with support for
3688 regexps. This is useful if there's a need to collect (or ignore) data
3689 for a group of interfaces that are similarly named, without the need to
3690 explicitly list all of them (especially useful if the list is dynamic).
3695 Interface "/^tun[0-9]+/"
3696 IgnoreSelected "true"
3698 This will ignore the loopback interface, all interfaces with names starting
3699 with I<veth> and all interfaces with names starting with I<tun> followed by
3702 =item B<ReportInactive> I<true>|I<false>
3704 When set to I<false>, only interfaces with non-zero traffic will be
3705 reported. Note that the check is done by looking into whether a
3706 package was sent at any time from boot and the corresponding counter
3707 is non-zero. So, if the interface has been sending data in the past
3708 since boot, but not during the reported time-interval, it will still
3711 The default value is I<true> and results in collection of the data
3712 from all interfaces that are selected by B<Interface> and
3713 B<IgnoreSelected> options.
3715 =item B<UniqueName> I<true>|I<false>
3717 Interface name is not unique on Solaris (KSTAT), interface name is unique
3718 only within a module/instance. Following tuple is considered unique:
3719 (ks_module, ks_instance, ks_name)
3720 If this option is set to true, interface name contains above three fields
3721 separated by an underscore. For more info on KSTAT, visit
3722 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3724 This option is only available on Solaris.
3728 =head2 Plugin C<ipmi>
3730 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3731 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3733 The plugin configuration consists of one or more B<Instance> blocks which
3734 specify one I<ipmi> connection each. Each block requires one unique string
3735 argument as the instance name. If instances are not configured, an instance with
3736 the default option values will be created.
3738 For backwards compatibility, any option other than B<Instance> block will trigger
3739 legacy config handling and it will be treated as an option within B<Instance>
3740 block. This support will go away in the next major version of Collectd.
3742 Within the B<Instance> blocks, the following options are allowed:
3746 =item B<Address> I<Address>
3748 Hostname or IP to connect to. If not specified, plugin will try to connect to
3749 local management controller (BMC).
3751 =item B<Username> I<Username>
3753 =item B<Password> I<Password>
3755 The username and the password to use for the connection to remote BMC.
3757 =item B<AuthType> I<MD5>|I<rmcp+>
3759 Forces the authentication type to use for the connection to remote BMC.
3760 By default most secure type is seleted.
3762 =item B<Host> I<Hostname>
3764 Sets the B<host> field of dispatched values. Defaults to the global hostname
3767 =item B<Sensor> I<Sensor>
3769 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3771 See F</"IGNORELISTS"> for details.
3773 =item B<IgnoreSelected> I<true>|I<false>
3775 If no configuration if given, the B<ipmi> plugin will collect data from all
3776 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3777 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3778 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3779 all other sensors are collected.
3781 =item B<NotifySensorAdd> I<true>|I<false>
3783 If a sensor appears after initialization time of a minute a notification
3786 =item B<NotifySensorRemove> I<true>|I<false>
3788 If a sensor disappears a notification is sent.
3790 =item B<NotifySensorNotPresent> I<true>|I<false>
3792 If you have for example dual power supply and one of them is (un)plugged then
3793 a notification is sent.
3795 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3797 If a IPMI connection state changes after initialization time of a minute
3798 a notification is sent. Defaults to B<false>.
3800 =item B<SELEnabled> I<true>|I<false>
3802 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3803 and discrete events. When event is received the notification is sent.
3804 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3806 Defaults to B<false>.
3808 =item B<SELSensor> I<SELSensor>
3810 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3812 See F</"IGNORELISTS"> for details.
3814 =item B<SELIgnoreSelected> I<true>|I<false>
3816 If no configuration is given, the B<ipmi> plugin will pass events from all
3817 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3818 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3819 sensors are ignored and all events from other sensors are passed.
3821 =item B<SELClearEvent> I<true>|I<false>
3823 If SEL clear event is enabled, plugin will delete event from SEL list after
3824 it is received and successfully handled. In this case other tools that are
3825 subscribed for SEL events will receive an empty event.
3826 Defaults to B<false>.
3830 =head2 Plugin C<iptables>
3834 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3836 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3838 Select the iptables/ip6tables filter rules to count packets and bytes from.
3840 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3841 of all rules which have a comment-match. The comment is then used as
3844 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3845 the I<n>th rule will be collected. Again, the comment (or the number) will be
3846 used as the type-instance.
3848 If I<Name> is supplied, it will be used as the type-instance instead of the
3849 comment or the number.
3853 =head2 Plugin C<irq>
3859 Select this irq. By default these irqs will then be collected. For a more
3860 detailed description see B<IgnoreSelected> below.
3862 See F</"IGNORELISTS"> for details.
3864 =item B<IgnoreSelected> I<true>|I<false>
3866 If no configuration if given, the B<irq>-plugin will collect data from all
3867 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3868 can use the B<Irq>-option to pick the interrupt you're interested in.
3869 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3870 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3871 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3872 and all other interrupts are collected.
3876 =head2 Plugin C<java>
3878 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3879 This section only discusses the syntax and semantic of the configuration
3880 options. For more in-depth information on the I<Java> plugin, please read
3881 L<collectd-java(5)>.
3886 JVMArg "-verbose:jni"
3887 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3888 LoadPlugin "org.collectd.java.Foobar"
3889 <Plugin "org.collectd.java.Foobar">
3890 # To be parsed by the plugin
3894 Available configuration options:
3898 =item B<JVMArg> I<Argument>
3900 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3901 exactly the way the arguments to the I<java> binary on the command line work.
3902 Execute C<javaE<nbsp>--help> for details.
3904 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3905 any other options! When another option is found, the JVM will be started and
3906 later options will have to be ignored!
3908 =item B<LoadPlugin> I<JavaClass>
3910 Instantiates a new I<JavaClass> object. The constructor of this object very
3911 likely then registers one or more callback methods with the server.
3913 See L<collectd-java(5)> for details.
3915 When the first such option is found, the virtual machine (JVM) is created. This
3916 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3917 B<LoadPlugin> options!
3919 =item B<Plugin> I<Name>
3921 The entire block is passed to the Java plugin as an
3922 I<org.collectd.api.OConfigItem> object.
3924 For this to work, the plugin has to register a configuration callback first,
3925 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3926 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3927 depends on the (Java) plugin registering the callback and is completely
3928 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3932 =head2 Plugin C<load>
3934 The I<Load plugin> collects the system load. These numbers give a rough overview
3935 over the utilization of a machine. The system load is defined as the number of
3936 runnable tasks in the run-queue and is provided by many operating systems as a
3937 one, five or fifteen minute average.
3939 The following configuration options are available:
3943 =item B<ReportRelative> B<false>|B<true>
3945 When enabled, system load divided by number of available CPU cores is reported
3946 for intervals 1 min, 5 min and 15 min. Defaults to false.
3951 =head2 Plugin C<logfile>
3955 =item B<LogLevel> B<debug|info|notice|warning|err>
3957 Sets the log-level. If, for example, set to B<notice>, then all events with
3958 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3960 Please note that B<debug> is only available if collectd has been compiled with
3963 =item B<File> I<File>
3965 Sets the file to write log messages to. The special strings B<stdout> and
3966 B<stderr> can be used to write to the standard output and standard error
3967 channels, respectively. This, of course, only makes much sense when I<collectd>
3968 is running in foreground- or non-daemon-mode.
3970 =item B<Timestamp> B<true>|B<false>
3972 Prefix all lines printed by the current time. Defaults to B<true>.
3974 =item B<PrintSeverity> B<true>|B<false>
3976 When enabled, all lines are prefixed by the severity of the log message, for
3977 example "warning". Defaults to B<false>.
3981 B<Note>: There is no need to notify the daemon after moving or removing the
3982 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3983 for each line it writes.
3985 =head2 Plugin C<log_logstash>
3987 The I<log logstash plugin> behaves like the logfile plugin but formats
3988 messages as JSON events for logstash to parse and input.
3992 =item B<LogLevel> B<debug|info|notice|warning|err>
3994 Sets the log-level. If, for example, set to B<notice>, then all events with
3995 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3997 Please note that B<debug> is only available if collectd has been compiled with
4000 =item B<File> I<File>
4002 Sets the file to write log messages to. The special strings B<stdout> and
4003 B<stderr> can be used to write to the standard output and standard error
4004 channels, respectively. This, of course, only makes much sense when I<collectd>
4005 is running in foreground- or non-daemon-mode.
4009 B<Note>: There is no need to notify the daemon after moving or removing the
4010 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
4011 for each line it writes.
4013 =head2 Plugin C<lpar>
4015 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
4016 virtualization technique for IBM POWER processors. It takes into account CPU
4017 time stolen from or donated to a partition, in addition to the usual user,
4018 system, I/O statistics.
4020 The following configuration options are available:
4024 =item B<CpuPoolStats> B<false>|B<true>
4026 When enabled, statistics about the processor pool are read, too. The partition
4027 needs to have pool authority in order to be able to acquire this information.
4030 =item B<ReportBySerial> B<false>|B<true>
4032 If enabled, the serial of the physical machine the partition is currently
4033 running on is reported as I<hostname> and the logical hostname of the machine
4034 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
4035 used (just like other plugins) and the I<plugin instance> will be empty.
4040 =head2 Plugin C<lua>
4042 This plugin embeds a Lua interpreter into collectd and provides an interface
4043 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
4046 =head2 Plugin C<mbmon>
4048 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
4050 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
4051 B<Host> and B<Port> options can be used to change these values, see below.
4052 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
4053 timeouts may appear which may interfere with other statistics..
4055 C<mbmon> must be run with the -r option ("print TAG and Value format");
4056 Debian's F</etc/init.d/mbmon> script already does this, other people
4057 will need to ensure that this is the case.
4061 =item B<Host> I<Hostname>
4063 Hostname to connect to. Defaults to B<127.0.0.1>.
4065 =item B<Port> I<Port>
4067 TCP-Port to connect to. Defaults to B<411>.
4071 =head2 Plugin C<mcelog>
4073 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
4075 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
4076 mcelog server is running. When the server is running, the plugin will tail the
4077 specified logfile to retrieve machine check exception information and send a
4078 notification with the details from the logfile. The plugin will use the mcelog
4079 client protocol to retrieve memory related machine check exceptions. Note that
4080 for memory exceptions, notifications are only sent when there is a change in
4081 the number of corrected/uncorrected memory errors.
4083 =head3 The Memory block
4085 Note: these options cannot be used in conjunction with the logfile options, they are mutually
4090 =item B<McelogClientSocket> I<Path>
4091 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
4092 Defaults to B<"/var/run/mcelog-client">.
4094 =item B<PersistentNotification> B<true>|B<false>
4095 Override default configuration to only send notifications when sent when there
4096 is a change in the number of corrected/uncorrected memory errors. When set to
4097 true notifications will be sent for every read cycle. Default is false. Does
4098 not affect the stats being dispatched.
4104 =item B<McelogLogfile> I<Path>
4106 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
4107 cannot be used in conjunction with the memory block options, they are mutually
4114 The C<md plugin> collects information from Linux Software-RAID devices (md).
4116 All reported values are of the type C<md_disks>. Reported type instances are
4117 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
4118 I<missing> (physically absent) disks.
4122 =item B<Device> I<Device>
4124 Select md devices based on device name. The I<device name> is the basename of
4125 the device, i.e. the name of the block device without the leading C</dev/>.
4126 See B<IgnoreSelected> for more details.
4128 See F</"IGNORELISTS"> for details.
4130 =item B<IgnoreSelected> B<true>|B<false>
4132 Invert device selection: If set to B<true>, all md devices B<except> those
4133 listed using B<Device> are collected. If B<false> (the default), only those
4134 listed are collected. If no configuration is given, the B<md> plugin will
4135 collect data from all md devices.
4139 =head2 Plugin C<memcachec>
4141 The C<memcachec plugin> connects to a memcached server, queries one or more
4142 given I<pages> and parses the returned data according to user specification.
4143 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4146 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4147 library. Please note that there is another library with a very similar name,
4148 libmemcache (notice the missing `d'), which is not applicable.
4150 Synopsis of the configuration:
4152 <Plugin "memcachec">
4153 <Page "plugin_instance">
4156 Plugin "plugin_name"
4158 Regex "(\\d+) bytes sent"
4161 Instance "type_instance"
4166 The configuration options are:
4170 =item E<lt>B<Page> I<Name>E<gt>
4172 Each B<Page> block defines one I<page> to be queried from the memcached server.
4173 The block requires one string argument which is used as I<plugin instance>.
4175 =item B<Server> I<Address>
4177 Sets the server address to connect to when querying the page. Must be inside a
4182 When connected to the memcached server, asks for the page I<Key>.
4184 =item B<Plugin> I<Plugin>
4186 Use I<Plugin> as the plugin name when submitting values.
4187 Defaults to C<memcachec>.
4189 =item E<lt>B<Match>E<gt>
4191 Match blocks define which strings to look for and how matches substrings are
4192 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4196 =head2 Plugin C<memcached>
4198 The B<memcached plugin> connects to a memcached server and queries statistics
4199 about cache utilization, memory and bandwidth used.
4200 L<http://memcached.org/>
4202 <Plugin "memcached">
4204 #Host "memcache.example.com"
4210 The plugin configuration consists of one or more B<Instance> blocks which
4211 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4212 following options are allowed:
4216 =item B<Host> I<Hostname>
4218 Sets the B<host> field of dispatched values. Defaults to the global hostname
4220 For backwards compatibility, values are also dispatched with the global
4221 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4224 =item B<Address> I<Address>
4226 Hostname or IP to connect to. For backwards compatibility, defaults to the
4227 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4229 =item B<Port> I<Port>
4231 TCP port to connect to. Defaults to B<11211>.
4233 =item B<Socket> I<Path>
4235 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4236 setting is given, the B<Address> and B<Port> settings are ignored.
4240 =head2 Plugin C<mic>
4242 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4243 Intel's Many Integrated Core (MIC) systems.
4252 ShowTemperatures true
4255 IgnoreSelectedTemperature true
4260 IgnoreSelectedPower true
4263 The following options are valid inside the B<PluginE<nbsp>mic> block:
4267 =item B<ShowCPU> B<true>|B<false>
4269 If enabled (the default) a sum of the CPU usage across all cores is reported.
4271 =item B<ShowCPUCores> B<true>|B<false>
4273 If enabled (the default) per-core CPU usage is reported.
4275 =item B<ShowMemory> B<true>|B<false>
4277 If enabled (the default) the physical memory usage of the MIC system is
4280 =item B<ShowTemperatures> B<true>|B<false>
4282 If enabled (the default) various temperatures of the MIC system are reported.
4284 =item B<Temperature> I<Name>
4286 This option controls which temperatures are being reported. Whether matching
4287 temperatures are being ignored or I<only> matching temperatures are reported
4288 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4289 temperatures are reported.
4291 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4293 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4294 (the default) only temperatures matching a B<Temperature> option are reported
4295 or, if no B<Temperature> option is specified, all temperatures are reported. If
4296 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4299 Known temperature names are:
4333 =item B<ShowPower> B<true>|B<false>
4335 If enabled (the default) various temperatures of the MIC system are reported.
4337 =item B<Power> I<Name>
4339 This option controls which power readings are being reported. Whether matching
4340 power readings are being ignored or I<only> matching power readings are reported
4341 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4342 power readings are reported.
4344 =item B<IgnoreSelectedPower> B<false>|B<true>
4346 Controls the behavior of the B<Power> setting above. If set to B<false>
4347 (the default) only power readings matching a B<Power> option are reported
4348 or, if no B<Power> option is specified, all power readings are reported. If
4349 set to B<true>, matching power readings are I<ignored> and all other power readings
4352 Known power names are:
4358 Total power utilization averaged over Time Window 0 (uWatts).
4362 Total power utilization averaged over Time Window 0 (uWatts).
4366 Instantaneous power (uWatts).
4370 Max instantaneous power (uWatts).
4374 PCI-E connector power (uWatts).
4378 2x3 connector power (uWatts).
4382 2x4 connector power (uWatts).
4390 Uncore rail (uVolts).
4394 Memory subsystem rail (uVolts).
4400 =head2 Plugin C<memory>
4402 The I<memory plugin> provides the following configuration options:
4406 =item B<ValuesAbsolute> B<true>|B<false>
4408 Enables or disables reporting of physical memory usage in absolute numbers,
4409 i.e. bytes. Defaults to B<true>.
4411 =item B<ValuesPercentage> B<false>|B<true>
4413 Enables or disables reporting of physical memory usage in percentages, e.g.
4414 percent of physical memory used. Defaults to B<false>.
4416 This is useful for deploying I<collectd> in a heterogeneous environment in
4417 which the sizes of physical memory vary.
4421 =head2 Plugin C<modbus>
4423 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4424 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4425 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4426 floating point values (two registers interpreted as IEEE floats in big endian
4431 <Data "voltage-input-1">
4434 RegisterCmd ReadHolding
4441 <Data "voltage-input-2">
4444 RegisterCmd ReadHolding
4449 <Data "supply-temperature-1">
4452 RegisterCmd ReadHolding
4457 <Host "modbus.example.com">
4458 Address "192.168.0.42"
4463 Instance "power-supply"
4464 Collect "voltage-input-1"
4465 Collect "voltage-input-2"
4470 Device "/dev/ttyUSB0"
4475 Instance "temperature"
4476 Collect "supply-temperature-1"
4482 =item E<lt>B<Data> I<Name>E<gt> blocks
4484 Data blocks define a mapping between register numbers and the "types" used by
4487 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4491 =item B<RegisterBase> I<Number>
4493 Configures the base register to read from the device. If the option
4494 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4495 register will be read (the register number is increased by one).
4497 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4499 Specifies what kind of data is returned by the device. This defaults to
4500 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4501 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4502 and B<RegisterBase+1> will be read and the data is combined into one
4503 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4504 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4505 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4506 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4507 registers are swapped with the most significant 16E<nbsp>bits in
4508 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4509 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4510 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4511 B<RegisterBase+3> will be read and the data combined into one
4514 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4516 Specifies register type to be collected from device. Works only with libmodbus
4517 2.9.2 or higher. Defaults to B<ReadHolding>.
4519 =item B<Type> I<Type>
4521 Specifies the "type" (data set) to use when dispatching the value to
4522 I<collectd>. Currently, only data sets with exactly one data source are
4525 =item B<Instance> I<Instance>
4527 Sets the type instance to use when dispatching the value to I<Instance>. If
4528 unset, an empty string (no type instance) is used.
4530 =item B<Scale> I<Value>
4532 The values taken from device are multiplied by I<Value>. The field is optional
4533 and the default is B<1.0>.
4535 =item B<Shift> I<Value>
4537 I<Value> is added to values from device after they have been multiplied by
4538 B<Scale> value. The field is optional and the default value is B<0.0>.
4542 =item E<lt>B<Host> I<Name>E<gt> blocks
4544 Host blocks are used to specify to which hosts to connect and what data to read
4545 from their "slaves". The string argument I<Name> is used as hostname when
4546 dispatching the values to I<collectd>.
4548 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4552 =item B<Address> I<Hostname>
4554 For Modbus/TCP, specifies the node name (the actual network address) used to
4555 connect to the host. This may be an IP address or a hostname. Please note that
4556 the used I<libmodbus> library only supports IPv4 at the moment.
4558 =item B<Port> I<Service>
4560 for Modbus/TCP, specifies the port used to connect to the host. The port can
4561 either be given as a number or as a service name. Please note that the
4562 I<Service> argument must be a string, even if ports are given in their numerical
4563 form. Defaults to "502".
4565 =item B<Device> I<Devicenode>
4567 For Modbus/RTU, specifies the path to the serial device being used.
4569 =item B<Baudrate> I<Baudrate>
4571 For Modbus/RTU, specifies the baud rate of the serial device.
4572 Note, connections currently support only 8/N/1.
4574 =item B<UARTType> I<UARTType>
4576 For Modbus/RTU, specifies the type of the serial device.
4577 RS232, RS422 and RS485 are supported. Defaults to RS232.
4578 Available only on Linux systems with libmodbus>=2.9.4.
4580 =item B<Interval> I<Interval>
4582 Sets the interval (in seconds) in which the values will be collected from this
4583 host. By default the global B<Interval> setting will be used.
4585 =item E<lt>B<Slave> I<ID>E<gt>
4587 Over each connection, multiple Modbus devices may be reached. The slave ID
4588 is used to specify which device should be addressed. For each device you want
4589 to query, one B<Slave> block must be given.
4591 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4595 =item B<Instance> I<Instance>
4597 Specify the plugin instance to use when dispatching the values to I<collectd>.
4598 By default "slave_I<ID>" is used.
4600 =item B<Collect> I<DataName>
4602 Specifies which data to retrieve from the device. I<DataName> must be the same
4603 string as the I<Name> argument passed to a B<Data> block. You can specify this
4604 option multiple times to collect more than one value from a slave. At least one
4605 B<Collect> option is mandatory.
4613 =head2 Plugin C<mqtt>
4615 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4616 values from MQTT (B<Subscribe> blocks).
4622 Host "mqtt.example.com"
4626 Host "mqtt.example.com"
4631 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4632 configuring the sending and receiving direction respectively. The plugin will
4633 register a write callback named C<mqtt/I<name>> where I<name> is the string
4634 argument given to the B<Publish> block. Both types of blocks share many but not
4635 all of the following options. If an option is valid in only one of the blocks,
4636 it will be mentioned explicitly.
4642 =item B<Host> I<Hostname>
4644 Hostname of the MQTT broker to connect to.
4646 =item B<Port> I<Service>
4648 Port number or service name of the MQTT broker to connect to.
4650 =item B<User> I<UserName>
4652 Username used when authenticating to the MQTT broker.
4654 =item B<Password> I<Password>
4656 Password used when authenticating to the MQTT broker.
4658 =item B<ClientId> I<ClientId>
4660 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4662 =item B<QoS> [B<0>-B<2>]
4664 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4682 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4683 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4684 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4685 on a message is larger than the maximum accepted QoS of a subscriber, the
4686 message's QoS will be downgraded.
4688 =item B<Prefix> I<Prefix> (Publish only)
4690 This plugin will use one topic per I<value list> which will looks like a path.
4691 I<Prefix> is used as the first path element and defaults to B<collectd>.
4693 An example topic name would be:
4695 collectd/cpu-0/cpu-user
4697 =item B<Retain> B<false>|B<true> (Publish only)
4699 Controls whether the MQTT broker will retain (keep a copy of) the last message
4700 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4702 =item B<StoreRates> B<true>|B<false> (Publish only)
4704 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4705 before sending. Defaults to B<true>.
4707 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4709 Controls whether the MQTT "cleans" the session up after the subscriber
4710 disconnects or if it maintains the subscriber's subscriptions and all messages
4711 that arrive while the subscriber is disconnected. Defaults to B<true>.
4713 =item B<Topic> I<TopicName> (Subscribe only)
4715 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4716 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4717 the B<collectd> branch.
4719 =item B<CACert> I<file>
4721 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4722 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4723 port of the MQTT broker.
4724 This option enables the use of TLS.
4726 =item B<CertificateFile> I<file>
4728 Path to the PEM-encoded certificate file to use as client certificate when
4729 connecting to the MQTT broker.
4730 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4732 =item B<CertificateKeyFile> I<file>
4734 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4735 Only valid if B<CACert> and B<CertificateFile> are also set.
4737 =item B<TLSProtocol> I<protocol>
4739 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4740 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4741 version is used which depends on the version of OpenSSL the Mosquitto library
4743 Only valid if B<CACert> is set.
4745 =item B<CipherSuite> I<ciphersuite>
4747 A string describing the ciphers available for use. See L<ciphers(1)> and the
4748 C<openssl ciphers> utility for more information. If unset, the default ciphers
4750 Only valid if B<CACert> is set.
4754 =head2 Plugin C<mysql>
4756 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4757 one or more databases when started and keeps the connection up as long as
4758 possible. When the connection is interrupted for whatever reason it will try
4759 to re-connect. The plugin will complain loudly in case anything goes wrong.
4761 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4762 and collects information about MySQL network traffic, executed statements,
4763 requests, the query cache and threads by evaluating the
4764 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4765 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4766 Status Variables> for an explanation of these values.
4768 Optionally, master and slave statistics may be collected in a MySQL
4769 replication setup. In that case, information about the synchronization state
4770 of the nodes are collected by evaluating the C<Position> return value of the
4771 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4772 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4773 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4774 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4775 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4787 SSLKey "/path/to/key.pem"
4788 SSLCert "/path/to/cert.pem"
4789 SSLCA "/path/to/ca.pem"
4790 SSLCAPath "/path/to/cas/"
4791 SSLCipher "DHE-RSA-AES256-SHA"
4797 Socket "/var/run/mysql/mysqld.sock"
4799 SlaveNotifications true
4805 Socket "/var/run/mysql/mysqld.sock"
4810 A B<Database> block defines one connection to a MySQL database. It accepts a
4811 single argument which specifies the name of the database. None of the other
4812 options are required. MySQL will use default values as documented in the
4813 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4814 B<MySQL reference manual>.
4818 =item B<Alias> I<Alias>
4820 Alias to use as sender instead of hostname when reporting. This may be useful
4821 when having cryptic hostnames.
4823 =item B<Host> I<Hostname>
4825 Hostname of the database server. Defaults to B<localhost>.
4827 =item B<User> I<Username>
4829 Username to use when connecting to the database. The user does not have to be
4830 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4831 unless you want to collectd replication statistics (see B<MasterStats> and
4832 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4833 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4835 =item B<Password> I<Password>
4837 Password needed to log into the database.
4839 =item B<Database> I<Database>
4841 Select this database. Defaults to I<no database> which is a perfectly reasonable
4842 option for what this plugin does.
4844 =item B<Port> I<Port>
4846 TCP-port to connect to. The port must be specified in its numeric form, but it
4847 must be passed as a string nonetheless. For example:
4851 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4852 See the documentation for the C<mysql_real_connect> function for details.
4854 =item B<Socket> I<Socket>
4856 Specifies the path to the UNIX domain socket of the MySQL server. This option
4857 only has any effect, if B<Host> is set to B<localhost> (the default).
4858 Otherwise, use the B<Port> option above. See the documentation for the
4859 C<mysql_real_connect> function for details.
4861 =item B<InnodbStats> I<true|false>
4863 If enabled, metrics about the InnoDB storage engine are collected.
4864 Disabled by default.
4866 =item B<MasterStats> I<true|false>
4868 =item B<SlaveStats> I<true|false>
4870 Enable the collection of master / slave statistics in a replication setup. In
4871 order to be able to get access to these statistics, the user needs special
4872 privileges. See the B<User> documentation above. Defaults to B<false>.
4874 =item B<SlaveNotifications> I<true|false>
4876 If enabled, the plugin sends a notification if the replication slave I/O and /
4877 or SQL threads are not running. Defaults to B<false>.
4879 =item B<WsrepStats> I<true|false>
4881 Enable the collection of wsrep plugin statistics, used in Master-Master
4882 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4883 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4885 =item B<ConnectTimeout> I<Seconds>
4887 Sets the connect timeout for the MySQL client.
4889 =item B<SSLKey> I<Path>
4891 If provided, the X509 key in PEM format.
4893 =item B<SSLCert> I<Path>
4895 If provided, the X509 cert in PEM format.
4897 =item B<SSLCA> I<Path>
4899 If provided, the CA file in PEM format (check OpenSSL docs).
4901 =item B<SSLCAPath> I<Path>
4903 If provided, the CA directory (check OpenSSL docs).
4905 =item B<SSLCipher> I<String>
4907 If provided, the SSL cipher to use.
4911 =head2 Plugin C<netapp>
4913 The netapp plugin can collect various performance and capacity information
4914 from a NetApp filer using the NetApp API.
4916 Please note that NetApp has a wide line of products and a lot of different
4917 software versions for each of these products. This plugin was developed for a
4918 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4919 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4920 model and software version but it is very hard to test this.
4921 If you have used this plugin with other models and/or software version, feel
4922 free to send us a mail to tell us about the results, even if it's just a short
4925 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4926 basic authentication.
4928 B<Do not use a regular user for this!> Create a special collectd user with just
4929 the minimum of capabilities needed. The user only needs the "login-http-admin"
4930 capability as well as a few more depending on which data will be collected.
4931 Required capabilities are documented below.
4936 <Host "netapp1.example.com">
4960 IgnoreSelectedIO false
4962 IgnoreSelectedOps false
4963 GetLatency "volume0"
4964 IgnoreSelectedLatency false
4971 IgnoreSelectedCapacity false
4974 IgnoreSelectedSnapshot false
5002 The netapp plugin accepts the following configuration options:
5006 =item B<Host> I<Name>
5008 A host block defines one NetApp filer. It will appear in collectd with the name
5009 you specify here which does not have to be its real name nor its hostname (see
5010 the B<Address> option below).
5012 =item B<VFiler> I<Name>
5014 A B<VFiler> block may only be used inside a host block. It accepts all the
5015 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
5016 will execute all NetApp API commands in the context of the specified
5017 VFiler(R). It will appear in collectd with the name you specify here which
5018 does not have to be its real name. The VFiler name may be specified using the
5019 B<VFilerName> option. If this is not specified, it will default to the name
5022 The VFiler block inherits all connection related settings from the surrounding
5023 B<Host> block (which appear before the B<VFiler> block) but they may be
5024 overwritten inside the B<VFiler> block.
5026 This feature is useful, for example, when using a VFiler as SnapVault target
5027 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
5028 available in the host filer (vfiler0) but only in the respective VFiler
5031 =item B<Protocol> B<httpd>|B<http>
5033 The protocol collectd will use to query this host.
5041 Valid options: http, https
5043 =item B<Address> I<Address>
5045 The hostname or IP address of the host.
5051 Default: The "host" block's name.
5053 =item B<Port> I<Port>
5055 The TCP port to connect to on the host.
5061 Default: 80 for protocol "http", 443 for protocol "https"
5063 =item B<User> I<User>
5065 =item B<Password> I<Password>
5067 The username and password to use to login to the NetApp.
5073 =item B<VFilerName> I<Name>
5075 The name of the VFiler in which context to execute API commands. If not
5076 specified, the name provided to the B<VFiler> block will be used instead.
5082 Default: name of the B<VFiler> block
5084 B<Note:> This option may only be used inside B<VFiler> blocks.
5086 =item B<Interval> I<Interval>
5092 The following options decide what kind of data will be collected. You can
5093 either use them as a block and fine tune various parameters inside this block,
5094 use them as a single statement to just accept all default values, or omit it to
5095 not collect any data.
5097 The following options are valid inside all blocks:
5101 =item B<Interval> I<Seconds>
5103 Collect the respective statistics every I<Seconds> seconds. Defaults to the
5104 host specific setting.
5108 =head3 The System block
5110 This will collect various performance data about the whole system.
5112 B<Note:> To get this data the collectd user needs the
5113 "api-perf-object-get-instances" capability.
5117 =item B<Interval> I<Seconds>
5119 Collect disk statistics every I<Seconds> seconds.
5121 =item B<GetCPULoad> B<true>|B<false>
5123 If you set this option to true the current CPU usage will be read. This will be
5124 the average usage between all CPUs in your NetApp without any information about
5127 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5128 returns in the "CPU" field.
5136 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5138 =item B<GetInterfaces> B<true>|B<false>
5140 If you set this option to true the current traffic of the network interfaces
5141 will be read. This will be the total traffic over all interfaces of your NetApp
5142 without any information about individual interfaces.
5144 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5145 in the "Net kB/s" field.
5155 Result: One value list of type "if_octects".
5157 =item B<GetDiskIO> B<true>|B<false>
5159 If you set this option to true the current IO throughput will be read. This
5160 will be the total IO of your NetApp without any information about individual
5161 disks, volumes or aggregates.
5163 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5164 in the "DiskE<nbsp>kB/s" field.
5172 Result: One value list of type "disk_octets".
5174 =item B<GetDiskOps> B<true>|B<false>
5176 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5177 iSCSI, etc. operations will be read. This will be the total number of
5178 operations on your NetApp without any information about individual volumes or
5181 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5182 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5190 Result: A variable number of value lists of type "disk_ops_complex". Each type
5191 of operation will result in one value list with the name of the operation as
5196 =head3 The WAFL block
5198 This will collect various performance data about the WAFL file system. At the
5199 moment this just means cache performance.
5201 B<Note:> To get this data the collectd user needs the
5202 "api-perf-object-get-instances" capability.
5204 B<Note:> The interface to get these values is classified as "Diagnostics" by
5205 NetApp. This means that it is not guaranteed to be stable even between minor
5210 =item B<Interval> I<Seconds>
5212 Collect disk statistics every I<Seconds> seconds.
5214 =item B<GetNameCache> B<true>|B<false>
5222 Result: One value list of type "cache_ratio" and type instance
5225 =item B<GetDirCache> B<true>|B<false>
5233 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5235 =item B<GetInodeCache> B<true>|B<false>
5243 Result: One value list of type "cache_ratio" and type instance
5246 =item B<GetBufferCache> B<true>|B<false>
5248 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5249 in the "Cache hit" field.
5257 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5261 =head3 The Disks block
5263 This will collect performance data about the individual disks in the NetApp.
5265 B<Note:> To get this data the collectd user needs the
5266 "api-perf-object-get-instances" capability.
5270 =item B<Interval> I<Seconds>
5272 Collect disk statistics every I<Seconds> seconds.
5274 =item B<GetBusy> B<true>|B<false>
5276 If you set this option to true the busy time of all disks will be calculated
5277 and the value of the busiest disk in the system will be written.
5279 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5280 in the "Disk util" field. Probably.
5288 Result: One value list of type "percent" and type instance "disk_busy".
5292 =head3 The VolumePerf block
5294 This will collect various performance data about the individual volumes.
5296 You can select which data to collect about which volume using the following
5297 options. They follow the standard ignorelist semantic.
5299 B<Note:> To get this data the collectd user needs the
5300 I<api-perf-object-get-instances> capability.
5304 =item B<Interval> I<Seconds>
5306 Collect volume performance data every I<Seconds> seconds.
5308 =item B<GetIO> I<Volume>
5310 =item B<GetOps> I<Volume>
5312 =item B<GetLatency> I<Volume>
5314 Select the given volume for IO, operations or latency statistics collection.
5315 The argument is the name of the volume without the C</vol/> prefix.
5317 Since the standard ignorelist functionality is used here, you can use a string
5318 starting and ending with a slash to specify regular expression matching: To
5319 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5322 GetIO "/^vol[027]$/"
5324 If no regular expression is specified, an exact match is required. Both,
5325 regular and exact matching are case sensitive.
5327 If no volume was specified at all for either of the three options, that data
5328 will be collected for all available volumes.
5330 See F</"IGNORELISTS"> for details.
5332 =item B<IgnoreSelectedIO> B<true>|B<false>
5334 =item B<IgnoreSelectedOps> B<true>|B<false>
5336 =item B<IgnoreSelectedLatency> B<true>|B<false>
5338 When set to B<true>, the volumes selected for IO, operations or latency
5339 statistics collection will be ignored and the data will be collected for all
5342 When set to B<false>, data will only be collected for the specified volumes and
5343 all other volumes will be ignored.
5345 If no volumes have been specified with the above B<Get*> options, all volumes
5346 will be collected regardless of the B<IgnoreSelected*> option.
5348 Defaults to B<false>
5352 =head3 The VolumeUsage block
5354 This will collect capacity data about the individual volumes.
5356 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5361 =item B<Interval> I<Seconds>
5363 Collect volume usage statistics every I<Seconds> seconds.
5365 =item B<GetCapacity> I<VolumeName>
5367 The current capacity of the volume will be collected. This will result in two
5368 to four value lists, depending on the configuration of the volume. All data
5369 sources are of type "df_complex" with the name of the volume as
5372 There will be type_instances "used" and "free" for the number of used and
5373 available bytes on the volume. If the volume has some space reserved for
5374 snapshots, a type_instance "snap_reserved" will be available. If the volume
5375 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5376 number of bytes saved by the SIS feature.
5378 B<Note:> The current NetApp API has a bug that results in this value being
5379 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5380 number which works most of the time. If you see strange values here, bug
5381 NetApp support to fix this.
5383 Repeat this option to specify multiple volumes.
5385 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5387 Specify whether to collect only the volumes selected by the B<GetCapacity>
5388 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5389 B<false>. However, if no B<GetCapacity> option is specified at all, all
5390 capacities will be selected anyway.
5392 =item B<GetSnapshot> I<VolumeName>
5394 Select volumes from which to collect snapshot information.
5396 Usually, the space used for snapshots is included in the space reported as
5397 "used". If snapshot information is collected as well, the space used for
5398 snapshots is subtracted from the used space.
5400 To make things even more interesting, it is possible to reserve space to be
5401 used for snapshots. If the space required for snapshots is less than that
5402 reserved space, there is "reserved free" and "reserved used" space in addition
5403 to "free" and "used". If the space required for snapshots exceeds the reserved
5404 space, that part allocated in the normal space is subtracted from the "used"
5407 Repeat this option to specify multiple volumes.
5409 =item B<IgnoreSelectedSnapshot>
5411 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5412 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5413 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5414 capacities will be selected anyway.
5418 =head3 The Quota block
5420 This will collect (tree) quota statistics (used disk space and number of used
5421 files). This mechanism is useful to get usage information for single qtrees.
5422 In case the quotas are not used for any other purpose, an entry similar to the
5423 following in C</etc/quotas> would be sufficient:
5425 /vol/volA/some_qtree tree - - - - -
5427 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5431 =item B<Interval> I<Seconds>
5433 Collect SnapVault(R) statistics every I<Seconds> seconds.
5437 =head3 The SnapVault block
5439 This will collect statistics about the time and traffic of SnapVault(R)
5444 =item B<Interval> I<Seconds>
5446 Collect SnapVault(R) statistics every I<Seconds> seconds.
5450 =head2 Plugin C<netlink>
5452 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5453 statistics of various interface and routing aspects.
5457 =item B<Interface> I<Interface>
5459 =item B<VerboseInterface> I<Interface>
5461 Instruct the plugin to collect interface statistics. This is basically the same
5462 as the statistics provided by the C<interface> plugin (see above) but
5463 potentially much more detailed.
5465 When configuring with B<Interface> only the basic statistics will be collected,
5466 namely octets, packets, and errors. These statistics are collected by
5467 the C<interface> plugin, too, so using both at the same time is no benefit.
5469 When configured with B<VerboseInterface> all counters B<except> the basic ones
5470 will be collected, so that no data needs to be collected twice if you use the
5471 C<interface> plugin.
5472 This includes dropped packets, received multicast packets, collisions and a
5473 whole zoo of differentiated RX and TX errors. You can try the following command
5474 to get an idea of what awaits you:
5478 If I<Interface> is B<All>, all interfaces will be selected.
5480 =item B<QDisc> I<Interface> [I<QDisc>]
5482 =item B<Class> I<Interface> [I<Class>]
5484 =item B<Filter> I<Interface> [I<Filter>]
5486 Collect the octets and packets that pass a certain qdisc, class or filter.
5488 QDiscs and classes are identified by their type and handle (or classid).
5489 Filters don't necessarily have a handle, therefore the parent's handle is used.
5490 The notation used in collectd differs from that used in tc(1) in that it
5491 doesn't skip the major or minor number if it's zero and doesn't print special
5492 ids by their name. So, for example, a qdisc may be identified by
5493 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5494 thus not displayed by tc(1).
5496 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5497 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5498 associated with that interface will be collected.
5500 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5501 used. This may lead to problems when more than one filter is attached to a
5502 qdisc or class. This isn't nice, but we don't know how this could be done any
5503 better. If you have a idea, please don't hesitate to tell us.
5505 As with the B<Interface> option you can specify B<All> as the interface,
5506 meaning all interfaces.
5508 Here are some examples to help you understand the above text more easily:
5511 VerboseInterface "All"
5512 QDisc "eth0" "pfifo_fast-1:0"
5514 Class "ppp0" "htb-1:10"
5515 Filter "ppp0" "u32-1:0"
5518 See F</"IGNORELISTS"> for details.
5520 =item B<IgnoreSelected>
5522 The behavior is the same as with all other similar plugins: If nothing is
5523 selected at all, everything is collected. If some things are selected using the
5524 options described above, only these statistics are collected. If you set
5525 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5526 specified statistics will not be collected.
5530 =head2 Plugin C<network>
5532 The Network plugin sends data to a remote instance of collectd, receives data
5533 from a remote instance, or both at the same time. Data which has been received
5534 from the network is usually not transmitted again, but this can be activated, see
5535 the B<Forward> option below.
5537 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5538 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5540 Both, B<Server> and B<Listen> can be used as single option or as block. When
5541 used as block, given options are valid for this socket only. The following
5542 example will export the metrics twice: Once to an "internal" server (without
5543 encryption and signing) and one to an external server (with cryptographic
5547 # Export to an internal server
5548 # (demonstrates usage without additional options)
5549 Server "collectd.internal.tld"
5551 # Export to an external server
5552 # (demonstrates usage with signature options)
5553 <Server "collectd.external.tld">
5554 SecurityLevel "sign"
5555 Username "myhostname"
5562 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5564 The B<Server> statement/block sets the server to send datagrams to. The
5565 statement may occur multiple times to send each datagram to multiple
5568 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5569 optional second argument specifies a port number or a service name. If not
5570 given, the default, B<25826>, is used.
5572 The following options are recognized within B<Server> blocks:
5576 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5578 Set the security you require for network communication. When the security level
5579 has been set to B<Encrypt>, data sent over the network will be encrypted using
5580 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5581 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5582 authentication code. When set to B<None>, data is sent without any security.
5584 This feature is only available if the I<network> plugin was linked with
5587 =item B<Username> I<Username>
5589 Sets the username to transmit. This is used by the server to lookup the
5590 password. See B<AuthFile> below. All security levels except B<None> require
5593 This feature is only available if the I<network> plugin was linked with
5596 =item B<Password> I<Password>
5598 Sets a password (shared secret) for this socket. All security levels except
5599 B<None> require this setting.
5601 This feature is only available if the I<network> plugin was linked with
5604 =item B<Interface> I<Interface name>
5606 Set the outgoing interface for IP packets. This applies at least
5607 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5608 undefined or a non-existent interface name is specified, the default
5609 behavior is to let the kernel choose the appropriate interface. Be warned
5610 that the manual selection of an interface for unicast traffic is only
5611 necessary in rare cases.
5613 =item B<BindAddress> I<IP Address>
5615 Set the outgoing IP address for IP packets. This option can be used instead of
5616 the I<Interface> option to explicitly define the IP address which will be used
5617 to send Packets to the remote server.
5619 =item B<ResolveInterval> I<Seconds>
5621 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5622 useful to force a regular DNS lookup to support a high availability setup. If
5623 not specified, re-resolves are never attempted.
5627 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5629 The B<Listen> statement sets the interfaces to bind to. When multiple
5630 statements are found the daemon will bind to multiple interfaces.
5632 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5633 the argument is a multicast address the daemon will join that multicast group.
5634 The optional second argument specifies a port number or a service name. If not
5635 given, the default, B<25826>, is used.
5637 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5641 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5643 Set the security you require for network communication. When the security level
5644 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5645 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5646 signed and encrypted data is accepted. When set to B<None>, all data will be
5647 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5648 decrypted if possible.
5650 This feature is only available if the I<network> plugin was linked with
5653 =item B<AuthFile> I<Filename>
5655 Sets a file in which usernames are mapped to passwords. These passwords are
5656 used to verify signatures and to decrypt encrypted network packets. If
5657 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5658 verified and encrypted packets are decrypted. Otherwise, signed data is
5659 accepted without checking the signature and encrypted data cannot be decrypted.
5660 For the other security levels this option is mandatory.
5662 The file format is very simple: Each line consists of a username followed by a
5663 colon and any number of spaces followed by the password. To demonstrate, an
5664 example file could look like this:
5669 Each time a packet is received, the modification time of the file is checked
5670 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5671 the file is being read, it is locked using L<fcntl(2)>.
5673 =item B<Interface> I<Interface name>
5675 Set the incoming interface for IP packets explicitly. This applies at least
5676 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5677 undefined or a non-existent interface name is specified, the default
5678 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5679 traffic gets only accepted, if it arrives on the given interface.
5683 =item B<TimeToLive> I<1-255>
5685 Set the time-to-live of sent packets. This applies to all, unicast and
5686 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5687 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5690 =item B<MaxPacketSize> I<1024-65535>
5692 Set the maximum size for datagrams received over the network. Packets larger
5693 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5694 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5697 On the server side, this limit should be set to the largest value used on
5698 I<any> client. Likewise, the value on the client must not be larger than the
5699 value on the server, or data will be lost.
5701 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5702 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5703 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5706 =item B<Forward> I<true|false>
5708 If set to I<true>, write packets that were received via the network plugin to
5709 the sending sockets. This should only be activated when the B<Listen>- and
5710 B<Server>-statements differ. Otherwise packets may be send multiple times to
5711 the same multicast group. While this results in more network traffic than
5712 necessary it's not a huge problem since the plugin has a duplicate detection,
5713 so the values will not loop.
5715 =item B<ReportStats> B<true>|B<false>
5717 The network plugin cannot only receive and send statistics, it can also create
5718 statistics about itself. Collectd data included the number of received and
5719 sent octets and packets, the length of the receive queue and the number of
5720 values handled. When set to B<true>, the I<Network plugin> will make these
5721 statistics available. Defaults to B<false>.
5725 =head2 Plugin C<nfs>
5727 The I<nfs plugin> collects information about the usage of the Network File
5728 System (NFS). It counts the number of procedure calls for each procedure,
5729 grouped by version and whether the system runs as server or client.
5731 It is possibly to omit metrics for a specific NFS version by setting one or
5732 more of the following options to B<false> (all of them default to B<true>).
5736 =item B<ReportV2> B<true>|B<false>
5738 =item B<ReportV3> B<true>|B<false>
5740 =item B<ReportV4> B<true>|B<false>
5744 =head2 Plugin C<nginx>
5746 This plugin collects the number of connections and requests handled by the
5747 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5748 queries the page provided by the C<ngx_http_stub_status_module> module, which
5749 isn't compiled by default. Please refer to
5750 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5751 how to compile and configure nginx and this module.
5753 The following options are accepted by the C<nginx plugin>:
5757 =item B<URL> I<http://host/nginx_status>
5759 Sets the URL of the C<ngx_http_stub_status_module> output.
5761 =item B<User> I<Username>
5763 Optional user name needed for authentication.
5765 =item B<Password> I<Password>
5767 Optional password needed for authentication.
5769 =item B<VerifyPeer> B<true|false>
5771 Enable or disable peer SSL certificate verification. See
5772 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5774 =item B<VerifyHost> B<true|false>
5776 Enable or disable peer host name verification. If enabled, the plugin checks
5777 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5778 certificate matches the host name provided by the B<URL> option. If this
5779 identity check fails, the connection is aborted. Obviously, only works when
5780 connecting to a SSL enabled server. Enabled by default.
5782 =item B<CACert> I<File>
5784 File that holds one or more SSL certificates. If you want to use HTTPS you will
5785 possibly need this option. What CA certificates come bundled with C<libcurl>
5786 and are checked by default depends on the distribution you use.
5788 =item B<Timeout> I<Milliseconds>
5790 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5791 milliseconds. By default, the configured B<Interval> is used to set the
5796 =head2 Plugin C<notify_desktop>
5798 This plugin sends a desktop notification to a notification daemon, as defined
5799 in the Desktop Notification Specification. To actually display the
5800 notifications, B<notification-daemon> is required and B<collectd> has to be
5801 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5802 environment variables have to be set correctly) and the D-Bus message bus.
5804 The Desktop Notification Specification can be found at
5805 L<http://www.galago-project.org/specs/notification/>.
5809 =item B<OkayTimeout> I<timeout>
5811 =item B<WarningTimeout> I<timeout>
5813 =item B<FailureTimeout> I<timeout>
5815 Set the I<timeout>, in milliseconds, after which to expire the notification
5816 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5817 been specified, the displayed notification will not be closed at all - the
5818 user has to do so herself. These options default to 5000. If a negative number
5819 has been specified, the default is used as well.
5823 =head2 Plugin C<notify_email>
5825 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5826 configured email address.
5828 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5830 Available configuration options:
5834 =item B<From> I<Address>
5836 Email address from which the emails should appear to come from.
5838 Default: C<root@localhost>
5840 =item B<Recipient> I<Address>
5842 Configures the email address(es) to which the notifications should be mailed.
5843 May be repeated to send notifications to multiple addresses.
5845 At least one B<Recipient> must be present for the plugin to work correctly.
5847 =item B<SMTPServer> I<Hostname>
5849 Hostname of the SMTP server to connect to.
5851 Default: C<localhost>
5853 =item B<SMTPPort> I<Port>
5855 TCP port to connect to.
5859 =item B<SMTPUser> I<Username>
5861 Username for ASMTP authentication. Optional.
5863 =item B<SMTPPassword> I<Password>
5865 Password for ASMTP authentication. Optional.
5867 =item B<Subject> I<Subject>
5869 Subject-template to use when sending emails. There must be exactly two
5870 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5871 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5874 Default: C<Collectd notify: %s@%s>
5878 =head2 Plugin C<notify_nagios>
5880 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5881 a I<passive service check result>.
5883 Available configuration options:
5887 =item B<CommandFile> I<Path>
5889 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5893 =head2 Plugin C<ntpd>
5895 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5898 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5899 the wire - using B<mode 7> specific requests. This mode is deprecated with
5900 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5901 correctly with them, the ntp daemon must be explicitly configured to
5902 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5903 manual page for details.
5905 Available configuration options for the C<ntpd> plugin:
5909 =item B<Host> I<Hostname>
5911 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5913 =item B<Port> I<Port>
5915 UDP-Port to connect to. Defaults to B<123>.
5917 =item B<ReverseLookups> B<true>|B<false>
5919 Sets whether or not to perform reverse lookups on peers. Since the name or
5920 IP-address may be used in a filename it is recommended to disable reverse
5921 lookups. The default is to do reverse lookups to preserve backwards
5922 compatibility, though.
5924 =item B<IncludeUnitID> B<true>|B<false>
5926 When a peer is a refclock, include the unit ID in the I<type instance>.
5927 Defaults to B<false> for backward compatibility.
5929 If two refclock peers use the same driver and this is B<false>, the plugin will
5930 try to write simultaneous measurements from both to the same type instance.
5931 This will result in error messages in the log and only one set of measurements
5936 =head2 Plugin C<nut>
5940 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5942 Add a UPS to collect data from. The format is identical to the one accepted by
5945 =item B<ForceSSL> B<true>|B<false>
5947 Stops connections from falling back to unsecured if an SSL connection
5948 cannot be established. Defaults to false if undeclared.
5950 =item B<VerifyPeer> I<true>|I<false>
5952 If set to true, requires a CAPath be provided. Will use the CAPath to find
5953 certificates to use as Trusted Certificates to validate a upsd server certificate.
5954 If validation of the upsd server certificate fails, the connection will not be
5955 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5956 will override and set ForceSSL to true.
5958 =item B<CAPath> I/path/to/certs/folder
5960 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5961 The folder pointed at must contain certificate(s) named according to their hash.
5962 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5963 occur because two different certs have the same hash value, Y can be incremented
5964 in order to avoid conflict. To create a symbolic link to a certificate the following
5965 command can be used from within the directory where the cert resides:
5967 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5969 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5970 generate links like the one described above for ALL certs in a given folder.
5972 C<c_rehash /path/to/certs/folder>
5974 =item B<ConnectTimeout> I<Milliseconds>
5976 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5977 By default, the configured B<Interval> is used to set the timeout.
5981 =head2 Plugin C<olsrd>
5983 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5984 the Optimized Link State Routing daemon and reads information about the current
5985 state of the meshed network.
5987 The following configuration options are understood:
5991 =item B<Host> I<Host>
5993 Connect to I<Host>. Defaults to B<"localhost">.
5995 =item B<Port> I<Port>
5997 Specifies the port to connect to. This must be a string, even if you give the
5998 port as a number rather than a service name. Defaults to B<"2006">.
6000 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
6002 Specifies what information to collect about links, i.E<nbsp>e. direct
6003 connections of the daemon queried. If set to B<No>, no information is
6004 collected. If set to B<Summary>, the number of links and the average of all
6005 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
6006 If set to B<Detail> LQ and NLQ are collected per link.
6008 Defaults to B<Detail>.
6010 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
6012 Specifies what information to collect about routes of the daemon queried. If
6013 set to B<No>, no information is collected. If set to B<Summary>, the number of
6014 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
6015 metric and ETX are collected per route.
6017 Defaults to B<Summary>.
6019 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
6021 Specifies what information to collect about the global topology. If set to
6022 B<No>, no information is collected. If set to B<Summary>, the number of links
6023 in the entire topology and the average I<link quality> (LQ) is calculated.
6024 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
6026 Defaults to B<Summary>.
6030 =head2 Plugin C<onewire>
6032 B<EXPERIMENTAL!> See notes below.
6034 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
6035 L<http://owfs.org/> to read sensors connected via the onewire bus.
6037 It can be used in two possible modes - standard or advanced.
6039 In the standard mode only temperature sensors (sensors with the family code
6040 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
6041 other sensors you would like to have included, please send a sort request to
6042 the mailing list. You can select sensors to be read or to be ignored depending
6043 on the option B<IgnoreSelected>). When no list is provided the whole bus is
6044 walked and all sensors are read.
6046 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
6047 experimental, below.
6049 In the advanced mode you can configure any sensor to be read (only numerical
6050 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
6051 In this mode you have to list all the sensors. Neither default bus walk nor
6052 B<IgnoreSelected> are used here. Address and type (file) is extracted from
6053 the path automatically and should produce compatible structure with the "standard"
6054 mode (basically the path is expected as for example
6055 "/uncached/10.F10FCA000800/temperature" where it would extract address part
6056 "F10FCA000800" and the rest after the slash is considered the type - here
6058 There are two advantages to this mode - you can access virtually any sensor
6059 (not just temperature), select whether to use cached or directly read values
6060 and it is slighlty faster. The downside is more complex configuration.
6062 The two modes are distinguished automatically by the format of the address.
6063 It is not possible to mix the two modes. Once a full path is detected in any
6064 B<Sensor> then the whole addressing (all sensors) is considered to be this way
6065 (and as standard addresses will fail parsing they will be ignored).
6069 =item B<Device> I<Device>
6071 Sets the device to read the values from. This can either be a "real" hardware
6072 device, such as a serial port or an USB port, or the address of the
6073 L<owserver(1)> socket, usually B<localhost:4304>.
6075 Though the documentation claims to automatically recognize the given address
6076 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
6077 with that version, the following configuration worked for us:
6080 Device "-s localhost:4304"
6083 This directive is B<required> and does not have a default value.
6085 =item B<Sensor> I<Sensor>
6087 In the standard mode selects sensors to collect or to ignore
6088 (depending on B<IgnoreSelected>, see below). Sensors are specified without
6089 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
6090 and B<not> include the leading C<10.> family byte and point.
6091 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
6092 sensors (see above) are read.
6094 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
6095 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
6096 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
6098 As there can be multiple devices on the bus you can list multiple sensor (use
6099 multiple B<Sensor> elements).
6101 See F</"IGNORELISTS"> for details.
6103 =item B<IgnoreSelected> I<true>|I<false>
6105 If no configuration is given, the B<onewire> plugin will collect data from all
6106 sensors found. This may not be practical, especially if sensors are added and
6107 removed regularly. Sometimes, however, it's easier/preferred to collect only
6108 specific sensors or all sensors I<except> a few specified ones. This option
6109 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
6110 B<Sensor> is inverted: All selected interfaces are ignored and all other
6111 interfaces are collected.
6113 Used only in the standard mode - see above.
6115 =item B<Interval> I<Seconds>
6117 Sets the interval in which all sensors should be read. If not specified, the
6118 global B<Interval> setting is used.
6122 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
6123 work with big setups. It works with one sensor being attached to one
6124 controller, but as soon as you throw in a couple more senors and maybe a hub
6125 or two, reading all values will take more than ten seconds (the default
6126 interval). We will probably add some separate thread for reading the sensors
6127 and some cache or something like that, but it's not done yet. We will try to
6128 maintain backwards compatibility in the future, but we can't promise. So in
6129 short: If it works for you: Great! But keep in mind that the config I<might>
6130 change, though this is unlikely. Oh, and if you want to help improving this
6131 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
6133 =head2 Plugin C<openldap>
6135 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
6136 server correctly. The backend database C<monitor> needs to be loaded and
6137 working. See slapd-monitor(5) for the details.
6139 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6140 blocks. Each block requires one string argument as the instance name. For
6145 URL "ldap://localhost/"
6148 URL "ldaps://localhost/"
6152 The instance name will be used as the I<plugin instance>. To emulate the old
6153 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6154 plugin to work correctly, each instance name must be unique. This is not
6155 enforced by the plugin and it is your responsibility to ensure it is.
6157 The following options are accepted within each B<Instance> block:
6161 =item B<URL> I<ldap://host/binddn>
6163 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6166 =item B<BindDN> I<BindDN>
6168 Name in the form of an LDAP distinguished name intended to be used for
6169 authentication. Defaults to empty string to establish an anonymous authorization.
6171 =item B<Password> I<Password>
6173 Password for simple bind authentication. If this option is not set,
6174 unauthenticated bind operation is used.
6176 =item B<StartTLS> B<true|false>
6178 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6179 Disabled by default.
6181 =item B<VerifyHost> B<true|false>
6183 Enables or disables peer host name verification. If enabled, the plugin checks
6184 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6185 certificate matches the host name provided by the B<URL> option. If this
6186 identity check fails, the connection is aborted. Enabled by default.
6188 =item B<CACert> I<File>
6190 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6191 may possibly need this option. What CA certificates are checked by default
6192 depends on the distribution you use and can be changed with the usual ldap
6193 client configuration mechanisms. See ldap.conf(5) for the details.
6195 =item B<Timeout> I<Seconds>
6197 Sets the timeout value for ldap operations, in seconds. By default, the
6198 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6201 =item B<Version> I<Version>
6203 An integer which sets the LDAP protocol version number to use when connecting
6204 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6208 =head2 Plugin C<openvpn>
6210 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6211 traffic statistics about connected clients.
6213 To set up OpenVPN to write to the status file periodically, use the
6214 B<--status> option of OpenVPN.
6216 So, in a nutshell you need:
6218 openvpn $OTHER_OPTIONS \
6219 --status "/var/run/openvpn-status" 10
6225 =item B<StatusFile> I<File>
6227 Specifies the location of the status file.
6229 =item B<ImprovedNamingSchema> B<true>|B<false>
6231 When enabled, the filename of the status file will be used as plugin instance
6232 and the client's "common name" will be used as type instance. This is required
6233 when reading multiple status files. Enabling this option is recommended, but to
6234 maintain backwards compatibility this option is disabled by default.
6236 =item B<CollectCompression> B<true>|B<false>
6238 Sets whether or not statistics about the compression used by OpenVPN should be
6239 collected. This information is only available in I<single> mode. Enabled by
6242 =item B<CollectIndividualUsers> B<true>|B<false>
6244 Sets whether or not traffic information is collected for each connected client
6245 individually. If set to false, currently no traffic data is collected at all
6246 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6248 =item B<CollectUserCount> B<true>|B<false>
6250 When enabled, the number of currently connected clients or users is collected.
6251 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6252 can be configured independently from that option. Defaults to B<false>.
6256 =head2 Plugin C<oracle>
6258 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6259 Oracle® Database and lets you execute SQL statements there. It is very similar
6260 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6261 plugin's documentation above for details.
6264 <Query "out_of_stock">
6265 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6268 # InstancePrefix "foo"
6269 InstancesFrom "category"
6273 <Database "product_information">
6278 Query "out_of_stock"
6282 =head3 B<Query> blocks
6284 The Query blocks are handled identically to the Query blocks of the "dbi"
6285 plugin. Please see its documentation above for details on how to specify
6288 =head3 B<Database> blocks
6290 Database blocks define a connection to a database and which queries should be
6291 sent to that database. Each database needs a "name" as string argument in the
6292 starting tag of the block. This name will be used as "PluginInstance" in the
6293 values submitted to the daemon. Other than that, that name is not used.
6297 =item B<Plugin> I<Plugin>
6299 Use I<Plugin> as the plugin name when submitting query results from
6300 this B<Database>. Defaults to C<oracle>.
6302 =item B<ConnectID> I<ID>
6304 Defines the "database alias" or "service name" to connect to. Usually, these
6305 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6307 =item B<Host> I<Host>
6309 Hostname to use when dispatching values for this database. Defaults to using
6310 the global hostname of the I<collectd> instance.
6312 =item B<Username> I<Username>
6314 Username used for authentication.
6316 =item B<Password> I<Password>
6318 Password used for authentication.
6320 =item B<Query> I<QueryName>
6322 Associates the query named I<QueryName> with this database connection. The
6323 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6324 blocks you want to refer to must be placed above the database block you want to
6329 =head2 Plugin C<ovs_events>
6331 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6332 connected interfaces, dispatches the values to collectd and sends the
6333 notification whenever the link state change occurs. This plugin uses OVS
6334 database to get a link state change notification.
6338 <Plugin "ovs_events">
6341 Socket "/var/run/openvswitch/db.sock"
6342 Interfaces "br0" "veth0"
6343 SendNotification true
6344 DispatchValues false
6347 The plugin provides the following configuration options:
6351 =item B<Address> I<node>
6353 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6354 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6355 option. See L<ovsdb-server(1)> for more details. The option may be either
6356 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6357 format. Defaults to C<localhost>.
6359 =item B<Port> I<service>
6361 TCP-port to connect to. Either a service name or a port number may be given.
6362 Defaults to B<6640>.
6364 =item B<Socket> I<path>
6366 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6367 plugin. To enable the interface, the OVS DB daemon should be running with
6368 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6369 option is set, B<Address> and B<Port> options are ignored.
6371 =item B<Interfaces> [I<ifname> ...]
6373 List of interface names to be monitored by this plugin. If this option is not
6374 specified or is empty then all OVS connected interfaces on all bridges are
6377 Default: empty (all interfaces on all bridges are monitored)
6379 =item B<SendNotification> I<true|false>
6381 If set to true, OVS link notifications (interface status and OVS DB connection
6382 terminate) are sent to collectd. Default value is true.
6384 =item B<DispatchValues> I<true|false>
6386 Dispatch the OVS DB interface link status value with configured plugin interval.
6387 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6388 options are false, no OVS information will be provided by the plugin.
6392 B<Note:> By default, the global interval setting is used within which to
6393 retrieve the OVS link status. To configure a plugin-specific interval, please
6394 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6395 simple divide the time by 1000 for example if the desired interval is 50ms, set
6398 =head2 Plugin C<ovs_stats>
6400 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6401 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6402 statistics from OVSDB
6406 <Plugin "ovs_stats">
6409 Socket "/var/run/openvswitch/db.sock"
6410 Bridges "br0" "br_ext"
6411 InterfaceStats false
6414 The plugin provides the following configuration options:
6418 =item B<Address> I<node>
6420 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6421 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6422 option. See L<ovsdb-server(1)> for more details. The option may be either
6423 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6424 format. Defaults to C<localhost>.
6426 =item B<Port> I<service>
6428 TCP-port to connect to. Either a service name or a port number may be given.
6429 Defaults to B<6640>.
6431 =item B<Socket> I<path>
6433 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6434 plugin. To enable the interface, the OVS DB daemon should be running with
6435 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6436 option is set, B<Address> and B<Port> options are ignored.
6438 =item B<Bridges> [I<brname> ...]
6440 List of OVS bridge names to be monitored by this plugin. If this option is
6441 omitted or is empty then all OVS bridges will be monitored.
6443 Default: empty (monitor all bridges)
6445 =item B<InterfaceStats> B<false>|B<true>
6447 Indicates that the plugin should gather statistics for individual interfaces
6448 in addition to ports. This can be useful when monitoring an OVS setup with
6449 bond ports, where you might wish to know individual statistics for the
6450 interfaces included in the bonds. Defaults to B<false>.
6454 =head2 Plugin C<pcie_errors>
6456 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6457 structure and from Advanced Error Reporting Extended Capability where available.
6458 At every read it polls config space of PCI Express devices and dispatches
6459 notification for every error that is set. It checks for new errors at every read.
6460 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6461 Errors are divided into categories indicated by type_instance: "correctable", and
6462 for uncorrectable errors "non_fatal" or "fatal".
6463 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6467 <Plugin "pcie_errors">
6469 AccessDir "/sys/bus/pci"
6471 PersistentNotifications false
6478 =item B<Source> B<sysfs>|B<proc>
6480 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6481 The default value is B<sysfs>.
6483 =item B<AccessDir> I<dir>
6485 Directory used to access device config space. It is optional and defaults to
6486 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6488 =item B<ReportMasked> B<false>|B<true>
6490 If true plugin will notify about errors that are set to masked in Error Mask register.
6491 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6493 =item B<PersistentNotifications> B<false>|B<true>
6495 If false plugin will dispatch notification only on set/clear of error.
6496 The ones already reported will be ignored. Defaults to B<false>.
6500 =head2 Plugin C<perl>
6502 This plugin embeds a Perl-interpreter into collectd and provides an interface
6503 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6505 =head2 Plugin C<pinba>
6507 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6508 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6509 PHP-based webpage has been delivered, the extension will send a UDP packet
6510 containing timing information, peak memory usage and so on. The plugin will
6511 wait for such packets, parse them and account the provided information, which
6512 is then dispatched to the daemon once per interval.
6519 # Overall statistics for the website.
6521 Server "www.example.com"
6523 # Statistics for www-a only
6525 Host "www-a.example.com"
6526 Server "www.example.com"
6528 # Statistics for www-b only
6530 Host "www-b.example.com"
6531 Server "www.example.com"
6535 The plugin provides the following configuration options:
6539 =item B<Address> I<Node>
6541 Configures the address used to open a listening socket. By default, plugin will
6542 bind to the I<any> address C<::0>.
6544 =item B<Port> I<Service>
6546 Configures the port (service) to bind to. By default the default Pinba port
6547 "30002" will be used. The option accepts service names in addition to port
6548 numbers and thus requires a I<string> argument.
6550 =item E<lt>B<View> I<Name>E<gt> block
6552 The packets sent by the Pinba extension include the hostname of the server, the
6553 server name (the name of the virtual host) and the script that was executed.
6554 Using B<View> blocks it is possible to separate the data into multiple groups
6555 to get more meaningful statistics. Each packet is added to all matching groups,
6556 so that a packet may be accounted for more than once.
6560 =item B<Host> I<Host>
6562 Matches the hostname of the system the webserver / script is running on. This
6563 will contain the result of the L<gethostname(2)> system call. If not
6564 configured, all hostnames will be accepted.
6566 =item B<Server> I<Server>
6568 Matches the name of the I<virtual host>, i.e. the contents of the
6569 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6570 server names will be accepted.
6572 =item B<Script> I<Script>
6574 Matches the name of the I<script name>, i.e. the contents of the
6575 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6576 script names will be accepted.
6582 =head2 Plugin C<ping>
6584 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6585 configured hosts periodically and measures the network latency. Whenever the
6586 C<read> function of the plugin is called, it submits the average latency, the
6587 standard deviation and the drop rate for each host.
6589 Available configuration options:
6593 =item B<Host> I<IP-address>
6595 Host to ping periodically. This option may be repeated several times to ping
6598 =item B<Interval> I<Seconds>
6600 Sets the interval in which to send ICMP echo packets to the configured hosts.
6601 This is B<not> the interval in which metrics are read from the plugin but the
6602 interval in which the hosts are "pinged". Therefore, the setting here should be
6603 smaller than or equal to the global B<Interval> setting. Fractional times, such
6604 as "1.24" are allowed.
6608 =item B<Timeout> I<Seconds>
6610 Time to wait for a response from the host to which an ICMP packet had been
6611 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6612 to be down or the packet to be dropped. This setting must be smaller than the
6613 B<Interval> setting above for the plugin to work correctly. Fractional
6614 arguments are accepted.
6618 =item B<TTL> I<0-255>
6620 Sets the Time-To-Live of generated ICMP packets.
6622 =item B<Size> I<size>
6624 Sets the size of the data payload in ICMP packet to specified I<size> (it
6625 will be filled with regular ASCII pattern). If not set, default 56 byte
6626 long string is used so that the packet size of an ICMPv4 packet is exactly
6627 64 bytes, similar to the behaviour of normal ping(1) command.
6629 =item B<SourceAddress> I<host>
6631 Sets the source address to use. I<host> may either be a numerical network
6632 address or a network hostname.
6634 =item B<AddressFamily> I<af>
6636 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6637 option will be ignored if you set a B<SourceAddress>.
6639 =item B<Device> I<name>
6641 Sets the outgoing network device to be used. I<name> has to specify an
6642 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6645 =item B<MaxMissed> I<Packets>
6647 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6648 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6650 Default: B<-1> (disabled)
6654 =head2 Plugin C<postgresql>
6656 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6657 keeps a persistent connection to all configured databases and tries to
6658 reconnect if the connection has been interrupted. A database is configured by
6659 specifying a B<Database> block as described below. The default statistics are
6660 collected from PostgreSQL's B<statistics collector> which thus has to be
6661 enabled for this plugin to work correctly. This should usually be the case by
6662 default. See the section "The Statistics Collector" of the B<PostgreSQL
6663 Documentation> for details.
6665 By specifying custom database queries using a B<Query> block as described
6666 below, you may collect any data that is available from some PostgreSQL
6667 database. This way, you are able to access statistics of external daemons
6668 which are available in a PostgreSQL database or use future or special
6669 statistics provided by PostgreSQL without the need to upgrade your collectd
6672 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6673 PostgreSQL databases as well. This has been implemented in a generic way. You
6674 need to specify an SQL statement which will then be executed by collectd in
6675 order to write the data (see below for details). The benefit of that approach
6676 is that there is no fixed database layout. Rather, the layout may be optimized
6677 for the current setup.
6679 The B<PostgreSQL Documentation> manual can be found at
6680 L<http://www.postgresql.org/docs/manuals/>.
6684 Statement "SELECT magic FROM wizard WHERE host = $1;"
6688 InstancePrefix "magic"
6693 <Query rt36_tickets>
6694 Statement "SELECT COUNT(type) AS count, type \
6696 WHEN resolved = 'epoch' THEN 'open' \
6697 ELSE 'resolved' END AS type \
6698 FROM tickets) type \
6702 InstancePrefix "rt36_tickets"
6703 InstancesFrom "type"
6709 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6720 KRBSrvName "kerberos_service_name"
6726 Service "service_name"
6727 Query backends # predefined
6738 The B<Query> block defines one database query which may later be used by a
6739 database definition. It accepts a single mandatory argument which specifies
6740 the name of the query. The names of all queries have to be unique (see the
6741 B<MinVersion> and B<MaxVersion> options below for an exception to this
6744 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6745 B<Result> blocks may be used to extract multiple values from a single query.
6747 The following configuration options are available to define the query:
6751 =item B<Statement> I<sql query statement>
6753 Specify the I<sql query statement> which the plugin should execute. The string
6754 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6755 first, second, etc. parameter. The value of the parameters is specified by the
6756 B<Param> configuration option - see below for details. To include a literal
6757 B<$> character followed by a number, surround it with single quotes (B<'>).
6759 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6760 allowed. Note, however, that only a single command may be used. Semicolons are
6761 allowed as long as a single non-empty command has been specified only.
6763 The returned lines will be handled separately one after another.
6765 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6767 Specify the parameters which should be passed to the SQL query. The parameters
6768 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6769 they appear in the configuration file. The value of the parameter is
6770 determined depending on the value of the B<Param> option as follows:
6776 The configured hostname of the database connection. If a UNIX domain socket is
6777 used, the parameter expands to "localhost".
6781 The name of the database of the current connection.
6785 The name of the database plugin instance. See the B<Instance> option of the
6786 database specification below for details.
6790 The username used to connect to the database.
6794 The interval with which this database is queried (as specified by the database
6795 specific or global B<Interval> options).
6799 Please note that parameters are only supported by PostgreSQL's protocol
6800 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6802 =item B<PluginInstanceFrom> I<column>
6804 Specify how to create the "PluginInstance" for reporting this query results.
6805 Only one column is supported. You may concatenate fields and string values in
6806 the query statement to get the required results.
6808 =item B<MinVersion> I<version>
6810 =item B<MaxVersion> I<version>
6812 Specify the minimum or maximum version of PostgreSQL that this query should be
6813 used with. Some statistics might only be available with certain versions of
6814 PostgreSQL. This allows you to specify multiple queries with the same name but
6815 which apply to different versions, thus allowing you to use the same
6816 configuration in a heterogeneous environment.
6818 The I<version> has to be specified as the concatenation of the major, minor
6819 and patch-level versions, each represented as two-decimal-digit numbers. For
6820 example, version 8.2.3 will become 80203.
6824 The B<Result> block defines how to handle the values returned from the query.
6825 It defines which column holds which value and how to dispatch that value to
6830 =item B<Type> I<type>
6832 The I<type> name to be used when dispatching the values. The type describes
6833 how to handle the data and where to store it. See L<types.db(5)> for more
6834 details on types and their configuration. The number and type of values (as
6835 selected by the B<ValuesFrom> option) has to match the type of the given name.
6837 This option is mandatory.
6839 =item B<InstancePrefix> I<prefix>
6841 =item B<InstancesFrom> I<column0> [I<column1> ...]
6843 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6844 B<InstancePrefix> defines a static prefix that will be prepended to all type
6845 instances. B<InstancesFrom> defines the column names whose values will be used
6846 to create the type instance. Multiple values will be joined together using the
6847 hyphen (C<->) as separation character.
6849 The plugin itself does not check whether or not all built instances are
6850 different. It is your responsibility to assure that each is unique.
6852 Both options are optional. If none is specified, the type instance will be
6855 =item B<ValuesFrom> I<column0> [I<column1> ...]
6857 Names the columns whose content is used as the actual data for the data sets
6858 that are dispatched to the daemon. How many such columns you need is
6859 determined by the B<Type> setting as explained above. If you specify too many
6860 or not enough columns, the plugin will complain about that and no data will be
6861 submitted to the daemon.
6863 The actual data type, as seen by PostgreSQL, is not that important as long as
6864 it represents numbers. The plugin will automatically cast the values to the
6865 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6866 L<strtod(3)> functions, so anything supported by those functions is supported
6867 by the plugin as well.
6869 This option is required inside a B<Result> block and may be specified multiple
6870 times. If multiple B<ValuesFrom> options are specified, the columns are read
6875 The following predefined queries are available (the definitions can be found
6876 in the F<postgresql_default.conf> file which, by default, is available at
6877 C<I<prefix>/share/collectd/>):
6883 This query collects the number of backends, i.E<nbsp>e. the number of
6886 =item B<transactions>
6888 This query collects the numbers of committed and rolled-back transactions of
6893 This query collects the numbers of various table modifications (i.E<nbsp>e.
6894 insertions, updates, deletions) of the user tables.
6896 =item B<query_plans>
6898 This query collects the numbers of various table scans and returned tuples of
6901 =item B<table_states>
6903 This query collects the numbers of live and dead rows in the user tables.
6907 This query collects disk block access counts for user tables.
6911 This query collects the on-disk size of the database in bytes.
6915 In addition, the following detailed queries are available by default. Please
6916 note that each of those queries collects information B<by table>, thus,
6917 potentially producing B<a lot> of data. For details see the description of the
6918 non-by_table queries above.
6922 =item B<queries_by_table>
6924 =item B<query_plans_by_table>
6926 =item B<table_states_by_table>
6928 =item B<disk_io_by_table>
6932 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6933 mandatory argument specifying the name of the writer. This will then be used
6934 in the B<Database> specification in order to activate the writer instance. The
6935 names of all writers have to be unique. The following options may be
6940 =item B<Statement> I<sql statement>
6942 This mandatory option specifies the SQL statement that will be executed for
6943 each submitted value. A single SQL statement is allowed only. Anything after
6944 the first semicolon will be ignored.
6946 Nine parameters will be passed to the statement and should be specified as
6947 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6948 values are made available through those parameters:
6954 The timestamp of the queried value as an RFC 3339-formatted local time.
6958 The hostname of the queried value.
6962 The plugin name of the queried value.
6966 The plugin instance of the queried value. This value may be B<NULL> if there
6967 is no plugin instance.
6971 The type of the queried value (cf. L<types.db(5)>).
6975 The type instance of the queried value. This value may be B<NULL> if there is
6980 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6981 sources of the submitted value-list).
6985 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6986 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6987 B<StoreRates> is enabled (which is the default, see below), all types will be
6992 An array of the submitted values. The dimensions of the value name and value
6997 In general, it is advisable to create and call a custom function in the
6998 PostgreSQL database for this purpose. Any procedural language supported by
6999 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
7002 =item B<StoreRates> B<false>|B<true>
7004 If set to B<true> (the default), convert counter values to rates. If set to
7005 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7010 The B<Database> block defines one PostgreSQL database for which to collect
7011 statistics. It accepts a single mandatory argument which specifies the
7012 database name. None of the other options are required. PostgreSQL will use
7013 default values as documented in the section "CONNECTING TO A DATABASE" in the
7014 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
7015 the user collectd is run as and special environment variables. See the manpage
7020 =item B<Interval> I<seconds>
7022 Specify the interval with which the database should be queried. The default is
7023 to use the global B<Interval> setting.
7025 =item B<CommitInterval> I<seconds>
7027 This option may be used for database connections which have "writers" assigned
7028 (see above). If specified, it causes a writer to put several updates into a
7029 single transaction. This transaction will last for the specified amount of
7030 time. By default, each update will be executed in a separate transaction. Each
7031 transaction generates a fair amount of overhead which can, thus, be reduced by
7032 activating this option. The draw-back is, that data covering the specified
7033 amount of time will be lost, for example, if a single statement within the
7034 transaction fails or if the database server crashes.
7036 =item B<Plugin> I<Plugin>
7038 Use I<Plugin> as the plugin name when submitting query results from
7039 this B<Database>. Defaults to C<postgresql>.
7041 =item B<Instance> I<name>
7043 Specify the plugin instance name that should be used instead of the database
7044 name (which is the default, if this option has not been specified). This
7045 allows one to query multiple databases of the same name on the same host (e.g.
7046 when running multiple database server versions in parallel).
7047 The plugin instance name can also be set from the query result using
7048 the B<PluginInstanceFrom> option in B<Query> block.
7050 =item B<Host> I<hostname>
7052 Specify the hostname or IP of the PostgreSQL server to connect to. If the
7053 value begins with a slash, it is interpreted as the directory name in which to
7054 look for the UNIX domain socket.
7056 This option is also used to determine the hostname that is associated with a
7057 collected data set. If it has been omitted or either begins with with a slash
7058 or equals B<localhost> it will be replaced with the global hostname definition
7059 of collectd. Any other value will be passed literally to collectd when
7060 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
7062 =item B<Port> I<port>
7064 Specify the TCP port or the local UNIX domain socket file extension of the
7067 =item B<User> I<username>
7069 Specify the username to be used when connecting to the server.
7071 =item B<Password> I<password>
7073 Specify the password to be used when connecting to the server.
7075 =item B<ExpireDelay> I<delay>
7077 Skip expired values in query output.
7079 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
7081 Specify whether to use an SSL connection when contacting the server. The
7082 following modes are supported:
7088 Do not use SSL at all.
7092 First, try to connect without using SSL. If that fails, try using SSL.
7094 =item I<prefer> (default)
7096 First, try to connect using SSL. If that fails, try without using SSL.
7104 =item B<Instance> I<name>
7106 Specify the plugin instance name that should be used instead of the database
7107 name (which is the default, if this option has not been specified). This
7108 allows one to query multiple databases of the same name on the same host (e.g.
7109 when running multiple database server versions in parallel).
7111 =item B<KRBSrvName> I<kerberos_service_name>
7113 Specify the Kerberos service name to use when authenticating with Kerberos 5
7114 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
7115 B<PostgreSQL Documentation> for details.
7117 =item B<Service> I<service_name>
7119 Specify the PostgreSQL service name to use for additional parameters. That
7120 service has to be defined in F<pg_service.conf> and holds additional
7121 connection parameters. See the section "The Connection Service File" in the
7122 B<PostgreSQL Documentation> for details.
7124 =item B<Query> I<query>
7126 Specifies a I<query> which should be executed in the context of the database
7127 connection. This may be any of the predefined or user-defined queries. If no
7128 such option is given, it defaults to "backends", "transactions", "queries",
7129 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
7130 has been specified). Else, the specified queries are used only.
7132 =item B<Writer> I<writer>
7134 Assigns the specified I<writer> backend to the database connection. This
7135 causes all collected data to be send to the database using the settings
7136 defined in the writer configuration (see the section "FILTER CONFIGURATION"
7137 below for details on how to selectively send data to certain plugins).
7139 Each writer will register a flush callback which may be used when having long
7140 transactions enabled (see the B<CommitInterval> option above). When issuing
7141 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
7142 transaction will be committed right away. Two different kinds of flush
7143 callbacks are available with the C<postgresql> plugin:
7149 Flush all writer backends.
7151 =item B<postgresql->I<database>
7153 Flush all writers of the specified I<database> only.
7159 =head2 Plugin C<powerdns>
7161 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7162 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7163 values, many of which are probably meaningless to most users, but may be useful
7164 for some. So you may chose which values to collect, but if you don't, some
7165 reasonable defaults will be collected.
7168 <Server "server_name">
7170 Collect "udp-answers" "udp-queries"
7171 Socket "/var/run/pdns.controlsocket"
7173 <Recursor "recursor_name">
7175 Collect "cache-hits" "cache-misses"
7176 Socket "/var/run/pdns_recursor.controlsocket"
7178 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7183 =item B<Server> and B<Recursor> block
7185 The B<Server> block defines one authoritative server to query, the B<Recursor>
7186 does the same for an recursing server. The possible options in both blocks are
7187 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7192 =item B<Collect> I<Field>
7194 Using the B<Collect> statement you can select which values to collect. Here,
7195 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7196 C<dlg-only-drops>, C<answers10-100>.
7198 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7199 When querying the server a C<SHOW *> command is issued in any case, because
7200 that's the only way of getting multiple values out of the server at once.
7201 collectd then picks out the values you have selected. When querying the
7202 recursor, a command is generated to query exactly these values. So if you
7203 specify invalid fields when querying the recursor, a syntax error may be
7204 returned by the daemon and collectd may not collect any values at all.
7206 If no B<Collect> statement is given, the following B<Server> values will be
7213 =item packetcache-hit
7215 =item packetcache-miss
7217 =item packetcache-size
7219 =item query-cache-hit
7221 =item query-cache-miss
7223 =item recursing-answers
7225 =item recursing-questions
7237 The following B<Recursor> values will be collected by default:
7241 =item noerror-answers
7243 =item nxdomain-answers
7245 =item servfail-answers
7263 Please note that up to that point collectd doesn't know what values are
7264 available on the server and values that are added do not need a change of the
7265 mechanism so far. However, the values must be mapped to collectd's naming
7266 scheme, which is done using a lookup table that lists all known values. If
7267 values are added in the future and collectd does not know about them, you will
7268 get an error much like this:
7270 powerdns plugin: submit: Not found in lookup table: foobar = 42
7272 In this case please file a bug report with the collectd team.
7274 =item B<Socket> I<Path>
7276 Configures the path to the UNIX domain socket to be used when connecting to the
7277 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7278 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7279 will be used for the recursor.
7283 =item B<LocalSocket> I<Path>
7285 Querying the recursor is done using UDP. When using UDP over UNIX domain
7286 sockets, the client socket needs a name in the file system, too. You can set
7287 this local name to I<Path> using the B<LocalSocket> option. The default is
7288 C<I<prefix>/var/run/collectd-powerdns>.
7292 =head2 Plugin C<processes>
7294 Collects information about processes of local system.
7296 By default, with no process matches configured, only general statistics is
7297 collected: the number of processes in each state and fork rate.
7299 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7300 These may also be a block in which further options may be specified.
7302 The statistics collected for matched processes are:
7303 - size of the resident segment size (RSS)
7304 - user- and system-time used
7305 - number of processes
7307 - number of open files (under Linux)
7308 - number of memory mapped files (under Linux)
7309 - io data (where available)
7310 - context switches (under Linux)
7311 - minor and major pagefaults
7312 - Delay Accounting information (Linux only, requires libmnl)
7317 CollectFileDescriptor true
7318 CollectContextSwitch true
7319 CollectDelayAccounting false
7321 ProcessMatch "name" "regex"
7322 <Process "collectd">
7323 CollectFileDescriptor false
7324 CollectContextSwitch false
7325 CollectDelayAccounting true
7327 <ProcessMatch "name" "regex">
7328 CollectFileDescriptor false
7329 CollectContextSwitch true
7335 =item B<Process> I<Name>
7337 Select more detailed statistics of processes matching this name.
7339 Some platforms have a limit on the length of process names.
7340 I<Name> must stay below this limit.
7342 =item B<ProcessMatch> I<name> I<regex>
7344 Select more detailed statistics of processes matching the specified I<regex>
7345 (see L<regex(7)> for details). The statistics of all matching processes are
7346 summed up and dispatched to the daemon using the specified I<name> as an
7347 identifier. This allows one to "group" several processes together.
7348 I<name> must not contain slashes.
7350 =item B<CollectContextSwitch> I<Boolean>
7352 Collect the number of context switches for matched processes.
7353 Disabled by default.
7355 =item B<CollectDelayAccounting> I<Boolean>
7357 If enabled, collect Linux Delay Accounding information for matching processes.
7358 Delay Accounting provides the time processes wait for the CPU to become
7359 available, for I/O operations to finish, for pages to be swapped in and for
7360 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7361 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7362 Disabled by default.
7364 This option is only available on Linux, requires the C<libmnl> library and
7365 requires the C<CAP_NET_ADMIN> capability at runtime.
7367 =item B<CollectFileDescriptor> I<Boolean>
7369 Collect number of file descriptors of matched processes.
7370 Disabled by default.
7372 =item B<CollectMemoryMaps> I<Boolean>
7374 Collect the number of memory mapped files of the process.
7375 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7380 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7381 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7382 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7383 reporting the corresponding processes only. Outside of B<Process> and
7384 B<ProcessMatch> blocks these options set the default value for subsequent
7387 =head2 Plugin C<procevent>
7389 The I<procevent> plugin monitors when processes start (EXEC) and stop (EXIT).
7396 ProcessRegex "regex"
7403 =item B<BufferLength> I<length>
7405 Maximum number of process events that can be stored in plugin's ring buffer.
7406 By default, this is set to 10. Once an event has been read, its location
7407 becomes available for storing a new event.
7409 =item B<Process> I<name>
7411 Enumerate a process name to monitor. All processes that match this exact
7412 name will be monitored for EXECs and EXITs.
7414 =item B<ProcessRegex> I<regex>
7416 Enumerate a process pattern to monitor. All processes that match this
7417 regular expression will be monitored for EXECs and EXITs.
7421 =head2 Plugin C<protocols>
7423 Collects a lot of information about various network protocols, such as I<IP>,
7424 I<TCP>, I<UDP>, etc.
7426 Available configuration options:
7430 =item B<Value> I<Selector>
7432 Selects whether or not to select a specific value. The string being matched is
7433 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7434 plugin instance and I<ValueName> will be used as type instance. An example of
7435 the string being used would be C<Tcp:RetransSegs>.
7437 You can use regular expressions to match a large number of values with just one
7438 configuration option. To select all "extended" I<TCP> values, you could use the
7439 following statement:
7443 Whether only matched values are selected or all matched values are ignored
7444 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7445 If no value is configured at all, all values will be selected.
7447 See F</"IGNORELISTS"> for details.
7449 =item B<IgnoreSelected> B<true>|B<false>
7451 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7452 matching values will be ignored.
7456 =head2 Plugin C<python>
7458 This plugin embeds a Python-interpreter into collectd and provides an interface
7459 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7461 =head2 Plugin C<routeros>
7463 The C<routeros> plugin connects to a device running I<RouterOS>, the
7464 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7465 I<librouteros> to connect and reads information about the interfaces and
7466 wireless connections of the device. The configuration supports querying
7471 Host "router0.example.com"
7474 CollectInterface true
7479 Host "router1.example.com"
7482 CollectInterface true
7483 CollectRegistrationTable true
7490 As you can see above, the configuration of the I<routeros> plugin consists of
7491 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7492 options are understood:
7496 =item B<Host> I<Host>
7498 Hostname or IP-address of the router to connect to.
7500 =item B<Port> I<Port>
7502 Port name or port number used when connecting. If left unspecified, the default
7503 will be chosen by I<librouteros>, currently "8728". This option expects a
7504 string argument, even when a numeric port number is given.
7506 =item B<User> I<User>
7508 Use the user name I<User> to authenticate. Defaults to "admin".
7510 =item B<Password> I<Password>
7512 Set the password used to authenticate.
7514 =item B<CollectInterface> B<true>|B<false>
7516 When set to B<true>, interface statistics will be collected for all interfaces
7517 present on the device. Defaults to B<false>.
7519 =item B<CollectRegistrationTable> B<true>|B<false>
7521 When set to B<true>, information about wireless LAN connections will be
7522 collected. Defaults to B<false>.
7524 =item B<CollectCPULoad> B<true>|B<false>
7526 When set to B<true>, information about the CPU usage will be collected. The
7527 number is a dimensionless value where zero indicates no CPU usage at all.
7528 Defaults to B<false>.
7530 =item B<CollectMemory> B<true>|B<false>
7532 When enabled, the amount of used and free memory will be collected. How used
7533 memory is calculated is unknown, for example whether or not caches are counted
7535 Defaults to B<false>.
7537 =item B<CollectDF> B<true>|B<false>
7539 When enabled, the amount of used and free disk space will be collected.
7540 Defaults to B<false>.
7542 =item B<CollectDisk> B<true>|B<false>
7544 When enabled, the number of sectors written and bad blocks will be collected.
7545 Defaults to B<false>.
7547 =item B<CollectHealth> B<true>|B<false>
7549 When enabled, the health statistics will be collected. This includes the
7550 voltage and temperature on supported hardware.
7551 Defaults to B<false>.
7555 =head2 Plugin C<redis>
7557 The I<Redis plugin> connects to one or more Redis servers, gathers
7558 information about each server's state and executes user-defined queries.
7559 For each server there is a I<Node> block which configures the connection
7560 parameters and set of user-defined queries for this node.
7566 #Socket "/var/run/redis/redis.sock"
7568 ReportCommandStats false
7570 <Query "LLEN myqueue">
7580 =item B<Node> I<Nodename>
7582 The B<Node> block identifies a new Redis node, that is a new Redis instance
7583 running in an specified host and port. The name for node is a canonical
7584 identifier which is used as I<plugin instance>. It is limited to
7585 128E<nbsp>characters in length.
7587 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7589 =item B<Host> I<Hostname>
7591 The B<Host> option is the hostname or IP-address where the Redis instance is
7594 =item B<Port> I<Port>
7596 The B<Port> option is the TCP port on which the Redis instance accepts
7597 connections. Either a service name of a port number may be given. Please note
7598 that numerical port numbers must be given as a string, too.
7600 =item B<Socket> I<Path>
7602 Connect to Redis using the UNIX domain socket at I<Path>. If this
7603 setting is given, the B<Hostname> and B<Port> settings are ignored.
7605 =item B<Password> I<Password>
7607 Use I<Password> to authenticate when connecting to I<Redis>.
7609 =item B<Timeout> I<Milliseconds>
7611 The B<Timeout> option set the socket timeout for node response. Since the Redis
7612 read function is blocking, you should keep this value as low as possible.
7613 It is expected what B<Timeout> values should be lower than B<Interval> defined
7616 Defaults to 2000 (2 seconds).
7618 =item B<ReportCommandStats> B<false>|B<true>
7620 Enables or disables reporting of statistics based on the command type, including
7621 rate of command calls and average CPU time consumed by command processing.
7622 Defaults to B<false>.
7624 =item B<ReportCpuUsage> B<true>|B<false>
7626 Enables or disables reporting of CPU consumption statistics.
7627 Defaults to B<true>.
7629 =item B<Query> I<Querystring>
7631 The B<Query> block identifies a query to execute against the redis server.
7632 There may be an arbitrary number of queries to execute. Each query should
7633 return single string or integer.
7635 =item B<Type> I<Collectd type>
7637 Within a query definition, a valid I<collectd type> to use as when submitting
7638 the result of the query. When not supplied, will default to B<gauge>.
7640 Currently only types with one datasource are supported.
7641 See L<types.db(5)> for more details on types and their configuration.
7643 =item B<Instance> I<Type instance>
7645 Within a query definition, an optional type instance to use when submitting
7646 the result of the query. When not supplied will default to the escaped
7647 command, up to 128 chars.
7649 =item B<Database> I<Index>
7651 This index selects the Redis logical database to use for query. Defaults
7656 =head2 Plugin C<rrdcached>
7658 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7659 to store values to RRD files in an efficient manner. The combination of the
7660 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7661 way the C<rrdtool> plugin works (see below). The added abstraction layer
7662 provides a number of benefits, though: Because the cache is not within
7663 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7664 restarted. This results in much shorter (if any) gaps in graphs, especially
7665 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7666 daemon so that it can flush values to disk automatically when needed. This
7667 allows one to integrate automated flushing of values into graphing solutions
7670 There are disadvantages, though: The daemon may reside on a different host, so
7671 it may not be possible for C<collectd> to create the appropriate RRD files
7672 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7673 different base directory, so relative paths may do weird stuff if you're not
7676 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7677 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7678 setting should be set to an absolute path, so that a changed base directory
7679 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7683 =item B<DaemonAddress> I<Address>
7685 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7686 library. See L<rrdcached(1)> for details. Example:
7688 <Plugin "rrdcached">
7689 DaemonAddress "unix:/var/run/rrdcached.sock"
7692 =item B<DataDir> I<Directory>
7694 Set the base directory in which the RRD files reside. If this is a relative
7695 path, it is relative to the working base directory of the C<rrdcached> daemon!
7696 Use of an absolute path is recommended.
7698 =item B<CreateFiles> B<true>|B<false>
7700 Enables or disables the creation of RRD files. If the daemon is not running
7701 locally, or B<DataDir> is set to a relative path, this will not work as
7702 expected. Default is B<true>.
7704 =item B<CreateFilesAsync> B<false>|B<true>
7706 When enabled, new RRD files are enabled asynchronously, using a separate thread
7707 that runs in the background. This prevents writes to block, which is a problem
7708 especially when many hundreds of files need to be created at once. However,
7709 since the purpose of creating the files asynchronously is I<not> to block until
7710 the file is available, values before the file is available will be discarded.
7711 When disabled (the default) files are created synchronously, blocking for a
7712 short while, while the file is being written.
7714 =item B<StepSize> I<Seconds>
7716 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7717 this setting is unset and the stepsize is set to the interval in which the data
7718 is collected. Do not use this option unless you absolutely have to for some
7719 reason. Setting this option may cause problems with the C<snmp plugin>, the
7720 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7722 =item B<HeartBeat> I<Seconds>
7724 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7725 in which case the heartbeat is set to twice the B<StepSize> which should equal
7726 the interval in which data is collected. Do not set this option unless you have
7727 a very good reason to do so.
7729 =item B<RRARows> I<NumRows>
7731 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7732 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7733 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7734 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7735 week, one month, and one year.
7737 So for each timespan, it calculates how many PDPs need to be consolidated into
7738 one CDP by calculating:
7739 number of PDPs = timespan / (stepsize * rrarows)
7741 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7744 =item B<RRATimespan> I<Seconds>
7746 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7747 more then one RRA. If this option is never used, the built-in default of (3600,
7748 86400, 604800, 2678400, 31622400) is used.
7750 For more information on how RRA-sizes are calculated see B<RRARows> above.
7752 =item B<XFF> I<Factor>
7754 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7755 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7758 =item B<CollectStatistics> B<false>|B<true>
7760 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7761 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7763 Statistics are read via I<rrdcached>s socket using the STATS command.
7764 See L<rrdcached(1)> for details.
7768 =head2 Plugin C<rrdtool>
7770 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7771 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7772 using these settings. If you don't want to dive into the depths of RRDtool, you
7773 can safely ignore these settings.
7777 =item B<DataDir> I<Directory>
7779 Set the directory to store RRD files under. By default RRD files are generated
7780 beneath the daemon's working directory, i.e. the B<BaseDir>.
7782 =item B<CreateFilesAsync> B<false>|B<true>
7784 When enabled, new RRD files are enabled asynchronously, using a separate thread
7785 that runs in the background. This prevents writes to block, which is a problem
7786 especially when many hundreds of files need to be created at once. However,
7787 since the purpose of creating the files asynchronously is I<not> to block until
7788 the file is available, values before the file is available will be discarded.
7789 When disabled (the default) files are created synchronously, blocking for a
7790 short while, while the file is being written.
7792 =item B<StepSize> I<Seconds>
7794 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7795 this setting is unset and the stepsize is set to the interval in which the data
7796 is collected. Do not use this option unless you absolutely have to for some
7797 reason. Setting this option may cause problems with the C<snmp plugin>, the
7798 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7800 =item B<HeartBeat> I<Seconds>
7802 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7803 in which case the heartbeat is set to twice the B<StepSize> which should equal
7804 the interval in which data is collected. Do not set this option unless you have
7805 a very good reason to do so.
7807 =item B<RRARows> I<NumRows>
7809 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7810 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7811 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7812 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7813 week, one month, and one year.
7815 So for each timespan, it calculates how many PDPs need to be consolidated into
7816 one CDP by calculating:
7817 number of PDPs = timespan / (stepsize * rrarows)
7819 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7822 =item B<RRATimespan> I<Seconds>
7824 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7825 more then one RRA. If this option is never used, the built-in default of (3600,
7826 86400, 604800, 2678400, 31622400) is used.
7828 For more information on how RRA-sizes are calculated see B<RRARows> above.
7830 =item B<XFF> I<Factor>
7832 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7833 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7836 =item B<CacheFlush> I<Seconds>
7838 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7839 it writes all values for a certain RRD-file if the oldest value is older than
7840 (or equal to) the number of seconds specified by B<CacheTimeout>.
7841 That check happens on new values arriwal. If some RRD-file is not updated
7842 anymore for some reason (the computer was shut down, the network is broken,
7843 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7844 every I<Seconds> seconds the entire cache is searched for entries older than
7845 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7846 disk. Since scanning the entire cache is kind of expensive and does nothing
7847 under normal circumstances, this value should not be too small. 900 seconds
7848 might be a good value, though setting this to 7200 seconds doesn't normally
7849 do much harm either.
7851 Defaults to 10x B<CacheTimeout>.
7852 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7853 above default is used.
7855 =item B<CacheTimeout> I<Seconds>
7857 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7858 save values in a cache, as described above. Writing multiple values at once
7859 reduces IO-operations and thus lessens the load produced by updating the files.
7860 The trade off is that the graphs kind of "drag behind" and that more memory is
7863 =item B<WritesPerSecond> I<Updates>
7865 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7866 will run serious performance problems. The B<CacheFlush> setting and the
7867 internal update queue assert that collectd continues to work just fine even
7868 under heavy load, but the system may become very unresponsive and slow. This is
7869 a problem especially if you create graphs from the RRD files on the same
7870 machine, for example using the C<graph.cgi> script included in the
7871 C<contrib/collection3/> directory.
7873 This setting is designed for very large setups. Setting this option to a value
7874 between 25 and 80 updates per second, depending on your hardware, will leave
7875 the server responsive enough to draw graphs even while all the cached values
7876 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7877 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7878 written as fast as possible, so that web frontends have up to date data when
7881 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7882 updates per second, writing all values to disk will take approximately
7883 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7884 "collection3" you'll end up with a responsive and fast system, up to date
7885 graphs and basically a "backup" of your values every hour.
7887 =item B<RandomTimeout> I<Seconds>
7889 When set, the actual timeout for each value is chosen randomly between
7890 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7891 intention is to avoid high load situations that appear when many values timeout
7892 at the same time. This is especially a problem shortly after the daemon starts,
7893 because all values were added to the internal cache at roughly the same time.
7897 =head2 Plugin C<sensors>
7899 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7900 that all the needed modules have to be loaded and lm_sensors has to be
7901 configured (most likely by editing F</etc/sensors.conf>. Read
7902 L<sensors.conf(5)> for details.
7904 The B<lm_sensors> homepage can be found at
7905 L<http://secure.netroedge.com/~lm78/>.
7909 =item B<SensorConfigFile> I<File>
7911 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7912 the library's default will be used.
7914 =item B<Sensor> I<chip-bus-address/type-feature>
7916 Selects the name of the sensor which you want to collect or ignore, depending
7917 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7918 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7919 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7921 See F</"IGNORELISTS"> for details.
7923 =item B<IgnoreSelected> I<true>|I<false>
7925 If no configuration if given, the B<sensors>-plugin will collect data from all
7926 sensors. This may not be practical, especially for uninteresting sensors.
7927 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7928 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7929 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7930 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7931 and all other sensors are collected.
7933 =item B<UseLabels> I<true>|I<false>
7935 Configures how sensor readings are reported. When set to I<true>, sensor
7936 readings are reported using their descriptive label (e.g. "VCore"). When set to
7937 I<false> (the default) the sensor name is used ("in0").
7941 =head2 Plugin C<sigrok>
7943 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7944 supported by the L<sigrok|http://sigrok.org/> project.
7950 <Device "AC Voltage">
7955 <Device "Sound Level">
7956 Driver "cem-dt-885x"
7963 =item B<LogLevel> B<0-5>
7965 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7966 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7967 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7968 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7969 their level, are always submitted to I<collectd> at its INFO log level.
7971 =item E<lt>B<Device> I<Name>E<gt>
7973 A sigrok-supported device, uniquely identified by this section's options. The
7974 I<Name> is passed to I<collectd> as the I<plugin instance>.
7976 =item B<Driver> I<DriverName>
7978 The sigrok driver to use for this device.
7980 =item B<Conn> I<ConnectionSpec>
7982 If the device cannot be auto-discovered, or more than one might be discovered
7983 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7984 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7985 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7986 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7987 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7989 =item B<SerialComm> I<SerialSpec>
7991 For serial devices with non-standard port settings, this option can be used
7992 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7993 This should not be necessary; drivers know how to communicate with devices they
7996 =item B<MinimumInterval> I<Seconds>
7998 Specifies the minimum time between measurement dispatches to I<collectd>, in
7999 seconds. Since some I<sigrok> supported devices can acquire measurements many
8000 times per second, it may be necessary to throttle these. For example, the
8001 I<RRD plugin> cannot process writes more than once per second.
8003 The default B<MinimumInterval> is B<0>, meaning measurements received from the
8004 device are always dispatched to I<collectd>. When throttled, unused
8005 measurements are discarded.
8009 =head2 Plugin C<smart>
8011 The C<smart> plugin collects SMART information from physical
8012 disks. Values collectd include temperature, power cycle count, poweron
8013 time and bad sectors. Also, all SMART attributes are collected along
8014 with the normalized current value, the worst value, the threshold and
8015 a human readable value.
8017 Using the following two options you can ignore some disks or configure the
8018 collection only of specific disks.
8022 =item B<Disk> I<Name>
8024 Select the disk I<Name>. Whether it is collected or ignored depends on the
8025 B<IgnoreSelected> setting, see below. As with other plugins that use the
8026 daemon's ignorelist functionality, a string that starts and ends with a slash
8027 is interpreted as a regular expression. Examples:
8032 See F</"IGNORELISTS"> for details.
8034 =item B<IgnoreSelected> B<true>|B<false>
8036 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
8037 statements, are ignored or if all other disks are ignored. The behavior
8038 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
8039 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
8040 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
8041 is set to B<true>, all disks are collected B<except> the ones matched.
8043 =item B<IgnoreSleepMode> B<true>|B<false>
8045 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
8046 This option disables the sleep mode check and allows the plugin to collect data
8047 from these disks anyway. This is useful in cases where libatasmart mistakenly
8048 reports disks as asleep because it has not been updated to incorporate support
8049 for newer idle states in the ATA spec.
8051 =item B<UseSerial> B<true>|B<false>
8053 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
8054 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
8055 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
8056 storing data. This ensures that the data for a given disk will be kept together
8057 even if the kernel name changes.
8061 =head2 Plugin C<snmp>
8063 Since the configuration of the C<snmp plugin> is a little more complicated than
8064 other plugins, its documentation has been moved to an own manpage,
8065 L<collectd-snmp(5)>. Please see there for details.
8067 =head2 Plugin C<snmp_agent>
8069 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
8070 from SNMP master agent and returns the data collected by read plugins.
8071 The I<snmp_agent> plugin handles requests only for OIDs specified in
8072 configuration file. To handle SNMP queries the plugin gets data from collectd
8073 and translates requested values from collectd's internal format to SNMP format.
8074 This plugin is a generic plugin and cannot work without configuration.
8075 For more details on AgentX subagent see
8076 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
8081 <Data "memAvailReal">
8083 #PluginInstance "some"
8086 OIDs "1.3.6.1.4.1.2021.4.6.0"
8089 IndexOID "IF-MIB::ifIndex"
8090 SizeOID "IF-MIB::ifNumber"
8093 Source "PluginInstance"
8096 OIDs "IF-MIB::ifDescr"
8102 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
8105 <Table "CPUAffinityTable">
8108 Source "PluginInstance"
8111 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
8116 Source "TypeInstance"
8117 Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
8120 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
8125 Source "TypeInstance"
8126 Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
8129 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
8131 <Data "CPUAffinity">
8134 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
8139 There are two types of blocks that can be contained in the
8140 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
8142 =head3 B<Data> block
8144 The B<Data> block defines a list OIDs that are to be handled. This block can
8145 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
8146 block it reperesents table OIDs.
8147 The following options can be set:
8151 =item B<IndexKey> block
8153 B<IndexKey> block contains all data needed for proper index build of snmp table.
8155 one table B<Data> block has B<IndexKey> block present then multiple key index is
8156 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
8161 =item B<Source> I<String>
8163 B<Source> can be set to one of the following values: "Hostname", "Plugin",
8164 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
8165 corresponding collectd metric is taken as a SNMP table index.
8167 =item B<Regex> I<String>
8169 B<Regex> option can also be used to parse strings or numbers out of
8170 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
8171 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
8174 =item B<Group> I<Number>
8176 B<Group> number can be specified in case groups are used in regex.
8180 =item B<Plugin> I<String>
8182 Read plugin name whose collected data will be mapped to specified OIDs.
8184 =item B<PluginInstance> I<String>
8186 Read plugin instance whose collected data will be mapped to specified OIDs.
8187 The field is optional and by default there is no plugin instance check.
8188 Allowed only if B<Data> block defines scalar data type.
8190 =item B<Type> I<String>
8192 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
8193 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
8195 =item B<TypeInstance> I<String>
8197 Collectd's type-instance that is to be used for specified OID.
8199 =item B<OIDs> I<OID> [I<OID> ...]
8201 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8202 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8203 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8204 configured should correspond to number of values in specified B<Type>.
8205 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8206 "rx" and "tx" values of "if_octets" type.
8208 =item B<Scale> I<Value>
8210 The values taken from collectd are multiplied by I<Value>. The field is optional
8211 and the default is B<1.0>.
8213 =item B<Shift> I<Value>
8215 I<Value> is added to values from collectd after they have been multiplied by
8216 B<Scale> value. The field is optional and the default value is B<0.0>.
8220 =head3 The B<Table> block
8222 The B<Table> block defines a collection of B<Data> blocks that belong to one
8223 snmp table. In addition to multiple B<Data> blocks the following options can be
8228 =item B<IndexOID> I<OID>
8230 OID that is handled by the plugin and is mapped to numerical index value that is
8231 generated by the plugin for each table record.
8233 =item B<SizeOID> I<OID>
8235 OID that is handled by the plugin. Returned value is the number of records in
8236 the table. The field is optional.
8240 =head2 Plugin C<statsd>
8242 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8243 protocol and dispatches rates or other aggregates of these numbers
8246 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8247 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8248 C<objects> respectively.
8250 The following configuration options are valid:
8254 =item B<Host> I<Host>
8256 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8257 "any" address, i.e. accept packets sent to any of the hosts addresses.
8259 =item B<Port> I<Port>
8261 UDP port to listen to. This can be either a service name or a port number.
8262 Defaults to C<8125>.
8264 =item B<DeleteCounters> B<false>|B<true>
8266 =item B<DeleteTimers> B<false>|B<true>
8268 =item B<DeleteGauges> B<false>|B<true>
8270 =item B<DeleteSets> B<false>|B<true>
8272 These options control what happens if metrics are not updated in an interval.
8273 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8274 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8275 are unchanged. If set to B<True>, the such metrics are not dispatched and
8276 removed from the internal cache.
8278 =item B<CounterSum> B<false>|B<true>
8280 When enabled, creates a C<count> metric which reports the change since the last
8281 read. This option primarily exists for compatibility with the I<statsd>
8282 implementation by Etsy.
8284 =item B<TimerPercentile> I<Percent>
8286 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8287 that I<Percent> of all reported timers are smaller than or equal to the
8288 computed latency. This is useful for cutting off the long tail latency, as it's
8289 often done in I<Service Level Agreements> (SLAs).
8291 Different percentiles can be calculated by setting this option several times.
8292 If none are specified, no percentiles are calculated / dispatched.
8294 =item B<TimerLower> B<false>|B<true>
8296 =item B<TimerUpper> B<false>|B<true>
8298 =item B<TimerSum> B<false>|B<true>
8300 =item B<TimerCount> B<false>|B<true>
8302 Calculate and dispatch various values out of I<Timer> metrics received during
8303 an interval. If set to B<False>, the default, these values aren't calculated /
8306 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8310 =head2 Plugin C<swap>
8312 The I<Swap plugin> collects information about used and available swap space. On
8313 I<Linux> and I<Solaris>, the following options are available:
8317 =item B<ReportByDevice> B<false>|B<true>
8319 Configures how to report physical swap devices. If set to B<false> (the
8320 default), the summary over all swap devices is reported only, i.e. the globally
8321 used and available space over all devices. If B<true> is configured, the used
8322 and available space of each device will be reported separately.
8324 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8325 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8327 =item B<ReportBytes> B<false>|B<true>
8329 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8330 I<swap I/O> is reported in pages. This option is available under Linux only.
8332 =item B<ValuesAbsolute> B<true>|B<false>
8334 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8335 available and used. Defaults to B<true>.
8337 =item B<ValuesPercentage> B<false>|B<true>
8339 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8340 available and free. Defaults to B<false>.
8342 This is useful for deploying I<collectd> in a heterogeneous environment, where
8343 swap sizes differ and you want to specify generic thresholds or similar.
8345 =item B<ReportIO> B<true>|B<false>
8347 Enables or disables reporting swap IO. Defaults to B<true>.
8349 This is useful for the cases when swap IO is not neccessary, is not available,
8354 =head2 Plugin C<sysevent>
8356 The I<sysevent> plugin monitors rsyslog messages.
8361 Listen "192.168.0.2" "6666"
8367 rsyslog should be configured such that it sends data to the IP and port you
8368 include in the plugin configuration. For example, given the configuration
8369 above, something like this would be set in /etc/rsyslog.conf:
8371 if $programname != 'collectd' then
8372 *.* @192.168.0.2:6666
8374 This plugin is designed to consume JSON rsyslog data, so a more complete
8375 rsyslog configuration would look like so (where we define a JSON template
8376 and use it when sending data to our IP and port):
8378 $template ls_json,"{%timestamp:::date-rfc3339,jsonf:@timestamp%, \
8379 %source:::jsonf:@source_host%,\"@source\":\"syslog://%fromhost-ip:::json%\", \
8380 \"@message\":\"%timestamp% %app-name%:%msg:::json%\",\"@fields\": \
8381 {%syslogfacility-text:::jsonf:facility%,%syslogseverity:::jsonf:severity-num%, \
8382 %syslogseverity-text:::jsonf:severity%,%programname:::jsonf:program%, \
8383 %procid:::jsonf:processid%}}"
8385 if $programname != 'collectd' then
8386 *.* @192.168.0.2:6666;ls_json
8388 Please note that these rsyslog.conf examples are *not* complete, as rsyslog
8389 requires more than these options in the configuration file. These examples
8390 are meant to demonstration the proper remote logging and JSON format syntax.
8396 =item B<Listen> I<host> I<port>
8398 Listen on this IP on this port for incoming rsyslog messages.
8400 =item B<BufferSize> I<length>
8402 Maximum allowed size for incoming rsyslog messages. Messages that exceed
8403 this number will be truncated to this size. Default is 4096 bytes.
8405 =item B<BufferLength> I<length>
8407 Maximum number of rsyslog events that can be stored in plugin's ring buffer.
8408 By default, this is set to 10. Once an event has been read, its location
8409 becomes available for storing a new event.
8411 =item B<RegexFilter> I<regex>
8413 Enumerate a regex filter to apply to all incoming rsyslog messages. If a
8414 message matches this filter, it will be published.
8418 =head2 Plugin C<syslog>
8422 =item B<LogLevel> B<debug|info|notice|warning|err>
8424 Sets the log-level. If, for example, set to B<notice>, then all events with
8425 severity B<notice>, B<warning>, or B<err> will be submitted to the
8428 Please note that B<debug> is only available if collectd has been compiled with
8431 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8433 Controls which notifications should be sent to syslog. The default behaviour is
8434 not to send any. Less severe notifications always imply logging more severe
8435 notifications: Setting this to B<OKAY> means all notifications will be sent to
8436 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8437 notifications but will dismiss B<OKAY> notifications. Setting this option to
8438 B<FAILURE> will only send failures to syslog.
8442 =head2 Plugin C<table>
8444 The C<table plugin> provides generic means to parse tabular data and dispatch
8445 user specified values. Values are selected based on column numbers. For
8446 example, this plugin may be used to get values from the Linux L<proc(5)>
8447 filesystem or CSV (comma separated values) files.
8450 <Table "/proc/slabinfo">
8456 InstancePrefix "active_objs"
8462 InstancePrefix "objperslab"
8469 The configuration consists of one or more B<Table> blocks, each of which
8470 configures one file to parse. Within each B<Table> block, there are one or
8471 more B<Result> blocks, which configure which data to select and how to
8474 The following options are available inside a B<Table> block:
8478 =item B<Plugin> I<Plugin>
8480 If specified, I<Plugin> is used as the plugin name when submitting values.
8481 Defaults to B<table>.
8483 =item B<Instance> I<instance>
8485 If specified, I<instance> is used as the plugin instance. If omitted, the
8486 filename of the table is used instead, with all special characters replaced
8487 with an underscore (C<_>).
8489 =item B<Separator> I<string>
8491 Any character of I<string> is interpreted as a delimiter between the different
8492 columns of the table. A sequence of two or more contiguous delimiters in the
8493 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8494 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8495 of a table - see its documentation for more details. This option is mandatory.
8497 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8498 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8499 required because of collectd's config parsing.
8503 The following options are available inside a B<Result> block:
8507 =item B<Type> I<type>
8509 Sets the type used to dispatch the values to the daemon. Detailed information
8510 about types and their configuration can be found in L<types.db(5)>. This
8511 option is mandatory.
8513 =item B<InstancePrefix> I<prefix>
8515 If specified, prepend I<prefix> to the type instance. If omitted, only the
8516 B<InstancesFrom> option is considered for the type instance.
8518 =item B<InstancesFrom> I<column0> [I<column1> ...]
8520 If specified, the content of the given columns (identified by the column
8521 number starting at zero) will be used to create the type instance for each
8522 row. Multiple values (and the instance prefix) will be joined together with
8523 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8524 option is considered for the type instance.
8526 The plugin itself does not check whether or not all built instances are
8527 different. It’s your responsibility to assure that each is unique. This is
8528 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8529 sure that the table only contains one row.
8531 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8534 =item B<ValuesFrom> I<column0> [I<column1> ...]
8536 Specifies the columns (identified by the column numbers starting at zero)
8537 whose content is used as the actual data for the data sets that are dispatched
8538 to the daemon. How many such columns you need is determined by the B<Type>
8539 setting above. If you specify too many or not enough columns, the plugin will
8540 complain about that and no data will be submitted to the daemon. The plugin
8541 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8542 respectively, so anything supported by those functions is supported by the
8543 plugin as well. This option is mandatory.
8547 =head2 Plugin C<tail>
8549 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8550 each line and dispatches found values. What is matched can be configured by the
8551 user using (extended) regular expressions, as described in L<regex(7)>.
8554 <File "/var/log/exim4/mainlog">
8559 Regex "S=([1-9][0-9]*)"
8565 Regex "\\<R=local_user\\>"
8566 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8569 Instance "local_user"
8572 Regex "l=([0-9]*\\.[0-9]*)"
8573 <DSType "Distribution">
8576 #BucketType "bucket"
8584 The config consists of one or more B<File> blocks, each of which configures one
8585 logfile to parse. Within each B<File> block, there are one or more B<Match>
8586 blocks, which configure a regular expression to search for.
8588 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8589 the plugin name and instance respectively. So in the above example the plugin name
8590 C<mail-exim> would be used.
8592 These options are applied for all B<Match> blocks that B<follow> it, until the
8593 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8594 instances from one logfile, handy when parsing syslog and the like.
8596 The B<Interval> option allows you to define the length of time between reads. If
8597 this is not set, the default Interval will be used.
8599 Each B<Match> block has the following options to describe how the match should
8604 =item B<Regex> I<regex>
8606 Sets the regular expression to use for matching against a line. The first
8607 subexpression has to match something that can be turned into a number by
8608 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8609 below. Because B<extended> regular expressions are used, you do not need to use
8610 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8611 collectd's config parsing you need to escape backslashes, though. So if you
8612 want to match literal parentheses you need to do the following:
8614 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8616 =item B<ExcludeRegex> I<regex>
8618 Sets an optional regular expression to use for excluding lines from the match.
8619 An example which excludes all connections from localhost from the match:
8621 ExcludeRegex "127\\.0\\.0\\.1"
8623 =item B<DSType> I<Type>
8625 Sets how the values are cumulated. I<Type> is one of:
8629 =item B<GaugeAverage>
8631 Calculate the average of all values matched during the interval.
8635 Report the smallest value matched during the interval.
8639 Report the greatest value matched during the interval.
8643 Report the last value matched during the interval.
8645 =item B<GaugePersist>
8647 Report the last matching value. The metric is I<not> reset to C<NaN> at the end
8648 of an interval. It is continuously reported until another value is matched.
8649 This is intended for cases in which only state changes are reported, for
8650 example a thermometer that only reports the temperature when it changes.
8656 =item B<AbsoluteSet>
8658 The matched number is a counter. Simply I<sets> the internal counter to this
8659 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8667 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8668 matched number may be negative, which will effectively subtract from the
8677 Increase the internal counter by one. These B<DSType> are the only ones that do
8678 not use the matched subexpression, but simply count the number of matched
8679 lines. Thus, you may use a regular expression without submatch in this case.
8681 B<GaugeInc> is reset to I<zero> after every read, unlike other B<Gauge*>
8682 metrics which are reset to C<NaN>.
8684 =item B<Distribution>
8686 Type to do calculations based on the distribution of values, primarily
8687 calculating percentiles. This is primarily geared towards latency, but can be
8688 used for other metrics as well. The range of values tracked with this setting
8689 must be in the range (0–2^34) and can be fractional. Please note that neither
8690 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8693 This option must be used together with the B<Percentile> and/or B<Bucket>
8698 <DSType "Distribution">
8706 =item B<Percentile> I<Percent>
8708 Calculate and dispatch the configured percentile, i.e. compute the value, so
8709 that I<Percent> of all matched values are smaller than or equal to the computed
8712 Metrics are reported with the I<type> B<Type> (the value of the above option)
8713 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8715 This option may be repeated to calculate more than one percentile.
8717 =item B<Bucket> I<lower_bound> I<upper_bound>
8719 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8720 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8721 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8722 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8723 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8726 To export the entire (0–inf) range without overlap, use the upper bound of the
8727 previous range as the lower bound of the following range. In other words, use
8728 the following schema:
8738 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8739 by default) and the I<type instance>
8740 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8742 This option may be repeated to calculate more than one rate.
8744 =item B<BucketType> I<Type>
8746 Sets the type used to dispatch B<Bucket> metrics.
8747 Optional, by default C<bucket> will be used.
8753 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8754 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8755 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8756 B<Derive*> types interpret the submatch as a signed integer using
8757 L<strtoll(3)>. B<CounterInc>, B<DeriveInc> and B<GaugeInc> do not use the
8758 submatch at all and it may be omitted in this case.
8760 The B<Gauge*> types, unless noted otherwise, are reset to C<NaN> after being
8761 reported. In other words, B<GaugeAverage> reports the average of all values
8762 matched since the last metric was reported (or C<NaN> if there was no match).
8764 =item B<Type> I<Type>
8766 Sets the type used to dispatch this value. Detailed information about types and
8767 their configuration can be found in L<types.db(5)>.
8769 =item B<Instance> I<TypeInstance>
8771 This optional setting sets the type instance to use.
8775 =head2 Plugin C<tail_csv>
8777 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8778 written by I<Snort>.
8783 <Metric "snort-dropped">
8788 <File "/var/log/snort/snort.stats">
8792 Collect "snort-dropped"
8797 The configuration consists of one or more B<Metric> blocks that define an index
8798 into the line of the CSV file and how this value is mapped to I<collectd's>
8799 internal representation. These are followed by one or more B<Instance> blocks
8800 which configure which file to read, in which interval and which metrics to
8805 =item E<lt>B<Metric> I<Name>E<gt>
8807 The B<Metric> block configures a new metric to be extracted from the statistics
8808 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8809 only used inside the B<Instance> blocks to refer to this block, so you can use
8810 one B<Metric> block for multiple CSV files.
8814 =item B<Type> I<Type>
8816 Configures which I<Type> to use when dispatching this metric. Types are defined
8817 in the L<types.db(5)> file, see the appropriate manual page for more
8818 information on specifying types. Only types with a single I<data source> are
8819 supported by the I<tail_csv plugin>. The information whether the value is an
8820 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8821 I<Type's> definition.
8823 =item B<Instance> I<TypeInstance>
8825 If set, I<TypeInstance> is used to populate the type instance field of the
8826 created value lists. Otherwise, no type instance is used.
8828 =item B<ValueFrom> I<Index>
8830 Configure to read the value from the field with the zero-based index I<Index>.
8831 If the value is parsed as signed integer, unsigned integer or double depends on
8832 the B<Type> setting, see above.
8836 =item E<lt>B<File> I<Path>E<gt>
8838 Each B<File> block represents one CSV file to read. There must be at least one
8839 I<File> block but there can be multiple if you have multiple CSV files.
8843 =item B<Plugin> I<Plugin>
8845 Use I<Plugin> as the plugin name when submitting values.
8846 Defaults to C<tail_csv>.
8848 =item B<Instance> I<PluginInstance>
8850 Sets the I<plugin instance> used when dispatching the values.
8852 =item B<Collect> I<Metric>
8854 Specifies which I<Metric> to collect. This option must be specified at least
8855 once, and you can use this option multiple times to specify more than one
8856 metric to be extracted from this statistic file.
8858 =item B<Interval> I<Seconds>
8860 Configures the interval in which to read values from this instance / file.
8861 Defaults to the plugin's default interval.
8863 =item B<TimeFrom> I<Index>
8865 Rather than using the local time when dispatching a value, read the timestamp
8866 from the field with the zero-based index I<Index>. The value is interpreted as
8867 seconds since epoch. The value is parsed as a double and may be factional.
8873 =head2 Plugin C<teamspeak2>
8875 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8876 polls interesting global and virtual server data. The plugin can query only one
8877 physical server but unlimited virtual servers. You can use the following
8878 options to configure it:
8882 =item B<Host> I<hostname/ip>
8884 The hostname or ip which identifies the physical server.
8887 =item B<Port> I<port>
8889 The query port of the physical server. This needs to be a string.
8892 =item B<Server> I<port>
8894 This option has to be added once for every virtual server the plugin should
8895 query. If you want to query the virtual server on port 8767 this is what the
8896 option would look like:
8900 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8901 use quotes around it! If no such statement is given only global information
8906 =head2 Plugin C<ted>
8908 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8909 measure power consumption. These devices are usually connected to a serial
8910 (RS232) or USB port. The plugin opens a configured device and tries to read the
8911 current energy readings. For more information on TED, visit
8912 L<http://www.theenergydetective.com/>.
8914 Available configuration options:
8918 =item B<Device> I<Path>
8920 Path to the device on which TED is connected. collectd will need read and write
8921 permissions on that file.
8923 Default: B</dev/ttyUSB0>
8925 =item B<Retries> I<Num>
8927 Apparently reading from TED is not that reliable. You can therefore configure a
8928 number of retries here. You only configure the I<retries> here, to if you
8929 specify zero, one reading will be performed (but no retries if that fails); if
8930 you specify three, a maximum of four readings are performed. Negative values
8937 =head2 Plugin C<tcpconns>
8939 The C<tcpconns plugin> counts the number of currently established TCP
8940 connections based on the local port and/or the remote port. Since there may be
8941 a lot of connections the default if to count all connections with a local port,
8942 for which a listening socket is opened. You can use the following options to
8943 fine-tune the ports you are interested in:
8947 =item B<ListeningPorts> I<true>|I<false>
8949 If this option is set to I<true>, statistics for all local ports for which a
8950 listening socket exists are collected. The default depends on B<LocalPort> and
8951 B<RemotePort> (see below): If no port at all is specifically selected, the
8952 default is to collect listening ports. If specific ports (no matter if local or
8953 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8954 the selected ports will be collected unless this option is set to I<true>
8957 =item B<LocalPort> I<Port>
8959 Count the connections to a specific local port. This can be used to see how
8960 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8961 You have to specify the port in numeric form, so for the mailserver example
8962 you'd need to set B<25>.
8964 =item B<RemotePort> I<Port>
8966 Count the connections to a specific remote port. This is useful to see how
8967 much a remote service is used. This is most useful if you want to know how many
8968 connections a local service has opened to remote services, e.E<nbsp>g. how many
8969 connections a mail server or news server has to other mail or news servers, or
8970 how many connections a web proxy holds to web servers. You have to give the
8971 port in numeric form.
8973 =item B<AllPortsSummary> I<true>|I<false>
8975 If this option is set to I<true> a summary of statistics from all connections
8976 are collected. This option defaults to I<false>.
8980 =head2 Plugin C<thermal>
8984 =item B<ForceUseProcfs> I<true>|I<false>
8986 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8987 C<sysfs> interface. If that is not available, the plugin falls back to the
8988 C<procfs> interface. By setting this option to I<true>, you can force the
8989 plugin to use the latter. This option defaults to I<false>.
8991 =item B<Device> I<Device>
8993 Selects the name of the thermal device that you want to collect or ignore,
8994 depending on the value of the B<IgnoreSelected> option. This option may be
8995 used multiple times to specify a list of devices.
8997 See F</"IGNORELISTS"> for details.
8999 =item B<IgnoreSelected> I<true>|I<false>
9001 Invert the selection: If set to true, all devices B<except> the ones that
9002 match the device names specified by the B<Device> option are collected. By
9003 default only selected devices are collected if a selection is made. If no
9004 selection is configured at all, B<all> devices are selected.
9008 =head2 Plugin C<threshold>
9010 The I<Threshold plugin> checks values collected or received by I<collectd>
9011 against a configurable I<threshold> and issues I<notifications> if values are
9014 Documentation for this plugin is available in the L<collectd-threshold(5)>
9017 =head2 Plugin C<tokyotyrant>
9019 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
9020 couple metrics: number of records, and database size on disk.
9024 =item B<Host> I<Hostname/IP>
9026 The hostname or IP which identifies the server.
9027 Default: B<127.0.0.1>
9029 =item B<Port> I<Service/Port>
9031 The query port of the server. This needs to be a string, even if the port is
9032 given in its numeric form.
9037 =head2 Plugin C<turbostat>
9039 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
9040 Intel processors by using I<Model Specific Registers>.
9044 =item B<CoreCstates> I<Bitmask(Integer)>
9046 Bit mask of the list of core C-states supported by the processor.
9047 This option should only be used if the automated detection fails.
9048 Default value extracted from the CPU model and family.
9050 Currently supported C-states (by this plugin): 3, 6, 7
9054 All states (3, 6 and 7):
9055 (1<<3) + (1<<6) + (1<<7) = 392
9057 =item B<PackageCstates> I<Bitmask(Integer)>
9059 Bit mask of the list of packages C-states supported by the processor. This
9060 option should only be used if the automated detection fails. Default value
9061 extracted from the CPU model and family.
9063 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
9067 States 2, 3, 6 and 7:
9068 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
9070 =item B<SystemManagementInterrupt> I<true>|I<false>
9072 Boolean enabling the collection of the I/O System-Management Interrupt counter.
9073 This option should only be used if the automated detection fails or if you want
9074 to disable this feature.
9076 =item B<DigitalTemperatureSensor> I<true>|I<false>
9078 Boolean enabling the collection of the temperature of each core. This option
9079 should only be used if the automated detection fails or if you want to disable
9082 =item B<TCCActivationTemp> I<Temperature>
9084 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
9085 temperature is used when collecting the temperature of cores or packages. This
9086 option should only be used if the automated detection fails. Default value
9087 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
9089 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
9091 Bit mask of the list of elements to be thermally monitored. This option should
9092 only be used if the automated detection fails or if you want to disable some
9093 collections. The different bits of this bit mask accepted by this plugin are:
9097 =item 0 ('1'): Package
9101 =item 2 ('4'): Cores
9103 =item 3 ('8'): Embedded graphic device
9107 =item B<LogicalCoreNames> I<true>|I<false>
9109 Boolean enabling the use of logical core numbering for per core statistics.
9110 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
9111 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
9112 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
9113 more than one, where I<n> is the n-th core of package I<m>.
9115 =item B<RestoreAffinityPolicy> I<AllCPUs>|I<Restore>
9117 Reading data from CPU has side-effect: collectd process's CPU affinity mask
9118 changes. After reading data is completed, affinity mask needs to be restored.
9119 This option allows to set restore policy.
9121 B<AllCPUs> (the default): Restore the affinity by setting affinity to any/all
9124 B<Restore>: Save affinity using sched_getaffinity() before reading data and
9127 On some systems, sched_getaffinity() will fail due to inconsistency of the CPU
9128 set size between userspace and kernel. In these cases plugin will detect the
9129 unsuccessful call and fail with an error, preventing data collection.
9130 Most of configurations does not need to save affinity as Collectd process is
9131 allowed to run on any/all available CPUs.
9133 If you need to save and restore affinity and get errors like 'Unable to save
9134 the CPU affinity', setting 'possible_cpus' kernel boot option may also help.
9136 See following links for details:
9138 L<https://github.com/collectd/collectd/issues/1593>
9139 L<https://sourceware.org/bugzilla/show_bug.cgi?id=15630>
9140 L<https://bugzilla.kernel.org/show_bug.cgi?id=151821>
9144 =head2 Plugin C<unixsock>
9148 =item B<SocketFile> I<Path>
9150 Sets the socket-file which is to be created.
9152 =item B<SocketGroup> I<Group>
9154 If running as root change the group of the UNIX-socket after it has been
9155 created. Defaults to B<collectd>.
9157 =item B<SocketPerms> I<Permissions>
9159 Change the file permissions of the UNIX-socket after it has been created. The
9160 permissions must be given as a numeric, octal value as you would pass to
9161 L<chmod(1)>. Defaults to B<0770>.
9163 =item B<DeleteSocket> B<false>|B<true>
9165 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
9166 with the given name already exists. If I<collectd> crashes a socket file may be
9167 left over, preventing the daemon from opening a new socket when restarted.
9168 Since this is potentially dangerous, this defaults to B<false>.
9172 =head2 Plugin C<uuid>
9174 This plugin, if loaded, causes the Hostname to be taken from the machine's
9175 UUID. The UUID is a universally unique designation for the machine, usually
9176 taken from the machine's BIOS. This is most useful if the machine is running in
9177 a virtual environment such as Xen, in which case the UUID is preserved across
9178 shutdowns and migration.
9180 The following methods are used to find the machine's UUID, in order:
9186 Check I</etc/uuid> (or I<UUIDFile>).
9190 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
9195 Check for UUID from C<dmidecode> / SMBIOS.
9199 Check for UUID from Xen hypervisor.
9203 If no UUID can be found then the hostname is not modified.
9207 =item B<UUIDFile> I<Path>
9209 Take the UUID from the given file (default I</etc/uuid>).
9213 =head2 Plugin C<varnish>
9215 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
9216 It collects a subset of the values displayed by L<varnishstat(1)>, and
9217 organizes them in categories which can be enabled or disabled. Currently only
9218 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
9219 meaning of each metric can be found in L<varnish-counters(7)>.
9224 <Instance "example">
9228 CollectConnections true
9229 CollectDirectorDNS false
9233 CollectObjects false
9235 CollectSession false
9245 CollectWorkers false
9247 CollectMempool false
9248 CollectManagement false
9255 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
9256 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
9257 will collectd statistics from the default "varnishd" instance (this should work
9258 fine in most cases).
9260 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
9264 =item B<CollectBackend> B<true>|B<false>
9266 Back-end connection statistics, such as successful, reused,
9267 and closed connections. True by default.
9269 =item B<CollectBan> B<true>|B<false>
9271 Statistics about ban operations, such as number of bans added, retired, and
9272 number of objects tested against ban operations. Only available with Varnish
9273 3.x and above. False by default.
9275 =item B<CollectCache> B<true>|B<false>
9277 Cache hits and misses. True by default.
9279 =item B<CollectConnections> B<true>|B<false>
9281 Number of client connections received, accepted and dropped. True by default.
9283 =item B<CollectDirectorDNS> B<true>|B<false>
9285 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
9288 =item B<CollectESI> B<true>|B<false>
9290 Edge Side Includes (ESI) parse statistics. False by default.
9292 =item B<CollectFetch> B<true>|B<false>
9294 Statistics about fetches (HTTP requests sent to the backend). False by default.
9296 =item B<CollectHCB> B<true>|B<false>
9298 Inserts and look-ups in the crit bit tree based hash. Look-ups are
9299 divided into locked and unlocked look-ups. False by default.
9301 =item B<CollectObjects> B<true>|B<false>
9303 Statistics on cached objects: number of objects expired, nuked (prematurely
9304 expired), saved, moved, etc. False by default.
9306 =item B<CollectPurge> B<true>|B<false>
9308 Statistics about purge operations, such as number of purges added, retired, and
9309 number of objects tested against purge operations. Only available with Varnish
9310 2.x. False by default.
9312 =item B<CollectSession> B<true>|B<false>
9314 Client session statistics. Number of past and current sessions, session herd and
9315 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9316 metrics found in the Connections and Threads sections with previous versions of
9317 Varnish have been moved here.
9319 =item B<CollectSHM> B<true>|B<false>
9321 Statistics about the shared memory log, a memory region to store
9322 log messages which is flushed to disk when full. True by default.
9324 =item B<CollectSMA> B<true>|B<false>
9326 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9327 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9328 only the one used by the Varnish instance. Only available with Varnish 2.x.
9331 =item B<CollectSMS> B<true>|B<false>
9333 synth (synthetic content) storage statistics. This storage
9334 component is used internally only. False by default.
9336 =item B<CollectSM> B<true>|B<false>
9338 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9339 in varnish 4.x. use CollectSMF.
9342 =item B<CollectStruct> B<true>|B<false>
9344 Current varnish internal state statistics. Number of current sessions, objects
9345 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9348 =item B<CollectTotals> B<true>|B<false>
9350 Collects overview counters, such as the number of sessions created,
9351 the number of requests and bytes transferred. False by default.
9353 =item B<CollectUptime> B<true>|B<false>
9355 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9357 =item B<CollectVCL> B<true>|B<false>
9359 Number of total (available + discarded) VCL (config files). False by default.
9361 =item B<CollectVSM> B<true>|B<false>
9363 Collect statistics about Varnish's shared memory usage (used by the logging and
9364 statistics subsystems). Only available with Varnish 4.x. False by default.
9366 =item B<CollectWorkers> B<true>|B<false>
9368 Collect statistics about worker threads. False by default.
9370 =item B<CollectVBE> B<true>|B<false>
9372 Backend counters. Only available with Varnish 4.x. False by default.
9374 =item B<CollectSMF> B<true>|B<false>
9376 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9377 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9378 instance. Used to be called SM in Varnish 2.x. False by default.
9380 =item B<CollectManagement> B<true>|B<false>
9382 Management process counters. Only available with Varnish 4.x. False by default.
9384 =item B<CollectLock> B<true>|B<false>
9386 Lock counters. Only available with Varnish 4.x. False by default.
9388 =item B<CollectMempool> B<true>|B<false>
9390 Memory pool counters. Only available with Varnish 4.x. False by default.
9392 =item B<CollectMSE> B<true>|B<false>
9394 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9395 Varnish, replacing the traditional malloc and file storages. Only available
9396 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9397 one used by the Varnish instance. False by default.
9401 =head2 Plugin C<virt>
9403 This plugin allows CPU, disk, network load and other metrics to be collected for
9404 virtualized guests on the machine. The statistics are collected through libvirt
9405 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9406 installing any additional software on guests, especially I<collectd>, which runs
9407 only on the host system.
9409 Only I<Connection> is required.
9411 Consider the following example config:
9414 Connection "qemu:///system"
9415 HostnameFormat "hostname"
9416 InterfaceFormat "address"
9417 PluginInstanceFormat "name"
9420 It will generate the following values:
9422 node42.example.com/virt-instance-0006f26c/disk_octets-vda
9423 node42.example.com/virt-instance-0006f26c/disk_ops-vda
9424 node42.example.com/virt-instance-0006f26c/if_dropped-ca:fe:ca:fe:ca:fe
9425 node42.example.com/virt-instance-0006f26c/if_errors-ca:fe:ca:fe:ca:fe
9426 node42.example.com/virt-instance-0006f26c/if_octets-ca:fe:ca:fe:ca:fe
9427 node42.example.com/virt-instance-0006f26c/if_packets-ca:fe:ca:fe:ca:fe
9428 node42.example.com/virt-instance-0006f26c/memory-actual_balloon
9429 node42.example.com/virt-instance-0006f26c/memory-available
9430 node42.example.com/virt-instance-0006f26c/memory-last_update
9431 node42.example.com/virt-instance-0006f26c/memory-major_fault
9432 node42.example.com/virt-instance-0006f26c/memory-minor_fault
9433 node42.example.com/virt-instance-0006f26c/memory-rss
9434 node42.example.com/virt-instance-0006f26c/memory-swap_in
9435 node42.example.com/virt-instance-0006f26c/memory-swap_out
9436 node42.example.com/virt-instance-0006f26c/memory-total
9437 node42.example.com/virt-instance-0006f26c/memory-unused
9438 node42.example.com/virt-instance-0006f26c/memory-usable
9439 node42.example.com/virt-instance-0006f26c/virt_cpu_total
9440 node42.example.com/virt-instance-0006f26c/virt_vcpu-0
9442 You can get information on the metric's units from the online libvirt documentation.
9443 For instance, I<virt_cpu_total> is in nanoseconds.
9447 =item B<Connection> I<uri>
9449 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9451 Connection "xen:///"
9453 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9455 =item B<RefreshInterval> I<seconds>
9457 Refresh the list of domains and devices every I<seconds>. The default is 60
9458 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9459 the list of domains and devices to be refreshed on every iteration.
9461 Refreshing the devices in particular is quite a costly operation, so if your
9462 virtualization setup is static you might consider increasing this. If this
9463 option is set to 0, refreshing is disabled completely.
9465 =item B<Domain> I<name>
9467 =item B<BlockDevice> I<name:dev>
9469 =item B<InterfaceDevice> I<name:dev>
9471 =item B<IgnoreSelected> B<true>|B<false>
9473 Select which domains and devices are collected.
9475 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9476 disk/network devices are collected.
9478 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9479 domains and disk/network devices are ignored, while the rest are collected.
9481 The domain name and device names may use a regular expression, if the name is
9482 surrounded by I</.../> and collectd was compiled with support for regexps.
9484 The default is to collect statistics for all domains and all their devices.
9486 B<Note:> B<BlockDevice> and B<InterfaceDevice> options are related to
9487 corresponding B<*Format> options. Specifically, B<BlockDevice> filtering depends
9488 on B<BlockDeviceFormat> setting - if user wants to filter block devices by
9489 'target' name then B<BlockDeviceFormat> option has to be set to 'target' and
9490 B<BlockDevice> option must be set to a valid block device target
9491 name("/:hdb/"). Mixing formats and filter values from different worlds (i.e.,
9492 using 'target' name as B<BlockDevice> value with B<BlockDeviceFormat> set to
9493 'source') may lead to unexpected results (all devices filtered out or all
9494 visible, depending on the value of B<IgnoreSelected> option).
9495 Similarly, option B<InterfaceDevice> is related to B<InterfaceFormat> setting
9496 (i.e., when user wants to use MAC address as a filter then B<InterfaceFormat>
9497 has to be set to 'address' - using wrong type here may filter out all of the
9502 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9505 BlockDevice "/:hdb/"
9506 IgnoreSelected "true"
9507 BlockDeviceFormat "target"
9511 Collect metrics only for block device on 'baremetal0' domain when its
9512 'source' matches given path:
9514 BlockDevice "baremetal0:/var/lib/libvirt/images/baremetal0.qcow2"
9515 BlockDeviceFormat source
9517 As you can see it is possible to filter devices/interfaces using
9518 various formats - for block devices 'target' or 'source' name can be
9519 used. Interfaces can be filtered using 'name', 'address' or 'number'.
9523 Collect metrics only for domains 'baremetal0' and 'baremetal1' and
9524 ignore any other domain:
9529 It is possible to filter multiple block devices/domains/interfaces by
9530 adding multiple filtering entries in separate lines.
9532 =item B<BlockDeviceFormat> B<target>|B<source>
9534 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9535 seen by the guest will be used for reporting metrics.
9536 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9539 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9540 using the path of the source, e.g. an image file.
9541 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9546 If the domain XML have the following device defined:
9548 <disk type='block' device='disk'>
9549 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9550 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9551 <target dev='sda' bus='scsi'/>
9553 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9556 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9558 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9559 to C<var_lib_libvirt_images_image1.qcow2>.
9561 B<Note:> this option determines also what field will be used for
9562 filtering over block devices (filter value in B<BlockDevice>
9563 will be applied to target or source). More info about filtering
9564 block devices can be found in the description of B<BlockDevice>.
9566 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9568 The B<BlockDeviceFormatBasename> controls whether the full path or the
9569 L<basename(1)> of the source is being used as the I<type instance> when
9570 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9574 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9575 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9576 be set to C<var_lib_libvirt_images_image1.qcow2>.
9577 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9578 set to C<image1.qcow2>.
9580 =item B<HostnameFormat> B<name|uuid|hostname|metadata...>
9582 When the virt plugin logs data, it sets the hostname of the collected data
9583 according to this setting. The default is to use the guest name as provided by
9584 the hypervisor, which is equal to setting B<name>.
9586 B<uuid> means use the guest's UUID. This is useful if you want to track the
9587 same guest across migrations.
9589 B<hostname> means to use the global B<Hostname> setting, which is probably not
9590 useful on its own because all guests will appear to have the same name. This is
9591 useful in conjunction with B<PluginInstanceFormat> though.
9593 B<metadata> means use information from guest's metadata. Use
9594 B<HostnameMetadataNS> and B<HostnameMetadataXPath> to localize this information.
9596 You can also specify combinations of these fields. For example B<name uuid>
9597 means to concatenate the guest name and UUID (with a literal colon character
9598 between, thus I<"foo:1234-1234-1234-1234">).
9600 At the moment of writing (collectd-5.5), hostname string is limited to 62
9601 characters. In case when combination of fields exceeds 62 characters,
9602 hostname will be truncated without a warning.
9604 =item B<InterfaceFormat> B<name>|B<address>|B<number>
9606 When the virt plugin logs interface data, it sets the name of the collected
9607 data according to this setting. The default is to use the path as provided by
9608 the hypervisor (the "dev" property of the target node), which is equal to
9611 B<address> means use the interface's mac address. This is useful since the
9612 interface path might change between reboots of a guest or across migrations.
9614 B<number> means use the interface's number in guest.
9616 B<Note:> this option determines also what field will be used for
9617 filtering over interface device (filter value in B<InterfaceDevice>
9618 will be applied to name, address or number). More info about filtering
9619 interfaces can be found in the description of B<InterfaceDevice>.
9621 =item B<PluginInstanceFormat> B<name|uuid|metadata|none>
9623 When the virt plugin logs data, it sets the plugin_instance of the collected
9624 data according to this setting. The default is to not set the plugin_instance.
9626 B<name> means use the guest's name as provided by the hypervisor.
9627 B<uuid> means use the guest's UUID.
9628 B<metadata> means use information from guest's metadata.
9630 You can also specify combinations of the B<name> and B<uuid> fields.
9631 For example B<name uuid> means to concatenate the guest name and UUID
9632 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9634 =item B<HostnameMetadataNS> B<string>
9636 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9637 selects in which metadata namespace we will pick the hostname. The default is
9638 I<http://openstack.org/xmlns/libvirt/nova/1.0>.
9640 =item B<HostnameMetadataXPath> B<string>
9642 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9643 describes where the hostname is located in the libvirt metadata. The default is
9644 I</instance/name/text()>.
9646 =item B<ReportBlockDevices> B<true>|B<false>
9648 Enabled by default. Allows to disable stats reporting of block devices for
9651 =item B<ReportNetworkInterfaces> B<true>|B<false>
9653 Enabled by default. Allows to disable stats reporting of network interfaces for
9656 =item B<ExtraStats> B<string>
9658 Report additional extra statistics. The default is no extra statistics, preserving
9659 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9660 allows the plugin to reported more detailed statistics about the behaviour of
9661 Virtual Machines. The argument is a space-separated list of selectors.
9663 Currently supported selectors are:
9667 =item B<cpu_util>: report CPU utilization per domain in percentage.
9669 =item B<disk>: report extra statistics like number of flush operations and total
9670 service time for read, write and flush operations. Requires libvirt API version
9673 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9676 =item B<domain_state>: report domain state and reason as 'domain_state' metric.
9678 =item B<fs_info>: report file system information as a notification. Requires
9679 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9680 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9681 version supports retrieving file system information.
9683 =item B<job_stats_background>: report statistics about progress of a background
9684 job on a domain. Only one type of job statistics can be collected at the same time.
9685 Requires libvirt API version I<1.2.9> or later.
9687 =item B<job_stats_completed>: report statistics about a recently completed job on
9688 a domain. Only one type of job statistics can be collected at the same time.
9689 Requires libvirt API version I<1.2.9> or later.
9691 =item B<memory>: report statistics about memory usage details, provided
9692 by libvirt virDomainMemoryStats() function.
9694 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9695 Requires libvirt API version I<0.9.11> or later.
9697 =item B<perf>: report performance monitoring events. To collect performance
9698 metrics they must be enabled for domain and supported by the platform. Requires
9699 libvirt API version I<1.3.3> or later.
9700 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9702 =item B<vcpu>: report domain virtual CPUs utilisation.
9704 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9706 =item B<disk_physical>: report 'disk_physical' statistic for disk device.
9707 B<Note>: This statistic is only reported for disk devices with 'source'
9710 =item B<disk_allocation>: report 'disk_allocation' statistic for disk device.
9711 B<Note>: This statistic is only reported for disk devices with 'source'
9714 =item B<disk_capacity>: report 'disk_capacity' statistic for disk device.
9715 B<Note>: This statistic is only reported for disk devices with 'source'
9720 =item B<PersistentNotification> B<true>|B<false>
9722 Override default configuration to only send notifications when there is a change
9723 in the lifecycle state of a domain. When set to true notifications will be sent
9724 for every read cycle. Default is false. Does not affect the stats being
9727 =item B<Instances> B<integer>
9729 How many read instances you want to use for this plugin. The default is one,
9730 and the sensible setting is a multiple of the B<ReadThreads> value.
9732 This option is only useful when domains are specially tagged.
9733 If you are not sure, just use the default setting.
9735 The reader instance will only query the domains with attached matching tag.
9736 Tags should have the form of 'virt-X' where X is the reader instance number,
9739 The special-purpose reader instance #0, guaranteed to be always present,
9740 will query all the domains with missing or unrecognized tag, so no domain will
9743 Domain tagging is done with a custom attribute in the libvirt domain metadata
9744 section. Value is selected by an XPath I</domain/metadata/ovirtmap/tag/text()>
9745 expression in the I<http://ovirt.org/ovirtmap/tag/1.0> namespace.
9746 (XPath and namespace values are not configurable yet).
9748 Tagging could be used by management applications to evenly spread the
9749 load among the reader threads, or to pin on the same threads all
9750 the libvirt domains which use the same shared storage, to minimize
9751 the disruption in presence of storage outages.
9755 =head2 Plugin C<vmem>
9757 The C<vmem> plugin collects information about the usage of virtual memory.
9758 Since the statistics provided by the Linux kernel are very detailed, they are
9759 collected very detailed. However, to get all the details, you have to switch
9760 them on manually. Most people just want an overview over, such as the number of
9761 pages read from swap space.
9765 =item B<Verbose> B<true>|B<false>
9767 Enables verbose collection of information. This will start collecting page
9768 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9769 Part of these statistics are collected on a "per zone" basis.
9773 =head2 Plugin C<vserver>
9775 This plugin doesn't have any options. B<VServer> support is only available for
9776 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9777 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9778 need to apply the patches and compile your own kernel, which will then provide
9779 the F</proc/virtual> filesystem that is required by this plugin.
9781 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9783 B<Note>: The traffic collected by this plugin accounts for the amount of
9784 traffic passing a socket which might be a lot less than the actual on-wire
9785 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9786 collect on-wire traffic you could, for example, use the logging facilities of
9787 iptables to feed data for the guest IPs into the iptables plugin.
9789 =head2 Plugin C<write_graphite>
9791 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9792 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9793 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9794 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9795 of at most 1428 bytes to minimize the number of network packets.
9799 <Plugin write_graphite>
9811 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9812 blocks. Inside the B<Node> blocks, the following options are recognized:
9816 =item B<Host> I<Address>
9818 Hostname or address to connect to. Defaults to C<localhost>.
9820 =item B<Port> I<Service>
9822 Service name or port number to connect to. Defaults to C<2003>.
9824 =item B<Protocol> I<String>
9826 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9828 =item B<ReconnectInterval> I<Seconds>
9830 When set to non-zero, forces the connection to the Graphite backend to be
9831 closed and re-opend periodically. This behavior is desirable in environments
9832 where the connection to the Graphite backend is done through load balancers,
9833 for example. When set to zero, the default, the connetion is kept open for as
9836 =item B<LogSendErrors> B<false>|B<true>
9838 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9839 If set to B<false>, it will not log the errors. This is especially useful when
9840 using Protocol UDP since many times we want to use the "fire-and-forget"
9841 approach and logging errors fills syslog with unneeded messages.
9843 =item B<Prefix> I<String>
9845 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9846 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9848 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9851 =item B<Postfix> I<String>
9853 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9854 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9855 (before the first ; that separates the name from the tags).
9857 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9860 =item B<EscapeCharacter> I<Char>
9862 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9863 in the identifier. The B<EscapeCharacter> option determines which character
9864 dots, whitespace and control characters are replaced with. Defaults to
9867 =item B<StoreRates> B<false>|B<true>
9869 If set to B<true> (the default), convert counter values to rates. If set to
9870 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9873 =item B<SeparateInstances> B<false>|B<true>
9875 If set to B<true>, the plugin instance and type instance will be in their own
9876 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9877 default), the plugin and plugin instance (and likewise the type and type
9878 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9880 Option value is not used when B<UseTags> is I<true>.
9882 =item B<AlwaysAppendDS> B<false>|B<true>
9884 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9885 identifier. If set to B<false> (the default), this is only done when there is
9888 =item B<PreserveSeparator> B<false>|B<true>
9890 If set to B<false> (the default) the C<.> (dot) character is replaced with
9891 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9892 is preserved, i.e. passed through.
9894 Option value is not used when B<UseTags> is I<true>.
9896 =item B<DropDuplicateFields> B<false>|B<true>
9898 If set to B<true>, detect and remove duplicate components in Graphite metric
9899 names. For example, the metric name C<host.load.load.shortterm> will
9900 be shortened to C<host.load.shortterm>.
9902 =item B<UseTags> B<false>|B<true>
9904 If set to B<true>, Graphite metric names will be generated as tagged series.
9905 This allows for much more flexibility than the traditional hierarchical layout.
9908 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9910 You can use B<Postfix> option to add more tags by specifying it like
9911 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9914 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9917 Default value: B<false>.
9919 =item B<ReverseHost> B<false>|B<true>
9921 If set to B<true>, the (dot separated) parts of the B<host> field of the
9922 I<value list> will be rewritten in reverse order. The rewrite happens I<before>
9923 special characters are replaced with the B<EscapeCharacter>.
9925 This option might be convenient if the metrics are presented with Graphite in a
9926 DNS like tree structure (probably without replacing dots in hostnames).
9929 Hostname "node3.cluster1.example.com"
9931 LoadPlugin "write_graphite"
9932 <Plugin "write_graphite">
9933 <Node "graphite.example.com">
9939 result on the wire: com.example.cluster1.node3.cpu-0.cpu-idle 99.900993 1543010932
9941 Default value: B<false>.
9945 =head2 Plugin C<write_log>
9947 The C<write_log> plugin writes metrics as INFO log messages.
9949 This plugin supports two output formats: I<Graphite> and I<JSON>.
9959 =item B<Format> I<Format>
9961 The output format to use. Can be one of C<Graphite> or C<JSON>.
9965 =head2 Plugin C<write_tsdb>
9967 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9968 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9969 state daemon that ingests metrics and stores them in HBase. The plugin uses
9970 I<TCP> over the "line based" protocol with a default port 4242. The data will
9971 be sent in blocks of at most 1428 bytes to minimize the number of network
9980 Host "tsd-1.my.domain"
9982 HostTags "status=production"
9986 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9987 blocks and global directives.
9989 Global directives are:
9993 =item B<ResolveInterval> I<seconds>
9995 =item B<ResolveJitter> I<seconds>
9997 When I<collectd> connects to a TSDB node, it will request the hostname from
9998 DNS. This can become a problem if the TSDB node is unavailable or badly
9999 configured because collectd will request DNS in order to reconnect for every
10000 metric, which can flood your DNS. So you can cache the last value for
10001 I<ResolveInterval> seconds.
10002 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
10004 You can also define a jitter, a random interval to wait in addition to
10005 I<ResolveInterval>. This prevents all your collectd servers to resolve the
10006 hostname at the same time when the connection fails.
10007 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
10009 B<Note:> If the DNS resolution has already been successful when the socket
10010 closes, the plugin will try to reconnect immediately with the cached
10011 information. DNS is queried only when the socket is closed for a longer than
10012 I<ResolveInterval> + I<ResolveJitter> seconds.
10016 Inside the B<Node> blocks, the following options are recognized:
10020 =item B<Host> I<Address>
10022 Hostname or address to connect to. Defaults to C<localhost>.
10024 =item B<Port> I<Service>
10026 Service name or port number to connect to. Defaults to C<4242>.
10029 =item B<HostTags> I<String>
10031 When set, I<HostTags> is added to the end of the metric. It is intended to be
10032 used for name=value pairs that the TSD will tag the metric with. Dots and
10033 whitespace are I<not> escaped in this string.
10035 =item B<StoreRates> B<false>|B<true>
10037 If set to B<true>, convert counter values to rates. If set to B<false>
10038 (the default) counter values are stored as is, as an increasing
10041 =item B<AlwaysAppendDS> B<false>|B<true>
10043 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
10044 identifier. If set to B<false> (the default), this is only done when there is
10049 =head2 Plugin C<write_mongodb>
10051 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
10056 <Plugin "write_mongodb">
10065 The plugin can send values to multiple instances of I<MongoDB> by specifying
10066 one B<Node> block for each instance. Within the B<Node> blocks, the following
10067 options are available:
10071 =item B<Host> I<Address>
10073 Hostname or address to connect to. Defaults to C<localhost>.
10075 =item B<Port> I<Service>
10077 Service name or port number to connect to. Defaults to C<27017>.
10079 =item B<Timeout> I<Milliseconds>
10081 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
10082 Setting this option to zero means no timeout, which is the default.
10084 =item B<StoreRates> B<false>|B<true>
10086 If set to B<true> (the default), convert counter values to rates. If set to
10087 B<false> counter values are stored as is, i.e. as an increasing integer
10090 =item B<Database> I<Database>
10092 =item B<User> I<User>
10094 =item B<Password> I<Password>
10096 Sets the information used when authenticating to a I<MongoDB> database. The
10097 fields are optional (in which case no authentication is attempted), but if you
10098 want to use authentication all three fields must be set.
10102 =head2 Plugin C<write_prometheus>
10104 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
10105 using I<Prometheus>.
10111 =item B<Host> I<Host>
10113 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
10114 "any" address, i.e. accept packets sent to any of the hosts addresses.
10116 This option is supported only for libmicrohttpd newer than 0.9.0.
10118 =item B<Port> I<Port>
10120 Port the embedded webserver should listen on. Defaults to B<9103>.
10122 =item B<StalenessDelta> I<Seconds>
10124 Time in seconds after which I<Prometheus> considers a metric "stale" if it
10125 hasn't seen any update for it. This value must match the setting in Prometheus.
10126 It defaults to B<300> seconds (5 minutes), same as Prometheus.
10130 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
10131 which time a metric without updates is considered "stale". This setting
10132 effectively puts an upper limit on the interval in which metrics are reported.
10134 When the I<write_prometheus plugin> encounters a metric with an interval
10135 exceeding this limit, it will inform you, the user, and provide the metric to
10136 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
10137 metric "fresh" each time it is scraped, with the time of the scrape being
10138 considered the time of the update. The result is that there appear more
10139 datapoints in I<Prometheus> than were actually created, but at least the metric
10140 doesn't disappear periodically.
10144 =head2 Plugin C<write_http>
10146 This output plugin submits values to an HTTP server using POST requests and
10147 encoding metrics with JSON or using the C<PUTVAL> command described in
10148 L<collectd-unixsock(5)>.
10152 <Plugin "write_http">
10154 URL "http://example.com/post-collectd"
10156 Password "weCh3ik0"
10161 The plugin can send values to multiple HTTP servers by specifying one
10162 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
10163 block, the following options are available:
10167 =item B<URL> I<URL>
10169 URL to which the values are submitted to. Mandatory.
10171 =item B<User> I<Username>
10173 Optional user name needed for authentication.
10175 =item B<Password> I<Password>
10177 Optional password needed for authentication.
10179 =item B<VerifyPeer> B<true>|B<false>
10181 Enable or disable peer SSL certificate verification. See
10182 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
10184 =item B<VerifyHost> B<true|false>
10186 Enable or disable peer host name verification. If enabled, the plugin checks if
10187 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
10188 matches the host name provided by the B<URL> option. If this identity check
10189 fails, the connection is aborted. Obviously, only works when connecting to a
10190 SSL enabled server. Enabled by default.
10192 =item B<CACert> I<File>
10194 File that holds one or more SSL certificates. If you want to use HTTPS you will
10195 possibly need this option. What CA certificates come bundled with C<libcurl>
10196 and are checked by default depends on the distribution you use.
10198 =item B<CAPath> I<Directory>
10200 Directory holding one or more CA certificate files. You can use this if for
10201 some reason all the needed CA certificates aren't in the same file and can't be
10202 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
10205 =item B<ClientKey> I<File>
10207 File that holds the private key in PEM format to be used for certificate-based
10210 =item B<ClientCert> I<File>
10212 File that holds the SSL certificate to be used for certificate-based
10215 =item B<ClientKeyPass> I<Password>
10217 Password required to load the private key in B<ClientKey>.
10219 =item B<Header> I<Header>
10221 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
10223 Header "X-Custom-Header: custom_value"
10225 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
10227 Define which SSL protocol version must be used. By default C<libcurl> will
10228 attempt to figure out the remote SSL protocol version. See
10229 L<curl_easy_setopt(3)> for more details.
10231 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
10233 Format of the output to generate. If set to B<Command>, will create output that
10234 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
10235 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
10236 , will create output in the KairosDB format.
10238 Defaults to B<Command>.
10240 =item B<Attribute> I<String> I<String>
10242 Only available for the KAIROSDB output format.
10244 Consider the two given strings to be the key and value of an additional tag for
10245 each metric being sent out.
10247 You can add multiple B<Attribute>.
10249 =item B<TTL> I<Int>
10251 Only available for the KAIROSDB output format.
10253 Sets the Cassandra ttl for the data points.
10255 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
10257 =item B<Prefix> I<String>
10259 Only available for the KAIROSDB output format.
10261 Sets the metrics prefix I<string>. Defaults to I<collectd>.
10263 =item B<Metrics> B<true>|B<false>
10265 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
10267 =item B<Notifications> B<false>|B<true>
10269 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
10271 =item B<StoreRates> B<true|false>
10273 If set to B<true>, convert counter values to rates. If set to B<false> (the
10274 default) counter values are stored as is, i.e. as an increasing integer number.
10276 =item B<BufferSize> I<Bytes>
10278 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
10279 requests will be generated, but more metrics will be batched / metrics are
10280 cached for longer before being sent, introducing additional delay until they
10281 are available on the server side. I<Bytes> must be at least 1024 and cannot
10282 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
10283 Defaults to C<4096>.
10285 =item B<LowSpeedLimit> I<Bytes per Second>
10287 Sets the minimal transfer rate in I<Bytes per Second> below which the
10288 connection with the HTTP server will be considered too slow and aborted. All
10289 the data submitted over this connection will probably be lost. Defaults to 0,
10290 which means no minimum transfer rate is enforced.
10292 =item B<Timeout> I<Timeout>
10294 Sets the maximum time in milliseconds given for HTTP POST operations to
10295 complete. When this limit is reached, the POST operation will be aborted, and
10296 all the data in the current send buffer will probably be lost. Defaults to 0,
10297 which means the connection never times out.
10299 =item B<LogHttpError> B<false>|B<true>
10301 Enables printing of HTTP error code to log. Turned off by default.
10303 The C<write_http> plugin regularly submits the collected values to the HTTP
10304 server. How frequently this happens depends on how much data you are collecting
10305 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
10306 slightly below this interval, which you can estimate by monitoring the network
10307 traffic between collectd and the HTTP server.
10311 =head2 Plugin C<write_kafka>
10313 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
10317 <Plugin "write_kafka">
10318 Property "metadata.broker.list" "broker1:9092,broker2:9092"
10324 The following options are understood by the I<write_kafka plugin>:
10328 =item E<lt>B<Topic> I<Name>E<gt>
10330 The plugin's configuration consists of one or more B<Topic> blocks. Each block
10331 is given a unique I<Name> and specifies one kafka producer.
10332 Inside the B<Topic> block, the following per-topic options are
10337 =item B<Property> I<String> I<String>
10339 Configure the named property for the current topic. Properties are
10340 forwarded to the kafka producer library B<librdkafka>.
10342 =item B<Key> I<String>
10344 Use the specified string as a partitioning key for the topic. Kafka breaks
10345 topic into partitions and guarantees that for a given topology, the same
10346 consumer will be used for a specific key. The special (case insensitive)
10347 string B<Random> can be used to specify that an arbitrary partition should
10350 =item B<Format> B<Command>|B<JSON>|B<Graphite>
10352 Selects the format in which messages are sent to the broker. If set to
10353 B<Command> (the default), values are sent as C<PUTVAL> commands which are
10354 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
10356 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
10357 an easy and straight forward exchange format.
10359 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
10360 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
10362 =item B<StoreRates> B<true>|B<false>
10364 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
10365 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
10366 default), no conversion is performed. Otherwise the conversion is performed
10367 using the internal value cache.
10369 Please note that currently this option is only used if the B<Format> option has
10370 been set to B<JSON>.
10372 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
10374 A prefix can be added in the metric name when outputting in the I<Graphite>
10377 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
10378 Metric name will be
10379 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>>
10381 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
10383 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
10385 A postfix can be added in the metric name when outputting in the I<Graphite>
10388 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
10389 Metric name will be
10390 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>>
10392 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
10393 name (before the first ; that separates the name from the tags).
10395 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
10397 Specify a character to replace dots (.) in the host part of the metric name.
10398 In I<Graphite> metric name, dots are used as separators between different
10399 metric parts (host, plugin, type).
10400 Default is C<_> (I<Underscore>).
10402 =item B<GraphiteSeparateInstances> B<false>|B<true>
10404 If set to B<true>, the plugin instance and type instance will be in their own
10405 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
10406 default), the plugin and plugin instance (and likewise the type and type
10407 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
10409 Option value is not used when B<GraphiteUseTags> is I<true>.
10411 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
10413 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10414 identifier. If set to B<false> (the default), this is only done when there is
10417 =item B<GraphitePreserveSeparator> B<false>|B<true>
10419 If set to B<false> (the default) the C<.> (dot) character is replaced with
10420 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
10421 is preserved, i.e. passed through.
10423 Option value is not used when B<GraphiteUseTags> is I<true>.
10425 =item B<GraphiteUseTags> B<false>|B<true>
10427 If set to B<true> Graphite metric names will be generated as tagged series.
10429 Default value: B<false>.
10431 =item B<StoreRates> B<true>|B<false>
10433 If set to B<true> (the default), convert counter values to rates. If set to
10434 B<false> counter values are stored as is, i.e. as an increasing integer number.
10436 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10437 converted values will have "rate" appended to the data source type, e.g.
10438 C<ds_type:derive:rate>.
10442 =item B<Property> I<String> I<String>
10444 Configure the kafka producer through properties, you almost always will
10445 want to set B<metadata.broker.list> to your Kafka broker list.
10449 =head2 Plugin C<write_redis>
10451 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
10455 <Plugin "write_redis">
10468 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
10469 the timestamp as the score. Retrieving a date range can then be done using the
10470 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
10471 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
10472 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
10473 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
10474 with the B<Database> parameter (default is C<0>). See
10475 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
10478 The information shown in the synopsis above is the I<default configuration>
10479 which is used by the plugin if no configuration is present.
10481 The plugin can send values to multiple instances of I<Redis> by specifying
10482 one B<Node> block for each instance. Within the B<Node> blocks, the following
10483 options are available:
10487 =item B<Node> I<Nodename>
10489 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10490 instance running on a specified host and port. The node name is a
10491 canonical identifier which is used as I<plugin instance>. It is limited to
10492 51E<nbsp>characters in length.
10494 =item B<Host> I<Hostname>
10496 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10499 =item B<Port> I<Port>
10501 The B<Port> option is the TCP port on which the Redis instance accepts
10502 connections. Either a service name of a port number may be given. Please note
10503 that numerical port numbers must be given as a string, too.
10505 =item B<Timeout> I<Milliseconds>
10507 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10509 =item B<Prefix> I<Prefix>
10511 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10512 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10513 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10514 is recommended but not required to include a trailing slash in I<Prefix>.
10516 =item B<Database> I<Index>
10518 This index selects the redis database to use for writing operations. Defaults
10521 =item B<MaxSetSize> I<Items>
10523 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10524 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10526 =item B<MaxSetDuration> I<Seconds>
10528 The B<MaxSetDuration> option limits the duration of items that the
10529 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10530 is the default behavior.
10532 =item B<StoreRates> B<true>|B<false>
10534 If set to B<true> (the default), convert counter values to rates. If set to
10535 B<false> counter values are stored as is, i.e. as an increasing integer number.
10539 =head2 Plugin C<write_riemann>
10541 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10542 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10543 I<Riemann> using UDP packets.
10547 <Plugin "write_riemann">
10553 AlwaysAppendDS false
10557 Attribute "foo" "bar"
10560 The following options are understood by the I<write_riemann plugin>:
10564 =item E<lt>B<Node> I<Name>E<gt>
10566 The plugin's configuration consists of one or more B<Node> blocks. Each block
10567 is given a unique I<Name> and specifies one connection to an instance of
10568 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10573 =item B<Host> I<Address>
10575 Hostname or address to connect to. Defaults to C<localhost>.
10577 =item B<Port> I<Service>
10579 Service name or port number to connect to. Defaults to C<5555>.
10581 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10583 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10586 =item B<TLSCertFile> I<Path>
10588 When using the B<TLS> protocol, path to a PEM certificate to present
10591 =item B<TLSCAFile> I<Path>
10593 When using the B<TLS> protocol, path to a PEM CA certificate to
10594 use to validate the remote hosts's identity.
10596 =item B<TLSKeyFile> I<Path>
10598 When using the B<TLS> protocol, path to a PEM private key associated
10599 with the certificate defined by B<TLSCertFile>.
10601 =item B<Batch> B<true>|B<false>
10603 If set to B<true> and B<Protocol> is set to B<TCP>,
10604 events will be batched in memory and flushed at
10605 regular intervals or when B<BatchMaxSize> is exceeded.
10607 Notifications are not batched and sent as soon as possible.
10609 When enabled, it can occur that events get processed by the Riemann server
10610 close to or after their expiration time. Tune the B<TTLFactor> and
10611 B<BatchMaxSize> settings according to the amount of values collected, if this
10616 =item B<BatchMaxSize> I<size>
10618 Maximum payload size for a riemann packet. Defaults to 8192
10620 =item B<BatchFlushTimeout> I<seconds>
10622 Maximum amount of seconds to wait in between to batch flushes.
10623 No timeout by default.
10625 =item B<StoreRates> B<true>|B<false>
10627 If set to B<true> (the default), convert counter values to rates. If set to
10628 B<false> counter values are stored as is, i.e. as an increasing integer number.
10630 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10631 converted values will have "rate" appended to the data source type, e.g.
10632 C<ds_type:derive:rate>.
10634 =item B<AlwaysAppendDS> B<false>|B<true>
10636 If set to B<true>, append the name of the I<Data Source> (DS) to the
10637 "service", i.e. the field that, together with the "host" field, uniquely
10638 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10639 only done when there is more than one DS.
10641 =item B<TTLFactor> I<Factor>
10643 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10644 event is considered active. I<collectd> populates this field based on the
10645 metrics interval setting. This setting controls the factor with which the
10646 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10647 know exactly what you're doing, you should only increase this setting from its
10650 =item B<Notifications> B<false>|B<true>
10652 If set to B<true>, create riemann events for notifications. This is B<true>
10653 by default. When processing thresholds from write_riemann, it might prove
10654 useful to avoid getting notification events.
10656 =item B<CheckThresholds> B<false>|B<true>
10658 If set to B<true>, attach state to events based on thresholds defined
10659 in the B<Threshold> plugin. Defaults to B<false>.
10661 =item B<EventServicePrefix> I<String>
10663 Add the given string as a prefix to the event service name.
10664 If B<EventServicePrefix> not set or set to an empty string (""),
10665 no prefix will be used.
10669 =item B<Tag> I<String>
10671 Add the given string as an additional tag to the metric being sent to
10674 =item B<Attribute> I<String> I<String>
10676 Consider the two given strings to be the key and value of an additional
10677 attribute for each metric being sent out to I<Riemann>.
10681 =head2 Plugin C<write_sensu>
10683 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10684 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10685 a local I<Sensu> client using a TCP socket.
10687 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10688 parameter so it is not possible to use one collectd instance as a gateway for
10689 others. Each collectd host must pair with one I<Sensu> client.
10693 <Plugin "write_sensu">
10698 AlwaysAppendDS false
10699 MetricHandler "influx"
10700 MetricHandler "default"
10701 NotificationHandler "flapjack"
10702 NotificationHandler "howling_monkey"
10706 Attribute "foo" "bar"
10709 The following options are understood by the I<write_sensu plugin>:
10713 =item E<lt>B<Node> I<Name>E<gt>
10715 The plugin's configuration consists of one or more B<Node> blocks. Each block
10716 is given a unique I<Name> and specifies one connection to an instance of
10717 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10722 =item B<Host> I<Address>
10724 Hostname or address to connect to. Defaults to C<localhost>.
10726 =item B<Port> I<Service>
10728 Service name or port number to connect to. Defaults to C<3030>.
10730 =item B<StoreRates> B<true>|B<false>
10732 If set to B<true> (the default), convert counter values to rates. If set to
10733 B<false> counter values are stored as is, i.e. as an increasing integer number.
10735 This will be reflected in the C<collectd_data_source_type> tag: If
10736 B<StoreRates> is enabled, converted values will have "rate" appended to the
10737 data source type, e.g. C<collectd_data_source_type:derive:rate>.
10739 =item B<AlwaysAppendDS> B<false>|B<true>
10741 If set the B<true>, append the name of the I<Data Source> (DS) to the
10742 "service", i.e. the field that, together with the "host" field, uniquely
10743 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10744 only done when there is more than one DS.
10746 =item B<Notifications> B<false>|B<true>
10748 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10749 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10751 =item B<Metrics> B<false>|B<true>
10753 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10754 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10757 =item B<Separator> I<String>
10759 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10761 =item B<MetricHandler> I<String>
10763 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10764 several of them, one per line. Defaults to no handler.
10766 =item B<NotificationHandler> I<String>
10768 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10769 add several of them, one per line. Defaults to no handler.
10771 =item B<EventServicePrefix> I<String>
10773 Add the given string as a prefix to the event service name.
10774 If B<EventServicePrefix> not set or set to an empty string (""),
10775 no prefix will be used.
10779 =item B<Tag> I<String>
10781 Add the given string as an additional tag to the metric being sent to
10784 =item B<Attribute> I<String> I<String>
10786 Consider the two given strings to be the key and value of an additional
10787 attribute for each metric being sent out to I<Sensu>.
10791 =head2 Plugin C<write_stackdriver>
10793 The C<write_stackdriver> plugin writes metrics to the
10794 I<Google Stackdriver Monitoring> service.
10796 This plugin supports two authentication methods: When configured, credentials
10797 are read from the JSON credentials file specified with B<CredentialFile>.
10798 Alternatively, when running on
10799 I<Google Compute Engine> (GCE), an I<OAuth> token is retrieved from the
10800 I<metadata server> and used to authenticate to GCM.
10804 <Plugin write_stackdriver>
10805 CredentialFile "/path/to/service_account.json"
10806 <Resource "global">
10807 Label "project_id" "monitored_project"
10813 =item B<CredentialFile> I<file>
10815 Path to a JSON credentials file holding the credentials for a GCP service
10818 If B<CredentialFile> is not specified, the plugin uses I<Application Default
10819 Credentials>. That means which credentials are used depends on the environment:
10825 The environment variable C<GOOGLE_APPLICATION_CREDENTIALS> is checked. If this
10826 variable is specified it should point to a JSON file that defines the
10831 The path C<${HOME}/.config/gcloud/application_default_credentials.json> is
10832 checked. This where credentials used by the I<gcloud> command line utility are
10833 stored. You can use C<gcloud auth application-default login> to create these
10836 Please note that these credentials are often of your personal account, not a
10837 service account, and are therefore unfit to be used in a production
10842 When running on GCE, the built-in service account associated with the virtual
10843 machine instance is used.
10844 See also the B<Email> option below.
10848 =item B<Project> I<Project>
10850 The I<Project ID> or the I<Project Number> of the I<Stackdriver Account>. The
10851 I<Project ID> is a string identifying the GCP project, which you can chose
10852 freely when creating a new project. The I<Project Number> is a 12-digit decimal
10853 number. You can look up both on the I<Developer Console>.
10855 This setting is optional. If not set, the project ID is read from the
10856 credentials file or determined from the GCE's metadata service.
10858 =item B<Email> I<Email> (GCE only)
10860 Choses the GCE I<Service Account> used for authentication.
10862 Each GCE instance has a C<default> I<Service Account> but may also be
10863 associated with additional I<Service Accounts>. This is often used to restrict
10864 the permissions of services running on the GCE instance to the required
10865 minimum. The I<write_stackdriver plugin> requires the
10866 C<https://www.googleapis.com/auth/monitoring> scope. When multiple I<Service
10867 Accounts> are available, this option selects which one is used by
10868 I<write_stackdriver plugin>.
10870 =item B<Resource> I<ResourceType>
10872 Configures the I<Monitored Resource> to use when storing metrics.
10873 More information on I<Monitored Resources> and I<Monitored Resource Types> are
10874 available at L<https://cloud.google.com/monitoring/api/resources>.
10876 This block takes one string argument, the I<ResourceType>. Inside the block are
10877 one or more B<Label> options which configure the resource labels.
10879 This block is optional. The default value depends on the runtime environment:
10880 on GCE, the C<gce_instance> resource type is used, otherwise the C<global>
10881 resource type ist used:
10887 B<On GCE>, defaults to the equivalent of this config:
10889 <Resource "gce_instance">
10890 Label "project_id" "<project_id>"
10891 Label "instance_id" "<instance_id>"
10892 Label "zone" "<zone>"
10895 The values for I<project_id>, I<instance_id> and I<zone> are read from the GCE
10900 B<Elsewhere>, i.e. not on GCE, defaults to the equivalent of this config:
10902 <Resource "global">
10903 Label "project_id" "<Project>"
10906 Where I<Project> refers to the value of the B<Project> option or the project ID
10907 inferred from the B<CredentialFile>.
10911 =item B<Url> I<Url>
10913 URL of the I<Stackdriver Monitoring> API. Defaults to
10914 C<https://monitoring.googleapis.com/v3>.
10918 =head2 Plugin C<write_syslog>
10920 The C<write_syslog> plugin writes data in I<syslog> format log messages.
10921 It implements the basic syslog protocol, RFC 5424, extends it with
10922 content-based filtering, rich filtering capabilities,
10923 flexible configuration options and adds features such as using TCP for transport.
10924 The plugin can connect to a I<Syslog> daemon, like syslog-ng and rsyslog, that will
10925 ingest metrics, transform and ship them to the specified output.
10926 The plugin uses I<TCP> over the "line based" protocol with a default port 44514.
10927 The data will be sent in blocks of at most 1428 bytes to minimize the number of
10932 <Plugin write_syslog>
10936 Host "syslog-1.my.domain"
10939 MessageFormat "human"
10944 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
10945 blocks and global directives.
10947 Global directives are:
10951 =item B<ResolveInterval> I<seconds>
10953 =item B<ResolveJitter> I<seconds>
10955 When I<collectd> connects to a syslog node, it will request the hostname from
10956 DNS. This can become a problem if the syslog node is unavailable or badly
10957 configured because collectd will request DNS in order to reconnect for every
10958 metric, which can flood your DNS. So you can cache the last value for
10959 I<ResolveInterval> seconds.
10960 Defaults to the I<Interval> of the I<write_syslog plugin>, e.g. 10E<nbsp>seconds.
10962 You can also define a jitter, a random interval to wait in addition to
10963 I<ResolveInterval>. This prevents all your collectd servers to resolve the
10964 hostname at the same time when the connection fails.
10965 Defaults to the I<Interval> of the I<write_syslog plugin>, e.g. 10E<nbsp>seconds.
10967 B<Note:> If the DNS resolution has already been successful when the socket
10968 closes, the plugin will try to reconnect immediately with the cached
10969 information. DNS is queried only when the socket is closed for a longer than
10970 I<ResolveInterval> + I<ResolveJitter> seconds.
10974 Inside the B<Node> blocks, the following options are recognized:
10978 =item B<Host> I<Address>
10980 Hostname or address to connect to. Defaults to C<localhost>.
10982 =item B<Port> I<Service>
10984 Service name or port number to connect to. Defaults to C<44514>.
10987 =item B<HostTags> I<String>
10989 When set, I<HostTags> is added to the end of the metric.
10990 It is intended to be used for adding additional metadata to tag the metric with.
10991 Dots and whitespace are I<not> escaped in this string.
10995 When MessageFormat is set to "human".
10997 ["prefix1" "example1"="example1_v"]["prefix2" "example2"="example2_v"]"
10999 When MessageFormat is set to "JSON", text should be in JSON format.
11000 Escaping the quotation marks is required.
11002 HostTags "\"prefix1\": {\"example1\":\"example1_v\",\"example2\":\"example2_v\"}"
11004 =item B<MessageFormat> I<String>
11006 I<MessageFormat> selects the format in which messages are sent to the
11007 syslog deamon, human or JSON. Defaults to human.
11009 Syslog message format:
11011 <priority>VERSION ISOTIMESTAMP HOSTNAME APPLICATION PID MESSAGEID STRUCTURED-DATA MSG
11013 The difference between the message formats are in the STRUCTURED-DATA and MSG parts.
11017 <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID
11018 ["collectd" "value": "v1" "plugin"="plugin_v" "plugin_instance"="plugin_instance_v"
11019 "type_instance"="type_instance_v" "type"="type_v" "ds_name"="ds_name_v" "interval"="interval_v" ]
11020 "host_tag_example"="host_tag_example_v" plugin_v.type_v.ds_name_v="v1"
11024 <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID STRUCTURED-DATA
11027 "time": time_as_epoch, "interval": interval_v, "plugin": "plugin_v",
11028 "plugin_instance": "plugin_instance_v", "type":"type_v",
11029 "type_instance": "type_instance_v", "plugin_v": {"type_v": v1}
11030 } , "host":"host_v", "host_tag_example": "host_tag_example_v"
11033 =item B<StoreRates> B<false>|B<true>
11035 If set to B<true>, convert counter values to rates. If set to B<false>
11036 (the default) counter values are stored as is, as an increasing
11039 =item B<AlwaysAppendDS> B<false>|B<true>
11041 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
11042 identifier. If set to B<false> (the default), this is only done when there is
11045 =item B<Prefix> I<String>
11047 When set, I<Prefix> is added to all metrics names as a prefix. It is intended in
11048 case you want to be able to define the source of the specific metric. Dots and
11049 whitespace are I<not> escaped in this string.
11053 =head2 Plugin C<xencpu>
11055 This plugin collects metrics of hardware CPU load for machine running Xen
11056 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
11057 Result is reported using the C<percent> type, for each CPU (core).
11059 This plugin doesn't have any options (yet).
11061 =head2 Plugin C<zookeeper>
11063 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
11064 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
11069 <Plugin "zookeeper">
11076 =item B<Host> I<Address>
11078 Hostname or address to connect to. Defaults to C<localhost>.
11080 =item B<Port> I<Service>
11082 Service name or port number to connect to. Defaults to C<2181>.
11086 =head1 THRESHOLD CONFIGURATION
11088 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
11089 we mean that the values are not only stored or sent somewhere, but that they
11090 are judged and, if a problem is recognized, acted upon. The only action
11091 collectd takes itself is to generate and dispatch a "notification". Plugins can
11092 register to receive notifications and perform appropriate further actions.
11094 Since systems and what you expect them to do differ a lot, you can configure
11095 B<thresholds> for your values freely. This gives you a lot of flexibility but
11096 also a lot of responsibility.
11098 Every time a value is out of range a notification is dispatched. This means
11099 that the idle percentage of your CPU needs to be less then the configured
11100 threshold only once for a notification to be generated. There's no such thing
11101 as a moving average or similar - at least not now.
11103 Also, all values that match a threshold are considered to be relevant or
11104 "interesting". As a consequence collectd will issue a notification if they are
11105 not received for B<Timeout> iterations. The B<Timeout> configuration option is
11106 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
11107 "2" (the default) and some hosts sends it's CPU statistics to the server every
11108 60 seconds, a notification will be dispatched after about 120 seconds. It may
11109 take a little longer because the timeout is checked only once each B<Interval>
11112 When a value comes within range again or is received after it was missing, an
11113 "OKAY-notification" is dispatched.
11115 Here is a configuration example to get you started. Read below for more
11128 <Plugin "interface">
11131 FailureMax 10000000
11145 WarningMin 100000000
11151 There are basically two types of configuration statements: The C<Host>,
11152 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
11153 configured. The C<Plugin> and C<Type> blocks may be specified further using the
11154 C<Instance> option. You can combine the block by nesting the blocks, though
11155 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
11156 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
11157 C<Type> may not contain other blocks. If multiple blocks apply to the same
11158 value the most specific block is used.
11160 The other statements specify the threshold to configure. They B<must> be
11161 included in a C<Type> block. Currently the following statements are recognized:
11165 =item B<FailureMax> I<Value>
11167 =item B<WarningMax> I<Value>
11169 Sets the upper bound of acceptable values. If unset defaults to positive
11170 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
11171 will be created. If the value is greater than B<WarningMax> but less than (or
11172 equal to) B<FailureMax> a B<WARNING> notification will be created.
11174 =item B<FailureMin> I<Value>
11176 =item B<WarningMin> I<Value>
11178 Sets the lower bound of acceptable values. If unset defaults to negative
11179 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
11180 be created. If the value is less than B<WarningMin> but greater than (or equal
11181 to) B<FailureMin> a B<WARNING> notification will be created.
11183 =item B<DataSource> I<DSName>
11185 Some data sets have more than one "data source". Interesting examples are the
11186 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
11187 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
11188 system load data set, C<load>, even has three data sources: C<shortterm>,
11189 C<midterm>, and C<longterm>.
11191 Normally, all data sources are checked against a configured threshold. If this
11192 is undesirable, or if you want to specify different limits for each data
11193 source, you can use the B<DataSource> option to have a threshold apply only to
11196 =item B<Invert> B<true>|B<false>
11198 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
11199 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
11200 B<WarningMax>) are not okay. Defaults to B<false>.
11202 =item B<Persist> B<true>|B<false>
11204 Sets how often notifications are generated. If set to B<true> one notification
11205 will be generated for each value that is out of the acceptable range. If set to
11206 B<false> (the default) then a notification is only generated if a value is out
11207 of range but the previous value was okay.
11209 This applies to missing values, too: If set to B<true> a notification about a
11210 missing value is generated once every B<Interval> seconds. If set to B<false>
11211 only one such notification is generated until the value appears again.
11213 =item B<Percentage> B<true>|B<false>
11215 If set to B<true>, the minimum and maximum values given are interpreted as
11216 percentage value, relative to the other data sources. This is helpful for
11217 example for the "df" type, where you may want to issue a warning when less than
11218 5E<nbsp>% of the total space is available. Defaults to B<false>.
11220 =item B<Hits> I<Number>
11222 Delay creating the notification until the threshold has been passed I<Number>
11223 times. When a notification has been generated, or when a subsequent value is
11224 inside the threshold, the counter is reset. If, for example, a value is
11225 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
11226 will be dispatched at most once every 30E<nbsp>seconds.
11228 This is useful when short bursts are not a problem. If, for example, 100% CPU
11229 usage for up to a minute is normal (and data is collected every
11230 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
11232 =item B<Hysteresis> I<Number>
11234 When set to non-zero, a hysteresis value is applied when checking minimum and
11235 maximum bounds. This is useful for values that increase slowly and fluctuate a
11236 bit while doing so. When these values come close to the threshold, they may
11237 "flap", i.e. switch between failure / warning case and okay case repeatedly.
11239 If, for example, the threshold is configures as
11244 then a I<Warning> notification is created when the value exceeds I<101> and the
11245 corresponding I<Okay> notification is only created once the value falls below
11246 I<99>, thus avoiding the "flapping".
11250 =head1 FILTER CONFIGURATION
11252 Starting with collectd 4.6 there is a powerful filtering infrastructure
11253 implemented in the daemon. The concept has mostly been copied from
11254 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
11255 terminology, so that users that are familiar with iptables feel right at home.
11259 The following are the terms used in the remainder of the filter configuration
11260 documentation. For an ASCII-art schema of the mechanism, see
11261 L<"General structure"> below.
11267 A I<match> is a criteria to select specific values. Examples are, of course, the
11268 name of the value or it's current value.
11270 Matches are implemented in plugins which you have to load prior to using the
11271 match. The name of such plugins starts with the "match_" prefix.
11275 A I<target> is some action that is to be performed with data. Such actions
11276 could, for example, be to change part of the value's identifier or to ignore
11277 the value completely.
11279 Some of these targets are built into the daemon, see L<"Built-in targets">
11280 below. Other targets are implemented in plugins which you have to load prior to
11281 using the target. The name of such plugins starts with the "target_" prefix.
11285 The combination of any number of matches and at least one target is called a
11286 I<rule>. The target actions will be performed for all values for which B<all>
11287 matches apply. If the rule does not have any matches associated with it, the
11288 target action will be performed for all values.
11292 A I<chain> is a list of rules and possibly default targets. The rules are tried
11293 in order and if one matches, the associated target will be called. If a value
11294 is handled by a rule, it depends on the target whether or not any subsequent
11295 rules are considered or if traversal of the chain is aborted, see
11296 L<"Flow control"> below. After all rules have been checked, the default targets
11301 =head2 General structure
11303 The following shows the resulting structure:
11310 +---------+ +---------+ +---------+ +---------+
11311 ! Rule !->! Match !->! Match !->! Target !
11312 +---------+ +---------+ +---------+ +---------+
11315 +---------+ +---------+ +---------+
11316 ! Rule !->! Target !->! Target !
11317 +---------+ +---------+ +---------+
11324 +---------+ +---------+ +---------+
11325 ! Rule !->! Match !->! Target !
11326 +---------+ +---------+ +---------+
11334 =head2 Flow control
11336 There are four ways to control which way a value takes through the filter
11343 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
11344 process the value with another chain. When the called chain finishes, usually
11345 the next target or rule after the jump is executed.
11349 The stop condition, signaled for example by the built-in target B<stop>, causes
11350 all processing of the value to be stopped immediately.
11354 Causes processing in the current chain to be aborted, but processing of the
11355 value generally will continue. This means that if the chain was called via
11356 B<Jump>, the next target or rule after the jump will be executed. If the chain
11357 was not called by another chain, control will be returned to the daemon and it
11358 may pass the value to another chain.
11362 Most targets will signal the B<continue> condition, meaning that processing
11363 should continue normally. There is no special built-in target for this
11370 The configuration reflects this structure directly:
11372 PostCacheChain "PostCache"
11373 <Chain "PostCache">
11374 <Rule "ignore_mysql_show">
11377 Type "^mysql_command$"
11378 TypeInstance "^show_"
11388 The above configuration example will ignore all values where the plugin field
11389 is "mysql", the type is "mysql_command" and the type instance begins with
11390 "show_". All other values will be sent to the C<rrdtool> write plugin via the
11391 default target of the chain. Since this chain is run after the value has been
11392 added to the cache, the MySQL C<show_*> command statistics will be available
11393 via the C<unixsock> plugin.
11395 =head2 List of configuration options
11399 =item B<PreCacheChain> I<ChainName>
11401 =item B<PostCacheChain> I<ChainName>
11403 Configure the name of the "pre-cache chain" and the "post-cache chain". The
11404 argument is the name of a I<chain> that should be executed before and/or after
11405 the values have been added to the cache.
11407 To understand the implications, it's important you know what is going on inside
11408 I<collectd>. The following diagram shows how values are passed from the
11409 read-plugins to the write-plugins:
11415 + - - - - V - - - - +
11416 : +---------------+ :
11419 : +-------+-------+ :
11422 : +-------+-------+ : +---------------+
11423 : ! Cache !--->! Value Cache !
11424 : ! insert ! : +---+---+-------+
11425 : +-------+-------+ : ! !
11426 : ! ,------------' !
11428 : +-------+---+---+ : +-------+-------+
11429 : ! Post-Cache +--->! Write-Plugins !
11430 : ! Chain ! : +---------------+
11431 : +---------------+ :
11433 : dispatch values :
11434 + - - - - - - - - - +
11436 After the values are passed from the "read" plugins to the dispatch functions,
11437 the pre-cache chain is run first. The values are added to the internal cache
11438 afterwards. The post-cache chain is run after the values have been added to the
11439 cache. So why is it such a huge deal if chains are run before or after the
11440 values have been added to this cache?
11442 Targets that change the identifier of a value list should be executed before
11443 the values are added to the cache, so that the name in the cache matches the
11444 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
11445 this cache to receive a list of all available values. If you change the
11446 identifier after the value list has been added to the cache, this may easily
11447 lead to confusion, but it's not forbidden of course.
11449 The cache is also used to convert counter values to rates. These rates are, for
11450 example, used by the C<value> match (see below). If you use the rate stored in
11451 the cache B<before> the new value is added, you will use the old, B<previous>
11452 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
11453 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
11456 Last but not last, the B<stop> target makes a difference: If the pre-cache
11457 chain returns the stop condition, the value will not be added to the cache and
11458 the post-cache chain will not be run.
11460 =item B<Chain> I<Name>
11462 Adds a new chain with a certain name. This name can be used to refer to a
11463 specific chain, for example to jump to it.
11465 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
11467 =item B<Rule> [I<Name>]
11469 Adds a new rule to the current chain. The name of the rule is optional and
11470 currently has no meaning for the daemon.
11472 Within the B<Rule> block, there may be any number of B<Match> blocks and there
11473 must be at least one B<Target> block.
11475 =item B<Match> I<Name>
11477 Adds a match to a B<Rule> block. The name specifies what kind of match should
11478 be performed. Available matches depend on the plugins that have been loaded.
11480 The arguments inside the B<Match> block are passed to the plugin implementing
11481 the match, so which arguments are valid here depends on the plugin being used.
11482 If you do not need any to pass any arguments to a match, you can use the
11487 Which is equivalent to:
11492 =item B<Target> I<Name>
11494 Add a target to a rule or a default target to a chain. The name specifies what
11495 kind of target is to be added. Which targets are available depends on the
11496 plugins being loaded.
11498 The arguments inside the B<Target> block are passed to the plugin implementing
11499 the target, so which arguments are valid here depends on the plugin being used.
11500 If you do not need any to pass any arguments to a target, you can use the
11505 This is the same as writing:
11512 =head2 Built-in targets
11514 The following targets are built into the core daemon and therefore need no
11515 plugins to be loaded:
11521 Signals the "return" condition, see the L<"Flow control"> section above. This
11522 causes the current chain to stop processing the value and returns control to
11523 the calling chain. The calling chain will continue processing targets and rules
11524 just after the B<jump> target (see below). This is very similar to the
11525 B<RETURN> target of iptables, see L<iptables(8)>.
11527 This target does not have any options.
11535 Signals the "stop" condition, see the L<"Flow control"> section above. This
11536 causes processing of the value to be aborted immediately. This is similar to
11537 the B<DROP> target of iptables, see L<iptables(8)>.
11539 This target does not have any options.
11547 Sends the value to "write" plugins.
11553 =item B<Plugin> I<Name>
11555 Name of the write plugin to which the data should be sent. This option may be
11556 given multiple times to send the data to more than one write plugin. If the
11557 plugin supports multiple instances, the plugin's instance(s) must also be
11562 If no plugin is explicitly specified, the values will be sent to all available
11565 Single-instance plugin example:
11571 Multi-instance plugin example:
11573 <Plugin "write_graphite">
11583 Plugin "write_graphite/foo"
11588 Starts processing the rules of another chain, see L<"Flow control"> above. If
11589 the end of that chain is reached, or a stop condition is encountered,
11590 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
11591 next target or the next rule. This is similar to the B<-j> command line option
11592 of iptables, see L<iptables(8)>.
11598 =item B<Chain> I<Name>
11600 Jumps to the chain I<Name>. This argument is required and may appear only once.
11612 =head2 Available matches
11618 Matches a value using regular expressions.
11624 =item B<Host> I<Regex>
11626 =item B<Plugin> I<Regex>
11628 =item B<PluginInstance> I<Regex>
11630 =item B<Type> I<Regex>
11632 =item B<TypeInstance> I<Regex>
11634 =item B<MetaData> I<String> I<Regex>
11636 Match values where the given regular expressions match the various fields of
11637 the identifier of a value. If multiple regular expressions are given, B<all>
11638 regexen must match for a value to match.
11640 =item B<Invert> B<false>|B<true>
11642 When set to B<true>, the result of the match is inverted, i.e. all value lists
11643 where all regular expressions apply are not matched, all other value lists are
11644 matched. Defaults to B<false>.
11651 Host "customer[0-9]+"
11657 Matches values that have a time which differs from the time on the server.
11659 This match is mainly intended for servers that receive values over the
11660 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
11661 is very sensitive to the timestamp used when updating the RRD files. In
11662 particular, the time must be ever increasing. If a misbehaving client sends one
11663 packet with a timestamp far in the future, all further packets with a correct
11664 time will be ignored because of that one packet. What's worse, such corrupted
11665 RRD files are hard to fix.
11667 This match lets one match all values B<outside> a specified time range
11668 (relative to the server's time), so you can use the B<stop> target (see below)
11669 to ignore the value, for example.
11675 =item B<Future> I<Seconds>
11677 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
11678 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11681 =item B<Past> I<Seconds>
11683 Matches all values that are I<behind> of the server's time by I<Seconds> or
11684 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11696 This example matches all values that are five minutes or more ahead of the
11697 server or one hour (or more) lagging behind.
11701 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
11702 values. If a data-set consists of more than one data-source, all data-sources
11703 must match the specified ranges for a positive match.
11709 =item B<Min> I<Value>
11711 Sets the smallest value which still results in a match. If unset, behaves like
11714 =item B<Max> I<Value>
11716 Sets the largest value which still results in a match. If unset, behaves like
11719 =item B<Invert> B<true>|B<false>
11721 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
11722 no-match is returned and vice versa. Please note that the B<Invert> setting
11723 only effects how B<Min> and B<Max> are applied to a specific value. Especially
11724 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
11726 =item B<DataSource> I<DSName> [I<DSName> ...]
11728 Select one or more of the data sources. If no data source is configured, all
11729 data sources will be checked. If the type handled by the match does not have a
11730 data source of the specified name(s), this will always result in no match
11731 (independent of the B<Invert> setting).
11733 =item B<Satisfy> B<Any>|B<All>
11735 Specifies how checking with several data sources is performed. If set to
11736 B<Any>, the match succeeds if one of the data sources is in the configured
11737 range. If set to B<All> the match only succeeds if all data sources are within
11738 the configured range. Default is B<All>.
11740 Usually B<All> is used for positive matches, B<Any> is used for negative
11741 matches. This means that with B<All> you usually check that all values are in a
11742 "good" range, while with B<Any> you check if any value is within a "bad" range
11743 (or outside the "good" range).
11747 Either B<Min> or B<Max>, but not both, may be unset.
11751 # Match all values smaller than or equal to 100. Matches only if all data
11752 # sources are below 100.
11758 # Match if the value of any data source is outside the range of 0 - 100.
11766 =item B<empty_counter>
11768 Matches all values with one or more data sources of type B<COUNTER> and where
11769 all counter values are zero. These counters usually I<never> increased since
11770 they started existing (and are therefore uninteresting), or got reset recently
11771 or overflowed and you had really, I<really> bad luck.
11773 Please keep in mind that ignoring such counters can result in confusing
11774 behavior: Counters which hardly ever increase will be zero for long periods of
11775 time. If the counter is reset for some reason (machine or service restarted,
11776 usually), the graph will be empty (NAN) for a long time. People may not
11781 Calculates a hash value of the host name and matches values according to that
11782 hash value. This makes it possible to divide all hosts into groups and match
11783 only values that are in a specific group. The intended use is in load
11784 balancing, where you want to handle only part of all data and leave the rest
11787 The hashing function used tries to distribute the hosts evenly. First, it
11788 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11791 for (i = 0; host[i] != 0; i++)
11792 hash_value = (hash_value * 251) + host[i];
11794 The constant 251 is a prime number which is supposed to make this hash value
11795 more random. The code then checks the group for this host according to the
11796 I<Total> and I<Match> arguments:
11798 if ((hash_value % Total) == Match)
11803 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11804 groups), then the least significant bit of the hash value will be the XOR of
11805 all least significant bits in the host name. One consequence is that when you
11806 have two hosts, "server0.example.com" and "server1.example.com", where the host
11807 name differs in one digit only and the digits differ by one, those hosts will
11808 never end up in the same group.
11814 =item B<Match> I<Match> I<Total>
11816 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11817 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11818 be smaller than I<Total>. I<Total> must be at least one, although only values
11819 greater than one really do make any sense.
11821 You can repeat this option to match multiple groups, for example:
11826 The above config will divide the data into seven groups and match groups three
11827 and five. One use would be to keep every value on two hosts so that if one
11828 fails the missing data can later be reconstructed from the second host.
11834 # Operate on the pre-cache chain, so that ignored values are not even in the
11839 # Divide all received hosts in seven groups and accept all hosts in
11843 # If matched: Return and continue.
11846 # If not matched: Return and stop.
11852 =head2 Available targets
11856 =item B<notification>
11858 Creates and dispatches a notification.
11864 =item B<Message> I<String>
11866 This required option sets the message of the notification. The following
11867 placeholders will be replaced by an appropriate value:
11875 =item B<%{plugin_instance}>
11879 =item B<%{type_instance}>
11881 These placeholders are replaced by the identifier field of the same name.
11883 =item B<%{ds:>I<name>B<}>
11885 These placeholders are replaced by a (hopefully) human readable representation
11886 of the current rate of this data source. If you changed the instance name
11887 (using the B<set> or B<replace> targets, see below), it may not be possible to
11888 convert counter values to rates.
11892 Please note that these placeholders are B<case sensitive>!
11894 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11896 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11903 <Target "notification">
11904 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11910 Replaces parts of the identifier using regular expressions.
11916 =item B<Host> I<Regex> I<Replacement>
11918 =item B<Plugin> I<Regex> I<Replacement>
11920 =item B<PluginInstance> I<Regex> I<Replacement>
11922 =item B<TypeInstance> I<Regex> I<Replacement>
11924 =item B<MetaData> I<String> I<Regex> I<Replacement>
11926 =item B<DeleteMetaData> I<String> I<Regex>
11928 Match the appropriate field with the given regular expression I<Regex>. If the
11929 regular expression matches, that part that matches is replaced with
11930 I<Replacement>. If multiple places of the input buffer match a given regular
11931 expression, only the first occurrence will be replaced.
11933 You can specify each option multiple times to use multiple regular expressions
11941 # Replace "example.net" with "example.com"
11942 Host "\\<example.net\\>" "example.com"
11944 # Strip "www." from hostnames
11945 Host "\\<www\\." ""
11950 Sets part of the identifier of a value to a given string.
11956 =item B<Host> I<String>
11958 =item B<Plugin> I<String>
11960 =item B<PluginInstance> I<String>
11962 =item B<TypeInstance> I<String>
11964 =item B<MetaData> I<String> I<String>
11966 Set the appropriate field to the given string. The strings for plugin instance,
11967 type instance, and meta data may be empty, the strings for host and plugin may
11968 not be empty. It's currently not possible to set the type of a value this way.
11970 The following placeholders will be replaced by an appropriate value:
11978 =item B<%{plugin_instance}>
11982 =item B<%{type_instance}>
11984 These placeholders are replaced by the identifier field of the same name.
11986 =item B<%{meta:>I<name>B<}>
11988 These placeholders are replaced by the meta data value with the given name.
11992 Please note that these placeholders are B<case sensitive>!
11994 =item B<DeleteMetaData> I<String>
11996 Delete the named meta data field.
12003 PluginInstance "coretemp"
12004 TypeInstance "core3"
12009 =head2 Backwards compatibility
12011 If you use collectd with an old configuration, i.E<nbsp>e. one without a
12012 B<Chain> block, it will behave as it used to. This is equivalent to the
12013 following configuration:
12015 <Chain "PostCache">
12019 If you specify a B<PostCacheChain>, the B<write> target will not be added
12020 anywhere and you will have to make sure that it is called where appropriate. We
12021 suggest to add the above snippet as default target to your "PostCache" chain.
12025 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
12040 B<Ignorelists> are a generic framework to either ignore some metrics or report
12041 specific metrics only. Plugins usually provide one or more options to specify
12042 the items (mounts points, devices, ...) and the boolean option
12047 =item B<Select> I<String>
12049 Selects the item I<String>. This option often has a plugin specific name, e.g.
12050 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
12051 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
12052 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
12054 By default, this option is doing a case-sensitive full-string match. The
12055 following config will match C<foo>, but not C<Foo>:
12059 If I<String> starts and ends with C</> (a slash), the string is compiled as a
12060 I<regular expression>. For example, so match all item starting with C<foo>, use
12061 could use the following syntax:
12065 The regular expression is I<not> anchored, i.e. the following config will match
12066 C<foobar>, C<barfoo> and C<AfooZ>:
12070 The B<Select> option may be repeated to select multiple items.
12072 =item B<IgnoreSelected> B<true>|B<false>
12074 If set to B<true>, matching metrics are I<ignored> and all other metrics are
12075 collected. If set to B<false>, matching metrics are I<collected> and all other
12076 metrics are ignored.
12083 L<collectd-exec(5)>,
12084 L<collectd-perl(5)>,
12085 L<collectd-unixsock(5)>,
12098 Florian Forster E<lt>octo@collectd.orgE<gt>