5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/var/lib/collectd"
10 PIDFile "/run/collectd.pid"
31 This config file controls how the system statistics collection daemon
32 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
33 controls which plugins to load. These plugins ultimately define collectd's
34 behavior. If the B<AutoLoadPlugin> option has been enabled, the explicit
35 B<LoadPlugin> lines may be omitted for all plugins with a configuration block,
36 i.e. a C<E<lt>PluginE<nbsp>...E<gt>> block.
38 The syntax of this config file is similar to the config file of the famous
39 I<Apache> webserver. Each line contains either an option (a key and a list of
40 one or more values) or a section-start or -end. Empty lines and everything
41 after a non-quoted hash-symbol (C<#>) are ignored. I<Keys> are unquoted
42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
43 character. Keys are handled case insensitive by I<collectd> itself and all
44 plugins included with it. I<Values> can either be an I<unquoted string>, a
45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
46 expression. I<Unquoted strings> consist of only alphanumeric characters and
47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
49 to include double quotes as part of the string. I<Numbers> can be specified in
50 decimal and floating point format (using a dot C<.> as decimal separator),
51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
52 I<Boolean> values are either B<true> or B<false>.
54 Lines may be wrapped by using C<\> as the last character before the newline.
55 This allows long lines to be split into multiple lines. Quoted strings may be
56 wrapped as well. However, those are treated special in that whitespace at the
57 beginning of the following lines will be ignored, which allows for nicely
58 indenting the wrapped lines.
60 The configuration is read and processed in order, i.e. from top to bottom. So
61 the plugins are loaded in the order listed in this config file. It is a good
62 idea to load any logging plugins first in order to catch messages from plugins
63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
64 B<LoadPlugin> option I<must> occur I<before> the appropriate
65 C<E<lt>B<Plugin> ...E<gt>> block.
71 =item B<BaseDir> I<Directory>
73 Sets the base directory. This is the directory beneath which all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
77 =item B<LoadPlugin> I<Plugin>
79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
81 I<collectd> will be mostly useless.
83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
84 effect. This is useful when you want to split up the configuration into smaller
85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
86 block I<and> the appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
93 statement looks like this:
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
104 The following options are valid inside B<LoadPlugin> blocks:
108 =item B<Globals> B<true|false>
110 If enabled, collectd will export all global symbols of the plugin (and of all
111 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
112 available for resolving unresolved symbols in subsequently loaded plugins if
113 that is supported by your system.
115 This is useful (or possibly even required), e.g., when loading a plugin that
116 embeds some scripting language into the daemon (e.g. the I<Perl> and
117 I<Python plugins>). Scripting languages usually provide means to load
118 extensions written in C. Those extensions require symbols provided by the
119 interpreter, which is loaded as a dependency of the respective collectd plugin.
120 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
121 L<collectd-python(5)>) for details.
123 By default, this is disabled. As a special exception, if the plugin name is
124 either C<perl> or C<python>, the default is changed to enabled in order to keep
125 the average user from ever having to deal with this low level linking stuff.
127 =item B<Interval> I<Seconds>
129 Sets a plugin-specific interval for collecting metrics. This overrides the
130 global B<Interval> setting. If a plugin provides its own support for specifying
131 an interval, that setting will take precedence.
133 =item B<FlushInterval> I<Seconds>
135 Specifies the interval, in seconds, to call the flush callback if it's
136 defined in this plugin. By default, this is disabled.
138 =item B<FlushTimeout> I<Seconds>
140 Specifies the value of the timeout argument of the flush callback.
144 =item B<AutoLoadPlugin> B<false>|B<true>
146 When set to B<false> (the default), each plugin needs to be loaded explicitly,
147 using the B<LoadPlugin> statement documented above. If a
148 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
149 handling callback for this plugin has been registered, a warning is logged and
150 the block is ignored.
152 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
153 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
154 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
155 plugins that don't provide any configuration, e.g. the I<Load plugin>.
157 =item B<CollectInternalStats> B<false>|B<true>
159 When set to B<true>, various statistics about the I<collectd> daemon will be
160 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
162 The following metrics are reported:
166 =item C<collectd-write_queue/queue_length>
168 The number of metrics currently in the write queue. You can limit the queue
169 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
171 =item C<collectd-write_queue/derive-dropped>
173 The number of metrics dropped due to a queue length limitation.
174 If this value is non-zero, your system can't handle all incoming metrics and
175 protects itself against overload by dropping metrics.
177 =item C<collectd-cache/cache_size>
179 The number of elements in the metric cache (the cache you can interact with
180 using L<collectd-unixsock(5)>).
184 =item B<Include> I<Path> [I<pattern>]
186 If I<Path> points to a file, includes that file. If I<Path> points to a
187 directory, recursively includes all files within that directory and its
188 subdirectories. If the C<wordexp> function is available on your system,
189 shell-like wildcards are expanded before files are included. This means you can
190 use statements like the following:
192 Include "/etc/collectd.d/*.conf"
194 Starting with version 5.3, this may also be a block in which further options
195 affecting the behavior of B<Include> may be specified. The following option is
198 <Include "/etc/collectd.d">
204 =item B<Filter> I<pattern>
206 If the C<fnmatch> function is available on your system, a shell-like wildcard
207 I<pattern> may be specified to filter which files to include. This may be used
208 in combination with recursively including a directory to easily be able to
209 arbitrarily mix configuration files and other documents (e.g. README files).
210 The given example is similar to the first example above but includes all files
211 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
215 If more than one file is included by a single B<Include> option, the files
216 will be included in lexicographical order (as defined by the C<strcmp>
217 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
218 order in which the files are loaded.
220 To prevent loops and shooting yourself in the foot in interesting ways the
221 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
222 most uses. Since symlinks are followed it is still possible to crash the daemon
223 by looping symlinks. In our opinion significant stupidity should result in an
224 appropriate amount of pain.
226 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
227 file, but you cannot include files from within blocks.
229 =item B<PIDFile> I<File>
231 Sets where to write the PID file to. This file is overwritten when it exists
232 and deleted when the program is stopped. Some init-scripts might override this
233 setting using the B<-P> command-line option.
235 =item B<PluginDir> I<Directory>
237 Path to the plugins (shared objects) of collectd.
239 =item B<TypesDB> I<File> [I<File> ...]
241 Set one or more files that contain the data-set descriptions. See
242 L<types.db(5)> for a description of the format of this file.
244 If this option is not specified, a default file is read. If you need to define
245 custom types in addition to the types defined in the default file, you need to
246 explicitly load both. In other words, if the B<TypesDB> option is encountered
247 the default behavior is disabled and if you need the default types you have to
248 also explicitly load them.
250 =item B<Interval> I<Seconds>
252 Configures the interval in which to query the read plugins. Obviously smaller
253 values lead to a higher system load produced by collectd, while higher values
254 lead to more coarse statistics.
256 B<Warning:> You should set this once and then never touch it again. If you do,
257 I<you will have to delete all your RRD files> or know some serious RRDtool
258 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
260 =item B<MaxReadInterval> I<Seconds>
262 A read plugin doubles the interval between queries after each failed attempt
265 This options limits the maximum value of the interval. The default value is
268 =item B<Timeout> I<Iterations>
270 Consider a value list "missing" when no update has been read or received for
271 I<Iterations> iterations. By default, I<collectd> considers a value list
272 missing when no update has been received for twice the update interval. Since
273 this setting uses iterations, the maximum allowed time without update depends
274 on the I<Interval> information contained in each value list. This is used in
275 the I<Threshold> configuration to dispatch notifications about missing values,
276 see L<collectd-threshold(5)> for details.
278 =item B<ReadThreads> I<Num>
280 Number of threads to start for reading plugins. The default value is B<5>, but
281 you may want to increase this if you have more than five plugins that take a
282 long time to read. Mostly those are plugins that do network-IO. Setting this to
283 a value higher than the number of registered read callbacks is not recommended.
285 =item B<WriteThreads> I<Num>
287 Number of threads to start for dispatching value lists to write plugins. The
288 default value is B<5>, but you may want to increase this if you have more than
289 five plugins that may take relatively long to write to.
291 =item B<WriteQueueLimitHigh> I<HighNum>
293 =item B<WriteQueueLimitLow> I<LowNum>
295 Metrics are read by the I<read threads> and then put into a queue to be handled
296 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
297 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
298 running into memory issues in such a case, you can limit the size of this
301 By default, there is no limit and memory may grow indefinitely. This is most
302 likely not an issue for clients, i.e. instances that only handle the local
303 metrics. For servers it is recommended to set this to a non-zero value, though.
305 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
306 Each of them takes a numerical argument which is the number of metrics in the
307 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
308 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
309 I<will> be enqueued. If the number of metrics currently in the queue is between
310 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
311 proportional to the number of metrics in the queue (i.e. it increases linearly
312 until it reaches 100%.)
314 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
315 unset, the latter will default to half of B<WriteQueueLimitHigh>.
317 If you do not want to randomly drop values when the queue size is between
318 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
321 Enabling the B<CollectInternalStats> option is of great help to figure out the
322 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
324 =item B<Hostname> I<Name>
326 Sets the hostname that identifies a host. If you omit this setting, the
327 hostname will be determined using the L<gethostname(2)> system call.
329 =item B<FQDNLookup> B<true|false>
331 If B<Hostname> is determined automatically this setting controls whether or not
332 the daemon should try to figure out the "fully qualified domain name", FQDN.
333 This is done using a lookup of the name returned by C<gethostname>. This option
334 is enabled by default.
336 =item B<PreCacheChain> I<ChainName>
338 =item B<PostCacheChain> I<ChainName>
340 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
341 see L</"FILTER CONFIGURATION"> below on information on chains and how these
342 setting change the daemon's behavior.
346 =head1 PLUGIN OPTIONS
348 Some plugins may register own options. These options must be enclosed in a
349 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
350 require external configuration, too. The C<apache plugin>, for example,
351 required C<mod_status> to be configured in the webserver you're going to
352 collect data from. These plugins are listed below as well, even if they don't
353 require any configuration within collectd's configuration file.
355 A list of all plugins and a short summary for each plugin can be found in the
356 F<README> file shipped with the sourcecode and hopefully binary packets as
359 =head2 Plugin C<aggregation>
361 The I<Aggregation plugin> makes it possible to aggregate several values into
362 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
363 This can be put to a wide variety of uses, e.g. average and total CPU
364 statistics for your entire fleet.
366 The grouping is powerful but, as with many powerful tools, may be a bit
367 difficult to wrap your head around. The grouping will therefore be
368 demonstrated using an example: The average and sum of the CPU usage across
369 all CPUs of each host is to be calculated.
371 To select all the affected values for our example, set C<Plugin cpu> and
372 C<Type cpu>. The other values are left unspecified, meaning "all values". The
373 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
374 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
380 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
381 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
382 example, the intention is to have a new value for each host / type instance
383 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
384 It can be specified multiple times to group by more than one field.
387 GroupBy "TypeInstance"
389 We do neither specify nor group by I<plugin instance> (the CPU number), so all
390 metrics that differ in the CPU number only will be aggregated. Each
391 aggregation needs I<at least one> such field, otherwise no aggregation would
394 The full example configuration looks like this:
396 <Plugin "aggregation">
402 GroupBy "TypeInstance"
405 CalculateAverage true
409 There are a couple of limitations you should be aware of:
415 The I<Type> cannot be left unspecified, because it is not reasonable to add
416 apples to oranges. Also, the internal lookup structure won't work if you try
421 There must be at least one unspecified, ungrouped field. Otherwise nothing
426 As you can see in the example above, each aggregation has its own
427 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
428 blocks may match the same values, i.e. one value list can update multiple
429 aggregations. The following options are valid inside B<Aggregation> blocks:
433 =item B<Host> I<Host>
435 =item B<Plugin> I<Plugin>
437 =item B<PluginInstance> I<PluginInstance>
439 =item B<Type> I<Type>
441 =item B<TypeInstance> I<TypeInstance>
443 Selects the value lists to be added to this aggregation. B<Type> must be a
444 valid data set name, see L<types.db(5)> for details.
446 If the string starts with and ends with a slash (C</>), the string is
447 interpreted as a I<regular expression>. The regex flavor used are POSIX
448 extended regular expressions as described in L<regex(7)>. Example usage:
450 Host "/^db[0-9]\\.example\\.com$/"
452 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
454 Group valued by the specified field. The B<GroupBy> option may be repeated to
455 group by multiple fields.
457 =item B<SetHost> I<Host>
459 =item B<SetPlugin> I<Plugin>
461 =item B<SetPluginInstance> I<PluginInstance>
463 =item B<SetTypeInstance> I<TypeInstance>
465 Sets the appropriate part of the identifier to the provided string.
467 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
468 will be replaced with the aggregation function, e.g. "average". Not including
469 the placeholder will result in duplication warnings and/or messed up values if
470 more than one aggregation function are enabled.
472 The following example calculates the average usage of all "even" CPUs:
474 <Plugin "aggregation">
477 PluginInstance "/[0,2,4,6,8]$/"
481 SetPluginInstance "even-%{aggregation}"
484 GroupBy "TypeInstance"
486 CalculateAverage true
490 This will create the files:
496 foo.example.com/cpu-even-average/cpu-idle
500 foo.example.com/cpu-even-average/cpu-system
504 foo.example.com/cpu-even-average/cpu-user
512 =item B<CalculateNum> B<true>|B<false>
514 =item B<CalculateSum> B<true>|B<false>
516 =item B<CalculateAverage> B<true>|B<false>
518 =item B<CalculateMinimum> B<true>|B<false>
520 =item B<CalculateMaximum> B<true>|B<false>
522 =item B<CalculateStddev> B<true>|B<false>
524 Boolean options for enabling calculation of the number of value lists, their
525 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
526 are disabled by default.
530 =head2 Plugin C<amqp>
532 The I<AMQP plugin> can be used to communicate with other instances of
533 I<collectd> or third party applications using an AMQP 0.9.1 message broker.
534 Values are sent to or received from the broker, which handles routing,
535 queueing and possibly filtering out messages.
540 # Send values to an AMQP broker
541 <Publish "some_name">
547 Exchange "amq.fanout"
548 # ExchangeType "fanout"
549 # RoutingKey "collectd"
551 # ConnectionRetryDelay 0
554 # GraphitePrefix "collectd."
555 # GraphiteEscapeChar "_"
556 # GraphiteSeparateInstances false
557 # GraphiteAlwaysAppendDS false
558 # GraphitePreserveSeparator false
561 # Receive values from an AMQP broker
562 <Subscribe "some_name">
568 Exchange "amq.fanout"
569 # ExchangeType "fanout"
572 # QueueAutoDelete true
573 # RoutingKey "collectd.#"
574 # ConnectionRetryDelay 0
578 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
579 blocks, which configure sending and receiving of values respectively. The two
580 blocks are very similar, so unless otherwise noted, an option can be used in
581 either block. The name given in the blocks starting tag is only used for
582 reporting messages, but may be used to support I<flushing> of certain
583 I<Publish> blocks in the future.
587 =item B<Host> I<Host>
589 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
590 the underlying communications library, I<rabbitmq-c>, which is "localhost".
592 =item B<Port> I<Port>
594 Service name or port number on which the AMQP broker accepts connections. This
595 argument must be a string, even if the numeric form is used. Defaults to
598 =item B<VHost> I<VHost>
600 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
602 =item B<User> I<User>
604 =item B<Password> I<Password>
606 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
609 =item B<Exchange> I<Exchange>
611 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
612 By default, "amq.fanout" will be used.
614 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
615 the given exchange and the I<queue> is created, using the I<routing key> if
616 configured. See the B<Queue> and B<RoutingKey> options below.
618 =item B<ExchangeType> I<Type>
620 If given, the plugin will try to create the configured I<exchange> with this
621 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
622 be bound to this exchange.
624 =item B<Queue> I<Queue> (Subscribe only)
626 Configures the I<queue> name to subscribe to. If no queue name was configured
627 explicitly, a unique queue name will be created by the broker.
629 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
631 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
632 or transient (will disappear if the AMQP broker is restarted). Defaults to
635 This option should be used in conjunction with the I<Persistent> option on the
638 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
640 Defines if the I<queue> subscribed to will be deleted once the last consumer
641 unsubscribes. Defaults to "true".
643 =item B<RoutingKey> I<Key>
645 In I<Publish> blocks, this configures the routing key to set on all outgoing
646 messages. If not given, the routing key will be computed from the I<identifier>
647 of the value. The host, plugin, type and the two instances are concatenated
648 together using dots as the separator and all containing dots replaced with
649 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
650 possible to receive only specific values using a "topic" exchange.
652 In I<Subscribe> blocks, configures the I<routing key> used when creating a
653 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
654 used to filter messages when using a "topic" exchange. If you're only
655 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
658 =item B<Persistent> B<true>|B<false> (Publish only)
660 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
661 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
662 default), the I<transient> delivery mode will be used, i.e. messages may be
663 lost due to high load, overflowing queues or similar issues.
665 =item B<ConnectionRetryDelay> I<Delay>
667 When the connection to the AMQP broker is lost, defines the time in seconds to
668 wait before attempting to reconnect. Defaults to 0, which implies collectd will
669 attempt to reconnect at each read interval (in Subscribe mode) or each time
670 values are ready for submission (in Publish mode).
672 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
674 Selects the format in which messages are sent to the broker. If set to
675 B<Command> (the default), values are sent as C<PUTVAL> commands which are
676 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
677 case, the C<Content-Type> header field will be set to C<text/collectd>.
679 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
680 an easy and straight forward exchange format. The C<Content-Type> header field
681 will be set to C<application/json>.
683 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
684 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
687 A subscribing client I<should> use the C<Content-Type> header field to
688 determine how to decode the values. Currently, the I<AMQP plugin> itself can
689 only decode the B<Command> format.
691 =item B<StoreRates> B<true>|B<false> (Publish only)
693 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
694 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
695 default), no conversion is performed. Otherwise the conversion is performed
696 using the internal value cache.
698 Please note that currently this option is only used if the B<Format> option has
701 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
703 A prefix can be added in the metric name when outputting in the I<Graphite> format.
704 It's added before the I<Host> name.
705 Metric name will be "<prefix><host><postfix><plugin><type><name>"
707 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
709 A postfix can be added in the metric name when outputting in the I<Graphite> format.
710 It's added after the I<Host> name.
711 Metric name will be "<prefix><host><postfix><plugin><type><name>"
713 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
715 Specify a character to replace dots (.) in the host part of the metric name.
716 In I<Graphite> metric name, dots are used as separators between different
717 metric parts (host, plugin, type).
718 Default is "_" (I<Underscore>).
720 =item B<GraphiteSeparateInstances> B<true>|B<false>
722 If set to B<true>, the plugin instance and type instance will be in their own
723 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
724 default), the plugin and plugin instance (and likewise the type and type
725 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
727 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
729 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
730 identifier. If set to B<false> (the default), this is only done when there is
733 =item B<GraphitePreserveSeparator> B<false>|B<true>
735 If set to B<false> (the default) the C<.> (dot) character is replaced with
736 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
737 is preserved, i.e. passed through.
741 =head2 Plugin C<amqp1>
743 The I<AMQP1 plugin> can be used to communicate with other instances of
744 I<collectd> or third party applications using an AMQP 1.0 message
745 intermediary. Metric values or notifications are sent to the
746 messaging intermediary which may handle direct messaging or
747 queue based transfer.
752 # Send values to an AMQP 1.0 intermediary
760 <Instance "some_name">
765 # GraphitePrefix "collectd."
766 # GraphiteEscapeChar "_"
767 # GraphiteSeparateInstances false
768 # GraphiteAlwaysAppendDS false
769 # GraphitePreserveSeparator false
774 The plugin's configuration consists of a I<Transport> that configures
775 communications to the AMQP 1.0 messaging bus and one or more I<Instance>
776 corresponding to metric or event publishers to the messaging system.
778 The address in the I<Transport> block concatenated with the name given in the
779 I<Instance> block starting tag will be used as the send-to address for
780 communications over the messaging link.
782 The following options are accepted within each I<Transport> block:
786 =item B<Host> I<Host>
788 Hostname or IP-address of the AMQP 1.0 intermediary. Defaults to the
789 default behavior of the underlying communications library,
790 I<libqpid-proton>, which is "localhost".
792 =item B<Port> I<Port>
794 Service name or port number on which the AMQP 1.0 intermediary accepts
795 connections. This argument must be a string, even if the numeric form
796 is used. Defaults to "5672".
798 =item B<User> I<User>
800 =item B<Password> I<Password>
802 Credentials used to authenticate to the AMQP 1.0 intermediary. By
803 default "guest"/"guest" is used.
805 =item B<Address> I<Address>
807 This option specifies the prefix for the send-to value in the message.
808 By default, "collectd" will be used.
810 =item B<RetryDelay> I<RetryDelay>
812 When the AMQP1 connection is lost, defines the time in seconds to wait
813 before attempting to reconnect. Defaults to 1, which implies attempt
814 to reconnect at 1 second intervals.
818 The following options are accepted within each I<Instance> block:
822 =item B<Format> B<Command>|B<JSON>|B<Graphite>
824 Selects the format in which messages are sent to the intermediary. If set to
825 B<Command> (the default), values are sent as C<PUTVAL> commands which are
826 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
827 case, the C<Content-Type> header field will be set to C<text/collectd>.
829 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
830 an easy and straight forward exchange format. The C<Content-Type> header field
831 will be set to C<application/json>.
833 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
834 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
837 A subscribing client I<should> use the C<Content-Type> header field to
838 determine how to decode the values.
840 =item B<PreSettle> B<true>|B<false>
842 If set to B<false> (the default), the plugin will wait for a message
843 acknowledgement from the messaging bus before sending the next
844 message. This indicates transfer of ownership to the messaging
845 system. If set to B<true>, the plugin will not wait for a message
846 acknowledgement and the message may be dropped prior to transfer of
849 =item B<Notify> B<true>|B<false>
851 If set to B<false> (the default), the plugin will service the
852 instance write call back as a value list. If set to B<true> the
853 plugin will service the instance as a write notification callback
854 for alert formatting.
856 =item B<StoreRates> B<true>|B<false>
858 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
859 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
860 default), no conversion is performed. Otherwise the conversion is performed
861 using the internal value cache.
863 Please note that currently this option is only used if the B<Format> option has
866 =item B<GraphitePrefix>
868 A prefix can be added in the metric name when outputting in the I<Graphite> format.
869 It's added before the I<Host> name.
870 Metric name will be "<prefix><host><postfix><plugin><type><name>"
872 =item B<GraphitePostfix>
874 A postfix can be added in the metric name when outputting in the I<Graphite> format.
875 It's added after the I<Host> name.
876 Metric name will be "<prefix><host><postfix><plugin><type><name>"
878 =item B<GraphiteEscapeChar>
880 Specify a character to replace dots (.) in the host part of the metric name.
881 In I<Graphite> metric name, dots are used as separators between different
882 metric parts (host, plugin, type).
883 Default is "_" (I<Underscore>).
885 =item B<GraphiteSeparateInstances> B<true>|B<false>
887 If set to B<true>, the plugin instance and type instance will be in their own
888 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
889 default), the plugin and plugin instance (and likewise the type and type
890 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
892 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
894 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
895 identifier. If set to B<false> (the default), this is only done when there is
898 =item B<GraphitePreserveSeparator> B<false>|B<true>
900 If set to B<false> (the default) the C<.> (dot) character is replaced with
901 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
902 is preserved, i.e. passed through.
906 =head2 Plugin C<apache>
908 To configure the C<apache>-plugin you first need to configure the Apache
909 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
910 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
911 the following snipped to base your Apache config upon:
914 <IfModule mod_status.c>
915 <Location /mod_status>
916 SetHandler server-status
920 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
921 also supported. It introduces a new field, called C<BusyServers>, to count the
922 number of currently connected clients. This field is also supported.
924 The configuration of the I<Apache> plugin consists of one or more
925 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
926 as the instance name. For example:
930 URL "http://www1.example.com/mod_status?auto"
933 URL "http://www2.example.com/mod_status?auto"
937 The instance name will be used as the I<plugin instance>. To emulate the old
938 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
939 plugin to work correctly, each instance name must be unique. This is not
940 enforced by the plugin and it is your responsibility to ensure it.
942 The following options are accepted within each I<Instance> block:
946 =item B<URL> I<http://host/mod_status?auto>
948 Sets the URL of the C<mod_status> output. This needs to be the output generated
949 by C<ExtendedStatus on> and it needs to be the machine readable output
950 generated by appending the C<?auto> argument. This option is I<mandatory>.
952 =item B<User> I<Username>
954 Optional user name needed for authentication.
956 =item B<Password> I<Password>
958 Optional password needed for authentication.
960 =item B<VerifyPeer> B<true|false>
962 Enable or disable peer SSL certificate verification. See
963 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
965 =item B<VerifyHost> B<true|false>
967 Enable or disable peer host name verification. If enabled, the plugin checks
968 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
969 certificate matches the host name provided by the B<URL> option. If this
970 identity check fails, the connection is aborted. Obviously, only works when
971 connecting to a SSL enabled server. Enabled by default.
973 =item B<CACert> I<File>
975 File that holds one or more SSL certificates. If you want to use HTTPS you will
976 possibly need this option. What CA certificates come bundled with C<libcurl>
977 and are checked by default depends on the distribution you use.
979 =item B<SSLCiphers> I<list of ciphers>
981 Specifies which ciphers to use in the connection. The list of ciphers
982 must specify valid ciphers. See
983 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
985 =item B<Timeout> I<Milliseconds>
987 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
988 milliseconds. By default, the configured B<Interval> is used to set the
993 =head2 Plugin C<apcups>
997 =item B<Host> I<Hostname>
999 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
1000 that IPv6 support has been disabled unless someone can confirm or decline that
1001 B<apcupsd> can handle it.
1003 =item B<Port> I<Port>
1005 TCP-Port to connect to. Defaults to B<3551>.
1007 =item B<ReportSeconds> B<true>|B<false>
1009 If set to B<true>, the time reported in the C<timeleft> metric will be
1010 converted to seconds. This is the recommended setting. If set to B<false>, the
1011 default for backwards compatibility, the time will be reported in minutes.
1013 =item B<PersistentConnection> B<true>|B<false>
1015 The plugin is designed to keep the connection to I<apcupsd> open between reads.
1016 If plugin poll interval is greater than 15 seconds (hardcoded socket close
1017 timeout in I<apcupsd> NIS), then this option is B<false> by default.
1019 You can instruct the plugin to close the connection after each read by setting
1020 this option to B<false> or force keeping the connection by setting it to B<true>.
1022 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
1023 the plugin will try to detect this problem and switch to an open-read-close mode.
1027 =head2 Plugin C<aquaero>
1029 This plugin collects the value of the available sensors in an
1030 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
1031 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
1032 connection for monitoring and configuration. The board can handle multiple
1033 temperature sensors, fans, water pumps and water level sensors and adjust the
1034 output settings such as fan voltage or power used by the water pump based on
1035 the available inputs using a configurable controller included in the board.
1036 This plugin collects all the available inputs as well as some of the output
1037 values chosen by this controller. The plugin is based on the I<libaquaero5>
1038 library provided by I<aquatools-ng>.
1042 =item B<Device> I<DevicePath>
1044 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
1045 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
1046 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
1050 =head2 Plugin C<ascent>
1052 This plugin collects information about an Ascent server, a free server for the
1053 "World of Warcraft" game. This plugin gathers the information by fetching the
1054 XML status page using C<libcurl> and parses it using C<libxml2>.
1056 The configuration options are the same as for the C<apache> plugin above:
1060 =item B<URL> I<http://localhost/ascent/status/>
1062 Sets the URL of the XML status output.
1064 =item B<User> I<Username>
1066 Optional user name needed for authentication.
1068 =item B<Password> I<Password>
1070 Optional password needed for authentication.
1072 =item B<VerifyPeer> B<true|false>
1074 Enable or disable peer SSL certificate verification. See
1075 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1077 =item B<VerifyHost> B<true|false>
1079 Enable or disable peer host name verification. If enabled, the plugin checks
1080 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1081 certificate matches the host name provided by the B<URL> option. If this
1082 identity check fails, the connection is aborted. Obviously, only works when
1083 connecting to a SSL enabled server. Enabled by default.
1085 =item B<CACert> I<File>
1087 File that holds one or more SSL certificates. If you want to use HTTPS you will
1088 possibly need this option. What CA certificates come bundled with C<libcurl>
1089 and are checked by default depends on the distribution you use.
1091 =item B<Timeout> I<Milliseconds>
1093 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1094 milliseconds. By default, the configured B<Interval> is used to set the
1099 =head2 Plugin C<barometer>
1101 This plugin reads absolute air pressure using digital barometer sensor on a I2C
1102 bus. Supported sensors are:
1106 =item I<MPL115A2> from Freescale,
1107 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
1110 =item I<MPL3115> from Freescale
1111 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
1114 =item I<BMP085> from Bosch Sensortec
1118 The sensor type - one of the above - is detected automatically by the plugin
1119 and indicated in the plugin_instance (you will see subdirectory
1120 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
1121 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
1122 (only one sensor can be used by the plugin).
1124 The plugin provides absolute barometric pressure, air pressure reduced to sea
1125 level (several possible approximations) and as an auxiliary value also internal
1126 sensor temperature. It uses (expects/provides) typical metric units - pressure
1127 in [hPa], temperature in [C], altitude in [m].
1129 It was developed and tested under Linux only. The only platform dependency is
1130 the standard Linux i2c-dev interface (the particular bus driver has to
1131 support the SM Bus command subset).
1133 The reduction or normalization to mean sea level pressure requires (depending
1134 on selected method/approximation) also altitude and reference to temperature
1135 sensor(s). When multiple temperature sensors are configured the minimum of
1136 their values is always used (expecting that the warmer ones are affected by
1137 e.g. direct sun light at that moment).
1141 <Plugin "barometer">
1142 Device "/dev/i2c-0";
1145 TemperatureOffset 0.0
1148 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
1153 =item B<Device> I<device>
1155 The only mandatory configuration parameter.
1157 Device name of the I2C bus to which the sensor is connected. Note that
1158 typically you need to have loaded the i2c-dev module.
1159 Using i2c-tools you can check/list i2c buses available on your system by:
1163 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1167 This way you should be able to verify that the pressure sensor (either type) is
1168 connected and detected on address 0x60.
1170 =item B<Oversampling> I<value>
1172 Optional parameter controlling the oversampling/accuracy. Default value
1173 is 1 providing fastest and least accurate reading.
1175 For I<MPL115> this is the size of the averaging window. To filter out sensor
1176 noise a simple averaging using floating window of this configurable size is
1177 used. The plugin will use average of the last C<value> measurements (value of 1
1178 means no averaging). Minimal size is 1, maximal 1024.
1180 For I<MPL3115> this is the oversampling value. The actual oversampling is
1181 performed by the sensor and the higher value the higher accuracy and longer
1182 conversion time (although nothing to worry about in the collectd context).
1183 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1184 adjusted by the plugin to the closest supported one.
1186 For I<BMP085> this is the oversampling value. The actual oversampling is
1187 performed by the sensor and the higher value the higher accuracy and longer
1188 conversion time (although nothing to worry about in the collectd context).
1189 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1190 the closest supported one.
1192 =item B<PressureOffset> I<offset>
1194 Optional parameter for MPL3115 only.
1196 You can further calibrate the sensor by supplying pressure and/or temperature
1197 offsets. This is added to the measured/caclulated value (i.e. if the measured
1198 value is too high then use negative offset).
1199 In hPa, default is 0.0.
1201 =item B<TemperatureOffset> I<offset>
1203 Optional parameter for MPL3115 only.
1205 You can further calibrate the sensor by supplying pressure and/or temperature
1206 offsets. This is added to the measured/caclulated value (i.e. if the measured
1207 value is too high then use negative offset).
1208 In C, default is 0.0.
1210 =item B<Normalization> I<method>
1212 Optional parameter, default value is 0.
1214 Normalization method - what approximation/model is used to compute the mean sea
1215 level pressure from the air absolute pressure.
1217 Supported values of the C<method> (integer between from 0 to 2) are:
1221 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1222 do not need to configure C<Altitude> or C<TemperatureSensor>.
1224 =item B<1> - international formula for conversion ,
1226 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1227 For this method you have to configure C<Altitude> but do not need
1228 C<TemperatureSensor> (uses fixed global temperature average instead).
1230 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1231 Meteorological Service).
1232 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1233 For this method you have to configure both C<Altitude> and
1234 C<TemperatureSensor>.
1239 =item B<Altitude> I<altitude>
1241 The altitude (in meters) of the location where you meassure the pressure.
1243 =item B<TemperatureSensor> I<reference>
1245 Temperature sensor(s) which should be used as a reference when normalizing the
1246 pressure using C<Normalization> method 2.
1247 When specified more sensors a minimum is found and used each time. The
1248 temperature reading directly from this pressure sensor/plugin is typically not
1249 suitable as the pressure sensor will be probably inside while we want outside
1250 temperature. The collectd reference name is something like
1251 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1252 (<type_instance> is usually omitted when there is just single value type). Or
1253 you can figure it out from the path of the output data files.
1257 =head2 Plugin C<battery>
1259 The I<battery plugin> reports the remaining capacity, power and voltage of
1264 =item B<ValuesPercentage> B<false>|B<true>
1266 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1267 capacity remaining". Otherwise the capacity is stored as reported by the
1268 battery, most likely in "Wh". This option does not work with all input methods,
1269 in particular when only C</proc/pmu> is available on an old Linux system.
1270 Defaults to B<false>.
1272 =item B<ReportDegraded> B<false>|B<true>
1274 Typical laptop batteries degrade over time, meaning the capacity decreases with
1275 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1276 "last full capacity" and used to determine that a battery is "fully charged".
1278 When this option is set to B<false>, the default, the I<battery plugin> will
1279 only report the remaining capacity. If the B<ValuesPercentage> option is
1280 enabled, the relative remaining capacity is calculated as the ratio of the
1281 "remaining capacity" and the "last full capacity". This is what most tools,
1282 such as the status bar of desktop environments, also do.
1284 When set to B<true>, the battery plugin will report three values: B<charged>
1285 (remaining capacity), B<discharged> (difference between "last full capacity"
1286 and "remaining capacity") and B<degraded> (difference between "design capacity"
1287 and "last full capacity").
1289 =item B<QueryStateFS> B<false>|B<true>
1291 When set to B<true>, the battery plugin will only read statistics
1292 related to battery performance as exposed by StateFS at
1293 /run/state. StateFS is used in Mer-based Sailfish OS, for
1298 =head2 Plugin C<bind>
1300 Starting with BIND 9.5.0, the most widely used DNS server software provides
1301 extensive statistics about queries, responses and lots of other information.
1302 The bind plugin retrieves this information that's encoded in XML and provided
1303 via HTTP and submits the values to collectd.
1305 To use this plugin, you first need to tell BIND to make this information
1306 available. This is done with the C<statistics-channels> configuration option:
1308 statistics-channels {
1309 inet localhost port 8053;
1312 The configuration follows the grouping that can be seen when looking at the
1313 data with an XSLT compatible viewer, such as a modern web browser. It's
1314 probably a good idea to make yourself familiar with the provided values, so you
1315 can understand what the collected statistics actually mean.
1320 URL "http://localhost:8053/"
1335 Zone "127.in-addr.arpa/IN"
1339 The bind plugin accepts the following configuration options:
1345 URL from which to retrieve the XML data. If not specified,
1346 C<http://localhost:8053/> will be used.
1348 =item B<ParseTime> B<true>|B<false>
1350 When set to B<true>, the time provided by BIND will be parsed and used to
1351 dispatch the values. When set to B<false>, the local time source is queried.
1353 This setting is set to B<true> by default for backwards compatibility; setting
1354 this to B<false> is I<recommended> to avoid problems with timezones and
1357 =item B<OpCodes> B<true>|B<false>
1359 When enabled, statistics about the I<"OpCodes">, for example the number of
1360 C<QUERY> packets, are collected.
1364 =item B<QTypes> B<true>|B<false>
1366 When enabled, the number of I<incoming> queries by query types (for example
1367 C<A>, C<MX>, C<AAAA>) is collected.
1371 =item B<ServerStats> B<true>|B<false>
1373 Collect global server statistics, such as requests received over IPv4 and IPv6,
1374 successful queries, and failed updates.
1378 =item B<ZoneMaintStats> B<true>|B<false>
1380 Collect zone maintenance statistics, mostly information about notifications
1381 (zone updates) and zone transfers.
1385 =item B<ResolverStats> B<true>|B<false>
1387 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1388 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1389 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1390 default. Use the B<ResolverStats> option within a B<View "_default"> block
1391 instead for the same functionality.
1395 =item B<MemoryStats>
1397 Collect global memory statistics.
1401 =item B<Timeout> I<Milliseconds>
1403 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1404 milliseconds. By default, the configured B<Interval> is used to set the
1407 =item B<View> I<Name>
1409 Collect statistics about a specific I<"view">. BIND can behave different,
1410 mostly depending on the source IP-address of the request. These different
1411 configurations are called "views". If you don't use this feature, you most
1412 likely are only interested in the C<_default> view.
1414 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1415 information you want to collect about a view. If no B<View> block is
1416 configured, no detailed view statistics will be collected.
1420 =item B<QTypes> B<true>|B<false>
1422 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1423 C<MX>) is collected.
1427 =item B<ResolverStats> B<true>|B<false>
1429 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1430 (e.E<nbsp>g. queries over IPv4, lame servers).
1434 =item B<CacheRRSets> B<true>|B<false>
1436 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1437 type is collected. Negative entries (queries which resulted in an error, for
1438 example names that do not exist) are reported with a leading exclamation mark,
1443 =item B<Zone> I<Name>
1445 When given, collect detailed information about the given zone in the view. The
1446 information collected if very similar to the global B<ServerStats> information
1449 You can repeat this option to collect detailed information about multiple
1452 By default no detailed zone information is collected.
1458 =head2 Plugin C<ceph>
1460 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1461 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1463 A separate B<Daemon> block must be configured for each ceph daemon to be
1464 monitored. The following example will read daemon statistics from four
1465 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1468 LongRunAvgLatency false
1469 ConvertSpecialMetricTypes true
1471 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1474 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1477 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1480 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1484 The ceph plugin accepts the following configuration options:
1488 =item B<LongRunAvgLatency> B<true>|B<false>
1490 If enabled, latency values(sum,count pairs) are calculated as the long run
1491 average - average since the ceph daemon was started = (sum / count).
1492 When disabled, latency values are calculated as the average since the last
1493 collection = (sum_now - sum_last) / (count_now - count_last).
1497 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1499 If enabled, special metrics (metrics that differ in type from similar counters)
1500 are converted to the type of those similar counters. This currently only
1501 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1502 ceph schema reports this metric type as a sum,count pair while similar counters
1503 are treated as derive types. When converted, the sum is used as the counter
1504 value and is treated as a derive type.
1505 When disabled, all metrics are treated as the types received from the ceph schema.
1511 Each B<Daemon> block must have a string argument for the plugin instance name.
1512 A B<SocketPath> is also required for each B<Daemon> block:
1516 =item B<Daemon> I<DaemonName>
1518 Name to be used as the instance name for this daemon.
1520 =item B<SocketPath> I<SocketPath>
1522 Specifies the path to the UNIX admin socket of the ceph daemon.
1526 =head2 Plugin C<cgroups>
1528 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1529 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1530 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1534 =item B<CGroup> I<Directory>
1536 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1537 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1540 See F</"IGNORELISTS"> for details.
1542 =item B<IgnoreSelected> B<true>|B<false>
1544 Invert the selection: If set to true, all cgroups I<except> the ones that
1545 match any one of the criteria are collected. By default only selected
1546 cgroups are collected if a selection is made. If no selection is configured
1547 at all, B<all> cgroups are selected.
1551 =head2 Plugin C<chrony>
1553 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1554 skew and per-peer stratum.
1556 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1559 Available configuration options for the C<chrony> plugin:
1563 =item B<Host> I<Hostname>
1565 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1567 =item B<Port> I<Port>
1569 UDP-Port to connect to. Defaults to B<323>.
1571 =item B<Timeout> I<Timeout>
1573 Connection timeout in seconds. Defaults to B<2>.
1577 =head2 Plugin C<conntrack>
1579 This plugin collects IP conntrack statistics.
1585 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1586 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1590 =head2 Plugin C<cpu>
1592 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1593 as Jiffies, using the C<cpu> type. Two aggregations are available:
1599 Sum, per-state, over all CPUs installed in the system; and
1603 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1607 The two aggregations can be combined, leading to I<collectd> only emitting a
1608 single "active" metric for the entire system. As soon as one of these
1609 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1610 rather than Jiffies. In addition, you can request individual, per-state,
1611 per-CPU metrics to be reported as percentage.
1613 The following configuration options are available:
1617 =item B<ReportByState> B<true>|B<false>
1619 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1621 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1624 =item B<ReportByCpu> B<true>|B<false>
1626 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1627 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1628 global sum of CPU states is emitted.
1630 =item B<ValuesPercentage> B<false>|B<true>
1632 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1633 are set to B<true>. In this case, by default, metrics will be reported as
1634 Jiffies. By setting this option to B<true>, you can request percentage values
1635 in the un-aggregated (per-CPU, per-state) mode as well.
1637 =item B<ReportNumCpu> B<false>|B<true>
1639 When set to B<true>, reports the number of available CPUs.
1640 Defaults to B<false>.
1642 =item B<ReportGuestState> B<false>|B<true>
1644 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1645 Defaults to B<false>.
1647 =item B<SubtractGuestState> B<false>|B<true>
1649 This option is only considered when B<ReportGuestState> is set to B<true>.
1650 "guest" and "guest_nice" are included in respectively "user" and "nice".
1651 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1652 will be subtracted from "nice".
1653 Defaults to B<true>.
1657 =head2 Plugin C<cpufreq>
1659 This plugin doesn't have any options. It reads
1660 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1661 installed) to get the current CPU frequency. If this file does not exist make
1662 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1663 installed and an "cpu governor" (that's a kernel module) is loaded.
1665 =head2 Plugin C<cpusleep>
1667 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1668 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1669 BOOTTIME clock increments while device is suspended and MONOTONIC
1670 clock does not, the derivative of the difference between these clocks
1671 gives the relative amount of time the device has spent in suspend
1672 state. The recorded value is in milliseconds of sleep per seconds of
1675 =head2 Plugin C<csv>
1679 =item B<DataDir> I<Directory>
1681 Set the directory to store CSV-files under. Per default CSV-files are generated
1682 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1683 The special strings B<stdout> and B<stderr> can be used to write to the standard
1684 output and standard error channels, respectively. This, of course, only makes
1685 much sense when collectd is running in foreground- or non-daemon-mode.
1687 =item B<StoreRates> B<true|false>
1689 If set to B<true>, convert counter values to rates. If set to B<false> (the
1690 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1695 =head2 cURL Statistics
1697 All cURL-based plugins support collection of generic, request-based
1698 statistics. These are disabled by default and can be enabled selectively for
1699 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1700 the documentation of those plugins for specific information. This section
1701 describes the available metrics that can be configured for each plugin. All
1702 options are disabled by default.
1704 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1708 =item B<TotalTime> B<true|false>
1710 Total time of the transfer, including name resolving, TCP connect, etc.
1712 =item B<NamelookupTime> B<true|false>
1714 Time it took from the start until name resolving was completed.
1716 =item B<ConnectTime> B<true|false>
1718 Time it took from the start until the connect to the remote host (or proxy)
1721 =item B<AppconnectTime> B<true|false>
1723 Time it took from the start until the SSL/SSH connect/handshake to the remote
1726 =item B<PretransferTime> B<true|false>
1728 Time it took from the start until just before the transfer begins.
1730 =item B<StarttransferTime> B<true|false>
1732 Time it took from the start until the first byte was received.
1734 =item B<RedirectTime> B<true|false>
1736 Time it took for all redirection steps include name lookup, connect,
1737 pre-transfer and transfer before final transaction was started.
1739 =item B<RedirectCount> B<true|false>
1741 The total number of redirections that were actually followed.
1743 =item B<SizeUpload> B<true|false>
1745 The total amount of bytes that were uploaded.
1747 =item B<SizeDownload> B<true|false>
1749 The total amount of bytes that were downloaded.
1751 =item B<SpeedDownload> B<true|false>
1753 The average download speed that curl measured for the complete download.
1755 =item B<SpeedUpload> B<true|false>
1757 The average upload speed that curl measured for the complete upload.
1759 =item B<HeaderSize> B<true|false>
1761 The total size of all the headers received.
1763 =item B<RequestSize> B<true|false>
1765 The total size of the issued requests.
1767 =item B<ContentLengthDownload> B<true|false>
1769 The content-length of the download.
1771 =item B<ContentLengthUpload> B<true|false>
1773 The specified size of the upload.
1775 =item B<NumConnects> B<true|false>
1777 The number of new connections that were created to achieve the transfer.
1781 =head2 Plugin C<curl>
1783 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1784 and the match infrastructure (the same code used by the tail plugin) to use
1785 regular expressions with the received data.
1787 The following example will read the current value of AMD stock from Google's
1788 finance page and dispatch the value to collectd.
1791 <Page "stock_quotes">
1793 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1799 CACert "/path/to/ca.crt"
1800 Header "X-Custom-Header: foobar"
1803 MeasureResponseTime false
1804 MeasureResponseCode false
1807 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1808 DSType "GaugeAverage"
1809 # Note: `stock_value' is not a standard type.
1816 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1817 a web page and one or more "matches" to be performed on the returned data. The
1818 string argument to the B<Page> block is used as plugin instance.
1820 The following options are valid within B<Page> blocks:
1824 =item B<Plugin> I<Plugin>
1826 Use I<Plugin> as the plugin name when submitting values.
1827 Defaults to C<curl>.
1831 URL of the web site to retrieve. Since a regular expression will be used to
1832 extract information from this data, non-binary data is a big plus here ;)
1834 =item B<User> I<Name>
1836 Username to use if authorization is required to read the page.
1838 =item B<Password> I<Password>
1840 Password to use if authorization is required to read the page.
1842 =item B<Digest> B<true>|B<false>
1844 Enable HTTP digest authentication.
1846 =item B<VerifyPeer> B<true>|B<false>
1848 Enable or disable peer SSL certificate verification. See
1849 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1851 =item B<VerifyHost> B<true>|B<false>
1853 Enable or disable peer host name verification. If enabled, the plugin checks if
1854 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1855 matches the host name provided by the B<URL> option. If this identity check
1856 fails, the connection is aborted. Obviously, only works when connecting to a
1857 SSL enabled server. Enabled by default.
1859 =item B<CACert> I<file>
1861 File that holds one or more SSL certificates. If you want to use HTTPS you will
1862 possibly need this option. What CA certificates come bundled with C<libcurl>
1863 and are checked by default depends on the distribution you use.
1865 =item B<Header> I<Header>
1867 A HTTP header to add to the request. Multiple headers are added if this option
1868 is specified more than once.
1870 =item B<Post> I<Body>
1872 Specifies that the HTTP operation should be a POST instead of a GET. The
1873 complete data to be posted is given as the argument. This option will usually
1874 need to be accompanied by a B<Header> option to set an appropriate
1875 C<Content-Type> for the post body (e.g. to
1876 C<application/x-www-form-urlencoded>).
1878 =item B<MeasureResponseTime> B<true>|B<false>
1880 Measure response time for the request. If this setting is enabled, B<Match>
1881 blocks (see below) are optional. Disabled by default.
1883 Beware that requests will get aborted if they take too long to complete. Adjust
1884 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1887 This option is similar to enabling the B<TotalTime> statistic but it's
1888 measured by collectd instead of cURL.
1890 =item B<MeasureResponseCode> B<true>|B<false>
1892 Measure response code for the request. If this setting is enabled, B<Match>
1893 blocks (see below) are optional. Disabled by default.
1895 =item B<E<lt>StatisticsE<gt>>
1897 One B<Statistics> block can be used to specify cURL statistics to be collected
1898 for each request to the remote web site. See the section "cURL Statistics"
1899 above for details. If this setting is enabled, B<Match> blocks (see below) are
1902 =item B<E<lt>MatchE<gt>>
1904 One or more B<Match> blocks that define how to match information in the data
1905 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1906 used by the C<tail> plugin, so please see the documentation of the C<tail>
1907 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1908 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1911 =item B<Interval> I<Interval>
1913 Sets the interval (in seconds) in which the values will be collected from this
1914 URL. By default the global B<Interval> setting will be used.
1916 =item B<Timeout> I<Milliseconds>
1918 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1919 milliseconds. By default, the configured B<Interval> is used to set the
1920 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1921 indefinitely. This legacy behaviour can be achieved by setting the value of
1924 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1925 network connection will stall one read thread. Adjust the B<ReadThreads> global
1926 setting accordingly to prevent this from blocking other plugins.
1930 =head2 Plugin C<curl_json>
1932 The B<curl_json plugin> collects values from JSON data to be parsed by
1933 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1934 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1935 unix socket. The former can be used, for example, to collect values
1936 from CouchDB documents (which are stored JSON notation), and the
1937 latter to collect values from a uWSGI stats socket.
1939 The following example will collect several values from the built-in
1940 C<_stats> runtime statistics module of I<CouchDB>
1941 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1944 <URL "http://localhost:5984/_stats">
1946 <Key "httpd/requests/count">
1947 Type "http_requests"
1950 <Key "httpd_request_methods/*/count">
1951 Type "http_request_methods"
1954 <Key "httpd_status_codes/*/count">
1955 Type "http_response_codes"
1960 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1963 <Sock "/var/run/uwsgi.stats.sock">
1965 <Key "workers/*/requests">
1966 Type "http_requests"
1969 <Key "workers/*/apps/*/requests">
1970 Type "http_requests"
1975 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1976 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1977 blocks defining a unix socket to read JSON from directly. Each of
1978 these blocks may have one or more B<Key> blocks.
1980 The B<Key> string argument must be in a path format. Each component is
1981 used to match the key from a JSON map or the index of an JSON
1982 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1983 values for all map keys or array indices will be collectd.
1985 The following options are valid within B<URL> blocks:
1989 =item B<Host> I<Name>
1991 Use I<Name> as the host name when submitting values. Defaults to the global
1994 =item B<Plugin> I<Plugin>
1996 Use I<Plugin> as the plugin name when submitting values.
1997 Defaults to C<curl_json>.
1999 =item B<Instance> I<Instance>
2001 Sets the plugin instance to I<Instance>.
2003 =item B<Interval> I<Interval>
2005 Sets the interval (in seconds) in which the values will be collected from this
2006 URL. By default the global B<Interval> setting will be used.
2008 =item B<User> I<Name>
2010 =item B<Password> I<Password>
2012 =item B<Digest> B<true>|B<false>
2014 =item B<VerifyPeer> B<true>|B<false>
2016 =item B<VerifyHost> B<true>|B<false>
2018 =item B<CACert> I<file>
2020 =item B<Header> I<Header>
2022 =item B<Post> I<Body>
2024 =item B<Timeout> I<Milliseconds>
2026 These options behave exactly equivalent to the appropriate options of the
2027 I<cURL> plugin. Please see there for a detailed description.
2029 =item B<E<lt>StatisticsE<gt>>
2031 One B<Statistics> block can be used to specify cURL statistics to be collected
2032 for each request to the remote URL. See the section "cURL Statistics" above
2037 The following options are valid within B<Key> blocks:
2041 =item B<Type> I<Type>
2043 Sets the type used to dispatch the values to the daemon. Detailed information
2044 about types and their configuration can be found in L<types.db(5)>. This
2045 option is mandatory.
2047 =item B<Instance> I<Instance>
2049 Type-instance to use. Defaults to the current map key or current string array element value.
2053 =head2 Plugin C<curl_xml>
2055 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2056 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2059 <URL "http://localhost/stats.xml">
2062 Instance "some_instance"
2067 CACert "/path/to/ca.crt"
2068 Header "X-Custom-Header: foobar"
2071 <XPath "table[@id=\"magic_level\"]/tr">
2073 #InstancePrefix "prefix-"
2074 InstanceFrom "td[1]"
2075 #PluginInstanceFrom "td[1]"
2076 ValuesFrom "td[2]/span[@class=\"level\"]"
2081 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2082 URL to be fetched using libcurl. Within each B<URL> block there are
2083 options which specify the connection parameters, for example authentication
2084 information, and one or more B<XPath> blocks.
2086 Each B<XPath> block specifies how to get one type of information. The
2087 string argument must be a valid XPath expression which returns a list
2088 of "base elements". One value is dispatched for each "base element". The
2089 I<type instance> and values are looked up using further I<XPath> expressions
2090 that should be relative to the base element.
2092 Within the B<URL> block the following options are accepted:
2096 =item B<Host> I<Name>
2098 Use I<Name> as the host name when submitting values. Defaults to the global
2101 =item B<Plugin> I<Plugin>
2103 Use I<Plugin> as the plugin name when submitting values.
2104 Defaults to 'curl_xml'.
2106 =item B<Instance> I<Instance>
2108 Use I<Instance> as the plugin instance when submitting values.
2109 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2110 Defaults to an empty string (no plugin 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<Namespace> I<Prefix> I<URL>
2119 If an XPath expression references namespaces, they must be specified
2120 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2121 I<URL> is the "namespace name", an URI reference uniquely identifying the
2122 namespace. The option can be repeated to register multiple namespaces.
2126 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2127 Namespace "m" "http://www.w3.org/1998/Math/MathML"
2129 =item B<User> I<User>
2131 =item B<Password> I<Password>
2133 =item B<Digest> B<true>|B<false>
2135 =item B<VerifyPeer> B<true>|B<false>
2137 =item B<VerifyHost> B<true>|B<false>
2139 =item B<CACert> I<CA Cert File>
2141 =item B<Header> I<Header>
2143 =item B<Post> I<Body>
2145 =item B<Timeout> I<Milliseconds>
2147 These options behave exactly equivalent to the appropriate options of the
2148 I<cURL plugin>. Please see there for a detailed description.
2150 =item B<E<lt>StatisticsE<gt>>
2152 One B<Statistics> block can be used to specify cURL statistics to be collected
2153 for each request to the remote URL. See the section "cURL Statistics" above
2156 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2158 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2159 B<XPath> block specifies how to get one type of information. The string
2160 argument must be a valid XPath expression which returns a list of "base
2161 elements". One value is dispatched for each "base element".
2163 Within the B<XPath> block the following options are accepted:
2167 =item B<Type> I<Type>
2169 Specifies the I<Type> used for submitting patches. This determines the number
2170 of values that are required / expected and whether the strings are parsed as
2171 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2172 This option is required.
2174 =item B<InstancePrefix> I<InstancePrefix>
2176 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2177 concatenated together without any separator.
2178 This option is optional.
2180 =item B<InstanceFrom> I<InstanceFrom>
2182 Specifies a XPath expression to use for determining the I<type instance>. The
2183 XPath expression must return exactly one element. The element's value is then
2184 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2186 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2188 Specifies a XPath expression to use for determining the I<plugin instance>. The
2189 XPath expression must return exactly one element. The element's value is then
2190 used as I<plugin instance>.
2194 If the "base XPath expression" (the argument to the B<XPath> block) returns
2195 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2196 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2200 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2202 Specifies one or more XPath expression to use for reading the values. The
2203 number of XPath expressions must match the number of data sources in the
2204 I<type> specified with B<Type> (see above). Each XPath expression must return
2205 exactly one element. The element's value is then parsed as a number and used as
2206 value for the appropriate value in the value list dispatched to the daemon.
2207 This option is required.
2213 =head2 Plugin C<dbi>
2215 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2216 connect to various databases, execute I<SQL> statements and read back the
2217 results. I<dbi> is an acronym for "database interface" in case you were
2218 wondering about the name. You can configure how each column is to be
2219 interpreted and the plugin will generate one or more data sets from each row
2220 returned according to these rules.
2222 Because the plugin is very generic, the configuration is a little more complex
2223 than those of other plugins. It usually looks something like this:
2226 <Query "out_of_stock">
2227 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2228 # Use with MySQL 5.0.0 or later
2232 InstancePrefix "out_of_stock"
2233 InstancesFrom "category"
2237 <Database "product_information">
2241 DriverOption "host" "localhost"
2242 DriverOption "username" "collectd"
2243 DriverOption "password" "aZo6daiw"
2244 DriverOption "dbname" "prod_info"
2245 SelectDB "prod_info"
2246 Query "out_of_stock"
2250 The configuration above defines one query with one result and one database. The
2251 query is then linked to the database with the B<Query> option I<within> the
2252 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2253 and you can also use the B<Include> statement to split up the configuration
2254 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2255 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2258 The following is a complete list of options:
2260 =head3 B<Query> blocks
2262 Query blocks define I<SQL> statements and how the returned data should be
2263 interpreted. They are identified by the name that is given in the opening line
2264 of the block. Thus the name needs to be unique. Other than that, the name is
2265 not used in collectd.
2267 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2268 define which column holds which value or instance information. You can use
2269 multiple B<Result> blocks to create multiple values from one returned row. This
2270 is especially useful, when queries take a long time and sending almost the same
2271 query again and again is not desirable.
2275 <Query "environment">
2276 Statement "select station, temperature, humidity from environment"
2279 # InstancePrefix "foo"
2280 InstancesFrom "station"
2281 ValuesFrom "temperature"
2285 InstancesFrom "station"
2286 ValuesFrom "humidity"
2290 The following options are accepted:
2294 =item B<Statement> I<SQL>
2296 Sets the statement that should be executed on the server. This is B<not>
2297 interpreted by collectd, but simply passed to the database server. Therefore,
2298 the SQL dialect that's used depends on the server collectd is connected to.
2300 The query has to return at least two columns, one for the instance and one
2301 value. You cannot omit the instance, even if the statement is guaranteed to
2302 always return exactly one line. In that case, you can usually specify something
2305 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2307 (That works with MySQL but may not be valid SQL according to the spec. If you
2308 use a more strict database server, you may have to select from a dummy table or
2311 Please note that some databases, for example B<Oracle>, will fail if you
2312 include a semicolon at the end of the statement.
2314 =item B<MinVersion> I<Version>
2316 =item B<MaxVersion> I<Value>
2318 Only use this query for the specified database version. You can use these
2319 options to provide multiple queries with the same name but with a slightly
2320 different syntax. The plugin will use only those queries, where the specified
2321 minimum and maximum versions fit the version of the database in use.
2323 The database version is determined by C<dbi_conn_get_engine_version>, see the
2324 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2325 for details. Basically, each part of the version is assumed to be in the range
2326 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2327 "40102", version "5.0.42" becomes "50042".
2329 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2330 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2331 happen. Don't to it! A valid example would be something along these lines:
2342 In the above example, there are three ranges that don't overlap. The last one
2343 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2344 before "4.0.0" are not specified.
2346 =item B<Type> I<Type>
2348 The B<type> that's used for each line returned. See L<types.db(5)> for more
2349 details on how types are defined. In short: A type is a predefined layout of
2350 data and the number of values and type of values has to match the type
2353 If you specify "temperature" here, you need exactly one gauge column. If you
2354 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2357 There must be exactly one B<Type> option inside each B<Result> block.
2359 =item B<InstancePrefix> I<prefix>
2361 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2362 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2363 all strings returned in the appropriate columns are concatenated together,
2364 separated by dashes I<("-")>.
2366 =item B<InstancesFrom> I<column0> [I<column1> ...]
2368 Specifies the columns whose values will be used to create the "type-instance"
2369 for each row. If you specify more than one column, the value of all columns
2370 will be joined together with dashes I<("-")> as separation characters.
2372 The plugin itself does not check whether or not all built instances are
2373 different. It's your responsibility to assure that each is unique. This is
2374 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2375 sure that only one row is returned in this case.
2377 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2380 =item B<ValuesFrom> I<column0> [I<column1> ...]
2382 Names the columns whose content is used as the actual data for the data sets
2383 that are dispatched to the daemon. How many such columns you need is determined
2384 by the B<Type> setting above. If you specify too many or not enough columns,
2385 the plugin will complain about that and no data will be submitted to the
2388 The actual data type in the columns is not that important. The plugin will
2389 automatically cast the values to the right type if it know how to do that. So
2390 it should be able to handle integer an floating point types, as well as strings
2391 (if they include a number at the beginning).
2393 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2395 =item B<MetadataFrom> [I<column0> I<column1> ...]
2397 Names the columns whose content is used as metadata for the data sets
2398 that are dispatched to the daemon.
2400 The actual data type in the columns is not that important. The plugin will
2401 automatically cast the values to the right type if it know how to do that. So
2402 it should be able to handle integer an floating point types, as well as strings
2403 (if they include a number at the beginning).
2407 =head3 B<Database> blocks
2409 Database blocks define a connection to a database and which queries should be
2410 sent to that database. Since the used "dbi" library can handle a wide variety
2411 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2412 documentationE<nbsp>- we stick as close to the terminology used there.
2414 Each database needs a "name" as string argument in the starting tag of the
2415 block. This name will be used as "PluginInstance" in the values submitted to
2416 the daemon. Other than that, that name is not used.
2420 =item B<Plugin> I<Plugin>
2422 Use I<Plugin> as the plugin name when submitting query results from
2423 this B<Database>. Defaults to C<dbi>.
2425 =item B<Interval> I<Interval>
2427 Sets the interval (in seconds) in which the values will be collected from this
2428 database. By default the global B<Interval> setting will be used.
2430 =item B<Driver> I<Driver>
2432 Specifies the driver to use to connect to the database. In many cases those
2433 drivers are named after the database they can connect to, but this is not a
2434 technical necessity. These drivers are sometimes referred to as "DBD",
2435 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2436 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2437 project at L<http://libdbi-drivers.sourceforge.net/>.
2439 You need to give the driver name as expected by the "dbi" library here. You
2440 should be able to find that in the documentation for each driver. If you
2441 mistype the driver name, the plugin will dump a list of all known driver names
2444 =item B<DriverOption> I<Key> I<Value>
2446 Sets driver-specific options. What option a driver supports can be found in the
2447 documentation for each driver, somewhere at
2448 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2449 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2451 DBDs can register two types of options: String options and numeric options. The
2452 plugin will use the C<dbi_conn_set_option> function when the configuration
2453 provides a string and the C<dbi_conn_require_option_numeric> function when the
2454 configuration provides a number. So these two lines will actually result in
2455 different calls being used:
2457 DriverOption "Port" 1234 # numeric
2458 DriverOption "Port" "1234" # string
2460 Unfortunately, drivers are not too keen to report errors when an unknown option
2461 is passed to them, so invalid settings here may go unnoticed. This is not the
2462 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2463 the driver. If a driver complains about an option, the plugin will dump a
2464 complete list of all options understood by that driver to the log. There is no
2465 way to programmatically find out if an option expects a string or a numeric
2466 argument, so you will have to refer to the appropriate DBD's documentation to
2467 find this out. Sorry.
2469 =item B<SelectDB> I<Database>
2471 In some cases, the database name you connect with is not the database name you
2472 want to use for querying data. If this option is set, the plugin will "select"
2473 (switch to) that database after the connection is established.
2475 =item B<Query> I<QueryName>
2477 Associates the query named I<QueryName> with this database connection. The
2478 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2479 blocks you want to refer to must be placed above the database block you want to
2482 =item B<Host> I<Hostname>
2484 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2485 values. Defaults to the global hostname setting.
2493 =item B<Device> I<Device>
2495 Select partitions based on the devicename.
2497 See F</"IGNORELISTS"> for details.
2499 =item B<MountPoint> I<Directory>
2501 Select partitions based on the mountpoint.
2503 See F</"IGNORELISTS"> for details.
2505 =item B<FSType> I<FSType>
2507 Select partitions based on the filesystem type.
2509 See F</"IGNORELISTS"> for details.
2511 =item B<IgnoreSelected> B<true>|B<false>
2513 Invert the selection: If set to true, all partitions B<except> the ones that
2514 match any one of the criteria are collected. By default only selected
2515 partitions are collected if a selection is made. If no selection is configured
2516 at all, B<all> partitions are selected.
2518 =item B<ReportByDevice> B<true>|B<false>
2520 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2521 (the default), it will report a disk as "root", but with it I<true>, it will be
2522 "sda1" (or whichever).
2524 =item B<ReportInodes> B<true>|B<false>
2526 Enables or disables reporting of free, reserved and used inodes. Defaults to
2527 inode collection being disabled.
2529 Enable this option if inodes are a scarce resource for you, usually because
2530 many small files are stored on the disk. This is a usual scenario for mail
2531 transfer agents and web caches.
2533 =item B<ValuesAbsolute> B<true>|B<false>
2535 Enables or disables reporting of free and used disk space in 1K-blocks.
2536 Defaults to B<true>.
2538 =item B<ValuesPercentage> B<false>|B<true>
2540 Enables or disables reporting of free and used disk space in percentage.
2541 Defaults to B<false>.
2543 This is useful for deploying I<collectd> on the cloud, where machines with
2544 different disk size may exist. Then it is more practical to configure
2545 thresholds based on relative disk size.
2549 =head2 Plugin C<disk>
2551 The C<disk> plugin collects information about the usage of physical disks and
2552 logical disks (partitions). Values collected are the number of octets written
2553 to and read from a disk or partition, the number of read/write operations
2554 issued to the disk and a rather complex "time" it took for these commands to be
2557 Using the following two options you can ignore some disks or configure the
2558 collection only of specific disks.
2562 =item B<Disk> I<Name>
2564 Select the disk I<Name>. Whether it is collected or ignored depends on the
2565 B<IgnoreSelected> setting, see below. As with other plugins that use the
2566 daemon's ignorelist functionality, a string that starts and ends with a slash
2567 is interpreted as a regular expression. Examples:
2572 See F</"IGNORELISTS"> for details.
2574 =item B<IgnoreSelected> B<true>|B<false>
2576 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2577 statements, are ignored or if all other disks are ignored. The behavior
2578 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2579 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2580 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2581 is set to B<true>, all disks are collected B<except> the ones matched.
2583 =item B<UseBSDName> B<true>|B<false>
2585 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2586 default major/minor numbers. Requires collectd to be built with Apple's
2589 =item B<UdevNameAttr> I<Attribute>
2591 Attempt to override disk instance name with the value of a specified udev
2592 attribute when built with B<libudev>. If the attribute is not defined for the
2593 given device, the default name is used. Example:
2595 UdevNameAttr "DM_NAME"
2599 =head2 Plugin C<dns>
2603 =item B<Interface> I<Interface>
2605 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2606 option sets the interface that should be used. If this option is not set, or
2607 set to "any", the plugin will try to get packets from B<all> interfaces. This
2608 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2610 =item B<IgnoreSource> I<IP-address>
2612 Ignore packets that originate from this address.
2614 =item B<SelectNumericQueryTypes> B<true>|B<false>
2616 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2620 =head2 Plugin C<dpdkevents>
2622 The I<dpdkevents plugin> collects events from DPDK such as link status of
2623 network ports and Keep Alive status of DPDK logical cores.
2624 In order to get Keep Alive events following requirements must be met:
2626 - support for Keep Alive implemented in DPDK application. More details can
2627 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2631 <Plugin "dpdkevents">
2637 <Event "link_status">
2638 SendEventsOnUpdate true
2639 EnabledPortMask 0xffff
2640 PortName "interface1"
2641 PortName "interface2"
2642 SendNotification false
2644 <Event "keep_alive">
2645 SendEventsOnUpdate true
2647 KeepAliveShmName "/dpdk_keepalive_shm_name"
2648 SendNotification false
2655 =head3 The EAL block
2659 =item B<Coremask> I<Mask>
2661 =item B<Memorychannels> I<Channels>
2663 Number of memory channels per processor socket.
2665 =item B<FilePrefix> I<File>
2667 The prefix text used for hugepage filenames. The filename will be set to
2668 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2672 =head3 The Event block
2674 The B<Event> block defines configuration for specific event. It accepts a
2675 single argument which specifies the name of the event.
2677 =head4 Link Status event
2681 =item B<SendEventOnUpdate> I<true|false>
2683 If set to true link status value will be dispatched only when it is
2684 different from previously read value. This is an optional argument - default
2687 =item B<EnabledPortMask> I<Mask>
2689 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2690 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2691 that all ports will be enabled. This is an optional argument - by default
2692 all ports are enabled.
2694 =item B<PortName> I<Name>
2696 A string containing an optional name for the enabled DPDK ports. Each PortName
2697 option should contain only one port name; specify as many PortName options as
2698 desired. Default naming convention will be used if PortName is blank. If there
2699 are less PortName options than there are enabled ports, the default naming
2700 convention will be used for the additional ports.
2702 =item B<SendNotification> I<true|false>
2704 If set to true, link status notifications are sent, instead of link status
2705 being collected as a statistic. This is an optional argument - default
2710 =head4 Keep Alive event
2714 =item B<SendEventOnUpdate> I<true|false>
2716 If set to true keep alive value will be dispatched only when it is
2717 different from previously read value. This is an optional argument - default
2720 =item B<LCoreMask> I<Mask>
2722 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2724 =item B<KeepAliveShmName> I<Name>
2726 Shared memory name identifier that is used by secondary process to monitor
2727 the keep alive cores state.
2729 =item B<SendNotification> I<true|false>
2731 If set to true, keep alive notifications are sent, instead of keep alive
2732 information being collected as a statistic. This is an optional
2733 argument - default value is false.
2737 =head2 Plugin C<dpdkstat>
2739 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2740 extended NIC stats API in DPDK.
2751 RteDriverLibPath "/usr/lib/dpdk-pmd"
2753 SharedMemObj "dpdk_collectd_stats_0"
2754 EnabledPortMask 0xffff
2755 PortName "interface1"
2756 PortName "interface2"
2761 =head3 The EAL block
2765 =item B<Coremask> I<Mask>
2767 A string containing an hexadecimal bit mask of the cores to run on. Note that
2768 core numbering can change between platforms and should be determined beforehand.
2770 =item B<Memorychannels> I<Channels>
2772 A string containing a number of memory channels per processor socket.
2774 =item B<FilePrefix> I<File>
2776 The prefix text used for hugepage filenames. The filename will be set to
2777 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2779 =item B<SocketMemory> I<MB>
2781 A string containing amount of Memory to allocate from hugepages on specific
2782 sockets in MB. This is an optional value.
2784 =item B<LogLevel> I<LogLevel_number>
2786 A string containing log level number. This parameter is optional.
2787 If parameter is not present then default value "7" - (INFO) is used.
2788 Value "8" - (DEBUG) can be set to enable debug traces.
2790 =item B<RteDriverLibPath> I<Path>
2792 A string containing path to shared pmd driver lib or path to directory,
2793 where shared pmd driver libs are available. This parameter is optional.
2794 This parameter enable loading of shared pmd driver libs from defined path.
2795 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2796 or "/usr/lib/dpdk-pmd"
2802 =item B<SharedMemObj> I<Mask>
2804 A string containing the name of the shared memory object that should be used to
2805 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2806 Defaults to dpdk_collectd_stats if no other value is configured.
2808 =item B<EnabledPortMask> I<Mask>
2810 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2811 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2812 that all ports will be enabled. This is an optional argument - default
2813 is all ports enabled.
2815 =item B<PortName> I<Name>
2817 A string containing an optional name for the enabled DPDK ports. Each PortName
2818 option should contain only one port name; specify as many PortName options as
2819 desired. Default naming convention will be used if PortName is blank. If there
2820 are less PortName options than there are enabled ports, the default naming
2821 convention will be used for the additional ports.
2825 =head2 Plugin C<email>
2829 =item B<SocketFile> I<Path>
2831 Sets the socket-file which is to be created.
2833 =item B<SocketGroup> I<Group>
2835 If running as root change the group of the UNIX-socket after it has been
2836 created. Defaults to B<collectd>.
2838 =item B<SocketPerms> I<Permissions>
2840 Change the file permissions of the UNIX-socket after it has been created. The
2841 permissions must be given as a numeric, octal value as you would pass to
2842 L<chmod(1)>. Defaults to B<0770>.
2844 =item B<MaxConns> I<Number>
2846 Sets the maximum number of connections that can be handled in parallel. Since
2847 this many threads will be started immediately setting this to a very high
2848 value will waste valuable resources. Defaults to B<5> and will be forced to be
2849 at most B<16384> to prevent typos and dumb mistakes.
2853 =head2 Plugin C<ethstat>
2855 The I<ethstat plugin> collects information about network interface cards (NICs)
2856 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2862 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2863 Map "multicast" "if_multicast"
2870 =item B<Interface> I<Name>
2872 Collect statistical information about interface I<Name>.
2874 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2876 By default, the plugin will submit values as type C<derive> and I<type
2877 instance> set to I<Name>, the name of the metric as reported by the driver. If
2878 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2879 I<TypeInstance> will be used.
2881 =item B<MappedOnly> B<true>|B<false>
2883 When set to B<true>, only metrics that can be mapped to a I<type> will be
2884 collected, all other metrics will be ignored. Defaults to B<false>.
2888 =head2 Plugin C<exec>
2890 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2891 contains valuable information on when the executable is executed and the
2892 output that is expected from it.
2896 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2898 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2900 Execute the executable I<Executable> as user I<User>. If the user name is
2901 followed by a colon and a group name, the effective group is set to that group.
2902 The real group and saved-set group will be set to the default group of that
2903 user. If no group is given the effective group ID will be the same as the real
2906 Please note that in order to change the user and/or group the daemon needs
2907 superuser privileges. If the daemon is run as an unprivileged user you must
2908 specify the same user/group here. If the daemon is run with superuser
2909 privileges, you must supply a non-root user here.
2911 The executable may be followed by optional arguments that are passed to the
2912 program. Please note that due to the configuration parsing numbers and boolean
2913 values may be changed. If you want to be absolutely sure that something is
2914 passed as-is please enclose it in quotes.
2916 The B<Exec> and B<NotificationExec> statements change the semantics of the
2917 programs executed, i.E<nbsp>e. the data passed to them and the response
2918 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2922 =head2 Plugin C<fhcount>
2924 The C<fhcount> plugin provides statistics about used, unused and total number of
2925 file handles on Linux.
2927 The I<fhcount plugin> provides the following configuration options:
2931 =item B<ValuesAbsolute> B<true>|B<false>
2933 Enables or disables reporting of file handles usage in absolute numbers,
2934 e.g. file handles used. Defaults to B<true>.
2936 =item B<ValuesPercentage> B<false>|B<true>
2938 Enables or disables reporting of file handles usage in percentages, e.g.
2939 percent of file handles used. Defaults to B<false>.
2943 =head2 Plugin C<filecount>
2945 The C<filecount> plugin counts the number of files in a certain directory (and
2946 its subdirectories) and their combined size. The configuration is very straight
2949 <Plugin "filecount">
2950 <Directory "/var/qmail/queue/mess">
2951 Instance "qmail-message"
2953 <Directory "/var/qmail/queue/todo">
2954 Instance "qmail-todo"
2956 <Directory "/var/lib/php5">
2957 Instance "php5-sessions"
2962 The example above counts the number of files in QMail's queue directories and
2963 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2964 QMail has not yet looked at, the "message" queue holds the messages that were
2965 classified into "local" and "remote".
2967 As you can see, the configuration consists of one or more C<Directory> blocks,
2968 each of which specifies a directory in which to count the files. Within those
2969 blocks, the following options are recognized:
2973 =item B<Plugin> I<Plugin>
2975 Use I<Plugin> as the plugin name when submitting values.
2976 Defaults to B<filecount>.
2978 =item B<Instance> I<Instance>
2980 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2981 the directory name with all slashes replaced by underscores and all leading
2982 underscores removed. Empty value is allowed.
2984 =item B<Name> I<Pattern>
2986 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2987 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2988 against the pattern, not the entire path. In case this makes it easier for you:
2989 This option has been named after the B<-name> parameter to L<find(1)>.
2991 =item B<MTime> I<Age>
2993 Count only files of a specific age: If I<Age> is greater than zero, only files
2994 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2995 a negative number, this is inversed. For example, if B<-60> is specified, only
2996 files that have been modified in the last minute will be counted.
2998 The number can also be followed by a "multiplier" to easily specify a larger
2999 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3000 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3001 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3002 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3003 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3006 =item B<Size> I<Size>
3008 Count only files of a specific size. When I<Size> is a positive number, only
3009 files that are at least this big are counted. If I<Size> is a negative number,
3010 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3011 I<Size> are counted.
3013 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3014 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3015 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3016 note that there are 1000 bytes in a kilobyte, not 1024.
3018 =item B<Recursive> I<true>|I<false>
3020 Controls whether or not to recurse into subdirectories. Enabled by default.
3022 =item B<IncludeHidden> I<true>|I<false>
3024 Controls whether or not to include "hidden" files and directories in the count.
3025 "Hidden" files and directories are those, whose name begins with a dot.
3026 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3028 =item B<RegularOnly> I<true>|I<false>
3030 Controls whether or not to include only regular files in the count.
3031 Defaults to I<true>, i.e. by default non regular files are ignored.
3033 =item B<FilesSizeType> I<Type>
3035 Sets the type used to dispatch files combined size. Empty value ("") disables
3036 reporting. Defaults to B<bytes>.
3038 =item B<FilesCountType> I<Type>
3040 Sets the type used to dispatch number of files. Empty value ("") disables
3041 reporting. Defaults to B<files>.
3043 =item B<TypeInstance> I<Instance>
3045 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3046 (no plugin instance).
3050 =head2 Plugin C<GenericJMX>
3052 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3053 L<collectd-java(5)>.
3055 =head2 Plugin C<gmond>
3057 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3058 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3059 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3064 MCReceiveFrom "239.2.11.71" "8649"
3065 <Metric "swap_total">
3067 TypeInstance "total"
3070 <Metric "swap_free">
3077 The following metrics are built-in:
3083 load_one, load_five, load_fifteen
3087 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3091 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3103 Available configuration options:
3107 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3109 Sets sets the multicast group and UDP port to which to subscribe.
3111 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3113 =item E<lt>B<Metric> I<Name>E<gt>
3115 These blocks add a new metric conversion to the internal table. I<Name>, the
3116 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3120 =item B<Type> I<Type>
3122 Type to map this metric to. Required.
3124 =item B<TypeInstance> I<Instance>
3126 Type-instance to use. Optional.
3128 =item B<DataSource> I<Name>
3130 Data source to map this metric to. If the configured type has exactly one data
3131 source, this is optional. Otherwise the option is required.
3137 =head2 Plugin C<gps>
3139 The C<gps plugin> connects to gpsd on the host machine.
3140 The host, port, timeout and pause are configurable.
3142 This is useful if you run an NTP server using a GPS for source and you want to
3145 Mind your GPS must send $--GSA for having the data reported!
3147 The following elements are collected:
3153 Number of satellites used for fix (type instance "used") and in view (type
3154 instance "visible"). 0 means no GPS satellites are visible.
3156 =item B<dilution_of_precision>
3158 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3159 It should be between 0 and 3.
3160 Look at the documentation of your GPS to know more.
3168 # Connect to localhost on gpsd regular port:
3173 # PauseConnect of 5 sec. between connection attempts.
3177 Available configuration options:
3181 =item B<Host> I<Host>
3183 The host on which gpsd daemon runs. Defaults to B<localhost>.
3185 =item B<Port> I<Port>
3187 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3189 =item B<Timeout> I<Seconds>
3191 Timeout in seconds (default 0.015 sec).
3193 The GPS data stream is fetch by the plugin form the daemon.
3194 It waits for data to be available, if none arrives it times out
3195 and loop for another reading.
3196 Mind to put a low value gpsd expects value in the micro-seconds area
3197 (recommended is 500 us) since the waiting function is blocking.
3198 Value must be between 500 us and 5 sec., if outside that range the
3199 default value is applied.
3201 This only applies from gpsd release-2.95.
3203 =item B<PauseConnect> I<Seconds>
3205 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3209 =head2 Plugin C<grpc>
3211 The I<grpc> plugin provides an RPC interface to submit values to or query
3212 values from collectd based on the open source gRPC framework. It exposes an
3213 end-point for dispatching values to the daemon.
3215 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3219 =item B<Server> I<Host> I<Port>
3221 The B<Server> statement sets the address of a server to which to send metrics
3222 via the C<DispatchValues> function.
3224 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3226 Optionally, B<Server> may be specified as a configuration block which supports
3227 the following options:
3231 =item B<EnableSSL> B<false>|B<true>
3233 Whether to require SSL for outgoing connections. Default: false.
3235 =item B<SSLCACertificateFile> I<Filename>
3237 =item B<SSLCertificateFile> I<Filename>
3239 =item B<SSLCertificateKeyFile> I<Filename>
3241 Filenames specifying SSL certificate and key material to be used with SSL
3246 =item B<Listen> I<Host> I<Port>
3248 The B<Listen> statement sets the network address to bind to. When multiple
3249 statements are specified, the daemon will bind to all of them. If none are
3250 specified, it defaults to B<0.0.0.0:50051>.
3252 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3254 Optionally, B<Listen> may be specified as a configuration block which
3255 supports the following options:
3259 =item B<EnableSSL> I<true>|I<false>
3261 Whether to enable SSL for incoming connections. Default: false.
3263 =item B<SSLCACertificateFile> I<Filename>
3265 =item B<SSLCertificateFile> I<Filename>
3267 =item B<SSLCertificateKeyFile> I<Filename>
3269 Filenames specifying SSL certificate and key material to be used with SSL
3272 =item B<VerifyPeer> B<true>|B<false>
3274 When enabled, a valid client certificate is required to connect to the server.
3275 When disabled, a client certifiacte is not requested and any unsolicited client
3276 certificate is accepted.
3283 =head2 Plugin C<hddtemp>
3285 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3286 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3287 default values, see below. C<hddtemp> has to be running to work correctly. If
3288 C<hddtemp> is not running timeouts may appear which may interfere with other
3291 The B<hddtemp> homepage can be found at
3292 L<http://www.guzu.net/linux/hddtemp.php>.
3296 =item B<Host> I<Hostname>
3298 Hostname to connect to. Defaults to B<127.0.0.1>.
3300 =item B<Port> I<Port>
3302 TCP-Port to connect to. Defaults to B<7634>.
3306 =head2 Plugin C<hugepages>
3308 To collect B<hugepages> information, collectd reads directories
3309 "/sys/devices/system/node/*/hugepages" and
3310 "/sys/kernel/mm/hugepages".
3311 Reading of these directories can be disabled by the following
3312 options (default is enabled).
3316 =item B<ReportPerNodeHP> B<true>|B<false>
3318 If enabled, information will be collected from the hugepage
3319 counters in "/sys/devices/system/node/*/hugepages".
3320 This is used to check the per-node hugepage statistics on
3323 =item B<ReportRootHP> B<true>|B<false>
3325 If enabled, information will be collected from the hugepage
3326 counters in "/sys/kernel/mm/hugepages".
3327 This can be used on both NUMA and non-NUMA systems to check
3328 the overall hugepage statistics.
3330 =item B<ValuesPages> B<true>|B<false>
3332 Whether to report hugepages metrics in number of pages.
3333 Defaults to B<true>.
3335 =item B<ValuesBytes> B<false>|B<true>
3337 Whether to report hugepages metrics in bytes.
3338 Defaults to B<false>.
3340 =item B<ValuesPercentage> B<false>|B<true>
3342 Whether to report hugepages metrics as percentage.
3343 Defaults to B<false>.
3347 =head2 Plugin C<intel_pmu>
3349 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3350 Linux perf interface. All events are reported on a per core basis.
3355 ReportHardwareCacheEvents true
3356 ReportKernelPMUEvents true
3357 ReportSoftwareEvents true
3358 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3359 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3360 Cores "0-3" "4,6" "[12-15]"
3367 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3369 Enable or disable measuring of hardware CPU cache events:
3371 - L1-dcache-load-misses
3373 - L1-dcache-store-misses
3374 - L1-dcache-prefetches
3375 - L1-dcache-prefetch-misses
3377 - L1-icache-load-misses
3378 - L1-icache-prefetches
3379 - L1-icache-prefetch-misses
3385 - LLC-prefetch-misses
3391 - dTLB-prefetch-misses
3395 - branch-load-misses
3397 =item B<ReportKernelPMUEvents> B<false>|B<true>
3399 Enable or disable measuring of the following events:
3408 =item B<ReportSoftwareEvents> B<false>|B<true>
3410 Enable or disable measuring of software events provided by kernel:
3421 =item B<EventList> I<filename>
3423 JSON performance counter event list file name. To be able to monitor all Intel
3424 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3425 event_download.py script to download event list for current CPU.
3427 =item B<HardwareEvents> I<events>
3429 This field is a list of event names or groups of comma separated event names.
3430 This option requires B<EventList> option to be configured.
3432 =item B<Cores> I<cores groups>
3434 All events are reported on a per core basis. Monitoring of the events can be
3435 configured for a group of cores (aggregated statistics). This field defines
3436 groups of cores on which to monitor supported events. The field is represented
3437 as list of strings with core group values. Each string represents a list of
3438 cores in a group. If a group is enclosed in square brackets each core is added
3439 individually to a separate group (that is statistics are not aggregated).
3440 Allowed formats are:
3446 If an empty string is provided as value for this field default cores
3447 configuration is applied - that is separate group is created for each core.
3451 =head2 Plugin C<intel_rdt>
3453 The I<intel_rdt> plugin collects information provided by monitoring features of
3454 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3455 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3456 information about utilization of shared resources. CMT monitors last level cache
3457 occupancy (LLC). MBM supports two types of events reporting local and remote
3458 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3459 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3460 reports the bandwidth of accessing the remote socket. Also this technology
3461 allows to monitor instructions per clock (IPC).
3462 Monitor events are hardware dependant. Monitoring capabilities are detected on
3463 plugin initialization and only supported events are monitored.
3465 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3466 require an additional capability to be enabled if collectd is run as a service.
3467 Please refer to I<contrib/systemd.collectd.service> file for more details.
3471 <Plugin "intel_rdt">
3472 Cores "0-2" "3,4,6" "8-10,15"
3479 =item B<Interval> I<seconds>
3481 The interval within which to retrieve statistics on monitored events in seconds.
3482 For milliseconds divide the time by 1000 for example if the desired interval
3483 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3484 recommended to set interval higher than 1 sec.
3486 =item B<Cores> I<cores groups>
3488 All events are reported on a per core basis. Monitoring of the events can be
3489 configured for group of cores (aggregated statistics). This field defines groups
3490 of cores on which to monitor supported events. The field is represented as list
3491 of strings with core group values. Each string represents a list of cores in a
3492 group. Allowed formats are:
3497 If an empty string is provided as value for this field default cores
3498 configuration is applied - a separate group is created for each core.
3502 B<Note:> By default global interval is used to retrieve statistics on monitored
3503 events. To configure a plugin specific interval use B<Interval> option of the
3504 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3505 example if the desired interval is 50ms, set interval to 0.05.
3506 Due to limited capacity of counters it is not recommended to set interval higher
3509 =head2 Plugin C<interface>
3513 =item B<Interface> I<Interface>
3515 Select this interface. By default these interfaces will then be collected. For
3516 a more detailed description see B<IgnoreSelected> below.
3518 See F</"IGNORELISTS"> for details.
3520 =item B<IgnoreSelected> I<true>|I<false>
3522 If no configuration is given, the B<interface>-plugin will collect data from
3523 all interfaces. This may not be practical, especially for loopback- and
3524 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3525 interfaces you're interested in. Sometimes, however, it's easier/preferred
3526 to collect all interfaces I<except> a few ones. This option enables you to
3527 do that: By setting B<IgnoreSelected> to I<true> the effect of
3528 B<Interface> is inverted: All selected interfaces are ignored and all
3529 other interfaces are collected.
3531 It is possible to use regular expressions to match interface names, if the
3532 name is surrounded by I</.../> and collectd was compiled with support for
3533 regexps. This is useful if there's a need to collect (or ignore) data
3534 for a group of interfaces that are similarly named, without the need to
3535 explicitly list all of them (especially useful if the list is dynamic).
3540 Interface "/^tun[0-9]+/"
3541 IgnoreSelected "true"
3543 This will ignore the loopback interface, all interfaces with names starting
3544 with I<veth> and all interfaces with names starting with I<tun> followed by
3547 =item B<ReportInactive> I<true>|I<false>
3549 When set to I<false>, only interfaces with non-zero traffic will be
3550 reported. Note that the check is done by looking into whether a
3551 package was sent at any time from boot and the corresponding counter
3552 is non-zero. So, if the interface has been sending data in the past
3553 since boot, but not during the reported time-interval, it will still
3556 The default value is I<true> and results in collection of the data
3557 from all interfaces that are selected by B<Interface> and
3558 B<IgnoreSelected> options.
3560 =item B<UniqueName> I<true>|I<false>
3562 Interface name is not unique on Solaris (KSTAT), interface name is unique
3563 only within a module/instance. Following tuple is considered unique:
3564 (ks_module, ks_instance, ks_name)
3565 If this option is set to true, interface name contains above three fields
3566 separated by an underscore. For more info on KSTAT, visit
3567 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3569 This option is only available on Solaris.
3573 =head2 Plugin C<ipmi>
3575 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3576 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3578 The plugin configuration consists of one or more B<Instance> blocks which
3579 specify one I<ipmi> connection each. Each block requires one unique string
3580 argument as the instance name. If instances are not configured, an instance with
3581 the default option values will be created.
3583 For backwards compatibility, any option other than B<Instance> block will trigger
3584 legacy config handling and it will be treated as an option within B<Instance>
3585 block. This support will go away in the next major version of Collectd.
3587 Within the B<Instance> blocks, the following options are allowed:
3591 =item B<Address> I<Address>
3593 Hostname or IP to connect to. If not specified, plugin will try to connect to
3594 local management controller (BMC).
3596 =item B<Username> I<Username>
3598 =item B<Password> I<Password>
3600 The username and the password to use for the connection to remote BMC.
3602 =item B<AuthType> I<MD5>|I<rmcp+>
3604 Forces the authentication type to use for the connection to remote BMC.
3605 By default most secure type is seleted.
3607 =item B<Host> I<Hostname>
3609 Sets the B<host> field of dispatched values. Defaults to the global hostname
3612 =item B<Sensor> I<Sensor>
3614 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3616 See F</"IGNORELISTS"> for details.
3618 =item B<IgnoreSelected> I<true>|I<false>
3620 If no configuration if given, the B<ipmi> plugin will collect data from all
3621 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3622 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3623 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3624 all other sensors are collected.
3626 =item B<NotifySensorAdd> I<true>|I<false>
3628 If a sensor appears after initialization time of a minute a notification
3631 =item B<NotifySensorRemove> I<true>|I<false>
3633 If a sensor disappears a notification is sent.
3635 =item B<NotifySensorNotPresent> I<true>|I<false>
3637 If you have for example dual power supply and one of them is (un)plugged then
3638 a notification is sent.
3640 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3642 If a IPMI connection state changes after initialization time of a minute
3643 a notification is sent. Defaults to B<false>.
3645 =item B<SELEnabled> I<true>|I<false>
3647 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3648 and discrete events. When event is received the notification is sent.
3649 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3651 Defaults to B<false>.
3653 =item B<SELSensor> I<SELSensor>
3655 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3657 See F</"IGNORELISTS"> for details.
3659 =item B<SELIgnoreSelected> I<true>|I<false>
3661 If no configuration is given, the B<ipmi> plugin will pass events from all
3662 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3663 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3664 sensors are ignored and all events from other sensors are passed.
3666 =item B<SELClearEvent> I<true>|I<false>
3668 If SEL clear event is enabled, plugin will delete event from SEL list after
3669 it is received and successfully handled. In this case other tools that are
3670 subscribed for SEL events will receive an empty event.
3671 Defaults to B<false>.
3675 =head2 Plugin C<iptables>
3679 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3681 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3683 Select the iptables/ip6tables filter rules to count packets and bytes from.
3685 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3686 of all rules which have a comment-match. The comment is then used as
3689 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3690 the I<n>th rule will be collected. Again, the comment (or the number) will be
3691 used as the type-instance.
3693 If I<Name> is supplied, it will be used as the type-instance instead of the
3694 comment or the number.
3698 =head2 Plugin C<irq>
3704 Select this irq. By default these irqs will then be collected. For a more
3705 detailed description see B<IgnoreSelected> below.
3707 See F</"IGNORELISTS"> for details.
3709 =item B<IgnoreSelected> I<true>|I<false>
3711 If no configuration if given, the B<irq>-plugin will collect data from all
3712 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3713 can use the B<Irq>-option to pick the interrupt you're interested in.
3714 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3715 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3716 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3717 and all other interrupts are collected.
3721 =head2 Plugin C<java>
3723 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3724 This section only discusses the syntax and semantic of the configuration
3725 options. For more in-depth information on the I<Java> plugin, please read
3726 L<collectd-java(5)>.
3731 JVMArg "-verbose:jni"
3732 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3733 LoadPlugin "org.collectd.java.Foobar"
3734 <Plugin "org.collectd.java.Foobar">
3735 # To be parsed by the plugin
3739 Available configuration options:
3743 =item B<JVMArg> I<Argument>
3745 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3746 exactly the way the arguments to the I<java> binary on the command line work.
3747 Execute C<javaE<nbsp>--help> for details.
3749 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3750 any other options! When another option is found, the JVM will be started and
3751 later options will have to be ignored!
3753 =item B<LoadPlugin> I<JavaClass>
3755 Instantiates a new I<JavaClass> object. The constructor of this object very
3756 likely then registers one or more callback methods with the server.
3758 See L<collectd-java(5)> for details.
3760 When the first such option is found, the virtual machine (JVM) is created. This
3761 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3762 B<LoadPlugin> options!
3764 =item B<Plugin> I<Name>
3766 The entire block is passed to the Java plugin as an
3767 I<org.collectd.api.OConfigItem> object.
3769 For this to work, the plugin has to register a configuration callback first,
3770 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3771 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3772 depends on the (Java) plugin registering the callback and is completely
3773 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3777 =head2 Plugin C<load>
3779 The I<Load plugin> collects the system load. These numbers give a rough overview
3780 over the utilization of a machine. The system load is defined as the number of
3781 runnable tasks in the run-queue and is provided by many operating systems as a
3782 one, five or fifteen minute average.
3784 The following configuration options are available:
3788 =item B<ReportRelative> B<false>|B<true>
3790 When enabled, system load divided by number of available CPU cores is reported
3791 for intervals 1 min, 5 min and 15 min. Defaults to false.
3796 =head2 Plugin C<logfile>
3800 =item B<LogLevel> B<debug|info|notice|warning|err>
3802 Sets the log-level. If, for example, set to B<notice>, then all events with
3803 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3805 Please note that B<debug> is only available if collectd has been compiled with
3808 =item B<File> I<File>
3810 Sets the file to write log messages to. The special strings B<stdout> and
3811 B<stderr> can be used to write to the standard output and standard error
3812 channels, respectively. This, of course, only makes much sense when I<collectd>
3813 is running in foreground- or non-daemon-mode.
3815 =item B<Timestamp> B<true>|B<false>
3817 Prefix all lines printed by the current time. Defaults to B<true>.
3819 =item B<PrintSeverity> B<true>|B<false>
3821 When enabled, all lines are prefixed by the severity of the log message, for
3822 example "warning". Defaults to B<false>.
3826 B<Note>: There is no need to notify the daemon after moving or removing the
3827 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3828 for each line it writes.
3830 =head2 Plugin C<log_logstash>
3832 The I<log logstash plugin> behaves like the logfile plugin but formats
3833 messages as JSON events for logstash to parse and input.
3837 =item B<LogLevel> B<debug|info|notice|warning|err>
3839 Sets the log-level. If, for example, set to B<notice>, then all events with
3840 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3842 Please note that B<debug> is only available if collectd has been compiled with
3845 =item B<File> I<File>
3847 Sets the file to write log messages to. The special strings B<stdout> and
3848 B<stderr> can be used to write to the standard output and standard error
3849 channels, respectively. This, of course, only makes much sense when I<collectd>
3850 is running in foreground- or non-daemon-mode.
3854 B<Note>: There is no need to notify the daemon after moving or removing the
3855 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3856 for each line it writes.
3858 =head2 Plugin C<lpar>
3860 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3861 virtualization technique for IBM POWER processors. It takes into account CPU
3862 time stolen from or donated to a partition, in addition to the usual user,
3863 system, I/O statistics.
3865 The following configuration options are available:
3869 =item B<CpuPoolStats> B<false>|B<true>
3871 When enabled, statistics about the processor pool are read, too. The partition
3872 needs to have pool authority in order to be able to acquire this information.
3875 =item B<ReportBySerial> B<false>|B<true>
3877 If enabled, the serial of the physical machine the partition is currently
3878 running on is reported as I<hostname> and the logical hostname of the machine
3879 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3880 used (just like other plugins) and the I<plugin instance> will be empty.
3885 =head2 Plugin C<lua>
3887 This plugin embeds a Lua interpreter into collectd and provides an interface
3888 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3891 =head2 Plugin C<mbmon>
3893 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3895 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3896 B<Host> and B<Port> options can be used to change these values, see below.
3897 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3898 timeouts may appear which may interfere with other statistics..
3900 C<mbmon> must be run with the -r option ("print TAG and Value format");
3901 Debian's F</etc/init.d/mbmon> script already does this, other people
3902 will need to ensure that this is the case.
3906 =item B<Host> I<Hostname>
3908 Hostname to connect to. Defaults to B<127.0.0.1>.
3910 =item B<Port> I<Port>
3912 TCP-Port to connect to. Defaults to B<411>.
3916 =head2 Plugin C<mcelog>
3918 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3920 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3921 mcelog server is running. When the server is running, the plugin will tail the
3922 specified logfile to retrieve machine check exception information and send a
3923 notification with the details from the logfile. The plugin will use the mcelog
3924 client protocol to retrieve memory related machine check exceptions. Note that
3925 for memory exceptions, notifications are only sent when there is a change in
3926 the number of corrected/uncorrected memory errors.
3928 =head3 The Memory block
3930 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3935 =item B<McelogClientSocket> I<Path>
3936 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3937 Defaults to B<"/var/run/mcelog-client">.
3939 =item B<PersistentNotification> B<true>|B<false>
3940 Override default configuration to only send notifications when sent when there
3941 is a change in the number of corrected/uncorrected memory errors. When set to
3942 true notifications will be sent for every read cycle. Default is false. Does
3943 not affect the stats being dispatched.
3949 =item B<McelogLogfile> I<Path>
3951 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3952 cannot be used in conjunction with the memory block options, they are mutually
3959 The C<md plugin> collects information from Linux Software-RAID devices (md).
3961 All reported values are of the type C<md_disks>. Reported type instances are
3962 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3963 I<missing> (physically absent) disks.
3967 =item B<Device> I<Device>
3969 Select md devices based on device name. The I<device name> is the basename of
3970 the device, i.e. the name of the block device without the leading C</dev/>.
3971 See B<IgnoreSelected> for more details.
3973 See F</"IGNORELISTS"> for details.
3975 =item B<IgnoreSelected> B<true>|B<false>
3977 Invert device selection: If set to B<true>, all md devices B<except> those
3978 listed using B<Device> are collected. If B<false> (the default), only those
3979 listed are collected. If no configuration is given, the B<md> plugin will
3980 collect data from all md devices.
3984 =head2 Plugin C<memcachec>
3986 The C<memcachec plugin> connects to a memcached server, queries one or more
3987 given I<pages> and parses the returned data according to user specification.
3988 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3991 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3992 library. Please note that there is another library with a very similar name,
3993 libmemcache (notice the missing `d'), which is not applicable.
3995 Synopsis of the configuration:
3997 <Plugin "memcachec">
3998 <Page "plugin_instance">
4001 Plugin "plugin_name"
4003 Regex "(\\d+) bytes sent"
4006 Instance "type_instance"
4011 The configuration options are:
4015 =item E<lt>B<Page> I<Name>E<gt>
4017 Each B<Page> block defines one I<page> to be queried from the memcached server.
4018 The block requires one string argument which is used as I<plugin instance>.
4020 =item B<Server> I<Address>
4022 Sets the server address to connect to when querying the page. Must be inside a
4027 When connected to the memcached server, asks for the page I<Key>.
4029 =item B<Plugin> I<Plugin>
4031 Use I<Plugin> as the plugin name when submitting values.
4032 Defaults to C<memcachec>.
4034 =item E<lt>B<Match>E<gt>
4036 Match blocks define which strings to look for and how matches substrings are
4037 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4041 =head2 Plugin C<memcached>
4043 The B<memcached plugin> connects to a memcached server and queries statistics
4044 about cache utilization, memory and bandwidth used.
4045 L<http://memcached.org/>
4047 <Plugin "memcached">
4049 #Host "memcache.example.com"
4055 The plugin configuration consists of one or more B<Instance> blocks which
4056 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4057 following options are allowed:
4061 =item B<Host> I<Hostname>
4063 Sets the B<host> field of dispatched values. Defaults to the global hostname
4065 For backwards compatibility, values are also dispatched with the global
4066 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4069 =item B<Address> I<Address>
4071 Hostname or IP to connect to. For backwards compatibility, defaults to the
4072 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4074 =item B<Port> I<Port>
4076 TCP port to connect to. Defaults to B<11211>.
4078 =item B<Socket> I<Path>
4080 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4081 setting is given, the B<Address> and B<Port> settings are ignored.
4085 =head2 Plugin C<mic>
4087 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4088 Intel's Many Integrated Core (MIC) systems.
4097 ShowTemperatures true
4100 IgnoreSelectedTemperature true
4105 IgnoreSelectedPower true
4108 The following options are valid inside the B<PluginE<nbsp>mic> block:
4112 =item B<ShowCPU> B<true>|B<false>
4114 If enabled (the default) a sum of the CPU usage across all cores is reported.
4116 =item B<ShowCPUCores> B<true>|B<false>
4118 If enabled (the default) per-core CPU usage is reported.
4120 =item B<ShowMemory> B<true>|B<false>
4122 If enabled (the default) the physical memory usage of the MIC system is
4125 =item B<ShowTemperatures> B<true>|B<false>
4127 If enabled (the default) various temperatures of the MIC system are reported.
4129 =item B<Temperature> I<Name>
4131 This option controls which temperatures are being reported. Whether matching
4132 temperatures are being ignored or I<only> matching temperatures are reported
4133 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4134 temperatures are reported.
4136 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4138 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4139 (the default) only temperatures matching a B<Temperature> option are reported
4140 or, if no B<Temperature> option is specified, all temperatures are reported. If
4141 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4144 Known temperature names are:
4178 =item B<ShowPower> B<true>|B<false>
4180 If enabled (the default) various temperatures of the MIC system are reported.
4182 =item B<Power> I<Name>
4184 This option controls which power readings are being reported. Whether matching
4185 power readings are being ignored or I<only> matching power readings are reported
4186 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4187 power readings are reported.
4189 =item B<IgnoreSelectedPower> B<false>|B<true>
4191 Controls the behavior of the B<Power> setting above. If set to B<false>
4192 (the default) only power readings matching a B<Power> option are reported
4193 or, if no B<Power> option is specified, all power readings are reported. If
4194 set to B<true>, matching power readings are I<ignored> and all other power readings
4197 Known power names are:
4203 Total power utilization averaged over Time Window 0 (uWatts).
4207 Total power utilization averaged over Time Window 0 (uWatts).
4211 Instantaneous power (uWatts).
4215 Max instantaneous power (uWatts).
4219 PCI-E connector power (uWatts).
4223 2x3 connector power (uWatts).
4227 2x4 connector power (uWatts).
4235 Uncore rail (uVolts).
4239 Memory subsystem rail (uVolts).
4245 =head2 Plugin C<memory>
4247 The I<memory plugin> provides the following configuration options:
4251 =item B<ValuesAbsolute> B<true>|B<false>
4253 Enables or disables reporting of physical memory usage in absolute numbers,
4254 i.e. bytes. Defaults to B<true>.
4256 =item B<ValuesPercentage> B<false>|B<true>
4258 Enables or disables reporting of physical memory usage in percentages, e.g.
4259 percent of physical memory used. Defaults to B<false>.
4261 This is useful for deploying I<collectd> in a heterogeneous environment in
4262 which the sizes of physical memory vary.
4266 =head2 Plugin C<modbus>
4268 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4269 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4270 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4271 floating point values (two registers interpreted as IEEE floats in big endian
4276 <Data "voltage-input-1">
4279 RegisterCmd ReadHolding
4286 <Data "voltage-input-2">
4289 RegisterCmd ReadHolding
4294 <Data "supply-temperature-1">
4297 RegisterCmd ReadHolding
4302 <Host "modbus.example.com">
4303 Address "192.168.0.42"
4308 Instance "power-supply"
4309 Collect "voltage-input-1"
4310 Collect "voltage-input-2"
4315 Device "/dev/ttyUSB0"
4320 Instance "temperature"
4321 Collect "supply-temperature-1"
4327 =item E<lt>B<Data> I<Name>E<gt> blocks
4329 Data blocks define a mapping between register numbers and the "types" used by
4332 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4336 =item B<RegisterBase> I<Number>
4338 Configures the base register to read from the device. If the option
4339 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4340 register will be read (the register number is increased by one).
4342 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4344 Specifies what kind of data is returned by the device. This defaults to
4345 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4346 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4347 and B<RegisterBase+1> will be read and the data is combined into one
4348 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4349 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4350 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4351 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4352 registers are swapped with the most significant 16E<nbsp>bits in
4353 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4354 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4355 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4356 B<RegisterBase+3> will be read and the data combined into one
4359 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4361 Specifies register type to be collected from device. Works only with libmodbus
4362 2.9.2 or higher. Defaults to B<ReadHolding>.
4364 =item B<Type> I<Type>
4366 Specifies the "type" (data set) to use when dispatching the value to
4367 I<collectd>. Currently, only data sets with exactly one data source are
4370 =item B<Instance> I<Instance>
4372 Sets the type instance to use when dispatching the value to I<Instance>. If
4373 unset, an empty string (no type instance) is used.
4375 =item B<Scale> I<Value>
4377 The values taken from device are multiplied by I<Value>. The field is optional
4378 and the default is B<1.0>.
4380 =item B<Shift> I<Value>
4382 I<Value> is added to values from device after they have been multiplied by
4383 B<Scale> value. The field is optional and the default value is B<0.0>.
4387 =item E<lt>B<Host> I<Name>E<gt> blocks
4389 Host blocks are used to specify to which hosts to connect and what data to read
4390 from their "slaves". The string argument I<Name> is used as hostname when
4391 dispatching the values to I<collectd>.
4393 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4397 =item B<Address> I<Hostname>
4399 For Modbus/TCP, specifies the node name (the actual network address) used to
4400 connect to the host. This may be an IP address or a hostname. Please note that
4401 the used I<libmodbus> library only supports IPv4 at the moment.
4403 =item B<Port> I<Service>
4405 for Modbus/TCP, specifies the port used to connect to the host. The port can
4406 either be given as a number or as a service name. Please note that the
4407 I<Service> argument must be a string, even if ports are given in their numerical
4408 form. Defaults to "502".
4410 =item B<Device> I<Devicenode>
4412 For Modbus/RTU, specifies the path to the serial device being used.
4414 =item B<Baudrate> I<Baudrate>
4416 For Modbus/RTU, specifies the baud rate of the serial device.
4417 Note, connections currently support only 8/N/1.
4419 =item B<Interval> I<Interval>
4421 Sets the interval (in seconds) in which the values will be collected from this
4422 host. By default the global B<Interval> setting will be used.
4424 =item E<lt>B<Slave> I<ID>E<gt>
4426 Over each connection, multiple Modbus devices may be reached. The slave ID
4427 is used to specify which device should be addressed. For each device you want
4428 to query, one B<Slave> block must be given.
4430 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4434 =item B<Instance> I<Instance>
4436 Specify the plugin instance to use when dispatching the values to I<collectd>.
4437 By default "slave_I<ID>" is used.
4439 =item B<Collect> I<DataName>
4441 Specifies which data to retrieve from the device. I<DataName> must be the same
4442 string as the I<Name> argument passed to a B<Data> block. You can specify this
4443 option multiple times to collect more than one value from a slave. At least one
4444 B<Collect> option is mandatory.
4452 =head2 Plugin C<mqtt>
4454 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4455 values from MQTT (B<Subscribe> blocks).
4461 Host "mqtt.example.com"
4465 Host "mqtt.example.com"
4470 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4471 configuring the sending and receiving direction respectively. The plugin will
4472 register a write callback named C<mqtt/I<name>> where I<name> is the string
4473 argument given to the B<Publish> block. Both types of blocks share many but not
4474 all of the following options. If an option is valid in only one of the blocks,
4475 it will be mentioned explicitly.
4481 =item B<Host> I<Hostname>
4483 Hostname of the MQTT broker to connect to.
4485 =item B<Port> I<Service>
4487 Port number or service name of the MQTT broker to connect to.
4489 =item B<User> I<UserName>
4491 Username used when authenticating to the MQTT broker.
4493 =item B<Password> I<Password>
4495 Password used when authenticating to the MQTT broker.
4497 =item B<ClientId> I<ClientId>
4499 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4501 =item B<QoS> [B<0>-B<2>]
4503 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4521 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4522 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4523 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4524 on a message is larger than the maximum accepted QoS of a subscriber, the
4525 message's QoS will be downgraded.
4527 =item B<Prefix> I<Prefix> (Publish only)
4529 This plugin will use one topic per I<value list> which will looks like a path.
4530 I<Prefix> is used as the first path element and defaults to B<collectd>.
4532 An example topic name would be:
4534 collectd/cpu-0/cpu-user
4536 =item B<Retain> B<false>|B<true> (Publish only)
4538 Controls whether the MQTT broker will retain (keep a copy of) the last message
4539 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4541 =item B<StoreRates> B<true>|B<false> (Publish only)
4543 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4544 before sending. Defaults to B<true>.
4546 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4548 Controls whether the MQTT "cleans" the session up after the subscriber
4549 disconnects or if it maintains the subscriber's subscriptions and all messages
4550 that arrive while the subscriber is disconnected. Defaults to B<true>.
4552 =item B<Topic> I<TopicName> (Subscribe only)
4554 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4555 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4556 the B<collectd> branch.
4558 =item B<CACert> I<file>
4560 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4561 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4562 port of the MQTT broker.
4563 This option enables the use of TLS.
4565 =item B<CertificateFile> I<file>
4567 Path to the PEM-encoded certificate file to use as client certificate when
4568 connecting to the MQTT broker.
4569 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4571 =item B<CertificateKeyFile> I<file>
4573 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4574 Only valid if B<CACert> and B<CertificateFile> are also set.
4576 =item B<TLSProtocol> I<protocol>
4578 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4579 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4580 version is used which depends on the version of OpenSSL the Mosquitto library
4582 Only valid if B<CACert> is set.
4584 =item B<CipherSuite> I<ciphersuite>
4586 A string describing the ciphers available for use. See L<ciphers(1)> and the
4587 C<openssl ciphers> utility for more information. If unset, the default ciphers
4589 Only valid if B<CACert> is set.
4593 =head2 Plugin C<mysql>
4595 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4596 one or more databases when started and keeps the connection up as long as
4597 possible. When the connection is interrupted for whatever reason it will try
4598 to re-connect. The plugin will complain loudly in case anything goes wrong.
4600 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4601 and collects information about MySQL network traffic, executed statements,
4602 requests, the query cache and threads by evaluating the
4603 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4604 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4605 Status Variables> for an explanation of these values.
4607 Optionally, master and slave statistics may be collected in a MySQL
4608 replication setup. In that case, information about the synchronization state
4609 of the nodes are collected by evaluating the C<Position> return value of the
4610 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4611 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4612 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4613 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4614 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4626 SSLKey "/path/to/key.pem"
4627 SSLCert "/path/to/cert.pem"
4628 SSLCA "/path/to/ca.pem"
4629 SSLCAPath "/path/to/cas/"
4630 SSLCipher "DHE-RSA-AES256-SHA"
4636 Socket "/var/run/mysql/mysqld.sock"
4638 SlaveNotifications true
4644 Socket "/var/run/mysql/mysqld.sock"
4649 A B<Database> block defines one connection to a MySQL database. It accepts a
4650 single argument which specifies the name of the database. None of the other
4651 options are required. MySQL will use default values as documented in the
4652 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4653 B<MySQL reference manual>.
4657 =item B<Alias> I<Alias>
4659 Alias to use as sender instead of hostname when reporting. This may be useful
4660 when having cryptic hostnames.
4662 =item B<Host> I<Hostname>
4664 Hostname of the database server. Defaults to B<localhost>.
4666 =item B<User> I<Username>
4668 Username to use when connecting to the database. The user does not have to be
4669 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4670 unless you want to collectd replication statistics (see B<MasterStats> and
4671 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4672 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4674 =item B<Password> I<Password>
4676 Password needed to log into the database.
4678 =item B<Database> I<Database>
4680 Select this database. Defaults to I<no database> which is a perfectly reasonable
4681 option for what this plugin does.
4683 =item B<Port> I<Port>
4685 TCP-port to connect to. The port must be specified in its numeric form, but it
4686 must be passed as a string nonetheless. For example:
4690 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4691 See the documentation for the C<mysql_real_connect> function for details.
4693 =item B<Socket> I<Socket>
4695 Specifies the path to the UNIX domain socket of the MySQL server. This option
4696 only has any effect, if B<Host> is set to B<localhost> (the default).
4697 Otherwise, use the B<Port> option above. See the documentation for the
4698 C<mysql_real_connect> function for details.
4700 =item B<InnodbStats> I<true|false>
4702 If enabled, metrics about the InnoDB storage engine are collected.
4703 Disabled by default.
4705 =item B<MasterStats> I<true|false>
4707 =item B<SlaveStats> I<true|false>
4709 Enable the collection of master / slave statistics in a replication setup. In
4710 order to be able to get access to these statistics, the user needs special
4711 privileges. See the B<User> documentation above. Defaults to B<false>.
4713 =item B<SlaveNotifications> I<true|false>
4715 If enabled, the plugin sends a notification if the replication slave I/O and /
4716 or SQL threads are not running. Defaults to B<false>.
4718 =item B<WsrepStats> I<true|false>
4720 Enable the collection of wsrep plugin statistics, used in Master-Master
4721 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4722 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4724 =item B<ConnectTimeout> I<Seconds>
4726 Sets the connect timeout for the MySQL client.
4728 =item B<SSLKey> I<Path>
4730 If provided, the X509 key in PEM format.
4732 =item B<SSLCert> I<Path>
4734 If provided, the X509 cert in PEM format.
4736 =item B<SSLCA> I<Path>
4738 If provided, the CA file in PEM format (check OpenSSL docs).
4740 =item B<SSLCAPath> I<Path>
4742 If provided, the CA directory (check OpenSSL docs).
4744 =item B<SSLCipher> I<String>
4746 If provided, the SSL cipher to use.
4750 =head2 Plugin C<netapp>
4752 The netapp plugin can collect various performance and capacity information
4753 from a NetApp filer using the NetApp API.
4755 Please note that NetApp has a wide line of products and a lot of different
4756 software versions for each of these products. This plugin was developed for a
4757 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4758 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4759 model and software version but it is very hard to test this.
4760 If you have used this plugin with other models and/or software version, feel
4761 free to send us a mail to tell us about the results, even if it's just a short
4764 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4765 basic authentication.
4767 B<Do not use a regular user for this!> Create a special collectd user with just
4768 the minimum of capabilities needed. The user only needs the "login-http-admin"
4769 capability as well as a few more depending on which data will be collected.
4770 Required capabilities are documented below.
4775 <Host "netapp1.example.com">
4799 IgnoreSelectedIO false
4801 IgnoreSelectedOps false
4802 GetLatency "volume0"
4803 IgnoreSelectedLatency false
4810 IgnoreSelectedCapacity false
4813 IgnoreSelectedSnapshot false
4841 The netapp plugin accepts the following configuration options:
4845 =item B<Host> I<Name>
4847 A host block defines one NetApp filer. It will appear in collectd with the name
4848 you specify here which does not have to be its real name nor its hostname (see
4849 the B<Address> option below).
4851 =item B<VFiler> I<Name>
4853 A B<VFiler> block may only be used inside a host block. It accepts all the
4854 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4855 will execute all NetApp API commands in the context of the specified
4856 VFiler(R). It will appear in collectd with the name you specify here which
4857 does not have to be its real name. The VFiler name may be specified using the
4858 B<VFilerName> option. If this is not specified, it will default to the name
4861 The VFiler block inherits all connection related settings from the surrounding
4862 B<Host> block (which appear before the B<VFiler> block) but they may be
4863 overwritten inside the B<VFiler> block.
4865 This feature is useful, for example, when using a VFiler as SnapVault target
4866 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4867 available in the host filer (vfiler0) but only in the respective VFiler
4870 =item B<Protocol> B<httpd>|B<http>
4872 The protocol collectd will use to query this host.
4880 Valid options: http, https
4882 =item B<Address> I<Address>
4884 The hostname or IP address of the host.
4890 Default: The "host" block's name.
4892 =item B<Port> I<Port>
4894 The TCP port to connect to on the host.
4900 Default: 80 for protocol "http", 443 for protocol "https"
4902 =item B<User> I<User>
4904 =item B<Password> I<Password>
4906 The username and password to use to login to the NetApp.
4912 =item B<VFilerName> I<Name>
4914 The name of the VFiler in which context to execute API commands. If not
4915 specified, the name provided to the B<VFiler> block will be used instead.
4921 Default: name of the B<VFiler> block
4923 B<Note:> This option may only be used inside B<VFiler> blocks.
4925 =item B<Interval> I<Interval>
4931 The following options decide what kind of data will be collected. You can
4932 either use them as a block and fine tune various parameters inside this block,
4933 use them as a single statement to just accept all default values, or omit it to
4934 not collect any data.
4936 The following options are valid inside all blocks:
4940 =item B<Interval> I<Seconds>
4942 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4943 host specific setting.
4947 =head3 The System block
4949 This will collect various performance data about the whole system.
4951 B<Note:> To get this data the collectd user needs the
4952 "api-perf-object-get-instances" capability.
4956 =item B<Interval> I<Seconds>
4958 Collect disk statistics every I<Seconds> seconds.
4960 =item B<GetCPULoad> B<true>|B<false>
4962 If you set this option to true the current CPU usage will be read. This will be
4963 the average usage between all CPUs in your NetApp without any information about
4966 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4967 returns in the "CPU" field.
4975 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4977 =item B<GetInterfaces> B<true>|B<false>
4979 If you set this option to true the current traffic of the network interfaces
4980 will be read. This will be the total traffic over all interfaces of your NetApp
4981 without any information about individual interfaces.
4983 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4984 in the "Net kB/s" field.
4994 Result: One value list of type "if_octects".
4996 =item B<GetDiskIO> B<true>|B<false>
4998 If you set this option to true the current IO throughput will be read. This
4999 will be the total IO of your NetApp without any information about individual
5000 disks, volumes or aggregates.
5002 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5003 in the "DiskE<nbsp>kB/s" field.
5011 Result: One value list of type "disk_octets".
5013 =item B<GetDiskOps> B<true>|B<false>
5015 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5016 iSCSI, etc. operations will be read. This will be the total number of
5017 operations on your NetApp without any information about individual volumes or
5020 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5021 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5029 Result: A variable number of value lists of type "disk_ops_complex". Each type
5030 of operation will result in one value list with the name of the operation as
5035 =head3 The WAFL block
5037 This will collect various performance data about the WAFL file system. At the
5038 moment this just means cache performance.
5040 B<Note:> To get this data the collectd user needs the
5041 "api-perf-object-get-instances" capability.
5043 B<Note:> The interface to get these values is classified as "Diagnostics" by
5044 NetApp. This means that it is not guaranteed to be stable even between minor
5049 =item B<Interval> I<Seconds>
5051 Collect disk statistics every I<Seconds> seconds.
5053 =item B<GetNameCache> B<true>|B<false>
5061 Result: One value list of type "cache_ratio" and type instance
5064 =item B<GetDirCache> B<true>|B<false>
5072 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5074 =item B<GetInodeCache> B<true>|B<false>
5082 Result: One value list of type "cache_ratio" and type instance
5085 =item B<GetBufferCache> B<true>|B<false>
5087 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5088 in the "Cache hit" field.
5096 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5100 =head3 The Disks block
5102 This will collect performance data about the individual disks in the NetApp.
5104 B<Note:> To get this data the collectd user needs the
5105 "api-perf-object-get-instances" capability.
5109 =item B<Interval> I<Seconds>
5111 Collect disk statistics every I<Seconds> seconds.
5113 =item B<GetBusy> B<true>|B<false>
5115 If you set this option to true the busy time of all disks will be calculated
5116 and the value of the busiest disk in the system will be written.
5118 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5119 in the "Disk util" field. Probably.
5127 Result: One value list of type "percent" and type instance "disk_busy".
5131 =head3 The VolumePerf block
5133 This will collect various performance data about the individual volumes.
5135 You can select which data to collect about which volume using the following
5136 options. They follow the standard ignorelist semantic.
5138 B<Note:> To get this data the collectd user needs the
5139 I<api-perf-object-get-instances> capability.
5143 =item B<Interval> I<Seconds>
5145 Collect volume performance data every I<Seconds> seconds.
5147 =item B<GetIO> I<Volume>
5149 =item B<GetOps> I<Volume>
5151 =item B<GetLatency> I<Volume>
5153 Select the given volume for IO, operations or latency statistics collection.
5154 The argument is the name of the volume without the C</vol/> prefix.
5156 Since the standard ignorelist functionality is used here, you can use a string
5157 starting and ending with a slash to specify regular expression matching: To
5158 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5161 GetIO "/^vol[027]$/"
5163 If no regular expression is specified, an exact match is required. Both,
5164 regular and exact matching are case sensitive.
5166 If no volume was specified at all for either of the three options, that data
5167 will be collected for all available volumes.
5169 See F</"IGNORELISTS"> for details.
5171 =item B<IgnoreSelectedIO> B<true>|B<false>
5173 =item B<IgnoreSelectedOps> B<true>|B<false>
5175 =item B<IgnoreSelectedLatency> B<true>|B<false>
5177 When set to B<true>, the volumes selected for IO, operations or latency
5178 statistics collection will be ignored and the data will be collected for all
5181 When set to B<false>, data will only be collected for the specified volumes and
5182 all other volumes will be ignored.
5184 If no volumes have been specified with the above B<Get*> options, all volumes
5185 will be collected regardless of the B<IgnoreSelected*> option.
5187 Defaults to B<false>
5191 =head3 The VolumeUsage block
5193 This will collect capacity data about the individual volumes.
5195 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5200 =item B<Interval> I<Seconds>
5202 Collect volume usage statistics every I<Seconds> seconds.
5204 =item B<GetCapacity> I<VolumeName>
5206 The current capacity of the volume will be collected. This will result in two
5207 to four value lists, depending on the configuration of the volume. All data
5208 sources are of type "df_complex" with the name of the volume as
5211 There will be type_instances "used" and "free" for the number of used and
5212 available bytes on the volume. If the volume has some space reserved for
5213 snapshots, a type_instance "snap_reserved" will be available. If the volume
5214 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5215 number of bytes saved by the SIS feature.
5217 B<Note:> The current NetApp API has a bug that results in this value being
5218 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5219 number which works most of the time. If you see strange values here, bug
5220 NetApp support to fix this.
5222 Repeat this option to specify multiple volumes.
5224 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5226 Specify whether to collect only the volumes selected by the B<GetCapacity>
5227 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5228 B<false>. However, if no B<GetCapacity> option is specified at all, all
5229 capacities will be selected anyway.
5231 =item B<GetSnapshot> I<VolumeName>
5233 Select volumes from which to collect snapshot information.
5235 Usually, the space used for snapshots is included in the space reported as
5236 "used". If snapshot information is collected as well, the space used for
5237 snapshots is subtracted from the used space.
5239 To make things even more interesting, it is possible to reserve space to be
5240 used for snapshots. If the space required for snapshots is less than that
5241 reserved space, there is "reserved free" and "reserved used" space in addition
5242 to "free" and "used". If the space required for snapshots exceeds the reserved
5243 space, that part allocated in the normal space is subtracted from the "used"
5246 Repeat this option to specify multiple volumes.
5248 =item B<IgnoreSelectedSnapshot>
5250 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5251 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5252 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5253 capacities will be selected anyway.
5257 =head3 The Quota block
5259 This will collect (tree) quota statistics (used disk space and number of used
5260 files). This mechanism is useful to get usage information for single qtrees.
5261 In case the quotas are not used for any other purpose, an entry similar to the
5262 following in C</etc/quotas> would be sufficient:
5264 /vol/volA/some_qtree tree - - - - -
5266 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5270 =item B<Interval> I<Seconds>
5272 Collect SnapVault(R) statistics every I<Seconds> seconds.
5276 =head3 The SnapVault block
5278 This will collect statistics about the time and traffic of SnapVault(R)
5283 =item B<Interval> I<Seconds>
5285 Collect SnapVault(R) statistics every I<Seconds> seconds.
5289 =head2 Plugin C<netlink>
5291 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5292 statistics of various interface and routing aspects.
5296 =item B<Interface> I<Interface>
5298 =item B<VerboseInterface> I<Interface>
5300 Instruct the plugin to collect interface statistics. This is basically the same
5301 as the statistics provided by the C<interface> plugin (see above) but
5302 potentially much more detailed.
5304 When configuring with B<Interface> only the basic statistics will be collected,
5305 namely octets, packets, and errors. These statistics are collected by
5306 the C<interface> plugin, too, so using both at the same time is no benefit.
5308 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5309 so that no data needs to be collected twice if you use the C<interface> plugin.
5310 This includes dropped packets, received multicast packets, collisions and a
5311 whole zoo of differentiated RX and TX errors. You can try the following command
5312 to get an idea of what awaits you:
5316 If I<Interface> is B<All>, all interfaces will be selected.
5318 =item B<QDisc> I<Interface> [I<QDisc>]
5320 =item B<Class> I<Interface> [I<Class>]
5322 =item B<Filter> I<Interface> [I<Filter>]
5324 Collect the octets and packets that pass a certain qdisc, class or filter.
5326 QDiscs and classes are identified by their type and handle (or classid).
5327 Filters don't necessarily have a handle, therefore the parent's handle is used.
5328 The notation used in collectd differs from that used in tc(1) in that it
5329 doesn't skip the major or minor number if it's zero and doesn't print special
5330 ids by their name. So, for example, a qdisc may be identified by
5331 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5332 thus not displayed by tc(1).
5334 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5335 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5336 associated with that interface will be collected.
5338 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5339 used. This may lead to problems when more than one filter is attached to a
5340 qdisc or class. This isn't nice, but we don't know how this could be done any
5341 better. If you have a idea, please don't hesitate to tell us.
5343 As with the B<Interface> option you can specify B<All> as the interface,
5344 meaning all interfaces.
5346 Here are some examples to help you understand the above text more easily:
5349 VerboseInterface "All"
5350 QDisc "eth0" "pfifo_fast-1:0"
5352 Class "ppp0" "htb-1:10"
5353 Filter "ppp0" "u32-1:0"
5356 See F</"IGNORELISTS"> for details.
5358 =item B<IgnoreSelected>
5360 The behavior is the same as with all other similar plugins: If nothing is
5361 selected at all, everything is collected. If some things are selected using the
5362 options described above, only these statistics are collected. If you set
5363 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5364 specified statistics will not be collected.
5368 =head2 Plugin C<network>
5370 The Network plugin sends data to a remote instance of collectd, receives data
5371 from a remote instance, or both at the same time. Data which has been received
5372 from the network is usually not transmitted again, but this can be activated, see
5373 the B<Forward> option below.
5375 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5376 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5378 Both, B<Server> and B<Listen> can be used as single option or as block. When
5379 used as block, given options are valid for this socket only. The following
5380 example will export the metrics twice: Once to an "internal" server (without
5381 encryption and signing) and one to an external server (with cryptographic
5385 # Export to an internal server
5386 # (demonstrates usage without additional options)
5387 Server "collectd.internal.tld"
5389 # Export to an external server
5390 # (demonstrates usage with signature options)
5391 <Server "collectd.external.tld">
5392 SecurityLevel "sign"
5393 Username "myhostname"
5400 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5402 The B<Server> statement/block sets the server to send datagrams to. The
5403 statement may occur multiple times to send each datagram to multiple
5406 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5407 optional second argument specifies a port number or a service name. If not
5408 given, the default, B<25826>, is used.
5410 The following options are recognized within B<Server> blocks:
5414 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5416 Set the security you require for network communication. When the security level
5417 has been set to B<Encrypt>, data sent over the network will be encrypted using
5418 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5419 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5420 authentication code. When set to B<None>, data is sent without any security.
5422 This feature is only available if the I<network> plugin was linked with
5425 =item B<Username> I<Username>
5427 Sets the username to transmit. This is used by the server to lookup the
5428 password. See B<AuthFile> below. All security levels except B<None> require
5431 This feature is only available if the I<network> plugin was linked with
5434 =item B<Password> I<Password>
5436 Sets a password (shared secret) for this socket. All security levels except
5437 B<None> require this setting.
5439 This feature is only available if the I<network> plugin was linked with
5442 =item B<Interface> I<Interface name>
5444 Set the outgoing interface for IP packets. This applies at least
5445 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5446 undefined or a non-existent interface name is specified, the default
5447 behavior is to let the kernel choose the appropriate interface. Be warned
5448 that the manual selection of an interface for unicast traffic is only
5449 necessary in rare cases.
5451 =item B<BindAddress> I<IP Address>
5453 Set the outgoing IP address for IP packets. This option can be used instead of
5454 the I<Interface> option to explicitly define the IP address which will be used
5455 to send Packets to the remote server.
5457 =item B<ResolveInterval> I<Seconds>
5459 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5460 useful to force a regular DNS lookup to support a high availability setup. If
5461 not specified, re-resolves are never attempted.
5465 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5467 The B<Listen> statement sets the interfaces to bind to. When multiple
5468 statements are found the daemon will bind to multiple interfaces.
5470 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5471 the argument is a multicast address the daemon will join that multicast group.
5472 The optional second argument specifies a port number or a service name. If not
5473 given, the default, B<25826>, is used.
5475 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5479 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5481 Set the security you require for network communication. When the security level
5482 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5483 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5484 signed and encrypted data is accepted. When set to B<None>, all data will be
5485 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5486 decrypted if possible.
5488 This feature is only available if the I<network> plugin was linked with
5491 =item B<AuthFile> I<Filename>
5493 Sets a file in which usernames are mapped to passwords. These passwords are
5494 used to verify signatures and to decrypt encrypted network packets. If
5495 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5496 verified and encrypted packets are decrypted. Otherwise, signed data is
5497 accepted without checking the signature and encrypted data cannot be decrypted.
5498 For the other security levels this option is mandatory.
5500 The file format is very simple: Each line consists of a username followed by a
5501 colon and any number of spaces followed by the password. To demonstrate, an
5502 example file could look like this:
5507 Each time a packet is received, the modification time of the file is checked
5508 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5509 the file is being read, it is locked using L<fcntl(2)>.
5511 =item B<Interface> I<Interface name>
5513 Set the incoming interface for IP packets explicitly. This applies at least
5514 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5515 undefined or a non-existent interface name is specified, the default
5516 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5517 traffic gets only accepted, if it arrives on the given interface.
5521 =item B<TimeToLive> I<1-255>
5523 Set the time-to-live of sent packets. This applies to all, unicast and
5524 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5525 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5528 =item B<MaxPacketSize> I<1024-65535>
5530 Set the maximum size for datagrams received over the network. Packets larger
5531 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5532 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5535 On the server side, this limit should be set to the largest value used on
5536 I<any> client. Likewise, the value on the client must not be larger than the
5537 value on the server, or data will be lost.
5539 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5540 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5541 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5544 =item B<Forward> I<true|false>
5546 If set to I<true>, write packets that were received via the network plugin to
5547 the sending sockets. This should only be activated when the B<Listen>- and
5548 B<Server>-statements differ. Otherwise packets may be send multiple times to
5549 the same multicast group. While this results in more network traffic than
5550 necessary it's not a huge problem since the plugin has a duplicate detection,
5551 so the values will not loop.
5553 =item B<ReportStats> B<true>|B<false>
5555 The network plugin cannot only receive and send statistics, it can also create
5556 statistics about itself. Collectd data included the number of received and
5557 sent octets and packets, the length of the receive queue and the number of
5558 values handled. When set to B<true>, the I<Network plugin> will make these
5559 statistics available. Defaults to B<false>.
5563 =head2 Plugin C<nfs>
5565 The I<nfs plugin> collects information about the usage of the Network File
5566 System (NFS). It counts the number of procedure calls for each procedure,
5567 grouped by version and whether the system runs as server or client.
5569 It is possibly to omit metrics for a specific NFS version by setting one or
5570 more of the following options to B<false> (all of them default to B<true>).
5574 =item B<ReportV2> B<true>|B<false>
5576 =item B<ReportV3> B<true>|B<false>
5578 =item B<ReportV4> B<true>|B<false>
5582 =head2 Plugin C<nginx>
5584 This plugin collects the number of connections and requests handled by the
5585 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5586 queries the page provided by the C<ngx_http_stub_status_module> module, which
5587 isn't compiled by default. Please refer to
5588 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5589 how to compile and configure nginx and this module.
5591 The following options are accepted by the C<nginx plugin>:
5595 =item B<URL> I<http://host/nginx_status>
5597 Sets the URL of the C<ngx_http_stub_status_module> output.
5599 =item B<User> I<Username>
5601 Optional user name needed for authentication.
5603 =item B<Password> I<Password>
5605 Optional password needed for authentication.
5607 =item B<VerifyPeer> B<true|false>
5609 Enable or disable peer SSL certificate verification. See
5610 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5612 =item B<VerifyHost> B<true|false>
5614 Enable or disable peer host name verification. If enabled, the plugin checks
5615 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5616 certificate matches the host name provided by the B<URL> option. If this
5617 identity check fails, the connection is aborted. Obviously, only works when
5618 connecting to a SSL enabled server. Enabled by default.
5620 =item B<CACert> I<File>
5622 File that holds one or more SSL certificates. If you want to use HTTPS you will
5623 possibly need this option. What CA certificates come bundled with C<libcurl>
5624 and are checked by default depends on the distribution you use.
5626 =item B<Timeout> I<Milliseconds>
5628 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5629 milliseconds. By default, the configured B<Interval> is used to set the
5634 =head2 Plugin C<notify_desktop>
5636 This plugin sends a desktop notification to a notification daemon, as defined
5637 in the Desktop Notification Specification. To actually display the
5638 notifications, B<notification-daemon> is required and B<collectd> has to be
5639 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5640 environment variables have to be set correctly) and the D-Bus message bus.
5642 The Desktop Notification Specification can be found at
5643 L<http://www.galago-project.org/specs/notification/>.
5647 =item B<OkayTimeout> I<timeout>
5649 =item B<WarningTimeout> I<timeout>
5651 =item B<FailureTimeout> I<timeout>
5653 Set the I<timeout>, in milliseconds, after which to expire the notification
5654 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5655 been specified, the displayed notification will not be closed at all - the
5656 user has to do so herself. These options default to 5000. If a negative number
5657 has been specified, the default is used as well.
5661 =head2 Plugin C<notify_email>
5663 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5664 configured email address.
5666 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5668 Available configuration options:
5672 =item B<From> I<Address>
5674 Email address from which the emails should appear to come from.
5676 Default: C<root@localhost>
5678 =item B<Recipient> I<Address>
5680 Configures the email address(es) to which the notifications should be mailed.
5681 May be repeated to send notifications to multiple addresses.
5683 At least one B<Recipient> must be present for the plugin to work correctly.
5685 =item B<SMTPServer> I<Hostname>
5687 Hostname of the SMTP server to connect to.
5689 Default: C<localhost>
5691 =item B<SMTPPort> I<Port>
5693 TCP port to connect to.
5697 =item B<SMTPUser> I<Username>
5699 Username for ASMTP authentication. Optional.
5701 =item B<SMTPPassword> I<Password>
5703 Password for ASMTP authentication. Optional.
5705 =item B<Subject> I<Subject>
5707 Subject-template to use when sending emails. There must be exactly two
5708 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5709 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5712 Default: C<Collectd notify: %s@%s>
5716 =head2 Plugin C<notify_nagios>
5718 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5719 a I<passive service check result>.
5721 Available configuration options:
5725 =item B<CommandFile> I<Path>
5727 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5731 =head2 Plugin C<ntpd>
5733 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5736 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5737 the wire - using B<mode 7> specific requests. This mode is deprecated with
5738 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5739 correctly with them, the ntp daemon must be explicitly configured to
5740 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5741 manual page for details.
5743 Available configuration options for the C<ntpd> plugin:
5747 =item B<Host> I<Hostname>
5749 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5751 =item B<Port> I<Port>
5753 UDP-Port to connect to. Defaults to B<123>.
5755 =item B<ReverseLookups> B<true>|B<false>
5757 Sets whether or not to perform reverse lookups on peers. Since the name or
5758 IP-address may be used in a filename it is recommended to disable reverse
5759 lookups. The default is to do reverse lookups to preserve backwards
5760 compatibility, though.
5762 =item B<IncludeUnitID> B<true>|B<false>
5764 When a peer is a refclock, include the unit ID in the I<type instance>.
5765 Defaults to B<false> for backward compatibility.
5767 If two refclock peers use the same driver and this is B<false>, the plugin will
5768 try to write simultaneous measurements from both to the same type instance.
5769 This will result in error messages in the log and only one set of measurements
5774 =head2 Plugin C<nut>
5778 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5780 Add a UPS to collect data from. The format is identical to the one accepted by
5783 =item B<ForceSSL> B<true>|B<false>
5785 Stops connections from falling back to unsecured if an SSL connection
5786 cannot be established. Defaults to false if undeclared.
5788 =item B<VerifyPeer> I<true>|I<false>
5790 If set to true, requires a CAPath be provided. Will use the CAPath to find
5791 certificates to use as Trusted Certificates to validate a upsd server certificate.
5792 If validation of the upsd server certificate fails, the connection will not be
5793 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5794 will override and set ForceSSL to true.
5796 =item B<CAPath> I/path/to/certs/folder
5798 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5799 The folder pointed at must contain certificate(s) named according to their hash.
5800 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5801 occur because two different certs have the same hash value, Y can be incremented
5802 in order to avoid conflict. To create a symbolic link to a certificate the following
5803 command can be used from within the directory where the cert resides:
5805 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5807 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5808 generate links like the one described above for ALL certs in a given folder.
5810 C<c_rehash /path/to/certs/folder>
5812 =item B<ConnectTimeout> I<Milliseconds>
5814 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5815 By default, the configured B<Interval> is used to set the timeout.
5819 =head2 Plugin C<olsrd>
5821 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5822 the Optimized Link State Routing daemon and reads information about the current
5823 state of the meshed network.
5825 The following configuration options are understood:
5829 =item B<Host> I<Host>
5831 Connect to I<Host>. Defaults to B<"localhost">.
5833 =item B<Port> I<Port>
5835 Specifies the port to connect to. This must be a string, even if you give the
5836 port as a number rather than a service name. Defaults to B<"2006">.
5838 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5840 Specifies what information to collect about links, i.E<nbsp>e. direct
5841 connections of the daemon queried. If set to B<No>, no information is
5842 collected. If set to B<Summary>, the number of links and the average of all
5843 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5844 If set to B<Detail> LQ and NLQ are collected per link.
5846 Defaults to B<Detail>.
5848 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5850 Specifies what information to collect about routes of the daemon queried. If
5851 set to B<No>, no information is collected. If set to B<Summary>, the number of
5852 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5853 metric and ETX are collected per route.
5855 Defaults to B<Summary>.
5857 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5859 Specifies what information to collect about the global topology. If set to
5860 B<No>, no information is collected. If set to B<Summary>, the number of links
5861 in the entire topology and the average I<link quality> (LQ) is calculated.
5862 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5864 Defaults to B<Summary>.
5868 =head2 Plugin C<onewire>
5870 B<EXPERIMENTAL!> See notes below.
5872 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5873 L<http://owfs.org/> to read sensors connected via the onewire bus.
5875 It can be used in two possible modes - standard or advanced.
5877 In the standard mode only temperature sensors (sensors with the family code
5878 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5879 other sensors you would like to have included, please send a sort request to
5880 the mailing list. You can select sensors to be read or to be ignored depending
5881 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5882 walked and all sensors are read.
5884 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5885 experimental, below.
5887 In the advanced mode you can configure any sensor to be read (only numerical
5888 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5889 In this mode you have to list all the sensors. Neither default bus walk nor
5890 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5891 the path automatically and should produce compatible structure with the "standard"
5892 mode (basically the path is expected as for example
5893 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5894 "F10FCA000800" and the rest after the slash is considered the type - here
5896 There are two advantages to this mode - you can access virtually any sensor
5897 (not just temperature), select whether to use cached or directly read values
5898 and it is slighlty faster. The downside is more complex configuration.
5900 The two modes are distinguished automatically by the format of the address.
5901 It is not possible to mix the two modes. Once a full path is detected in any
5902 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5903 (and as standard addresses will fail parsing they will be ignored).
5907 =item B<Device> I<Device>
5909 Sets the device to read the values from. This can either be a "real" hardware
5910 device, such as a serial port or an USB port, or the address of the
5911 L<owserver(1)> socket, usually B<localhost:4304>.
5913 Though the documentation claims to automatically recognize the given address
5914 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5915 with that version, the following configuration worked for us:
5918 Device "-s localhost:4304"
5921 This directive is B<required> and does not have a default value.
5923 =item B<Sensor> I<Sensor>
5925 In the standard mode selects sensors to collect or to ignore
5926 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5927 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5928 and B<not> include the leading C<10.> family byte and point.
5929 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5930 sensors (see above) are read.
5932 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5933 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5934 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5936 As there can be multiple devices on the bus you can list multiple sensor (use
5937 multiple B<Sensor> elements).
5939 See F</"IGNORELISTS"> for details.
5941 =item B<IgnoreSelected> I<true>|I<false>
5943 If no configuration is given, the B<onewire> plugin will collect data from all
5944 sensors found. This may not be practical, especially if sensors are added and
5945 removed regularly. Sometimes, however, it's easier/preferred to collect only
5946 specific sensors or all sensors I<except> a few specified ones. This option
5947 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5948 B<Sensor> is inverted: All selected interfaces are ignored and all other
5949 interfaces are collected.
5951 Used only in the standard mode - see above.
5953 =item B<Interval> I<Seconds>
5955 Sets the interval in which all sensors should be read. If not specified, the
5956 global B<Interval> setting is used.
5960 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5961 work with big setups. It works with one sensor being attached to one
5962 controller, but as soon as you throw in a couple more senors and maybe a hub
5963 or two, reading all values will take more than ten seconds (the default
5964 interval). We will probably add some separate thread for reading the sensors
5965 and some cache or something like that, but it's not done yet. We will try to
5966 maintain backwards compatibility in the future, but we can't promise. So in
5967 short: If it works for you: Great! But keep in mind that the config I<might>
5968 change, though this is unlikely. Oh, and if you want to help improving this
5969 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5971 =head2 Plugin C<openldap>
5973 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5974 server correctly. The backend database C<monitor> needs to be loaded and
5975 working. See slapd-monitor(5) for the details.
5977 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5978 blocks. Each block requires one string argument as the instance name. For
5983 URL "ldap://localhost/"
5986 URL "ldaps://localhost/"
5990 The instance name will be used as the I<plugin instance>. To emulate the old
5991 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5992 plugin to work correctly, each instance name must be unique. This is not
5993 enforced by the plugin and it is your responsibility to ensure it is.
5995 The following options are accepted within each B<Instance> block:
5999 =item B<URL> I<ldap://host/binddn>
6001 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6004 =item B<BindDN> I<BindDN>
6006 Name in the form of an LDAP distinguished name intended to be used for
6007 authentication. Defaults to empty string to establish an anonymous authorization.
6009 =item B<Password> I<Password>
6011 Password for simple bind authentication. If this option is not set,
6012 unauthenticated bind operation is used.
6014 =item B<StartTLS> B<true|false>
6016 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6017 Disabled by default.
6019 =item B<VerifyHost> B<true|false>
6021 Enables or disables peer host name verification. If enabled, the plugin checks
6022 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6023 certificate matches the host name provided by the B<URL> option. If this
6024 identity check fails, the connection is aborted. Enabled by default.
6026 =item B<CACert> I<File>
6028 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6029 may possibly need this option. What CA certificates are checked by default
6030 depends on the distribution you use and can be changed with the usual ldap
6031 client configuration mechanisms. See ldap.conf(5) for the details.
6033 =item B<Timeout> I<Seconds>
6035 Sets the timeout value for ldap operations, in seconds. By default, the
6036 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6039 =item B<Version> I<Version>
6041 An integer which sets the LDAP protocol version number to use when connecting
6042 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6046 =head2 Plugin C<openvpn>
6048 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6049 traffic statistics about connected clients.
6051 To set up OpenVPN to write to the status file periodically, use the
6052 B<--status> option of OpenVPN.
6054 So, in a nutshell you need:
6056 openvpn $OTHER_OPTIONS \
6057 --status "/var/run/openvpn-status" 10
6063 =item B<StatusFile> I<File>
6065 Specifies the location of the status file.
6067 =item B<ImprovedNamingSchema> B<true>|B<false>
6069 When enabled, the filename of the status file will be used as plugin instance
6070 and the client's "common name" will be used as type instance. This is required
6071 when reading multiple status files. Enabling this option is recommended, but to
6072 maintain backwards compatibility this option is disabled by default.
6074 =item B<CollectCompression> B<true>|B<false>
6076 Sets whether or not statistics about the compression used by OpenVPN should be
6077 collected. This information is only available in I<single> mode. Enabled by
6080 =item B<CollectIndividualUsers> B<true>|B<false>
6082 Sets whether or not traffic information is collected for each connected client
6083 individually. If set to false, currently no traffic data is collected at all
6084 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6086 =item B<CollectUserCount> B<true>|B<false>
6088 When enabled, the number of currently connected clients or users is collected.
6089 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6090 can be configured independently from that option. Defaults to B<false>.
6094 =head2 Plugin C<oracle>
6096 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6097 Oracle® Database and lets you execute SQL statements there. It is very similar
6098 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6099 plugin's documentation above for details.
6102 <Query "out_of_stock">
6103 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6106 # InstancePrefix "foo"
6107 InstancesFrom "category"
6111 <Database "product_information">
6116 Query "out_of_stock"
6120 =head3 B<Query> blocks
6122 The Query blocks are handled identically to the Query blocks of the "dbi"
6123 plugin. Please see its documentation above for details on how to specify
6126 =head3 B<Database> blocks
6128 Database blocks define a connection to a database and which queries should be
6129 sent to that database. Each database needs a "name" as string argument in the
6130 starting tag of the block. This name will be used as "PluginInstance" in the
6131 values submitted to the daemon. Other than that, that name is not used.
6135 =item B<Plugin> I<Plugin>
6137 Use I<Plugin> as the plugin name when submitting query results from
6138 this B<Database>. Defaults to C<oracle>.
6140 =item B<ConnectID> I<ID>
6142 Defines the "database alias" or "service name" to connect to. Usually, these
6143 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6145 =item B<Host> I<Host>
6147 Hostname to use when dispatching values for this database. Defaults to using
6148 the global hostname of the I<collectd> instance.
6150 =item B<Username> I<Username>
6152 Username used for authentication.
6154 =item B<Password> I<Password>
6156 Password used for authentication.
6158 =item B<Query> I<QueryName>
6160 Associates the query named I<QueryName> with this database connection. The
6161 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6162 blocks you want to refer to must be placed above the database block you want to
6167 =head2 Plugin C<ovs_events>
6169 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6170 connected interfaces, dispatches the values to collectd and sends the
6171 notification whenever the link state change occurs. This plugin uses OVS
6172 database to get a link state change notification.
6176 <Plugin "ovs_events">
6179 Socket "/var/run/openvswitch/db.sock"
6180 Interfaces "br0" "veth0"
6181 SendNotification true
6182 DispatchValues false
6185 The plugin provides the following configuration options:
6189 =item B<Address> I<node>
6191 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6192 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6193 option. See L<ovsdb-server(1)> for more details. The option may be either
6194 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6195 format. Defaults to C<localhost>.
6197 =item B<Port> I<service>
6199 TCP-port to connect to. Either a service name or a port number may be given.
6200 Defaults to B<6640>.
6202 =item B<Socket> I<path>
6204 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6205 plugin. To enable the interface, the OVS DB daemon should be running with
6206 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6207 option is set, B<Address> and B<Port> options are ignored.
6209 =item B<Interfaces> [I<ifname> ...]
6211 List of interface names to be monitored by this plugin. If this option is not
6212 specified or is empty then all OVS connected interfaces on all bridges are
6215 Default: empty (all interfaces on all bridges are monitored)
6217 =item B<SendNotification> I<true|false>
6219 If set to true, OVS link notifications (interface status and OVS DB connection
6220 terminate) are sent to collectd. Default value is true.
6222 =item B<DispatchValues> I<true|false>
6224 Dispatch the OVS DB interface link status value with configured plugin interval.
6225 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6226 options are false, no OVS information will be provided by the plugin.
6230 B<Note:> By default, the global interval setting is used within which to
6231 retrieve the OVS link status. To configure a plugin-specific interval, please
6232 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6233 simple divide the time by 1000 for example if the desired interval is 50ms, set
6236 =head2 Plugin C<ovs_stats>
6238 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6239 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6240 statistics from OVSDB
6244 <Plugin "ovs_stats">
6247 Socket "/var/run/openvswitch/db.sock"
6248 Bridges "br0" "br_ext"
6249 InterfaceStats false
6252 The plugin provides the following configuration options:
6256 =item B<Address> I<node>
6258 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6259 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6260 option. See L<ovsdb-server(1)> for more details. The option may be either
6261 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6262 format. Defaults to C<localhost>.
6264 =item B<Port> I<service>
6266 TCP-port to connect to. Either a service name or a port number may be given.
6267 Defaults to B<6640>.
6269 =item B<Socket> I<path>
6271 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6272 plugin. To enable the interface, the OVS DB daemon should be running with
6273 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6274 option is set, B<Address> and B<Port> options are ignored.
6276 =item B<Bridges> [I<brname> ...]
6278 List of OVS bridge names to be monitored by this plugin. If this option is
6279 omitted or is empty then all OVS bridges will be monitored.
6281 Default: empty (monitor all bridges)
6283 =item B<InterfaceStats> B<false>|B<true>
6285 Indicates that the plugin should gather statistics for individual interfaces
6286 in addition to ports. This can be useful when monitoring an OVS setup with
6287 bond ports, where you might wish to know individual statistics for the
6288 interfaces included in the bonds. Defaults to B<false>.
6292 =head2 Plugin C<pcie_errors>
6294 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6295 structure and from Advanced Error Reporting Extended Capability where available.
6296 At every read it polls config space of PCI Express devices and dispatches
6297 notification for every error that is set. It checks for new errors at every read.
6298 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6299 Errors are divided into categories indicated by type_instance: "correctable", and
6300 for uncorrectable errors "non_fatal" or "fatal".
6301 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6305 <Plugin "pcie_errors">
6307 AccessDir "/sys/bus/pci"
6309 PersistentNotifications false
6316 =item B<Source> B<sysfs>|B<proc>
6318 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6319 The default value is B<sysfs>.
6321 =item B<AccessDir> I<dir>
6323 Directory used to access device config space. It is optional and defaults to
6324 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6326 =item B<ReportMasked> B<false>|B<true>
6328 If true plugin will notify about errors that are set to masked in Error Mask register.
6329 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6331 =item B<PersistentNotifications> B<false>|B<true>
6333 If false plugin will dispatch notification only on set/clear of error.
6334 The ones already reported will be ignored. Defaults to B<false>.
6338 =head2 Plugin C<perl>
6340 This plugin embeds a Perl-interpreter into collectd and provides an interface
6341 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6343 =head2 Plugin C<pinba>
6345 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6346 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6347 PHP-based webpage has been delivered, the extension will send a UDP packet
6348 containing timing information, peak memory usage and so on. The plugin will
6349 wait for such packets, parse them and account the provided information, which
6350 is then dispatched to the daemon once per interval.
6357 # Overall statistics for the website.
6359 Server "www.example.com"
6361 # Statistics for www-a only
6363 Host "www-a.example.com"
6364 Server "www.example.com"
6366 # Statistics for www-b only
6368 Host "www-b.example.com"
6369 Server "www.example.com"
6373 The plugin provides the following configuration options:
6377 =item B<Address> I<Node>
6379 Configures the address used to open a listening socket. By default, plugin will
6380 bind to the I<any> address C<::0>.
6382 =item B<Port> I<Service>
6384 Configures the port (service) to bind to. By default the default Pinba port
6385 "30002" will be used. The option accepts service names in addition to port
6386 numbers and thus requires a I<string> argument.
6388 =item E<lt>B<View> I<Name>E<gt> block
6390 The packets sent by the Pinba extension include the hostname of the server, the
6391 server name (the name of the virtual host) and the script that was executed.
6392 Using B<View> blocks it is possible to separate the data into multiple groups
6393 to get more meaningful statistics. Each packet is added to all matching groups,
6394 so that a packet may be accounted for more than once.
6398 =item B<Host> I<Host>
6400 Matches the hostname of the system the webserver / script is running on. This
6401 will contain the result of the L<gethostname(2)> system call. If not
6402 configured, all hostnames will be accepted.
6404 =item B<Server> I<Server>
6406 Matches the name of the I<virtual host>, i.e. the contents of the
6407 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6408 server names will be accepted.
6410 =item B<Script> I<Script>
6412 Matches the name of the I<script name>, i.e. the contents of the
6413 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6414 script names will be accepted.
6420 =head2 Plugin C<ping>
6422 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6423 configured hosts periodically and measures the network latency. Whenever the
6424 C<read> function of the plugin is called, it submits the average latency, the
6425 standard deviation and the drop rate for each host.
6427 Available configuration options:
6431 =item B<Host> I<IP-address>
6433 Host to ping periodically. This option may be repeated several times to ping
6436 =item B<Interval> I<Seconds>
6438 Sets the interval in which to send ICMP echo packets to the configured hosts.
6439 This is B<not> the interval in which metrics are read from the plugin but the
6440 interval in which the hosts are "pinged". Therefore, the setting here should be
6441 smaller than or equal to the global B<Interval> setting. Fractional times, such
6442 as "1.24" are allowed.
6446 =item B<Timeout> I<Seconds>
6448 Time to wait for a response from the host to which an ICMP packet had been
6449 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6450 to be down or the packet to be dropped. This setting must be smaller than the
6451 B<Interval> setting above for the plugin to work correctly. Fractional
6452 arguments are accepted.
6456 =item B<TTL> I<0-255>
6458 Sets the Time-To-Live of generated ICMP packets.
6460 =item B<Size> I<size>
6462 Sets the size of the data payload in ICMP packet to specified I<size> (it
6463 will be filled with regular ASCII pattern). If not set, default 56 byte
6464 long string is used so that the packet size of an ICMPv4 packet is exactly
6465 64 bytes, similar to the behaviour of normal ping(1) command.
6467 =item B<SourceAddress> I<host>
6469 Sets the source address to use. I<host> may either be a numerical network
6470 address or a network hostname.
6472 =item B<AddressFamily> I<af>
6474 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6475 option will be ignored if you set a B<SourceAddress>.
6477 =item B<Device> I<name>
6479 Sets the outgoing network device to be used. I<name> has to specify an
6480 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6483 =item B<MaxMissed> I<Packets>
6485 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6486 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6488 Default: B<-1> (disabled)
6492 =head2 Plugin C<postgresql>
6494 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6495 keeps a persistent connection to all configured databases and tries to
6496 reconnect if the connection has been interrupted. A database is configured by
6497 specifying a B<Database> block as described below. The default statistics are
6498 collected from PostgreSQL's B<statistics collector> which thus has to be
6499 enabled for this plugin to work correctly. This should usually be the case by
6500 default. See the section "The Statistics Collector" of the B<PostgreSQL
6501 Documentation> for details.
6503 By specifying custom database queries using a B<Query> block as described
6504 below, you may collect any data that is available from some PostgreSQL
6505 database. This way, you are able to access statistics of external daemons
6506 which are available in a PostgreSQL database or use future or special
6507 statistics provided by PostgreSQL without the need to upgrade your collectd
6510 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6511 PostgreSQL databases as well. This has been implemented in a generic way. You
6512 need to specify an SQL statement which will then be executed by collectd in
6513 order to write the data (see below for details). The benefit of that approach
6514 is that there is no fixed database layout. Rather, the layout may be optimized
6515 for the current setup.
6517 The B<PostgreSQL Documentation> manual can be found at
6518 L<http://www.postgresql.org/docs/manuals/>.
6522 Statement "SELECT magic FROM wizard WHERE host = $1;"
6526 InstancePrefix "magic"
6531 <Query rt36_tickets>
6532 Statement "SELECT COUNT(type) AS count, type \
6534 WHEN resolved = 'epoch' THEN 'open' \
6535 ELSE 'resolved' END AS type \
6536 FROM tickets) type \
6540 InstancePrefix "rt36_tickets"
6541 InstancesFrom "type"
6547 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6558 KRBSrvName "kerberos_service_name"
6564 Service "service_name"
6565 Query backends # predefined
6576 The B<Query> block defines one database query which may later be used by a
6577 database definition. It accepts a single mandatory argument which specifies
6578 the name of the query. The names of all queries have to be unique (see the
6579 B<MinVersion> and B<MaxVersion> options below for an exception to this
6582 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6583 B<Result> blocks may be used to extract multiple values from a single query.
6585 The following configuration options are available to define the query:
6589 =item B<Statement> I<sql query statement>
6591 Specify the I<sql query statement> which the plugin should execute. The string
6592 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6593 first, second, etc. parameter. The value of the parameters is specified by the
6594 B<Param> configuration option - see below for details. To include a literal
6595 B<$> character followed by a number, surround it with single quotes (B<'>).
6597 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6598 allowed. Note, however, that only a single command may be used. Semicolons are
6599 allowed as long as a single non-empty command has been specified only.
6601 The returned lines will be handled separately one after another.
6603 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6605 Specify the parameters which should be passed to the SQL query. The parameters
6606 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6607 they appear in the configuration file. The value of the parameter is
6608 determined depending on the value of the B<Param> option as follows:
6614 The configured hostname of the database connection. If a UNIX domain socket is
6615 used, the parameter expands to "localhost".
6619 The name of the database of the current connection.
6623 The name of the database plugin instance. See the B<Instance> option of the
6624 database specification below for details.
6628 The username used to connect to the database.
6632 The interval with which this database is queried (as specified by the database
6633 specific or global B<Interval> options).
6637 Please note that parameters are only supported by PostgreSQL's protocol
6638 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6640 =item B<PluginInstanceFrom> I<column>
6642 Specify how to create the "PluginInstance" for reporting this query results.
6643 Only one column is supported. You may concatenate fields and string values in
6644 the query statement to get the required results.
6646 =item B<MinVersion> I<version>
6648 =item B<MaxVersion> I<version>
6650 Specify the minimum or maximum version of PostgreSQL that this query should be
6651 used with. Some statistics might only be available with certain versions of
6652 PostgreSQL. This allows you to specify multiple queries with the same name but
6653 which apply to different versions, thus allowing you to use the same
6654 configuration in a heterogeneous environment.
6656 The I<version> has to be specified as the concatenation of the major, minor
6657 and patch-level versions, each represented as two-decimal-digit numbers. For
6658 example, version 8.2.3 will become 80203.
6662 The B<Result> block defines how to handle the values returned from the query.
6663 It defines which column holds which value and how to dispatch that value to
6668 =item B<Type> I<type>
6670 The I<type> name to be used when dispatching the values. The type describes
6671 how to handle the data and where to store it. See L<types.db(5)> for more
6672 details on types and their configuration. The number and type of values (as
6673 selected by the B<ValuesFrom> option) has to match the type of the given name.
6675 This option is mandatory.
6677 =item B<InstancePrefix> I<prefix>
6679 =item B<InstancesFrom> I<column0> [I<column1> ...]
6681 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6682 B<InstancePrefix> defines a static prefix that will be prepended to all type
6683 instances. B<InstancesFrom> defines the column names whose values will be used
6684 to create the type instance. Multiple values will be joined together using the
6685 hyphen (C<->) as separation character.
6687 The plugin itself does not check whether or not all built instances are
6688 different. It is your responsibility to assure that each is unique.
6690 Both options are optional. If none is specified, the type instance will be
6693 =item B<ValuesFrom> I<column0> [I<column1> ...]
6695 Names the columns whose content is used as the actual data for the data sets
6696 that are dispatched to the daemon. How many such columns you need is
6697 determined by the B<Type> setting as explained above. If you specify too many
6698 or not enough columns, the plugin will complain about that and no data will be
6699 submitted to the daemon.
6701 The actual data type, as seen by PostgreSQL, is not that important as long as
6702 it represents numbers. The plugin will automatically cast the values to the
6703 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6704 L<strtod(3)> functions, so anything supported by those functions is supported
6705 by the plugin as well.
6707 This option is required inside a B<Result> block and may be specified multiple
6708 times. If multiple B<ValuesFrom> options are specified, the columns are read
6713 The following predefined queries are available (the definitions can be found
6714 in the F<postgresql_default.conf> file which, by default, is available at
6715 C<I<prefix>/share/collectd/>):
6721 This query collects the number of backends, i.E<nbsp>e. the number of
6724 =item B<transactions>
6726 This query collects the numbers of committed and rolled-back transactions of
6731 This query collects the numbers of various table modifications (i.E<nbsp>e.
6732 insertions, updates, deletions) of the user tables.
6734 =item B<query_plans>
6736 This query collects the numbers of various table scans and returned tuples of
6739 =item B<table_states>
6741 This query collects the numbers of live and dead rows in the user tables.
6745 This query collects disk block access counts for user tables.
6749 This query collects the on-disk size of the database in bytes.
6753 In addition, the following detailed queries are available by default. Please
6754 note that each of those queries collects information B<by table>, thus,
6755 potentially producing B<a lot> of data. For details see the description of the
6756 non-by_table queries above.
6760 =item B<queries_by_table>
6762 =item B<query_plans_by_table>
6764 =item B<table_states_by_table>
6766 =item B<disk_io_by_table>
6770 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6771 mandatory argument specifying the name of the writer. This will then be used
6772 in the B<Database> specification in order to activate the writer instance. The
6773 names of all writers have to be unique. The following options may be
6778 =item B<Statement> I<sql statement>
6780 This mandatory option specifies the SQL statement that will be executed for
6781 each submitted value. A single SQL statement is allowed only. Anything after
6782 the first semicolon will be ignored.
6784 Nine parameters will be passed to the statement and should be specified as
6785 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6786 values are made available through those parameters:
6792 The timestamp of the queried value as an RFC 3339-formatted local time.
6796 The hostname of the queried value.
6800 The plugin name of the queried value.
6804 The plugin instance of the queried value. This value may be B<NULL> if there
6805 is no plugin instance.
6809 The type of the queried value (cf. L<types.db(5)>).
6813 The type instance of the queried value. This value may be B<NULL> if there is
6818 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6819 sources of the submitted value-list).
6823 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6824 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6825 B<StoreRates> is enabled (which is the default, see below), all types will be
6830 An array of the submitted values. The dimensions of the value name and value
6835 In general, it is advisable to create and call a custom function in the
6836 PostgreSQL database for this purpose. Any procedural language supported by
6837 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6840 =item B<StoreRates> B<false>|B<true>
6842 If set to B<true> (the default), convert counter values to rates. If set to
6843 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6848 The B<Database> block defines one PostgreSQL database for which to collect
6849 statistics. It accepts a single mandatory argument which specifies the
6850 database name. None of the other options are required. PostgreSQL will use
6851 default values as documented in the section "CONNECTING TO A DATABASE" in the
6852 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6853 the user collectd is run as and special environment variables. See the manpage
6858 =item B<Interval> I<seconds>
6860 Specify the interval with which the database should be queried. The default is
6861 to use the global B<Interval> setting.
6863 =item B<CommitInterval> I<seconds>
6865 This option may be used for database connections which have "writers" assigned
6866 (see above). If specified, it causes a writer to put several updates into a
6867 single transaction. This transaction will last for the specified amount of
6868 time. By default, each update will be executed in a separate transaction. Each
6869 transaction generates a fair amount of overhead which can, thus, be reduced by
6870 activating this option. The draw-back is, that data covering the specified
6871 amount of time will be lost, for example, if a single statement within the
6872 transaction fails or if the database server crashes.
6874 =item B<Plugin> I<Plugin>
6876 Use I<Plugin> as the plugin name when submitting query results from
6877 this B<Database>. Defaults to C<postgresql>.
6879 =item B<Instance> I<name>
6881 Specify the plugin instance name that should be used instead of the database
6882 name (which is the default, if this option has not been specified). This
6883 allows one to query multiple databases of the same name on the same host (e.g.
6884 when running multiple database server versions in parallel).
6885 The plugin instance name can also be set from the query result using
6886 the B<PluginInstanceFrom> option in B<Query> block.
6888 =item B<Host> I<hostname>
6890 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6891 value begins with a slash, it is interpreted as the directory name in which to
6892 look for the UNIX domain socket.
6894 This option is also used to determine the hostname that is associated with a
6895 collected data set. If it has been omitted or either begins with with a slash
6896 or equals B<localhost> it will be replaced with the global hostname definition
6897 of collectd. Any other value will be passed literally to collectd when
6898 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6900 =item B<Port> I<port>
6902 Specify the TCP port or the local UNIX domain socket file extension of the
6905 =item B<User> I<username>
6907 Specify the username to be used when connecting to the server.
6909 =item B<Password> I<password>
6911 Specify the password to be used when connecting to the server.
6913 =item B<ExpireDelay> I<delay>
6915 Skip expired values in query output.
6917 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6919 Specify whether to use an SSL connection when contacting the server. The
6920 following modes are supported:
6926 Do not use SSL at all.
6930 First, try to connect without using SSL. If that fails, try using SSL.
6932 =item I<prefer> (default)
6934 First, try to connect using SSL. If that fails, try without using SSL.
6942 =item B<Instance> I<name>
6944 Specify the plugin instance name that should be used instead of the database
6945 name (which is the default, if this option has not been specified). This
6946 allows one to query multiple databases of the same name on the same host (e.g.
6947 when running multiple database server versions in parallel).
6949 =item B<KRBSrvName> I<kerberos_service_name>
6951 Specify the Kerberos service name to use when authenticating with Kerberos 5
6952 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6953 B<PostgreSQL Documentation> for details.
6955 =item B<Service> I<service_name>
6957 Specify the PostgreSQL service name to use for additional parameters. That
6958 service has to be defined in F<pg_service.conf> and holds additional
6959 connection parameters. See the section "The Connection Service File" in the
6960 B<PostgreSQL Documentation> for details.
6962 =item B<Query> I<query>
6964 Specifies a I<query> which should be executed in the context of the database
6965 connection. This may be any of the predefined or user-defined queries. If no
6966 such option is given, it defaults to "backends", "transactions", "queries",
6967 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6968 has been specified). Else, the specified queries are used only.
6970 =item B<Writer> I<writer>
6972 Assigns the specified I<writer> backend to the database connection. This
6973 causes all collected data to be send to the database using the settings
6974 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6975 below for details on how to selectively send data to certain plugins).
6977 Each writer will register a flush callback which may be used when having long
6978 transactions enabled (see the B<CommitInterval> option above). When issuing
6979 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6980 transaction will be committed right away. Two different kinds of flush
6981 callbacks are available with the C<postgresql> plugin:
6987 Flush all writer backends.
6989 =item B<postgresql->I<database>
6991 Flush all writers of the specified I<database> only.
6997 =head2 Plugin C<powerdns>
6999 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7000 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7001 values, many of which are probably meaningless to most users, but may be useful
7002 for some. So you may chose which values to collect, but if you don't, some
7003 reasonable defaults will be collected.
7006 <Server "server_name">
7008 Collect "udp-answers" "udp-queries"
7009 Socket "/var/run/pdns.controlsocket"
7011 <Recursor "recursor_name">
7013 Collect "cache-hits" "cache-misses"
7014 Socket "/var/run/pdns_recursor.controlsocket"
7016 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7021 =item B<Server> and B<Recursor> block
7023 The B<Server> block defines one authoritative server to query, the B<Recursor>
7024 does the same for an recursing server. The possible options in both blocks are
7025 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7030 =item B<Collect> I<Field>
7032 Using the B<Collect> statement you can select which values to collect. Here,
7033 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7034 C<dlg-only-drops>, C<answers10-100>.
7036 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7037 When querying the server a C<SHOW *> command is issued in any case, because
7038 that's the only way of getting multiple values out of the server at once.
7039 collectd then picks out the values you have selected. When querying the
7040 recursor, a command is generated to query exactly these values. So if you
7041 specify invalid fields when querying the recursor, a syntax error may be
7042 returned by the daemon and collectd may not collect any values at all.
7044 If no B<Collect> statement is given, the following B<Server> values will be
7051 =item packetcache-hit
7053 =item packetcache-miss
7055 =item packetcache-size
7057 =item query-cache-hit
7059 =item query-cache-miss
7061 =item recursing-answers
7063 =item recursing-questions
7075 The following B<Recursor> values will be collected by default:
7079 =item noerror-answers
7081 =item nxdomain-answers
7083 =item servfail-answers
7101 Please note that up to that point collectd doesn't know what values are
7102 available on the server and values that are added do not need a change of the
7103 mechanism so far. However, the values must be mapped to collectd's naming
7104 scheme, which is done using a lookup table that lists all known values. If
7105 values are added in the future and collectd does not know about them, you will
7106 get an error much like this:
7108 powerdns plugin: submit: Not found in lookup table: foobar = 42
7110 In this case please file a bug report with the collectd team.
7112 =item B<Socket> I<Path>
7114 Configures the path to the UNIX domain socket to be used when connecting to the
7115 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7116 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7117 will be used for the recursor.
7121 =item B<LocalSocket> I<Path>
7123 Querying the recursor is done using UDP. When using UDP over UNIX domain
7124 sockets, the client socket needs a name in the file system, too. You can set
7125 this local name to I<Path> using the B<LocalSocket> option. The default is
7126 C<I<prefix>/var/run/collectd-powerdns>.
7130 =head2 Plugin C<processes>
7132 Collects information about processes of local system.
7134 By default, with no process matches configured, only general statistics is
7135 collected: the number of processes in each state and fork rate.
7137 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7138 These may also be a block in which further options may be specified.
7140 The statistics collected for matched processes are:
7141 - size of the resident segment size (RSS)
7142 - user- and system-time used
7143 - number of processes
7145 - number of open files (under Linux)
7146 - number of memory mapped files (under Linux)
7147 - io data (where available)
7148 - context switches (under Linux)
7149 - minor and major pagefaults
7150 - Delay Accounting information (Linux only, requires libmnl)
7155 CollectFileDescriptor true
7156 CollectContextSwitch true
7157 CollectDelayAccounting false
7159 ProcessMatch "name" "regex"
7160 <Process "collectd">
7161 CollectFileDescriptor false
7162 CollectContextSwitch false
7163 CollectDelayAccounting true
7165 <ProcessMatch "name" "regex">
7166 CollectFileDescriptor false
7167 CollectContextSwitch true
7173 =item B<Process> I<Name>
7175 Select more detailed statistics of processes matching this name.
7177 Some platforms have a limit on the length of process names.
7178 I<Name> must stay below this limit.
7180 =item B<ProcessMatch> I<name> I<regex>
7182 Select more detailed statistics of processes matching the specified I<regex>
7183 (see L<regex(7)> for details). The statistics of all matching processes are
7184 summed up and dispatched to the daemon using the specified I<name> as an
7185 identifier. This allows one to "group" several processes together.
7186 I<name> must not contain slashes.
7188 =item B<CollectContextSwitch> I<Boolean>
7190 Collect the number of context switches for matched processes.
7191 Disabled by default.
7193 =item B<CollectDelayAccounting> I<Boolean>
7195 If enabled, collect Linux Delay Accounding information for matching processes.
7196 Delay Accounting provides the time processes wait for the CPU to become
7197 available, for I/O operations to finish, for pages to be swapped in and for
7198 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7199 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7200 Disabled by default.
7202 This option is only available on Linux, requires the C<libmnl> library and
7203 requires the C<CAP_NET_ADMIN> capability at runtime.
7205 =item B<CollectFileDescriptor> I<Boolean>
7207 Collect number of file descriptors of matched processes.
7208 Disabled by default.
7210 =item B<CollectMemoryMaps> I<Boolean>
7212 Collect the number of memory mapped files of the process.
7213 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7218 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7219 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7220 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7221 reporting the corresponding processes only. Outside of B<Process> and
7222 B<ProcessMatch> blocks these options set the default value for subsequent
7225 =head2 Plugin C<protocols>
7227 Collects a lot of information about various network protocols, such as I<IP>,
7228 I<TCP>, I<UDP>, etc.
7230 Available configuration options:
7234 =item B<Value> I<Selector>
7236 Selects whether or not to select a specific value. The string being matched is
7237 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7238 plugin instance and I<ValueName> will be used as type instance. An example of
7239 the string being used would be C<Tcp:RetransSegs>.
7241 You can use regular expressions to match a large number of values with just one
7242 configuration option. To select all "extended" I<TCP> values, you could use the
7243 following statement:
7247 Whether only matched values are selected or all matched values are ignored
7248 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7249 If no value is configured at all, all values will be selected.
7251 See F</"IGNORELISTS"> for details.
7253 =item B<IgnoreSelected> B<true>|B<false>
7255 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7256 matching values will be ignored.
7260 =head2 Plugin C<python>
7262 This plugin embeds a Python-interpreter into collectd and provides an interface
7263 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7265 =head2 Plugin C<routeros>
7267 The C<routeros> plugin connects to a device running I<RouterOS>, the
7268 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7269 I<librouteros> to connect and reads information about the interfaces and
7270 wireless connections of the device. The configuration supports querying
7275 Host "router0.example.com"
7278 CollectInterface true
7283 Host "router1.example.com"
7286 CollectInterface true
7287 CollectRegistrationTable true
7294 As you can see above, the configuration of the I<routeros> plugin consists of
7295 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7296 options are understood:
7300 =item B<Host> I<Host>
7302 Hostname or IP-address of the router to connect to.
7304 =item B<Port> I<Port>
7306 Port name or port number used when connecting. If left unspecified, the default
7307 will be chosen by I<librouteros>, currently "8728". This option expects a
7308 string argument, even when a numeric port number is given.
7310 =item B<User> I<User>
7312 Use the user name I<User> to authenticate. Defaults to "admin".
7314 =item B<Password> I<Password>
7316 Set the password used to authenticate.
7318 =item B<CollectInterface> B<true>|B<false>
7320 When set to B<true>, interface statistics will be collected for all interfaces
7321 present on the device. Defaults to B<false>.
7323 =item B<CollectRegistrationTable> B<true>|B<false>
7325 When set to B<true>, information about wireless LAN connections will be
7326 collected. Defaults to B<false>.
7328 =item B<CollectCPULoad> B<true>|B<false>
7330 When set to B<true>, information about the CPU usage will be collected. The
7331 number is a dimensionless value where zero indicates no CPU usage at all.
7332 Defaults to B<false>.
7334 =item B<CollectMemory> B<true>|B<false>
7336 When enabled, the amount of used and free memory will be collected. How used
7337 memory is calculated is unknown, for example whether or not caches are counted
7339 Defaults to B<false>.
7341 =item B<CollectDF> B<true>|B<false>
7343 When enabled, the amount of used and free disk space will be collected.
7344 Defaults to B<false>.
7346 =item B<CollectDisk> B<true>|B<false>
7348 When enabled, the number of sectors written and bad blocks will be collected.
7349 Defaults to B<false>.
7351 =item B<CollectHealth> B<true>|B<false>
7353 When enabled, the health statistics will be collected. This includes the
7354 voltage and temperature on supported hardware.
7355 Defaults to B<false>.
7359 =head2 Plugin C<redis>
7361 The I<Redis plugin> connects to one or more Redis servers, gathers
7362 information about each server's state and executes user-defined queries.
7363 For each server there is a I<Node> block which configures the connection
7364 parameters and set of user-defined queries for this node.
7371 ReportCommandStats false
7373 <Query "LLEN myqueue">
7383 =item B<Node> I<Nodename>
7385 The B<Node> block identifies a new Redis node, that is a new Redis instance
7386 running in an specified host and port. The name for node is a canonical
7387 identifier which is used as I<plugin instance>. It is limited to
7388 128E<nbsp>characters in length.
7390 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7392 =item B<Host> I<Hostname>
7394 The B<Host> option is the hostname or IP-address where the Redis instance is
7397 =item B<Port> I<Port>
7399 The B<Port> option is the TCP port on which the Redis instance accepts
7400 connections. Either a service name of a port number may be given. Please note
7401 that numerical port numbers must be given as a string, too.
7403 =item B<Password> I<Password>
7405 Use I<Password> to authenticate when connecting to I<Redis>.
7407 =item B<Timeout> I<Milliseconds>
7409 The B<Timeout> option set the socket timeout for node response. Since the Redis
7410 read function is blocking, you should keep this value as low as possible.
7411 It is expected what B<Timeout> values should be lower than B<Interval> defined
7414 Defaults to 2000 (2 seconds).
7416 =item B<ReportCommandStats> B<false>|B<true>
7418 Enables or disables reporting of statistics based on the command type, including
7419 rate of command calls and average CPU time consumed by command processing.
7420 Defaults to B<false>.
7422 =item B<ReportCpuUsage> B<true>|B<false>
7424 Enables or disables reporting of CPU consumption statistics.
7425 Defaults to B<true>.
7427 =item B<Query> I<Querystring>
7429 The B<Query> block identifies a query to execute against the redis server.
7430 There may be an arbitrary number of queries to execute. Each query should
7431 return single string or integer.
7433 =item B<Type> I<Collectd type>
7435 Within a query definition, a valid I<collectd type> to use as when submitting
7436 the result of the query. When not supplied, will default to B<gauge>.
7438 Currently only types with one datasource are supported.
7439 See L<types.db(5)> for more details on types and their configuration.
7441 =item B<Instance> I<Type instance>
7443 Within a query definition, an optional type instance to use when submitting
7444 the result of the query. When not supplied will default to the escaped
7445 command, up to 128 chars.
7447 =item B<Database> I<Index>
7449 This index selects the Redis logical database to use for query. Defaults
7454 =head2 Plugin C<rrdcached>
7456 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7457 to store values to RRD files in an efficient manner. The combination of the
7458 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7459 way the C<rrdtool> plugin works (see below). The added abstraction layer
7460 provides a number of benefits, though: Because the cache is not within
7461 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7462 restarted. This results in much shorter (if any) gaps in graphs, especially
7463 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7464 daemon so that it can flush values to disk automatically when needed. This
7465 allows one to integrate automated flushing of values into graphing solutions
7468 There are disadvantages, though: The daemon may reside on a different host, so
7469 it may not be possible for C<collectd> to create the appropriate RRD files
7470 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7471 different base directory, so relative paths may do weird stuff if you're not
7474 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7475 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7476 setting should be set to an absolute path, so that a changed base directory
7477 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7481 =item B<DaemonAddress> I<Address>
7483 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7484 library. See L<rrdcached(1)> for details. Example:
7486 <Plugin "rrdcached">
7487 DaemonAddress "unix:/var/run/rrdcached.sock"
7490 =item B<DataDir> I<Directory>
7492 Set the base directory in which the RRD files reside. If this is a relative
7493 path, it is relative to the working base directory of the C<rrdcached> daemon!
7494 Use of an absolute path is recommended.
7496 =item B<CreateFiles> B<true>|B<false>
7498 Enables or disables the creation of RRD files. If the daemon is not running
7499 locally, or B<DataDir> is set to a relative path, this will not work as
7500 expected. Default is B<true>.
7502 =item B<CreateFilesAsync> B<false>|B<true>
7504 When enabled, new RRD files are enabled asynchronously, using a separate thread
7505 that runs in the background. This prevents writes to block, which is a problem
7506 especially when many hundreds of files need to be created at once. However,
7507 since the purpose of creating the files asynchronously is I<not> to block until
7508 the file is available, values before the file is available will be discarded.
7509 When disabled (the default) files are created synchronously, blocking for a
7510 short while, while the file is being written.
7512 =item B<StepSize> I<Seconds>
7514 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7515 this setting is unset and the stepsize is set to the interval in which the data
7516 is collected. Do not use this option unless you absolutely have to for some
7517 reason. Setting this option may cause problems with the C<snmp plugin>, the
7518 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7520 =item B<HeartBeat> I<Seconds>
7522 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7523 in which case the heartbeat is set to twice the B<StepSize> which should equal
7524 the interval in which data is collected. Do not set this option unless you have
7525 a very good reason to do so.
7527 =item B<RRARows> I<NumRows>
7529 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7530 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7531 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7532 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7533 week, one month, and one year.
7535 So for each timespan, it calculates how many PDPs need to be consolidated into
7536 one CDP by calculating:
7537 number of PDPs = timespan / (stepsize * rrarows)
7539 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7542 =item B<RRATimespan> I<Seconds>
7544 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7545 more then one RRA. If this option is never used, the built-in default of (3600,
7546 86400, 604800, 2678400, 31622400) is used.
7548 For more information on how RRA-sizes are calculated see B<RRARows> above.
7550 =item B<XFF> I<Factor>
7552 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7553 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7556 =item B<CollectStatistics> B<false>|B<true>
7558 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7559 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7561 Statistics are read via I<rrdcached>s socket using the STATS command.
7562 See L<rrdcached(1)> for details.
7566 =head2 Plugin C<rrdtool>
7568 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7569 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7570 using these settings. If you don't want to dive into the depths of RRDtool, you
7571 can safely ignore these settings.
7575 =item B<DataDir> I<Directory>
7577 Set the directory to store RRD files under. By default RRD files are generated
7578 beneath the daemon's working directory, i.e. the B<BaseDir>.
7580 =item B<CreateFilesAsync> B<false>|B<true>
7582 When enabled, new RRD files are enabled asynchronously, using a separate thread
7583 that runs in the background. This prevents writes to block, which is a problem
7584 especially when many hundreds of files need to be created at once. However,
7585 since the purpose of creating the files asynchronously is I<not> to block until
7586 the file is available, values before the file is available will be discarded.
7587 When disabled (the default) files are created synchronously, blocking for a
7588 short while, while the file is being written.
7590 =item B<StepSize> I<Seconds>
7592 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7593 this setting is unset and the stepsize is set to the interval in which the data
7594 is collected. Do not use this option unless you absolutely have to for some
7595 reason. Setting this option may cause problems with the C<snmp plugin>, the
7596 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7598 =item B<HeartBeat> I<Seconds>
7600 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7601 in which case the heartbeat is set to twice the B<StepSize> which should equal
7602 the interval in which data is collected. Do not set this option unless you have
7603 a very good reason to do so.
7605 =item B<RRARows> I<NumRows>
7607 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7608 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7609 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7610 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7611 week, one month, and one year.
7613 So for each timespan, it calculates how many PDPs need to be consolidated into
7614 one CDP by calculating:
7615 number of PDPs = timespan / (stepsize * rrarows)
7617 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7620 =item B<RRATimespan> I<Seconds>
7622 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7623 more then one RRA. If this option is never used, the built-in default of (3600,
7624 86400, 604800, 2678400, 31622400) is used.
7626 For more information on how RRA-sizes are calculated see B<RRARows> above.
7628 =item B<XFF> I<Factor>
7630 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7631 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7634 =item B<CacheFlush> I<Seconds>
7636 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7637 it writes all values for a certain RRD-file if the oldest value is older than
7638 (or equal to) the number of seconds specified by B<CacheTimeout>.
7639 That check happens on new values arriwal. If some RRD-file is not updated
7640 anymore for some reason (the computer was shut down, the network is broken,
7641 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7642 every I<Seconds> seconds the entire cache is searched for entries older than
7643 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7644 disk. Since scanning the entire cache is kind of expensive and does nothing
7645 under normal circumstances, this value should not be too small. 900 seconds
7646 might be a good value, though setting this to 7200 seconds doesn't normally
7647 do much harm either.
7649 Defaults to 10x B<CacheTimeout>.
7650 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7651 above default is used.
7653 =item B<CacheTimeout> I<Seconds>
7655 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7656 save values in a cache, as described above. Writing multiple values at once
7657 reduces IO-operations and thus lessens the load produced by updating the files.
7658 The trade off is that the graphs kind of "drag behind" and that more memory is
7661 =item B<WritesPerSecond> I<Updates>
7663 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7664 will run serious performance problems. The B<CacheFlush> setting and the
7665 internal update queue assert that collectd continues to work just fine even
7666 under heavy load, but the system may become very unresponsive and slow. This is
7667 a problem especially if you create graphs from the RRD files on the same
7668 machine, for example using the C<graph.cgi> script included in the
7669 C<contrib/collection3/> directory.
7671 This setting is designed for very large setups. Setting this option to a value
7672 between 25 and 80 updates per second, depending on your hardware, will leave
7673 the server responsive enough to draw graphs even while all the cached values
7674 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7675 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7676 written as fast as possible, so that web frontends have up to date data when
7679 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7680 updates per second, writing all values to disk will take approximately
7681 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7682 "collection3" you'll end up with a responsive and fast system, up to date
7683 graphs and basically a "backup" of your values every hour.
7685 =item B<RandomTimeout> I<Seconds>
7687 When set, the actual timeout for each value is chosen randomly between
7688 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7689 intention is to avoid high load situations that appear when many values timeout
7690 at the same time. This is especially a problem shortly after the daemon starts,
7691 because all values were added to the internal cache at roughly the same time.
7695 =head2 Plugin C<sensors>
7697 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7698 that all the needed modules have to be loaded and lm_sensors has to be
7699 configured (most likely by editing F</etc/sensors.conf>. Read
7700 L<sensors.conf(5)> for details.
7702 The B<lm_sensors> homepage can be found at
7703 L<http://secure.netroedge.com/~lm78/>.
7707 =item B<SensorConfigFile> I<File>
7709 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7710 the library's default will be used.
7712 =item B<Sensor> I<chip-bus-address/type-feature>
7714 Selects the name of the sensor which you want to collect or ignore, depending
7715 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7716 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7717 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7719 See F</"IGNORELISTS"> for details.
7721 =item B<IgnoreSelected> I<true>|I<false>
7723 If no configuration if given, the B<sensors>-plugin will collect data from all
7724 sensors. This may not be practical, especially for uninteresting sensors.
7725 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7726 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7727 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7728 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7729 and all other sensors are collected.
7731 =item B<UseLabels> I<true>|I<false>
7733 Configures how sensor readings are reported. When set to I<true>, sensor
7734 readings are reported using their descriptive label (e.g. "VCore"). When set to
7735 I<false> (the default) the sensor name is used ("in0").
7739 =head2 Plugin C<sigrok>
7741 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7742 supported by the L<sigrok|http://sigrok.org/> project.
7748 <Device "AC Voltage">
7753 <Device "Sound Level">
7754 Driver "cem-dt-885x"
7761 =item B<LogLevel> B<0-5>
7763 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7764 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7765 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7766 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7767 their level, are always submitted to I<collectd> at its INFO log level.
7769 =item E<lt>B<Device> I<Name>E<gt>
7771 A sigrok-supported device, uniquely identified by this section's options. The
7772 I<Name> is passed to I<collectd> as the I<plugin instance>.
7774 =item B<Driver> I<DriverName>
7776 The sigrok driver to use for this device.
7778 =item B<Conn> I<ConnectionSpec>
7780 If the device cannot be auto-discovered, or more than one might be discovered
7781 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7782 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7783 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7784 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7785 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7787 =item B<SerialComm> I<SerialSpec>
7789 For serial devices with non-standard port settings, this option can be used
7790 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7791 This should not be necessary; drivers know how to communicate with devices they
7794 =item B<MinimumInterval> I<Seconds>
7796 Specifies the minimum time between measurement dispatches to I<collectd>, in
7797 seconds. Since some I<sigrok> supported devices can acquire measurements many
7798 times per second, it may be necessary to throttle these. For example, the
7799 I<RRD plugin> cannot process writes more than once per second.
7801 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7802 device are always dispatched to I<collectd>. When throttled, unused
7803 measurements are discarded.
7807 =head2 Plugin C<smart>
7809 The C<smart> plugin collects SMART information from physical
7810 disks. Values collectd include temperature, power cycle count, poweron
7811 time and bad sectors. Also, all SMART attributes are collected along
7812 with the normalized current value, the worst value, the threshold and
7813 a human readable value.
7815 Using the following two options you can ignore some disks or configure the
7816 collection only of specific disks.
7820 =item B<Disk> I<Name>
7822 Select the disk I<Name>. Whether it is collected or ignored depends on the
7823 B<IgnoreSelected> setting, see below. As with other plugins that use the
7824 daemon's ignorelist functionality, a string that starts and ends with a slash
7825 is interpreted as a regular expression. Examples:
7830 See F</"IGNORELISTS"> for details.
7832 =item B<IgnoreSelected> B<true>|B<false>
7834 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7835 statements, are ignored or if all other disks are ignored. The behavior
7836 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7837 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7838 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7839 is set to B<true>, all disks are collected B<except> the ones matched.
7841 =item B<IgnoreSleepMode> B<true>|B<false>
7843 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7844 This option disables the sleep mode check and allows the plugin to collect data
7845 from these disks anyway. This is useful in cases where libatasmart mistakenly
7846 reports disks as asleep because it has not been updated to incorporate support
7847 for newer idle states in the ATA spec.
7849 =item B<UseSerial> B<true>|B<false>
7851 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7852 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7853 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7854 storing data. This ensures that the data for a given disk will be kept together
7855 even if the kernel name changes.
7859 =head2 Plugin C<snmp>
7861 Since the configuration of the C<snmp plugin> is a little more complicated than
7862 other plugins, its documentation has been moved to an own manpage,
7863 L<collectd-snmp(5)>. Please see there for details.
7865 =head2 Plugin C<snmp_agent>
7867 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7868 from SNMP master agent and returns the data collected by read plugins.
7869 The I<snmp_agent> plugin handles requests only for OIDs specified in
7870 configuration file. To handle SNMP queries the plugin gets data from collectd
7871 and translates requested values from collectd's internal format to SNMP format.
7872 This plugin is a generic plugin and cannot work without configuration.
7873 For more details on AgentX subagent see
7874 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7879 <Data "memAvailReal">
7881 #PluginInstance "some"
7884 OIDs "1.3.6.1.4.1.2021.4.6.0"
7887 IndexOID "IF-MIB::ifIndex"
7888 SizeOID "IF-MIB::ifNumber"
7891 Source "PluginInstance"
7894 OIDs "IF-MIB::ifDescr"
7900 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7903 <Table "CPUAffinityTable">
7906 Source "PluginInstance"
7909 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
7914 Source "TypeInstance"
7915 Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
7918 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
7923 Source "TypeInstance"
7924 Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
7927 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
7929 <Data "CPUAffinity">
7932 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
7937 There are two types of blocks that can be contained in the
7938 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7940 =head3 B<Data> block
7942 The B<Data> block defines a list OIDs that are to be handled. This block can
7943 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7944 block it reperesents table OIDs.
7945 The following options can be set:
7949 =item B<IndexKey> block
7951 B<IndexKey> block contains all data needed for proper index build of snmp table.
7953 one table B<Data> block has B<IndexKey> block present then multiple key index is
7954 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
7959 =item B<Source> I<String>
7961 B<Source> can be set to one of the following values: "Hostname", "Plugin",
7962 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
7963 corresponding collectd metric is taken as a SNMP table index.
7965 =item B<Regex> I<String>
7967 B<Regex> option can also be used to parse strings or numbers out of
7968 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
7969 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
7972 =item B<Group> I<Number>
7974 B<Group> number can be specified in case groups are used in regex.
7978 =item B<Plugin> I<String>
7980 Read plugin name whose collected data will be mapped to specified OIDs.
7982 =item B<PluginInstance> I<String>
7984 Read plugin instance whose collected data will be mapped to specified OIDs.
7985 The field is optional and by default there is no plugin instance check.
7986 Allowed only if B<Data> block defines scalar data type.
7988 =item B<Type> I<String>
7990 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7991 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7993 =item B<TypeInstance> I<String>
7995 Collectd's type-instance that is to be used for specified OID.
7997 =item B<OIDs> I<OID> [I<OID> ...]
7999 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8000 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8001 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8002 configured should correspond to number of values in specified B<Type>.
8003 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8004 "rx" and "tx" values of "if_octets" type.
8006 =item B<Scale> I<Value>
8008 The values taken from collectd are multiplied by I<Value>. The field is optional
8009 and the default is B<1.0>.
8011 =item B<Shift> I<Value>
8013 I<Value> is added to values from collectd after they have been multiplied by
8014 B<Scale> value. The field is optional and the default value is B<0.0>.
8018 =head3 The B<Table> block
8020 The B<Table> block defines a collection of B<Data> blocks that belong to one
8021 snmp table. In addition to multiple B<Data> blocks the following options can be
8026 =item B<IndexOID> I<OID>
8028 OID that is handled by the plugin and is mapped to numerical index value that is
8029 generated by the plugin for each table record.
8031 =item B<SizeOID> I<OID>
8033 OID that is handled by the plugin. Returned value is the number of records in
8034 the table. The field is optional.
8038 =head2 Plugin C<statsd>
8040 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8041 protocol and dispatches rates or other aggregates of these numbers
8044 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8045 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8046 C<objects> respectively.
8048 The following configuration options are valid:
8052 =item B<Host> I<Host>
8054 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8055 "any" address, i.e. accept packets sent to any of the hosts addresses.
8057 =item B<Port> I<Port>
8059 UDP port to listen to. This can be either a service name or a port number.
8060 Defaults to C<8125>.
8062 =item B<DeleteCounters> B<false>|B<true>
8064 =item B<DeleteTimers> B<false>|B<true>
8066 =item B<DeleteGauges> B<false>|B<true>
8068 =item B<DeleteSets> B<false>|B<true>
8070 These options control what happens if metrics are not updated in an interval.
8071 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8072 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8073 are unchanged. If set to B<True>, the such metrics are not dispatched and
8074 removed from the internal cache.
8076 =item B<CounterSum> B<false>|B<true>
8078 When enabled, creates a C<count> metric which reports the change since the last
8079 read. This option primarily exists for compatibility with the I<statsd>
8080 implementation by Etsy.
8082 =item B<TimerPercentile> I<Percent>
8084 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8085 that I<Percent> of all reported timers are smaller than or equal to the
8086 computed latency. This is useful for cutting off the long tail latency, as it's
8087 often done in I<Service Level Agreements> (SLAs).
8089 Different percentiles can be calculated by setting this option several times.
8090 If none are specified, no percentiles are calculated / dispatched.
8092 =item B<TimerLower> B<false>|B<true>
8094 =item B<TimerUpper> B<false>|B<true>
8096 =item B<TimerSum> B<false>|B<true>
8098 =item B<TimerCount> B<false>|B<true>
8100 Calculate and dispatch various values out of I<Timer> metrics received during
8101 an interval. If set to B<False>, the default, these values aren't calculated /
8104 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8108 =head2 Plugin C<swap>
8110 The I<Swap plugin> collects information about used and available swap space. On
8111 I<Linux> and I<Solaris>, the following options are available:
8115 =item B<ReportByDevice> B<false>|B<true>
8117 Configures how to report physical swap devices. If set to B<false> (the
8118 default), the summary over all swap devices is reported only, i.e. the globally
8119 used and available space over all devices. If B<true> is configured, the used
8120 and available space of each device will be reported separately.
8122 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8123 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8125 =item B<ReportBytes> B<false>|B<true>
8127 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8128 I<swap I/O> is reported in pages. This option is available under Linux only.
8130 =item B<ValuesAbsolute> B<true>|B<false>
8132 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8133 available and used. Defaults to B<true>.
8135 =item B<ValuesPercentage> B<false>|B<true>
8137 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8138 available and free. Defaults to B<false>.
8140 This is useful for deploying I<collectd> in a heterogeneous environment, where
8141 swap sizes differ and you want to specify generic thresholds or similar.
8143 =item B<ReportIO> B<true>|B<false>
8145 Enables or disables reporting swap IO. Defaults to B<true>.
8147 This is useful for the cases when swap IO is not neccessary, is not available,
8152 =head2 Plugin C<syslog>
8156 =item B<LogLevel> B<debug|info|notice|warning|err>
8158 Sets the log-level. If, for example, set to B<notice>, then all events with
8159 severity B<notice>, B<warning>, or B<err> will be submitted to the
8162 Please note that B<debug> is only available if collectd has been compiled with
8165 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8167 Controls which notifications should be sent to syslog. The default behaviour is
8168 not to send any. Less severe notifications always imply logging more severe
8169 notifications: Setting this to B<OKAY> means all notifications will be sent to
8170 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8171 notifications but will dismiss B<OKAY> notifications. Setting this option to
8172 B<FAILURE> will only send failures to syslog.
8176 =head2 Plugin C<table>
8178 The C<table plugin> provides generic means to parse tabular data and dispatch
8179 user specified values. Values are selected based on column numbers. For
8180 example, this plugin may be used to get values from the Linux L<proc(5)>
8181 filesystem or CSV (comma separated values) files.
8184 <Table "/proc/slabinfo">
8190 InstancePrefix "active_objs"
8196 InstancePrefix "objperslab"
8203 The configuration consists of one or more B<Table> blocks, each of which
8204 configures one file to parse. Within each B<Table> block, there are one or
8205 more B<Result> blocks, which configure which data to select and how to
8208 The following options are available inside a B<Table> block:
8212 =item B<Plugin> I<Plugin>
8214 If specified, I<Plugin> is used as the plugin name when submitting values.
8215 Defaults to B<table>.
8217 =item B<Instance> I<instance>
8219 If specified, I<instance> is used as the plugin instance. If omitted, the
8220 filename of the table is used instead, with all special characters replaced
8221 with an underscore (C<_>).
8223 =item B<Separator> I<string>
8225 Any character of I<string> is interpreted as a delimiter between the different
8226 columns of the table. A sequence of two or more contiguous delimiters in the
8227 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8228 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8229 of a table - see its documentation for more details. This option is mandatory.
8231 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8232 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8233 required because of collectd's config parsing.
8237 The following options are available inside a B<Result> block:
8241 =item B<Type> I<type>
8243 Sets the type used to dispatch the values to the daemon. Detailed information
8244 about types and their configuration can be found in L<types.db(5)>. This
8245 option is mandatory.
8247 =item B<InstancePrefix> I<prefix>
8249 If specified, prepend I<prefix> to the type instance. If omitted, only the
8250 B<InstancesFrom> option is considered for the type instance.
8252 =item B<InstancesFrom> I<column0> [I<column1> ...]
8254 If specified, the content of the given columns (identified by the column
8255 number starting at zero) will be used to create the type instance for each
8256 row. Multiple values (and the instance prefix) will be joined together with
8257 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8258 option is considered for the type instance.
8260 The plugin itself does not check whether or not all built instances are
8261 different. It’s your responsibility to assure that each is unique. This is
8262 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8263 sure that the table only contains one row.
8265 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8268 =item B<ValuesFrom> I<column0> [I<column1> ...]
8270 Specifies the columns (identified by the column numbers starting at zero)
8271 whose content is used as the actual data for the data sets that are dispatched
8272 to the daemon. How many such columns you need is determined by the B<Type>
8273 setting above. If you specify too many or not enough columns, the plugin will
8274 complain about that and no data will be submitted to the daemon. The plugin
8275 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8276 respectively, so anything supported by those functions is supported by the
8277 plugin as well. This option is mandatory.
8281 =head2 Plugin C<tail>
8283 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8284 each line and dispatches found values. What is matched can be configured by the
8285 user using (extended) regular expressions, as described in L<regex(7)>.
8288 <File "/var/log/exim4/mainlog">
8293 Regex "S=([1-9][0-9]*)"
8299 Regex "\\<R=local_user\\>"
8300 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8303 Instance "local_user"
8306 Regex "l=([0-9]*\\.[0-9]*)"
8307 <DSType "Distribution">
8310 #BucketType "bucket"
8318 The config consists of one or more B<File> blocks, each of which configures one
8319 logfile to parse. Within each B<File> block, there are one or more B<Match>
8320 blocks, which configure a regular expression to search for.
8322 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8323 the plugin name and instance respectively. So in the above example the plugin name
8324 C<mail-exim> would be used.
8326 These options are applied for all B<Match> blocks that B<follow> it, until the
8327 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8328 instances from one logfile, handy when parsing syslog and the like.
8330 The B<Interval> option allows you to define the length of time between reads. If
8331 this is not set, the default Interval will be used.
8333 Each B<Match> block has the following options to describe how the match should
8338 =item B<Regex> I<regex>
8340 Sets the regular expression to use for matching against a line. The first
8341 subexpression has to match something that can be turned into a number by
8342 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8343 below. Because B<extended> regular expressions are used, you do not need to use
8344 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8345 collectd's config parsing you need to escape backslashes, though. So if you
8346 want to match literal parentheses you need to do the following:
8348 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8350 =item B<ExcludeRegex> I<regex>
8352 Sets an optional regular expression to use for excluding lines from the match.
8353 An example which excludes all connections from localhost from the match:
8355 ExcludeRegex "127\\.0\\.0\\.1"
8357 =item B<DSType> I<Type>
8359 Sets how the values are cumulated. I<Type> is one of:
8363 =item B<GaugeAverage>
8365 Calculate the average.
8369 Use the smallest number only.
8373 Use the greatest number only.
8377 Use the last number found.
8379 =item B<GaugePersist>
8381 Use the last number found. The number is not reset at the end of an interval.
8382 It is continously reported until another number is matched. This is intended
8383 for cases in which only state changes are reported, for example a thermometer
8384 that only reports the temperature when it changes.
8390 =item B<AbsoluteSet>
8392 The matched number is a counter. Simply I<sets> the internal counter to this
8393 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8401 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8402 matched number may be negative, which will effectively subtract from the
8411 Increase the internal counter by one. These B<DSType> are the only ones that do
8412 not use the matched subexpression, but simply count the number of matched
8413 lines. Thus, you may use a regular expression without submatch in this case.
8415 =item B<Distribution>
8417 Type to do calculations based on the distribution of values, primarily
8418 calculating percentiles. This is primarily geared towards latency, but can be
8419 used for other metrics as well. The range of values tracked with this setting
8420 must be in the range (0–2^34) and can be fractional. Please note that neither
8421 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8424 This option must be used together with the B<Percentile> and/or B<Bucket>
8429 <DSType "Distribution">
8437 =item B<Percentile> I<Percent>
8439 Calculate and dispatch the configured percentile, i.e. compute the value, so
8440 that I<Percent> of all matched values are smaller than or equal to the computed
8443 Metrics are reported with the I<type> B<Type> (the value of the above option)
8444 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8446 This option may be repeated to calculate more than one percentile.
8448 =item B<Bucket> I<lower_bound> I<upper_bound>
8450 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8451 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8452 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8453 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8454 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8457 To export the entire (0–inf) range without overlap, use the upper bound of the
8458 previous range as the lower bound of the following range. In other words, use
8459 the following schema:
8469 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8470 by default) and the I<type instance>
8471 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8473 This option may be repeated to calculate more than one rate.
8475 =item B<BucketType> I<Type>
8477 Sets the type used to dispatch B<Bucket> metrics.
8478 Optional, by default C<bucket> will be used.
8484 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8485 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8486 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8487 B<Derive*> types interpret the submatch as a signed integer using
8488 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8489 and it may be omitted in this case.
8491 =item B<Type> I<Type>
8493 Sets the type used to dispatch this value. Detailed information about types and
8494 their configuration can be found in L<types.db(5)>.
8496 =item B<Instance> I<TypeInstance>
8498 This optional setting sets the type instance to use.
8502 =head2 Plugin C<tail_csv>
8504 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8505 written by I<Snort>.
8510 <Metric "snort-dropped">
8515 <File "/var/log/snort/snort.stats">
8519 Collect "snort-dropped"
8524 The configuration consists of one or more B<Metric> blocks that define an index
8525 into the line of the CSV file and how this value is mapped to I<collectd's>
8526 internal representation. These are followed by one or more B<Instance> blocks
8527 which configure which file to read, in which interval and which metrics to
8532 =item E<lt>B<Metric> I<Name>E<gt>
8534 The B<Metric> block configures a new metric to be extracted from the statistics
8535 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8536 only used inside the B<Instance> blocks to refer to this block, so you can use
8537 one B<Metric> block for multiple CSV files.
8541 =item B<Type> I<Type>
8543 Configures which I<Type> to use when dispatching this metric. Types are defined
8544 in the L<types.db(5)> file, see the appropriate manual page for more
8545 information on specifying types. Only types with a single I<data source> are
8546 supported by the I<tail_csv plugin>. The information whether the value is an
8547 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8548 I<Type's> definition.
8550 =item B<Instance> I<TypeInstance>
8552 If set, I<TypeInstance> is used to populate the type instance field of the
8553 created value lists. Otherwise, no type instance is used.
8555 =item B<ValueFrom> I<Index>
8557 Configure to read the value from the field with the zero-based index I<Index>.
8558 If the value is parsed as signed integer, unsigned integer or double depends on
8559 the B<Type> setting, see above.
8563 =item E<lt>B<File> I<Path>E<gt>
8565 Each B<File> block represents one CSV file to read. There must be at least one
8566 I<File> block but there can be multiple if you have multiple CSV files.
8570 =item B<Plugin> I<Plugin>
8572 Use I<Plugin> as the plugin name when submitting values.
8573 Defaults to C<tail_csv>.
8575 =item B<Instance> I<PluginInstance>
8577 Sets the I<plugin instance> used when dispatching the values.
8579 =item B<Collect> I<Metric>
8581 Specifies which I<Metric> to collect. This option must be specified at least
8582 once, and you can use this option multiple times to specify more than one
8583 metric to be extracted from this statistic file.
8585 =item B<Interval> I<Seconds>
8587 Configures the interval in which to read values from this instance / file.
8588 Defaults to the plugin's default interval.
8590 =item B<TimeFrom> I<Index>
8592 Rather than using the local time when dispatching a value, read the timestamp
8593 from the field with the zero-based index I<Index>. The value is interpreted as
8594 seconds since epoch. The value is parsed as a double and may be factional.
8600 =head2 Plugin C<teamspeak2>
8602 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8603 polls interesting global and virtual server data. The plugin can query only one
8604 physical server but unlimited virtual servers. You can use the following
8605 options to configure it:
8609 =item B<Host> I<hostname/ip>
8611 The hostname or ip which identifies the physical server.
8614 =item B<Port> I<port>
8616 The query port of the physical server. This needs to be a string.
8619 =item B<Server> I<port>
8621 This option has to be added once for every virtual server the plugin should
8622 query. If you want to query the virtual server on port 8767 this is what the
8623 option would look like:
8627 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8628 use quotes around it! If no such statement is given only global information
8633 =head2 Plugin C<ted>
8635 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8636 measure power consumption. These devices are usually connected to a serial
8637 (RS232) or USB port. The plugin opens a configured device and tries to read the
8638 current energy readings. For more information on TED, visit
8639 L<http://www.theenergydetective.com/>.
8641 Available configuration options:
8645 =item B<Device> I<Path>
8647 Path to the device on which TED is connected. collectd will need read and write
8648 permissions on that file.
8650 Default: B</dev/ttyUSB0>
8652 =item B<Retries> I<Num>
8654 Apparently reading from TED is not that reliable. You can therefore configure a
8655 number of retries here. You only configure the I<retries> here, to if you
8656 specify zero, one reading will be performed (but no retries if that fails); if
8657 you specify three, a maximum of four readings are performed. Negative values
8664 =head2 Plugin C<tcpconns>
8666 The C<tcpconns plugin> counts the number of currently established TCP
8667 connections based on the local port and/or the remote port. Since there may be
8668 a lot of connections the default if to count all connections with a local port,
8669 for which a listening socket is opened. You can use the following options to
8670 fine-tune the ports you are interested in:
8674 =item B<ListeningPorts> I<true>|I<false>
8676 If this option is set to I<true>, statistics for all local ports for which a
8677 listening socket exists are collected. The default depends on B<LocalPort> and
8678 B<RemotePort> (see below): If no port at all is specifically selected, the
8679 default is to collect listening ports. If specific ports (no matter if local or
8680 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8681 the selected ports will be collected unless this option is set to I<true>
8684 =item B<LocalPort> I<Port>
8686 Count the connections to a specific local port. This can be used to see how
8687 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8688 You have to specify the port in numeric form, so for the mailserver example
8689 you'd need to set B<25>.
8691 =item B<RemotePort> I<Port>
8693 Count the connections to a specific remote port. This is useful to see how
8694 much a remote service is used. This is most useful if you want to know how many
8695 connections a local service has opened to remote services, e.E<nbsp>g. how many
8696 connections a mail server or news server has to other mail or news servers, or
8697 how many connections a web proxy holds to web servers. You have to give the
8698 port in numeric form.
8700 =item B<AllPortsSummary> I<true>|I<false>
8702 If this option is set to I<true> a summary of statistics from all connections
8703 are collected. This option defaults to I<false>.
8707 =head2 Plugin C<thermal>
8711 =item B<ForceUseProcfs> I<true>|I<false>
8713 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8714 C<sysfs> interface. If that is not available, the plugin falls back to the
8715 C<procfs> interface. By setting this option to I<true>, you can force the
8716 plugin to use the latter. This option defaults to I<false>.
8718 =item B<Device> I<Device>
8720 Selects the name of the thermal device that you want to collect or ignore,
8721 depending on the value of the B<IgnoreSelected> option. This option may be
8722 used multiple times to specify a list of devices.
8724 See F</"IGNORELISTS"> for details.
8726 =item B<IgnoreSelected> I<true>|I<false>
8728 Invert the selection: If set to true, all devices B<except> the ones that
8729 match the device names specified by the B<Device> option are collected. By
8730 default only selected devices are collected if a selection is made. If no
8731 selection is configured at all, B<all> devices are selected.
8735 =head2 Plugin C<threshold>
8737 The I<Threshold plugin> checks values collected or received by I<collectd>
8738 against a configurable I<threshold> and issues I<notifications> if values are
8741 Documentation for this plugin is available in the L<collectd-threshold(5)>
8744 =head2 Plugin C<tokyotyrant>
8746 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8747 couple metrics: number of records, and database size on disk.
8751 =item B<Host> I<Hostname/IP>
8753 The hostname or IP which identifies the server.
8754 Default: B<127.0.0.1>
8756 =item B<Port> I<Service/Port>
8758 The query port of the server. This needs to be a string, even if the port is
8759 given in its numeric form.
8764 =head2 Plugin C<turbostat>
8766 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8767 Intel processors by using I<Model Specific Registers>.
8771 =item B<CoreCstates> I<Bitmask(Integer)>
8773 Bit mask of the list of core C-states supported by the processor.
8774 This option should only be used if the automated detection fails.
8775 Default value extracted from the CPU model and family.
8777 Currently supported C-states (by this plugin): 3, 6, 7
8781 All states (3, 6 and 7):
8782 (1<<3) + (1<<6) + (1<<7) = 392
8784 =item B<PackageCstates> I<Bitmask(Integer)>
8786 Bit mask of the list of packages C-states supported by the processor. This
8787 option should only be used if the automated detection fails. Default value
8788 extracted from the CPU model and family.
8790 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8794 States 2, 3, 6 and 7:
8795 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8797 =item B<SystemManagementInterrupt> I<true>|I<false>
8799 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8800 This option should only be used if the automated detection fails or if you want
8801 to disable this feature.
8803 =item B<DigitalTemperatureSensor> I<true>|I<false>
8805 Boolean enabling the collection of the temperature of each core. This option
8806 should only be used if the automated detection fails or if you want to disable
8809 =item B<TCCActivationTemp> I<Temperature>
8811 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8812 temperature is used when collecting the temperature of cores or packages. This
8813 option should only be used if the automated detection fails. Default value
8814 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8816 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8818 Bit mask of the list of elements to be thermally monitored. This option should
8819 only be used if the automated detection fails or if you want to disable some
8820 collections. The different bits of this bit mask accepted by this plugin are:
8824 =item 0 ('1'): Package
8828 =item 2 ('4'): Cores
8830 =item 3 ('8'): Embedded graphic device
8834 =item B<LogicalCoreNames> I<true>|I<false>
8836 Boolean enabling the use of logical core numbering for per core statistics.
8837 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8838 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8839 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8840 more than one, where I<n> is the n-th core of package I<m>.
8844 =head2 Plugin C<unixsock>
8848 =item B<SocketFile> I<Path>
8850 Sets the socket-file which is to be created.
8852 =item B<SocketGroup> I<Group>
8854 If running as root change the group of the UNIX-socket after it has been
8855 created. Defaults to B<collectd>.
8857 =item B<SocketPerms> I<Permissions>
8859 Change the file permissions of the UNIX-socket after it has been created. The
8860 permissions must be given as a numeric, octal value as you would pass to
8861 L<chmod(1)>. Defaults to B<0770>.
8863 =item B<DeleteSocket> B<false>|B<true>
8865 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8866 with the given name already exists. If I<collectd> crashes a socket file may be
8867 left over, preventing the daemon from opening a new socket when restarted.
8868 Since this is potentially dangerous, this defaults to B<false>.
8872 =head2 Plugin C<uuid>
8874 This plugin, if loaded, causes the Hostname to be taken from the machine's
8875 UUID. The UUID is a universally unique designation for the machine, usually
8876 taken from the machine's BIOS. This is most useful if the machine is running in
8877 a virtual environment such as Xen, in which case the UUID is preserved across
8878 shutdowns and migration.
8880 The following methods are used to find the machine's UUID, in order:
8886 Check I</etc/uuid> (or I<UUIDFile>).
8890 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8895 Check for UUID from C<dmidecode> / SMBIOS.
8899 Check for UUID from Xen hypervisor.
8903 If no UUID can be found then the hostname is not modified.
8907 =item B<UUIDFile> I<Path>
8909 Take the UUID from the given file (default I</etc/uuid>).
8913 =head2 Plugin C<varnish>
8915 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8916 It collects a subset of the values displayed by L<varnishstat(1)>, and
8917 organizes them in categories which can be enabled or disabled. Currently only
8918 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8919 meaning of each metric can be found in L<varnish-counters(7)>.
8924 <Instance "example">
8928 CollectConnections true
8929 CollectDirectorDNS false
8933 CollectObjects false
8935 CollectSession false
8945 CollectWorkers false
8947 CollectMempool false
8948 CollectManagement false
8955 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8956 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8957 will collectd statistics from the default "varnishd" instance (this should work
8958 fine in most cases).
8960 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8964 =item B<CollectBackend> B<true>|B<false>
8966 Back-end connection statistics, such as successful, reused,
8967 and closed connections. True by default.
8969 =item B<CollectBan> B<true>|B<false>
8971 Statistics about ban operations, such as number of bans added, retired, and
8972 number of objects tested against ban operations. Only available with Varnish
8973 3.x and above. False by default.
8975 =item B<CollectCache> B<true>|B<false>
8977 Cache hits and misses. True by default.
8979 =item B<CollectConnections> B<true>|B<false>
8981 Number of client connections received, accepted and dropped. True by default.
8983 =item B<CollectDirectorDNS> B<true>|B<false>
8985 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8988 =item B<CollectESI> B<true>|B<false>
8990 Edge Side Includes (ESI) parse statistics. False by default.
8992 =item B<CollectFetch> B<true>|B<false>
8994 Statistics about fetches (HTTP requests sent to the backend). False by default.
8996 =item B<CollectHCB> B<true>|B<false>
8998 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8999 divided into locked and unlocked look-ups. False by default.
9001 =item B<CollectObjects> B<true>|B<false>
9003 Statistics on cached objects: number of objects expired, nuked (prematurely
9004 expired), saved, moved, etc. False by default.
9006 =item B<CollectPurge> B<true>|B<false>
9008 Statistics about purge operations, such as number of purges added, retired, and
9009 number of objects tested against purge operations. Only available with Varnish
9010 2.x. False by default.
9012 =item B<CollectSession> B<true>|B<false>
9014 Client session statistics. Number of past and current sessions, session herd and
9015 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9016 metrics found in the Connections and Threads sections with previous versions of
9017 Varnish have been moved here.
9019 =item B<CollectSHM> B<true>|B<false>
9021 Statistics about the shared memory log, a memory region to store
9022 log messages which is flushed to disk when full. True by default.
9024 =item B<CollectSMA> B<true>|B<false>
9026 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9027 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9028 only the one used by the Varnish instance. Only available with Varnish 2.x.
9031 =item B<CollectSMS> B<true>|B<false>
9033 synth (synthetic content) storage statistics. This storage
9034 component is used internally only. False by default.
9036 =item B<CollectSM> B<true>|B<false>
9038 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9039 in varnish 4.x. use CollectSMF.
9042 =item B<CollectStruct> B<true>|B<false>
9044 Current varnish internal state statistics. Number of current sessions, objects
9045 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9048 =item B<CollectTotals> B<true>|B<false>
9050 Collects overview counters, such as the number of sessions created,
9051 the number of requests and bytes transferred. False by default.
9053 =item B<CollectUptime> B<true>|B<false>
9055 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9057 =item B<CollectVCL> B<true>|B<false>
9059 Number of total (available + discarded) VCL (config files). False by default.
9061 =item B<CollectVSM> B<true>|B<false>
9063 Collect statistics about Varnish's shared memory usage (used by the logging and
9064 statistics subsystems). Only available with Varnish 4.x. False by default.
9066 =item B<CollectWorkers> B<true>|B<false>
9068 Collect statistics about worker threads. False by default.
9070 =item B<CollectVBE> B<true>|B<false>
9072 Backend counters. Only available with Varnish 4.x. False by default.
9074 =item B<CollectSMF> B<true>|B<false>
9076 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9077 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9078 instance. Used to be called SM in Varnish 2.x. False by default.
9080 =item B<CollectManagement> B<true>|B<false>
9082 Management process counters. Only available with Varnish 4.x. False by default.
9084 =item B<CollectLock> B<true>|B<false>
9086 Lock counters. Only available with Varnish 4.x. False by default.
9088 =item B<CollectMempool> B<true>|B<false>
9090 Memory pool counters. Only available with Varnish 4.x. False by default.
9092 =item B<CollectMSE> B<true>|B<false>
9094 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9095 Varnish, replacing the traditional malloc and file storages. Only available
9096 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9097 one used by the Varnish instance. False by default.
9101 =head2 Plugin C<virt>
9103 This plugin allows CPU, disk, network load and other metrics to be collected for
9104 virtualized guests on the machine. The statistics are collected through libvirt
9105 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9106 installing any additional software on guests, especially I<collectd>, which runs
9107 only on the host system.
9109 Only I<Connection> is required.
9113 =item B<Connection> I<uri>
9115 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9117 Connection "xen:///"
9119 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9121 =item B<RefreshInterval> I<seconds>
9123 Refresh the list of domains and devices every I<seconds>. The default is 60
9124 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9125 the list of domains and devices to be refreshed on every iteration.
9127 Refreshing the devices in particular is quite a costly operation, so if your
9128 virtualization setup is static you might consider increasing this. If this
9129 option is set to 0, refreshing is disabled completely.
9131 =item B<Domain> I<name>
9133 =item B<BlockDevice> I<name:dev>
9135 =item B<InterfaceDevice> I<name:dev>
9137 =item B<IgnoreSelected> B<true>|B<false>
9139 Select which domains and devices are collected.
9141 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9142 disk/network devices are collected.
9144 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9145 domains and disk/network devices are ignored, while the rest are collected.
9147 The domain name and device names may use a regular expression, if the name is
9148 surrounded by I</.../> and collectd was compiled with support for regexps.
9150 The default is to collect statistics for all domains and all their devices.
9154 BlockDevice "/:hdb/"
9155 IgnoreSelected "true"
9157 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9160 =item B<BlockDeviceFormat> B<target>|B<source>
9162 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9163 seen by the guest will be used for reporting metrics.
9164 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9167 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9168 using the path of the source, e.g. an image file.
9169 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9174 If the domain XML have the following device defined:
9176 <disk type='block' device='disk'>
9177 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9178 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9179 <target dev='sda' bus='scsi'/>
9181 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9184 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9186 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9187 to C<var_lib_libvirt_images_image1.qcow2>.
9189 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9191 The B<BlockDeviceFormatBasename> controls whether the full path or the
9192 L<basename(1)> of the source is being used as the I<type instance> when
9193 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9197 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9198 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9199 be set to C<var_lib_libvirt_images_image1.qcow2>.
9200 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9201 set to C<image1.qcow2>.
9203 =item B<HostnameFormat> B<name|uuid|hostname|...>
9205 When the virt plugin logs data, it sets the hostname of the collected data
9206 according to this setting. The default is to use the guest name as provided by
9207 the hypervisor, which is equal to setting B<name>.
9209 B<uuid> means use the guest's UUID. This is useful if you want to track the
9210 same guest across migrations.
9212 B<hostname> means to use the global B<Hostname> setting, which is probably not
9213 useful on its own because all guests will appear to have the same name.
9215 You can also specify combinations of these fields. For example B<name uuid>
9216 means to concatenate the guest name and UUID (with a literal colon character
9217 between, thus I<"foo:1234-1234-1234-1234">).
9219 At the moment of writing (collectd-5.5), hostname string is limited to 62
9220 characters. In case when combination of fields exceeds 62 characters,
9221 hostname will be truncated without a warning.
9223 =item B<InterfaceFormat> B<name>|B<address>
9225 When the virt plugin logs interface data, it sets the name of the collected
9226 data according to this setting. The default is to use the path as provided by
9227 the hypervisor (the "dev" property of the target node), which is equal to
9230 B<address> means use the interface's mac address. This is useful since the
9231 interface path might change between reboots of a guest or across migrations.
9233 =item B<PluginInstanceFormat> B<name|uuid|none>
9235 When the virt plugin logs data, it sets the plugin_instance of the collected
9236 data according to this setting. The default is to not set the plugin_instance.
9238 B<name> means use the guest's name as provided by the hypervisor.
9239 B<uuid> means use the guest's UUID.
9241 You can also specify combinations of the B<name> and B<uuid> fields.
9242 For example B<name uuid> means to concatenate the guest name and UUID
9243 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9245 =item B<Instances> B<integer>
9247 How many read instances you want to use for this plugin. The default is one,
9248 and the sensible setting is a multiple of the B<ReadThreads> value.
9249 If you are not sure, just use the default setting.
9251 =item B<ExtraStats> B<string>
9253 Report additional extra statistics. The default is no extra statistics, preserving
9254 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9255 allows the plugin to reported more detailed statistics about the behaviour of
9256 Virtual Machines. The argument is a space-separated list of selectors.
9258 Currently supported selectors are:
9262 =item B<cpu_util>: report CPU utilization per domain in percentage.
9264 =item B<disk>: report extra statistics like number of flush operations and total
9265 service time for read, write and flush operations. Requires libvirt API version
9268 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9271 =item B<domain_state>: report domain state and reason in human-readable format as
9272 a notification. If libvirt API version I<0.9.2> or later is available, domain
9273 reason will be included in notification.
9275 =item B<fs_info>: report file system information as a notification. Requires
9276 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9277 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9278 version supports retrieving file system information.
9280 =item B<job_stats_background>: report statistics about progress of a background
9281 job on a domain. Only one type of job statistics can be collected at the same time.
9282 Requires libvirt API version I<1.2.9> or later.
9284 =item B<job_stats_completed>: report statistics about a recently completed job on
9285 a domain. Only one type of job statistics can be collected at the same time.
9286 Requires libvirt API version I<1.2.9> or later.
9288 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9289 Requires libvirt API version I<0.9.11> or later.
9291 =item B<perf>: report performance monitoring events. To collect performance
9292 metrics they must be enabled for domain and supported by the platform. Requires
9293 libvirt API version I<1.3.3> or later.
9294 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9296 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9300 =item B<PersistentNotification> B<true>|B<false>
9301 Override default configuration to only send notifications when there is a change
9302 in the lifecycle state of a domain. When set to true notifications will be sent
9303 for every read cycle. Default is false. Does not affect the stats being
9308 =head2 Plugin C<vmem>
9310 The C<vmem> plugin collects information about the usage of virtual memory.
9311 Since the statistics provided by the Linux kernel are very detailed, they are
9312 collected very detailed. However, to get all the details, you have to switch
9313 them on manually. Most people just want an overview over, such as the number of
9314 pages read from swap space.
9318 =item B<Verbose> B<true>|B<false>
9320 Enables verbose collection of information. This will start collecting page
9321 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9322 Part of these statistics are collected on a "per zone" basis.
9326 =head2 Plugin C<vserver>
9328 This plugin doesn't have any options. B<VServer> support is only available for
9329 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9330 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9331 need to apply the patches and compile your own kernel, which will then provide
9332 the F</proc/virtual> filesystem that is required by this plugin.
9334 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9336 B<Note>: The traffic collected by this plugin accounts for the amount of
9337 traffic passing a socket which might be a lot less than the actual on-wire
9338 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9339 collect on-wire traffic you could, for example, use the logging facilities of
9340 iptables to feed data for the guest IPs into the iptables plugin.
9342 =head2 Plugin C<write_graphite>
9344 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9345 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9346 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9347 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9348 of at most 1428 bytes to minimize the number of network packets.
9352 <Plugin write_graphite>
9363 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9364 blocks. Inside the B<Node> blocks, the following options are recognized:
9368 =item B<Host> I<Address>
9370 Hostname or address to connect to. Defaults to C<localhost>.
9372 =item B<Port> I<Service>
9374 Service name or port number to connect to. Defaults to C<2003>.
9376 =item B<Protocol> I<String>
9378 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9380 =item B<ReconnectInterval> I<Seconds>
9382 When set to non-zero, forces the connection to the Graphite backend to be
9383 closed and re-opend periodically. This behavior is desirable in environments
9384 where the connection to the Graphite backend is done through load balancers,
9385 for example. When set to zero, the default, the connetion is kept open for as
9388 =item B<LogSendErrors> B<false>|B<true>
9390 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9391 If set to B<false>, it will not log the errors. This is especially useful when
9392 using Protocol UDP since many times we want to use the "fire-and-forget"
9393 approach and logging errors fills syslog with unneeded messages.
9395 =item B<Prefix> I<String>
9397 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9398 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9400 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9403 =item B<Postfix> I<String>
9405 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9406 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9407 (before the first ; that separates the name from the tags).
9409 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9412 =item B<EscapeCharacter> I<Char>
9414 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9415 in the identifier. The B<EscapeCharacter> option determines which character
9416 dots, whitespace and control characters are replaced with. Defaults to
9419 =item B<StoreRates> B<false>|B<true>
9421 If set to B<true> (the default), convert counter values to rates. If set to
9422 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9425 =item B<SeparateInstances> B<false>|B<true>
9427 If set to B<true>, the plugin instance and type instance will be in their own
9428 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9429 default), the plugin and plugin instance (and likewise the type and type
9430 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9432 Option value is not used when B<UseTags> is I<true>.
9434 =item B<AlwaysAppendDS> B<false>|B<true>
9436 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9437 identifier. If set to B<false> (the default), this is only done when there is
9440 =item B<PreserveSeparator> B<false>|B<true>
9442 If set to B<false> (the default) the C<.> (dot) character is replaced with
9443 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9444 is preserved, i.e. passed through.
9446 Option value is not used when B<UseTags> is I<true>.
9448 =item B<DropDuplicateFields> B<false>|B<true>
9450 If set to B<true>, detect and remove duplicate components in Graphite metric
9451 names. For example, the metric name C<host.load.load.shortterm> will
9452 be shortened to C<host.load.shortterm>.
9454 =item B<UseTags> B<false>|B<true>
9456 If set to B<true>, Graphite metric names will be generated as tagged series.
9457 This allows for much more flexibility than the traditional hierarchical layout.
9460 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9462 You can use B<Postfix> option to add more tags by specifying it like
9463 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9466 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9469 Default value: B<false>.
9473 =head2 Plugin C<write_log>
9475 The C<write_log> plugin writes metrics as INFO log messages.
9477 This plugin supports two output formats: I<Graphite> and I<JSON>.
9487 =item B<Format> I<Format>
9489 The output format to use. Can be one of C<Graphite> or C<JSON>.
9493 =head2 Plugin C<write_tsdb>
9495 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9496 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9497 state daemon that ingests metrics and stores them in HBase. The plugin uses
9498 I<TCP> over the "line based" protocol with a default port 4242. The data will
9499 be sent in blocks of at most 1428 bytes to minimize the number of network
9508 Host "tsd-1.my.domain"
9510 HostTags "status=production"
9514 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9515 blocks and global directives.
9517 Global directives are:
9521 =item B<ResolveInterval> I<seconds>
9523 =item B<ResolveJitter> I<seconds>
9525 When I<collectd> connects to a TSDB node, it will request the hostname from
9526 DNS. This can become a problem if the TSDB node is unavailable or badly
9527 configured because collectd will request DNS in order to reconnect for every
9528 metric, which can flood your DNS. So you can cache the last value for
9529 I<ResolveInterval> seconds.
9530 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9532 You can also define a jitter, a random interval to wait in addition to
9533 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9534 hostname at the same time when the connection fails.
9535 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9537 B<Note:> If the DNS resolution has already been successful when the socket
9538 closes, the plugin will try to reconnect immediately with the cached
9539 information. DNS is queried only when the socket is closed for a longer than
9540 I<ResolveInterval> + I<ResolveJitter> seconds.
9544 Inside the B<Node> blocks, the following options are recognized:
9548 =item B<Host> I<Address>
9550 Hostname or address to connect to. Defaults to C<localhost>.
9552 =item B<Port> I<Service>
9554 Service name or port number to connect to. Defaults to C<4242>.
9557 =item B<HostTags> I<String>
9559 When set, I<HostTags> is added to the end of the metric. It is intended to be
9560 used for name=value pairs that the TSD will tag the metric with. Dots and
9561 whitespace are I<not> escaped in this string.
9563 =item B<StoreRates> B<false>|B<true>
9565 If set to B<true>, convert counter values to rates. If set to B<false>
9566 (the default) counter values are stored as is, as an increasing
9569 =item B<AlwaysAppendDS> B<false>|B<true>
9571 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9572 identifier. If set to B<false> (the default), this is only done when there is
9577 =head2 Plugin C<write_mongodb>
9579 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9584 <Plugin "write_mongodb">
9593 The plugin can send values to multiple instances of I<MongoDB> by specifying
9594 one B<Node> block for each instance. Within the B<Node> blocks, the following
9595 options are available:
9599 =item B<Host> I<Address>
9601 Hostname or address to connect to. Defaults to C<localhost>.
9603 =item B<Port> I<Service>
9605 Service name or port number to connect to. Defaults to C<27017>.
9607 =item B<Timeout> I<Milliseconds>
9609 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9610 Setting this option to zero means no timeout, which is the default.
9612 =item B<StoreRates> B<false>|B<true>
9614 If set to B<true> (the default), convert counter values to rates. If set to
9615 B<false> counter values are stored as is, i.e. as an increasing integer
9618 =item B<Database> I<Database>
9620 =item B<User> I<User>
9622 =item B<Password> I<Password>
9624 Sets the information used when authenticating to a I<MongoDB> database. The
9625 fields are optional (in which case no authentication is attempted), but if you
9626 want to use authentication all three fields must be set.
9630 =head2 Plugin C<write_prometheus>
9632 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9633 using I<Prometheus>.
9639 =item B<Port> I<Port>
9641 Port the embedded webserver should listen on. Defaults to B<9103>.
9643 =item B<StalenessDelta> I<Seconds>
9645 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9646 hasn't seen any update for it. This value must match the setting in Prometheus.
9647 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9651 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9652 which time a metric without updates is considered "stale". This setting
9653 effectively puts an upper limit on the interval in which metrics are reported.
9655 When the I<write_prometheus plugin> encounters a metric with an interval
9656 exceeding this limit, it will inform you, the user, and provide the metric to
9657 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9658 metric "fresh" each time it is scraped, with the time of the scrape being
9659 considered the time of the update. The result is that there appear more
9660 datapoints in I<Prometheus> than were actually created, but at least the metric
9661 doesn't disappear periodically.
9665 =head2 Plugin C<write_http>
9667 This output plugin submits values to an HTTP server using POST requests and
9668 encoding metrics with JSON or using the C<PUTVAL> command described in
9669 L<collectd-unixsock(5)>.
9673 <Plugin "write_http">
9675 URL "http://example.com/post-collectd"
9682 The plugin can send values to multiple HTTP servers by specifying one
9683 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9684 block, the following options are available:
9690 URL to which the values are submitted to. Mandatory.
9692 =item B<User> I<Username>
9694 Optional user name needed for authentication.
9696 =item B<Password> I<Password>
9698 Optional password needed for authentication.
9700 =item B<VerifyPeer> B<true>|B<false>
9702 Enable or disable peer SSL certificate verification. See
9703 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9705 =item B<VerifyHost> B<true|false>
9707 Enable or disable peer host name verification. If enabled, the plugin checks if
9708 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9709 matches the host name provided by the B<URL> option. If this identity check
9710 fails, the connection is aborted. Obviously, only works when connecting to a
9711 SSL enabled server. Enabled by default.
9713 =item B<CACert> I<File>
9715 File that holds one or more SSL certificates. If you want to use HTTPS you will
9716 possibly need this option. What CA certificates come bundled with C<libcurl>
9717 and are checked by default depends on the distribution you use.
9719 =item B<CAPath> I<Directory>
9721 Directory holding one or more CA certificate files. You can use this if for
9722 some reason all the needed CA certificates aren't in the same file and can't be
9723 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9726 =item B<ClientKey> I<File>
9728 File that holds the private key in PEM format to be used for certificate-based
9731 =item B<ClientCert> I<File>
9733 File that holds the SSL certificate to be used for certificate-based
9736 =item B<ClientKeyPass> I<Password>
9738 Password required to load the private key in B<ClientKey>.
9740 =item B<Header> I<Header>
9742 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9744 Header "X-Custom-Header: custom_value"
9746 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9748 Define which SSL protocol version must be used. By default C<libcurl> will
9749 attempt to figure out the remote SSL protocol version. See
9750 L<curl_easy_setopt(3)> for more details.
9752 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9754 Format of the output to generate. If set to B<Command>, will create output that
9755 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9756 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9757 , will create output in the KairosDB format.
9759 Defaults to B<Command>.
9761 =item B<Attribute> I<String> I<String>
9763 Only available for the KAIROSDB output format.
9765 Consider the two given strings to be the key and value of an additional tag for
9766 each metric being sent out.
9768 You can add multiple B<Attribute>.
9772 Only available for the KAIROSDB output format.
9774 Sets the Cassandra ttl for the data points.
9776 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9778 =item B<Prefix> I<String>
9780 Only available for the KAIROSDB output format.
9782 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9784 =item B<Metrics> B<true>|B<false>
9786 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9788 =item B<Notifications> B<false>|B<true>
9790 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9792 =item B<StoreRates> B<true|false>
9794 If set to B<true>, convert counter values to rates. If set to B<false> (the
9795 default) counter values are stored as is, i.e. as an increasing integer number.
9797 =item B<BufferSize> I<Bytes>
9799 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9800 requests will be generated, but more metrics will be batched / metrics are
9801 cached for longer before being sent, introducing additional delay until they
9802 are available on the server side. I<Bytes> must be at least 1024 and cannot
9803 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9804 Defaults to C<4096>.
9806 =item B<LowSpeedLimit> I<Bytes per Second>
9808 Sets the minimal transfer rate in I<Bytes per Second> below which the
9809 connection with the HTTP server will be considered too slow and aborted. All
9810 the data submitted over this connection will probably be lost. Defaults to 0,
9811 which means no minimum transfer rate is enforced.
9813 =item B<Timeout> I<Timeout>
9815 Sets the maximum time in milliseconds given for HTTP POST operations to
9816 complete. When this limit is reached, the POST operation will be aborted, and
9817 all the data in the current send buffer will probably be lost. Defaults to 0,
9818 which means the connection never times out.
9820 =item B<LogHttpError> B<false>|B<true>
9822 Enables printing of HTTP error code to log. Turned off by default.
9824 The C<write_http> plugin regularly submits the collected values to the HTTP
9825 server. How frequently this happens depends on how much data you are collecting
9826 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9827 slightly below this interval, which you can estimate by monitoring the network
9828 traffic between collectd and the HTTP server.
9832 =head2 Plugin C<write_kafka>
9834 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9838 <Plugin "write_kafka">
9839 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9845 The following options are understood by the I<write_kafka plugin>:
9849 =item E<lt>B<Topic> I<Name>E<gt>
9851 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9852 is given a unique I<Name> and specifies one kafka producer.
9853 Inside the B<Topic> block, the following per-topic options are
9858 =item B<Property> I<String> I<String>
9860 Configure the named property for the current topic. Properties are
9861 forwarded to the kafka producer library B<librdkafka>.
9863 =item B<Key> I<String>
9865 Use the specified string as a partitioning key for the topic. Kafka breaks
9866 topic into partitions and guarantees that for a given topology, the same
9867 consumer will be used for a specific key. The special (case insensitive)
9868 string B<Random> can be used to specify that an arbitrary partition should
9871 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9873 Selects the format in which messages are sent to the broker. If set to
9874 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9875 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9877 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9878 an easy and straight forward exchange format.
9880 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9881 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9883 =item B<StoreRates> B<true>|B<false>
9885 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9886 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9887 default), no conversion is performed. Otherwise the conversion is performed
9888 using the internal value cache.
9890 Please note that currently this option is only used if the B<Format> option has
9891 been set to B<JSON>.
9893 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9895 A prefix can be added in the metric name when outputting in the I<Graphite>
9898 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
9900 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>>
9902 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
9904 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9906 A postfix can be added in the metric name when outputting in the I<Graphite>
9909 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
9911 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>>
9913 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
9914 name (before the first ; that separates the name from the tags).
9916 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9918 Specify a character to replace dots (.) in the host part of the metric name.
9919 In I<Graphite> metric name, dots are used as separators between different
9920 metric parts (host, plugin, type).
9921 Default is C<_> (I<Underscore>).
9923 =item B<GraphiteSeparateInstances> B<false>|B<true>
9925 If set to B<true>, the plugin instance and type instance will be in their own
9926 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9927 default), the plugin and plugin instance (and likewise the type and type
9928 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9930 Option value is not used when B<GraphiteUseTags> is I<true>.
9932 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9934 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9935 identifier. If set to B<false> (the default), this is only done when there is
9938 =item B<GraphitePreserveSeparator> B<false>|B<true>
9940 If set to B<false> (the default) the C<.> (dot) character is replaced with
9941 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9942 is preserved, i.e. passed through.
9944 Option value is not used when B<GraphiteUseTags> is I<true>.
9946 =item B<GraphiteUseTags> B<false>|B<true>
9948 If set to B<true> Graphite metric names will be generated as tagged series.
9950 Default value: B<false>.
9952 =item B<StoreRates> B<true>|B<false>
9954 If set to B<true> (the default), convert counter values to rates. If set to
9955 B<false> counter values are stored as is, i.e. as an increasing integer number.
9957 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9958 converted values will have "rate" appended to the data source type, e.g.
9959 C<ds_type:derive:rate>.
9963 =item B<Property> I<String> I<String>
9965 Configure the kafka producer through properties, you almost always will
9966 want to set B<metadata.broker.list> to your Kafka broker list.
9970 =head2 Plugin C<write_redis>
9972 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9976 <Plugin "write_redis">
9989 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9990 the timestamp as the score. Retrieving a date range can then be done using the
9991 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9992 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9993 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9994 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9995 with the B<Database> parameter (default is C<0>). See
9996 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9999 The information shown in the synopsis above is the I<default configuration>
10000 which is used by the plugin if no configuration is present.
10002 The plugin can send values to multiple instances of I<Redis> by specifying
10003 one B<Node> block for each instance. Within the B<Node> blocks, the following
10004 options are available:
10008 =item B<Node> I<Nodename>
10010 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10011 instance running on a specified host and port. The node name is a
10012 canonical identifier which is used as I<plugin instance>. It is limited to
10013 51E<nbsp>characters in length.
10015 =item B<Host> I<Hostname>
10017 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10020 =item B<Port> I<Port>
10022 The B<Port> option is the TCP port on which the Redis instance accepts
10023 connections. Either a service name of a port number may be given. Please note
10024 that numerical port numbers must be given as a string, too.
10026 =item B<Timeout> I<Milliseconds>
10028 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10030 =item B<Prefix> I<Prefix>
10032 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10033 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10034 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10035 is recommended but not required to include a trailing slash in I<Prefix>.
10037 =item B<Database> I<Index>
10039 This index selects the redis database to use for writing operations. Defaults
10042 =item B<MaxSetSize> I<Items>
10044 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10045 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10047 =item B<MaxSetDuration> I<Seconds>
10049 The B<MaxSetDuration> option limits the duration of items that the
10050 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10051 is the default behavior.
10053 =item B<StoreRates> B<true>|B<false>
10055 If set to B<true> (the default), convert counter values to rates. If set to
10056 B<false> counter values are stored as is, i.e. as an increasing integer number.
10060 =head2 Plugin C<write_riemann>
10062 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10063 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10064 I<Riemann> using UDP packets.
10068 <Plugin "write_riemann">
10074 AlwaysAppendDS false
10078 Attribute "foo" "bar"
10081 The following options are understood by the I<write_riemann plugin>:
10085 =item E<lt>B<Node> I<Name>E<gt>
10087 The plugin's configuration consists of one or more B<Node> blocks. Each block
10088 is given a unique I<Name> and specifies one connection to an instance of
10089 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10094 =item B<Host> I<Address>
10096 Hostname or address to connect to. Defaults to C<localhost>.
10098 =item B<Port> I<Service>
10100 Service name or port number to connect to. Defaults to C<5555>.
10102 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10104 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10107 =item B<TLSCertFile> I<Path>
10109 When using the B<TLS> protocol, path to a PEM certificate to present
10112 =item B<TLSCAFile> I<Path>
10114 When using the B<TLS> protocol, path to a PEM CA certificate to
10115 use to validate the remote hosts's identity.
10117 =item B<TLSKeyFile> I<Path>
10119 When using the B<TLS> protocol, path to a PEM private key associated
10120 with the certificate defined by B<TLSCertFile>.
10122 =item B<Batch> B<true>|B<false>
10124 If set to B<true> and B<Protocol> is set to B<TCP>,
10125 events will be batched in memory and flushed at
10126 regular intervals or when B<BatchMaxSize> is exceeded.
10128 Notifications are not batched and sent as soon as possible.
10130 When enabled, it can occur that events get processed by the Riemann server
10131 close to or after their expiration time. Tune the B<TTLFactor> and
10132 B<BatchMaxSize> settings according to the amount of values collected, if this
10137 =item B<BatchMaxSize> I<size>
10139 Maximum payload size for a riemann packet. Defaults to 8192
10141 =item B<BatchFlushTimeout> I<seconds>
10143 Maximum amount of seconds to wait in between to batch flushes.
10144 No timeout by default.
10146 =item B<StoreRates> B<true>|B<false>
10148 If set to B<true> (the default), convert counter values to rates. If set to
10149 B<false> counter values are stored as is, i.e. as an increasing integer number.
10151 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10152 converted values will have "rate" appended to the data source type, e.g.
10153 C<ds_type:derive:rate>.
10155 =item B<AlwaysAppendDS> B<false>|B<true>
10157 If set to B<true>, append the name of the I<Data Source> (DS) to the
10158 "service", i.e. the field that, together with the "host" field, uniquely
10159 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10160 only done when there is more than one DS.
10162 =item B<TTLFactor> I<Factor>
10164 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10165 event is considered active. I<collectd> populates this field based on the
10166 metrics interval setting. This setting controls the factor with which the
10167 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10168 know exactly what you're doing, you should only increase this setting from its
10171 =item B<Notifications> B<false>|B<true>
10173 If set to B<true>, create riemann events for notifications. This is B<true>
10174 by default. When processing thresholds from write_riemann, it might prove
10175 useful to avoid getting notification events.
10177 =item B<CheckThresholds> B<false>|B<true>
10179 If set to B<true>, attach state to events based on thresholds defined
10180 in the B<Threshold> plugin. Defaults to B<false>.
10182 =item B<EventServicePrefix> I<String>
10184 Add the given string as a prefix to the event service name.
10185 If B<EventServicePrefix> not set or set to an empty string (""),
10186 no prefix will be used.
10190 =item B<Tag> I<String>
10192 Add the given string as an additional tag to the metric being sent to
10195 =item B<Attribute> I<String> I<String>
10197 Consider the two given strings to be the key and value of an additional
10198 attribute for each metric being sent out to I<Riemann>.
10202 =head2 Plugin C<write_sensu>
10204 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10205 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10206 a local I<Sensu> client using a TCP socket.
10208 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10209 parameter so it is not possible to use one collectd instance as a gateway for
10210 others. Each collectd host must pair with one I<Sensu> client.
10214 <Plugin "write_sensu">
10219 AlwaysAppendDS false
10220 MetricHandler "influx"
10221 MetricHandler "default"
10222 NotificationHandler "flapjack"
10223 NotificationHandler "howling_monkey"
10227 Attribute "foo" "bar"
10230 The following options are understood by the I<write_sensu plugin>:
10234 =item E<lt>B<Node> I<Name>E<gt>
10236 The plugin's configuration consists of one or more B<Node> blocks. Each block
10237 is given a unique I<Name> and specifies one connection to an instance of
10238 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10243 =item B<Host> I<Address>
10245 Hostname or address to connect to. Defaults to C<localhost>.
10247 =item B<Port> I<Service>
10249 Service name or port number to connect to. Defaults to C<3030>.
10251 =item B<StoreRates> B<true>|B<false>
10253 If set to B<true> (the default), convert counter values to rates. If set to
10254 B<false> counter values are stored as is, i.e. as an increasing integer number.
10256 This will be reflected in the C<collectd_data_source_type> tag: If
10257 B<StoreRates> is enabled, converted values will have "rate" appended to the
10258 data source type, e.g. C<collectd_data_source_type:derive:rate>.
10260 =item B<AlwaysAppendDS> B<false>|B<true>
10262 If set the B<true>, append the name of the I<Data Source> (DS) to the
10263 "service", i.e. the field that, together with the "host" field, uniquely
10264 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10265 only done when there is more than one DS.
10267 =item B<Notifications> B<false>|B<true>
10269 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10270 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10272 =item B<Metrics> B<false>|B<true>
10274 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10275 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10278 =item B<Separator> I<String>
10280 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10282 =item B<MetricHandler> I<String>
10284 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10285 several of them, one per line. Defaults to no handler.
10287 =item B<NotificationHandler> I<String>
10289 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10290 add several of them, one per line. Defaults to no handler.
10292 =item B<EventServicePrefix> I<String>
10294 Add the given string as a prefix to the event service name.
10295 If B<EventServicePrefix> not set or set to an empty string (""),
10296 no prefix will be used.
10300 =item B<Tag> I<String>
10302 Add the given string as an additional tag to the metric being sent to
10305 =item B<Attribute> I<String> I<String>
10307 Consider the two given strings to be the key and value of an additional
10308 attribute for each metric being sent out to I<Sensu>.
10312 =head2 Plugin C<xencpu>
10314 This plugin collects metrics of hardware CPU load for machine running Xen
10315 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10316 Result is reported using the C<percent> type, for each CPU (core).
10318 This plugin doesn't have any options (yet).
10320 =head2 Plugin C<zookeeper>
10322 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10323 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
10328 <Plugin "zookeeper">
10335 =item B<Host> I<Address>
10337 Hostname or address to connect to. Defaults to C<localhost>.
10339 =item B<Port> I<Service>
10341 Service name or port number to connect to. Defaults to C<2181>.
10345 =head1 THRESHOLD CONFIGURATION
10347 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
10348 we mean that the values are not only stored or sent somewhere, but that they
10349 are judged and, if a problem is recognized, acted upon. The only action
10350 collectd takes itself is to generate and dispatch a "notification". Plugins can
10351 register to receive notifications and perform appropriate further actions.
10353 Since systems and what you expect them to do differ a lot, you can configure
10354 B<thresholds> for your values freely. This gives you a lot of flexibility but
10355 also a lot of responsibility.
10357 Every time a value is out of range a notification is dispatched. This means
10358 that the idle percentage of your CPU needs to be less then the configured
10359 threshold only once for a notification to be generated. There's no such thing
10360 as a moving average or similar - at least not now.
10362 Also, all values that match a threshold are considered to be relevant or
10363 "interesting". As a consequence collectd will issue a notification if they are
10364 not received for B<Timeout> iterations. The B<Timeout> configuration option is
10365 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
10366 "2" (the default) and some hosts sends it's CPU statistics to the server every
10367 60 seconds, a notification will be dispatched after about 120 seconds. It may
10368 take a little longer because the timeout is checked only once each B<Interval>
10371 When a value comes within range again or is received after it was missing, an
10372 "OKAY-notification" is dispatched.
10374 Here is a configuration example to get you started. Read below for more
10387 <Plugin "interface">
10390 FailureMax 10000000
10404 WarningMin 100000000
10410 There are basically two types of configuration statements: The C<Host>,
10411 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10412 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10413 C<Instance> option. You can combine the block by nesting the blocks, though
10414 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10415 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10416 C<Type> may not contain other blocks. If multiple blocks apply to the same
10417 value the most specific block is used.
10419 The other statements specify the threshold to configure. They B<must> be
10420 included in a C<Type> block. Currently the following statements are recognized:
10424 =item B<FailureMax> I<Value>
10426 =item B<WarningMax> I<Value>
10428 Sets the upper bound of acceptable values. If unset defaults to positive
10429 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10430 will be created. If the value is greater than B<WarningMax> but less than (or
10431 equal to) B<FailureMax> a B<WARNING> notification will be created.
10433 =item B<FailureMin> I<Value>
10435 =item B<WarningMin> I<Value>
10437 Sets the lower bound of acceptable values. If unset defaults to negative
10438 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10439 be created. If the value is less than B<WarningMin> but greater than (or equal
10440 to) B<FailureMin> a B<WARNING> notification will be created.
10442 =item B<DataSource> I<DSName>
10444 Some data sets have more than one "data source". Interesting examples are the
10445 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10446 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10447 system load data set, C<load>, even has three data sources: C<shortterm>,
10448 C<midterm>, and C<longterm>.
10450 Normally, all data sources are checked against a configured threshold. If this
10451 is undesirable, or if you want to specify different limits for each data
10452 source, you can use the B<DataSource> option to have a threshold apply only to
10455 =item B<Invert> B<true>|B<false>
10457 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10458 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10459 B<WarningMax>) are not okay. Defaults to B<false>.
10461 =item B<Persist> B<true>|B<false>
10463 Sets how often notifications are generated. If set to B<true> one notification
10464 will be generated for each value that is out of the acceptable range. If set to
10465 B<false> (the default) then a notification is only generated if a value is out
10466 of range but the previous value was okay.
10468 This applies to missing values, too: If set to B<true> a notification about a
10469 missing value is generated once every B<Interval> seconds. If set to B<false>
10470 only one such notification is generated until the value appears again.
10472 =item B<Percentage> B<true>|B<false>
10474 If set to B<true>, the minimum and maximum values given are interpreted as
10475 percentage value, relative to the other data sources. This is helpful for
10476 example for the "df" type, where you may want to issue a warning when less than
10477 5E<nbsp>% of the total space is available. Defaults to B<false>.
10479 =item B<Hits> I<Number>
10481 Delay creating the notification until the threshold has been passed I<Number>
10482 times. When a notification has been generated, or when a subsequent value is
10483 inside the threshold, the counter is reset. If, for example, a value is
10484 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10485 will be dispatched at most once every 30E<nbsp>seconds.
10487 This is useful when short bursts are not a problem. If, for example, 100% CPU
10488 usage for up to a minute is normal (and data is collected every
10489 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10491 =item B<Hysteresis> I<Number>
10493 When set to non-zero, a hysteresis value is applied when checking minimum and
10494 maximum bounds. This is useful for values that increase slowly and fluctuate a
10495 bit while doing so. When these values come close to the threshold, they may
10496 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10498 If, for example, the threshold is configures as
10503 then a I<Warning> notification is created when the value exceeds I<101> and the
10504 corresponding I<Okay> notification is only created once the value falls below
10505 I<99>, thus avoiding the "flapping".
10509 =head1 FILTER CONFIGURATION
10511 Starting with collectd 4.6 there is a powerful filtering infrastructure
10512 implemented in the daemon. The concept has mostly been copied from
10513 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10514 terminology, so that users that are familiar with iptables feel right at home.
10518 The following are the terms used in the remainder of the filter configuration
10519 documentation. For an ASCII-art schema of the mechanism, see
10520 L<"General structure"> below.
10526 A I<match> is a criteria to select specific values. Examples are, of course, the
10527 name of the value or it's current value.
10529 Matches are implemented in plugins which you have to load prior to using the
10530 match. The name of such plugins starts with the "match_" prefix.
10534 A I<target> is some action that is to be performed with data. Such actions
10535 could, for example, be to change part of the value's identifier or to ignore
10536 the value completely.
10538 Some of these targets are built into the daemon, see L<"Built-in targets">
10539 below. Other targets are implemented in plugins which you have to load prior to
10540 using the target. The name of such plugins starts with the "target_" prefix.
10544 The combination of any number of matches and at least one target is called a
10545 I<rule>. The target actions will be performed for all values for which B<all>
10546 matches apply. If the rule does not have any matches associated with it, the
10547 target action will be performed for all values.
10551 A I<chain> is a list of rules and possibly default targets. The rules are tried
10552 in order and if one matches, the associated target will be called. If a value
10553 is handled by a rule, it depends on the target whether or not any subsequent
10554 rules are considered or if traversal of the chain is aborted, see
10555 L<"Flow control"> below. After all rules have been checked, the default targets
10560 =head2 General structure
10562 The following shows the resulting structure:
10569 +---------+ +---------+ +---------+ +---------+
10570 ! Rule !->! Match !->! Match !->! Target !
10571 +---------+ +---------+ +---------+ +---------+
10574 +---------+ +---------+ +---------+
10575 ! Rule !->! Target !->! Target !
10576 +---------+ +---------+ +---------+
10583 +---------+ +---------+ +---------+
10584 ! Rule !->! Match !->! Target !
10585 +---------+ +---------+ +---------+
10593 =head2 Flow control
10595 There are four ways to control which way a value takes through the filter
10602 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10603 process the value with another chain. When the called chain finishes, usually
10604 the next target or rule after the jump is executed.
10608 The stop condition, signaled for example by the built-in target B<stop>, causes
10609 all processing of the value to be stopped immediately.
10613 Causes processing in the current chain to be aborted, but processing of the
10614 value generally will continue. This means that if the chain was called via
10615 B<Jump>, the next target or rule after the jump will be executed. If the chain
10616 was not called by another chain, control will be returned to the daemon and it
10617 may pass the value to another chain.
10621 Most targets will signal the B<continue> condition, meaning that processing
10622 should continue normally. There is no special built-in target for this
10629 The configuration reflects this structure directly:
10631 PostCacheChain "PostCache"
10632 <Chain "PostCache">
10633 <Rule "ignore_mysql_show">
10636 Type "^mysql_command$"
10637 TypeInstance "^show_"
10647 The above configuration example will ignore all values where the plugin field
10648 is "mysql", the type is "mysql_command" and the type instance begins with
10649 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10650 default target of the chain. Since this chain is run after the value has been
10651 added to the cache, the MySQL C<show_*> command statistics will be available
10652 via the C<unixsock> plugin.
10654 =head2 List of configuration options
10658 =item B<PreCacheChain> I<ChainName>
10660 =item B<PostCacheChain> I<ChainName>
10662 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10663 argument is the name of a I<chain> that should be executed before and/or after
10664 the values have been added to the cache.
10666 To understand the implications, it's important you know what is going on inside
10667 I<collectd>. The following diagram shows how values are passed from the
10668 read-plugins to the write-plugins:
10674 + - - - - V - - - - +
10675 : +---------------+ :
10678 : +-------+-------+ :
10681 : +-------+-------+ : +---------------+
10682 : ! Cache !--->! Value Cache !
10683 : ! insert ! : +---+---+-------+
10684 : +-------+-------+ : ! !
10685 : ! ,------------' !
10687 : +-------+---+---+ : +-------+-------+
10688 : ! Post-Cache +--->! Write-Plugins !
10689 : ! Chain ! : +---------------+
10690 : +---------------+ :
10692 : dispatch values :
10693 + - - - - - - - - - +
10695 After the values are passed from the "read" plugins to the dispatch functions,
10696 the pre-cache chain is run first. The values are added to the internal cache
10697 afterwards. The post-cache chain is run after the values have been added to the
10698 cache. So why is it such a huge deal if chains are run before or after the
10699 values have been added to this cache?
10701 Targets that change the identifier of a value list should be executed before
10702 the values are added to the cache, so that the name in the cache matches the
10703 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10704 this cache to receive a list of all available values. If you change the
10705 identifier after the value list has been added to the cache, this may easily
10706 lead to confusion, but it's not forbidden of course.
10708 The cache is also used to convert counter values to rates. These rates are, for
10709 example, used by the C<value> match (see below). If you use the rate stored in
10710 the cache B<before> the new value is added, you will use the old, B<previous>
10711 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10712 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10715 Last but not last, the B<stop> target makes a difference: If the pre-cache
10716 chain returns the stop condition, the value will not be added to the cache and
10717 the post-cache chain will not be run.
10719 =item B<Chain> I<Name>
10721 Adds a new chain with a certain name. This name can be used to refer to a
10722 specific chain, for example to jump to it.
10724 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10726 =item B<Rule> [I<Name>]
10728 Adds a new rule to the current chain. The name of the rule is optional and
10729 currently has no meaning for the daemon.
10731 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10732 must be at least one B<Target> block.
10734 =item B<Match> I<Name>
10736 Adds a match to a B<Rule> block. The name specifies what kind of match should
10737 be performed. Available matches depend on the plugins that have been loaded.
10739 The arguments inside the B<Match> block are passed to the plugin implementing
10740 the match, so which arguments are valid here depends on the plugin being used.
10741 If you do not need any to pass any arguments to a match, you can use the
10746 Which is equivalent to:
10751 =item B<Target> I<Name>
10753 Add a target to a rule or a default target to a chain. The name specifies what
10754 kind of target is to be added. Which targets are available depends on the
10755 plugins being loaded.
10757 The arguments inside the B<Target> block are passed to the plugin implementing
10758 the target, so which arguments are valid here depends on the plugin being used.
10759 If you do not need any to pass any arguments to a target, you can use the
10764 This is the same as writing:
10771 =head2 Built-in targets
10773 The following targets are built into the core daemon and therefore need no
10774 plugins to be loaded:
10780 Signals the "return" condition, see the L<"Flow control"> section above. This
10781 causes the current chain to stop processing the value and returns control to
10782 the calling chain. The calling chain will continue processing targets and rules
10783 just after the B<jump> target (see below). This is very similar to the
10784 B<RETURN> target of iptables, see L<iptables(8)>.
10786 This target does not have any options.
10794 Signals the "stop" condition, see the L<"Flow control"> section above. This
10795 causes processing of the value to be aborted immediately. This is similar to
10796 the B<DROP> target of iptables, see L<iptables(8)>.
10798 This target does not have any options.
10806 Sends the value to "write" plugins.
10812 =item B<Plugin> I<Name>
10814 Name of the write plugin to which the data should be sent. This option may be
10815 given multiple times to send the data to more than one write plugin. If the
10816 plugin supports multiple instances, the plugin's instance(s) must also be
10821 If no plugin is explicitly specified, the values will be sent to all available
10824 Single-instance plugin example:
10830 Multi-instance plugin example:
10832 <Plugin "write_graphite">
10842 Plugin "write_graphite/foo"
10847 Starts processing the rules of another chain, see L<"Flow control"> above. If
10848 the end of that chain is reached, or a stop condition is encountered,
10849 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10850 next target or the next rule. This is similar to the B<-j> command line option
10851 of iptables, see L<iptables(8)>.
10857 =item B<Chain> I<Name>
10859 Jumps to the chain I<Name>. This argument is required and may appear only once.
10871 =head2 Available matches
10877 Matches a value using regular expressions.
10883 =item B<Host> I<Regex>
10885 =item B<Plugin> I<Regex>
10887 =item B<PluginInstance> I<Regex>
10889 =item B<Type> I<Regex>
10891 =item B<TypeInstance> I<Regex>
10893 =item B<MetaData> I<String> I<Regex>
10895 Match values where the given regular expressions match the various fields of
10896 the identifier of a value. If multiple regular expressions are given, B<all>
10897 regexen must match for a value to match.
10899 =item B<Invert> B<false>|B<true>
10901 When set to B<true>, the result of the match is inverted, i.e. all value lists
10902 where all regular expressions apply are not matched, all other value lists are
10903 matched. Defaults to B<false>.
10910 Host "customer[0-9]+"
10916 Matches values that have a time which differs from the time on the server.
10918 This match is mainly intended for servers that receive values over the
10919 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10920 is very sensitive to the timestamp used when updating the RRD files. In
10921 particular, the time must be ever increasing. If a misbehaving client sends one
10922 packet with a timestamp far in the future, all further packets with a correct
10923 time will be ignored because of that one packet. What's worse, such corrupted
10924 RRD files are hard to fix.
10926 This match lets one match all values B<outside> a specified time range
10927 (relative to the server's time), so you can use the B<stop> target (see below)
10928 to ignore the value, for example.
10934 =item B<Future> I<Seconds>
10936 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10937 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10940 =item B<Past> I<Seconds>
10942 Matches all values that are I<behind> of the server's time by I<Seconds> or
10943 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10955 This example matches all values that are five minutes or more ahead of the
10956 server or one hour (or more) lagging behind.
10960 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10961 values. If a data-set consists of more than one data-source, all data-sources
10962 must match the specified ranges for a positive match.
10968 =item B<Min> I<Value>
10970 Sets the smallest value which still results in a match. If unset, behaves like
10973 =item B<Max> I<Value>
10975 Sets the largest value which still results in a match. If unset, behaves like
10978 =item B<Invert> B<true>|B<false>
10980 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10981 no-match is returned and vice versa. Please note that the B<Invert> setting
10982 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10983 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10985 =item B<DataSource> I<DSName> [I<DSName> ...]
10987 Select one or more of the data sources. If no data source is configured, all
10988 data sources will be checked. If the type handled by the match does not have a
10989 data source of the specified name(s), this will always result in no match
10990 (independent of the B<Invert> setting).
10992 =item B<Satisfy> B<Any>|B<All>
10994 Specifies how checking with several data sources is performed. If set to
10995 B<Any>, the match succeeds if one of the data sources is in the configured
10996 range. If set to B<All> the match only succeeds if all data sources are within
10997 the configured range. Default is B<All>.
10999 Usually B<All> is used for positive matches, B<Any> is used for negative
11000 matches. This means that with B<All> you usually check that all values are in a
11001 "good" range, while with B<Any> you check if any value is within a "bad" range
11002 (or outside the "good" range).
11006 Either B<Min> or B<Max>, but not both, may be unset.
11010 # Match all values smaller than or equal to 100. Matches only if all data
11011 # sources are below 100.
11017 # Match if the value of any data source is outside the range of 0 - 100.
11025 =item B<empty_counter>
11027 Matches all values with one or more data sources of type B<COUNTER> and where
11028 all counter values are zero. These counters usually I<never> increased since
11029 they started existing (and are therefore uninteresting), or got reset recently
11030 or overflowed and you had really, I<really> bad luck.
11032 Please keep in mind that ignoring such counters can result in confusing
11033 behavior: Counters which hardly ever increase will be zero for long periods of
11034 time. If the counter is reset for some reason (machine or service restarted,
11035 usually), the graph will be empty (NAN) for a long time. People may not
11040 Calculates a hash value of the host name and matches values according to that
11041 hash value. This makes it possible to divide all hosts into groups and match
11042 only values that are in a specific group. The intended use is in load
11043 balancing, where you want to handle only part of all data and leave the rest
11046 The hashing function used tries to distribute the hosts evenly. First, it
11047 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11050 for (i = 0; host[i] != 0; i++)
11051 hash_value = (hash_value * 251) + host[i];
11053 The constant 251 is a prime number which is supposed to make this hash value
11054 more random. The code then checks the group for this host according to the
11055 I<Total> and I<Match> arguments:
11057 if ((hash_value % Total) == Match)
11062 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11063 groups), then the least significant bit of the hash value will be the XOR of
11064 all least significant bits in the host name. One consequence is that when you
11065 have two hosts, "server0.example.com" and "server1.example.com", where the host
11066 name differs in one digit only and the digits differ by one, those hosts will
11067 never end up in the same group.
11073 =item B<Match> I<Match> I<Total>
11075 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11076 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11077 be smaller than I<Total>. I<Total> must be at least one, although only values
11078 greater than one really do make any sense.
11080 You can repeat this option to match multiple groups, for example:
11085 The above config will divide the data into seven groups and match groups three
11086 and five. One use would be to keep every value on two hosts so that if one
11087 fails the missing data can later be reconstructed from the second host.
11093 # Operate on the pre-cache chain, so that ignored values are not even in the
11098 # Divide all received hosts in seven groups and accept all hosts in
11102 # If matched: Return and continue.
11105 # If not matched: Return and stop.
11111 =head2 Available targets
11115 =item B<notification>
11117 Creates and dispatches a notification.
11123 =item B<Message> I<String>
11125 This required option sets the message of the notification. The following
11126 placeholders will be replaced by an appropriate value:
11134 =item B<%{plugin_instance}>
11138 =item B<%{type_instance}>
11140 These placeholders are replaced by the identifier field of the same name.
11142 =item B<%{ds:>I<name>B<}>
11144 These placeholders are replaced by a (hopefully) human readable representation
11145 of the current rate of this data source. If you changed the instance name
11146 (using the B<set> or B<replace> targets, see below), it may not be possible to
11147 convert counter values to rates.
11151 Please note that these placeholders are B<case sensitive>!
11153 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11155 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11162 <Target "notification">
11163 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11169 Replaces parts of the identifier using regular expressions.
11175 =item B<Host> I<Regex> I<Replacement>
11177 =item B<Plugin> I<Regex> I<Replacement>
11179 =item B<PluginInstance> I<Regex> I<Replacement>
11181 =item B<TypeInstance> I<Regex> I<Replacement>
11183 =item B<MetaData> I<String> I<Regex> I<Replacement>
11185 =item B<DeleteMetaData> I<String> I<Regex>
11187 Match the appropriate field with the given regular expression I<Regex>. If the
11188 regular expression matches, that part that matches is replaced with
11189 I<Replacement>. If multiple places of the input buffer match a given regular
11190 expression, only the first occurrence will be replaced.
11192 You can specify each option multiple times to use multiple regular expressions
11200 # Replace "example.net" with "example.com"
11201 Host "\\<example.net\\>" "example.com"
11203 # Strip "www." from hostnames
11204 Host "\\<www\\." ""
11209 Sets part of the identifier of a value to a given string.
11215 =item B<Host> I<String>
11217 =item B<Plugin> I<String>
11219 =item B<PluginInstance> I<String>
11221 =item B<TypeInstance> I<String>
11223 =item B<MetaData> I<String> I<String>
11225 Set the appropriate field to the given string. The strings for plugin instance,
11226 type instance, and meta data may be empty, the strings for host and plugin may
11227 not be empty. It's currently not possible to set the type of a value this way.
11229 The following placeholders will be replaced by an appropriate value:
11237 =item B<%{plugin_instance}>
11241 =item B<%{type_instance}>
11243 These placeholders are replaced by the identifier field of the same name.
11245 =item B<%{meta:>I<name>B<}>
11247 These placeholders are replaced by the meta data value with the given name.
11251 Please note that these placeholders are B<case sensitive>!
11253 =item B<DeleteMetaData> I<String>
11255 Delete the named meta data field.
11262 PluginInstance "coretemp"
11263 TypeInstance "core3"
11268 =head2 Backwards compatibility
11270 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11271 B<Chain> block, it will behave as it used to. This is equivalent to the
11272 following configuration:
11274 <Chain "PostCache">
11278 If you specify a B<PostCacheChain>, the B<write> target will not be added
11279 anywhere and you will have to make sure that it is called where appropriate. We
11280 suggest to add the above snippet as default target to your "PostCache" chain.
11284 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11299 B<Ignorelists> are a generic framework to either ignore some metrics or report
11300 specific metircs only. Plugins usually provide one or more options to specify
11301 the items (mounts points, devices, ...) and the boolean option
11306 =item B<Select> I<String>
11308 Selects the item I<String>. This option often has a plugin specific name, e.g.
11309 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11310 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11311 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11313 By default, this option is doing a case-sensitive full-string match. The
11314 following config will match C<foo>, but not C<Foo>:
11318 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11319 I<regular expression>. For example, so match all item starting with C<foo>, use
11320 could use the following syntax:
11324 The regular expression is I<not> anchored, i.e. the following config will match
11325 C<foobar>, C<barfoo> and C<AfooZ>:
11329 The B<Select> option may be repeated to select multiple items.
11331 =item B<IgnoreSelected> B<true>|B<false>
11333 If set to B<true>, matching metrics are I<ignored> and all other metrics are
11334 collected. If set to B<false>, matching metrics are I<collected> and all other
11335 metrics are ignored.
11342 L<collectd-exec(5)>,
11343 L<collectd-perl(5)>,
11344 L<collectd-unixsock(5)>,
11357 Florian Forster E<lt>octo@collectd.orgE<gt>