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 If the system has the I<cpufreq-stats> kernel module loaded, this plugin reports
1666 the rate of p-state (cpu frequency) transitions and the percentage of time spent
1669 =head2 Plugin C<cpusleep>
1671 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1672 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1673 BOOTTIME clock increments while device is suspended and MONOTONIC
1674 clock does not, the derivative of the difference between these clocks
1675 gives the relative amount of time the device has spent in suspend
1676 state. The recorded value is in milliseconds of sleep per seconds of
1679 =head2 Plugin C<csv>
1683 =item B<DataDir> I<Directory>
1685 Set the directory to store CSV-files under. Per default CSV-files are generated
1686 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1687 The special strings B<stdout> and B<stderr> can be used to write to the standard
1688 output and standard error channels, respectively. This, of course, only makes
1689 much sense when collectd is running in foreground- or non-daemon-mode.
1691 =item B<StoreRates> B<true|false>
1693 If set to B<true>, convert counter values to rates. If set to B<false> (the
1694 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1699 =head2 cURL Statistics
1701 All cURL-based plugins support collection of generic, request-based
1702 statistics. These are disabled by default and can be enabled selectively for
1703 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1704 the documentation of those plugins for specific information. This section
1705 describes the available metrics that can be configured for each plugin. All
1706 options are disabled by default.
1708 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1712 =item B<TotalTime> B<true|false>
1714 Total time of the transfer, including name resolving, TCP connect, etc.
1716 =item B<NamelookupTime> B<true|false>
1718 Time it took from the start until name resolving was completed.
1720 =item B<ConnectTime> B<true|false>
1722 Time it took from the start until the connect to the remote host (or proxy)
1725 =item B<AppconnectTime> B<true|false>
1727 Time it took from the start until the SSL/SSH connect/handshake to the remote
1730 =item B<PretransferTime> B<true|false>
1732 Time it took from the start until just before the transfer begins.
1734 =item B<StarttransferTime> B<true|false>
1736 Time it took from the start until the first byte was received.
1738 =item B<RedirectTime> B<true|false>
1740 Time it took for all redirection steps include name lookup, connect,
1741 pre-transfer and transfer before final transaction was started.
1743 =item B<RedirectCount> B<true|false>
1745 The total number of redirections that were actually followed.
1747 =item B<SizeUpload> B<true|false>
1749 The total amount of bytes that were uploaded.
1751 =item B<SizeDownload> B<true|false>
1753 The total amount of bytes that were downloaded.
1755 =item B<SpeedDownload> B<true|false>
1757 The average download speed that curl measured for the complete download.
1759 =item B<SpeedUpload> B<true|false>
1761 The average upload speed that curl measured for the complete upload.
1763 =item B<HeaderSize> B<true|false>
1765 The total size of all the headers received.
1767 =item B<RequestSize> B<true|false>
1769 The total size of the issued requests.
1771 =item B<ContentLengthDownload> B<true|false>
1773 The content-length of the download.
1775 =item B<ContentLengthUpload> B<true|false>
1777 The specified size of the upload.
1779 =item B<NumConnects> B<true|false>
1781 The number of new connections that were created to achieve the transfer.
1785 =head2 Plugin C<curl>
1787 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1788 and the match infrastructure (the same code used by the tail plugin) to use
1789 regular expressions with the received data.
1791 The following example will read the current value of AMD stock from Google's
1792 finance page and dispatch the value to collectd.
1795 <Page "stock_quotes">
1797 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1803 CACert "/path/to/ca.crt"
1804 Header "X-Custom-Header: foobar"
1807 MeasureResponseTime false
1808 MeasureResponseCode false
1811 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1812 DSType "GaugeAverage"
1813 # Note: `stock_value' is not a standard type.
1820 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1821 a web page and one or more "matches" to be performed on the returned data. The
1822 string argument to the B<Page> block is used as plugin instance.
1824 The following options are valid within B<Page> blocks:
1828 =item B<Plugin> I<Plugin>
1830 Use I<Plugin> as the plugin name when submitting values.
1831 Defaults to C<curl>.
1835 URL of the web site to retrieve. Since a regular expression will be used to
1836 extract information from this data, non-binary data is a big plus here ;)
1838 =item B<User> I<Name>
1840 Username to use if authorization is required to read the page.
1842 =item B<Password> I<Password>
1844 Password to use if authorization is required to read the page.
1846 =item B<Digest> B<true>|B<false>
1848 Enable HTTP digest authentication.
1850 =item B<VerifyPeer> B<true>|B<false>
1852 Enable or disable peer SSL certificate verification. See
1853 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1855 =item B<VerifyHost> B<true>|B<false>
1857 Enable or disable peer host name verification. If enabled, the plugin checks if
1858 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1859 matches the host name provided by the B<URL> option. If this identity check
1860 fails, the connection is aborted. Obviously, only works when connecting to a
1861 SSL enabled server. Enabled by default.
1863 =item B<CACert> I<file>
1865 File that holds one or more SSL certificates. If you want to use HTTPS you will
1866 possibly need this option. What CA certificates come bundled with C<libcurl>
1867 and are checked by default depends on the distribution you use.
1869 =item B<Header> I<Header>
1871 A HTTP header to add to the request. Multiple headers are added if this option
1872 is specified more than once.
1874 =item B<Post> I<Body>
1876 Specifies that the HTTP operation should be a POST instead of a GET. The
1877 complete data to be posted is given as the argument. This option will usually
1878 need to be accompanied by a B<Header> option to set an appropriate
1879 C<Content-Type> for the post body (e.g. to
1880 C<application/x-www-form-urlencoded>).
1882 =item B<MeasureResponseTime> B<true>|B<false>
1884 Measure response time for the request. If this setting is enabled, B<Match>
1885 blocks (see below) are optional. Disabled by default.
1887 Beware that requests will get aborted if they take too long to complete. Adjust
1888 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1891 This option is similar to enabling the B<TotalTime> statistic but it's
1892 measured by collectd instead of cURL.
1894 =item B<MeasureResponseCode> B<true>|B<false>
1896 Measure response code for the request. If this setting is enabled, B<Match>
1897 blocks (see below) are optional. Disabled by default.
1899 =item B<E<lt>StatisticsE<gt>>
1901 One B<Statistics> block can be used to specify cURL statistics to be collected
1902 for each request to the remote web site. See the section "cURL Statistics"
1903 above for details. If this setting is enabled, B<Match> blocks (see below) are
1906 =item B<E<lt>MatchE<gt>>
1908 One or more B<Match> blocks that define how to match information in the data
1909 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1910 used by the C<tail> plugin, so please see the documentation of the C<tail>
1911 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1912 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1915 =item B<Interval> I<Interval>
1917 Sets the interval (in seconds) in which the values will be collected from this
1918 URL. By default the global B<Interval> setting will be used.
1920 =item B<Timeout> I<Milliseconds>
1922 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1923 milliseconds. By default, the configured B<Interval> is used to set the
1924 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1925 indefinitely. This legacy behaviour can be achieved by setting the value of
1928 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1929 network connection will stall one read thread. Adjust the B<ReadThreads> global
1930 setting accordingly to prevent this from blocking other plugins.
1934 =head2 Plugin C<curl_json>
1936 The B<curl_json plugin> collects values from JSON data to be parsed by
1937 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1938 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1939 unix socket. The former can be used, for example, to collect values
1940 from CouchDB documents (which are stored JSON notation), and the
1941 latter to collect values from a uWSGI stats socket.
1943 The following example will collect several values from the built-in
1944 C<_stats> runtime statistics module of I<CouchDB>
1945 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1948 <URL "http://localhost:5984/_stats">
1950 <Key "httpd/requests/count">
1951 Type "http_requests"
1954 <Key "httpd_request_methods/*/count">
1955 Type "http_request_methods"
1958 <Key "httpd_status_codes/*/count">
1959 Type "http_response_codes"
1964 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1967 <Sock "/var/run/uwsgi.stats.sock">
1969 <Key "workers/*/requests">
1970 Type "http_requests"
1973 <Key "workers/*/apps/*/requests">
1974 Type "http_requests"
1979 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1980 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1981 blocks defining a unix socket to read JSON from directly. Each of
1982 these blocks may have one or more B<Key> blocks.
1984 The B<Key> string argument must be in a path format. Each component is
1985 used to match the key from a JSON map or the index of an JSON
1986 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1987 values for all map keys or array indices will be collectd.
1989 The following options are valid within B<URL> blocks:
1993 =item B<Host> I<Name>
1995 Use I<Name> as the host name when submitting values. Defaults to the global
1998 =item B<Plugin> I<Plugin>
2000 Use I<Plugin> as the plugin name when submitting values.
2001 Defaults to C<curl_json>.
2003 =item B<Instance> I<Instance>
2005 Sets the plugin instance to I<Instance>.
2007 =item B<Interval> I<Interval>
2009 Sets the interval (in seconds) in which the values will be collected from this
2010 URL. By default the global B<Interval> setting will be used.
2012 =item B<User> I<Name>
2014 =item B<Password> I<Password>
2016 =item B<Digest> B<true>|B<false>
2018 =item B<VerifyPeer> B<true>|B<false>
2020 =item B<VerifyHost> B<true>|B<false>
2022 =item B<CACert> I<file>
2024 =item B<Header> I<Header>
2026 =item B<Post> I<Body>
2028 =item B<Timeout> I<Milliseconds>
2030 These options behave exactly equivalent to the appropriate options of the
2031 I<cURL> plugin. Please see there for a detailed description.
2033 =item B<E<lt>StatisticsE<gt>>
2035 One B<Statistics> block can be used to specify cURL statistics to be collected
2036 for each request to the remote URL. See the section "cURL Statistics" above
2041 The following options are valid within B<Key> blocks:
2045 =item B<Type> I<Type>
2047 Sets the type used to dispatch the values to the daemon. Detailed information
2048 about types and their configuration can be found in L<types.db(5)>. This
2049 option is mandatory.
2051 =item B<Instance> I<Instance>
2053 Type-instance to use. Defaults to the current map key or current string array element value.
2057 =head2 Plugin C<curl_xml>
2059 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2060 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2063 <URL "http://localhost/stats.xml">
2066 Instance "some_instance"
2071 CACert "/path/to/ca.crt"
2072 Header "X-Custom-Header: foobar"
2075 <XPath "table[@id=\"magic_level\"]/tr">
2077 #InstancePrefix "prefix-"
2078 InstanceFrom "td[1]"
2079 #PluginInstanceFrom "td[1]"
2080 ValuesFrom "td[2]/span[@class=\"level\"]"
2085 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2086 URL to be fetched using libcurl. Within each B<URL> block there are
2087 options which specify the connection parameters, for example authentication
2088 information, and one or more B<XPath> blocks.
2090 Each B<XPath> block specifies how to get one type of information. The
2091 string argument must be a valid XPath expression which returns a list
2092 of "base elements". One value is dispatched for each "base element". The
2093 I<type instance> and values are looked up using further I<XPath> expressions
2094 that should be relative to the base element.
2096 Within the B<URL> block the following options are accepted:
2100 =item B<Host> I<Name>
2102 Use I<Name> as the host name when submitting values. Defaults to the global
2105 =item B<Plugin> I<Plugin>
2107 Use I<Plugin> as the plugin name when submitting values.
2108 Defaults to 'curl_xml'.
2110 =item B<Instance> I<Instance>
2112 Use I<Instance> as the plugin instance when submitting values.
2113 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2114 Defaults to an empty string (no plugin instance).
2116 =item B<Interval> I<Interval>
2118 Sets the interval (in seconds) in which the values will be collected from this
2119 URL. By default the global B<Interval> setting will be used.
2121 =item B<Namespace> I<Prefix> I<URL>
2123 If an XPath expression references namespaces, they must be specified
2124 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2125 I<URL> is the "namespace name", an URI reference uniquely identifying the
2126 namespace. The option can be repeated to register multiple namespaces.
2130 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2131 Namespace "m" "http://www.w3.org/1998/Math/MathML"
2133 =item B<User> I<User>
2135 =item B<Password> I<Password>
2137 =item B<Digest> B<true>|B<false>
2139 =item B<VerifyPeer> B<true>|B<false>
2141 =item B<VerifyHost> B<true>|B<false>
2143 =item B<CACert> I<CA Cert File>
2145 =item B<Header> I<Header>
2147 =item B<Post> I<Body>
2149 =item B<Timeout> I<Milliseconds>
2151 These options behave exactly equivalent to the appropriate options of the
2152 I<cURL plugin>. Please see there for a detailed description.
2154 =item B<E<lt>StatisticsE<gt>>
2156 One B<Statistics> block can be used to specify cURL statistics to be collected
2157 for each request to the remote URL. See the section "cURL Statistics" above
2160 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2162 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2163 B<XPath> block specifies how to get one type of information. The string
2164 argument must be a valid XPath expression which returns a list of "base
2165 elements". One value is dispatched for each "base element".
2167 Within the B<XPath> block the following options are accepted:
2171 =item B<Type> I<Type>
2173 Specifies the I<Type> used for submitting patches. This determines the number
2174 of values that are required / expected and whether the strings are parsed as
2175 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2176 This option is required.
2178 =item B<InstancePrefix> I<InstancePrefix>
2180 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2181 concatenated together without any separator.
2182 This option is optional.
2184 =item B<InstanceFrom> I<InstanceFrom>
2186 Specifies a XPath expression to use for determining the I<type instance>. The
2187 XPath expression must return exactly one element. The element's value is then
2188 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2190 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2192 Specifies a XPath expression to use for determining the I<plugin instance>. The
2193 XPath expression must return exactly one element. The element's value is then
2194 used as I<plugin instance>.
2198 If the "base XPath expression" (the argument to the B<XPath> block) returns
2199 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2200 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2204 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2206 Specifies one or more XPath expression to use for reading the values. The
2207 number of XPath expressions must match the number of data sources in the
2208 I<type> specified with B<Type> (see above). Each XPath expression must return
2209 exactly one element. The element's value is then parsed as a number and used as
2210 value for the appropriate value in the value list dispatched to the daemon.
2211 This option is required.
2217 =head2 Plugin C<dbi>
2219 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2220 connect to various databases, execute I<SQL> statements and read back the
2221 results. I<dbi> is an acronym for "database interface" in case you were
2222 wondering about the name. You can configure how each column is to be
2223 interpreted and the plugin will generate one or more data sets from each row
2224 returned according to these rules.
2226 Because the plugin is very generic, the configuration is a little more complex
2227 than those of other plugins. It usually looks something like this:
2230 <Query "out_of_stock">
2231 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2232 # Use with MySQL 5.0.0 or later
2236 InstancePrefix "out_of_stock"
2237 InstancesFrom "category"
2241 <Database "product_information">
2245 DriverOption "host" "localhost"
2246 DriverOption "username" "collectd"
2247 DriverOption "password" "aZo6daiw"
2248 DriverOption "dbname" "prod_info"
2249 SelectDB "prod_info"
2250 Query "out_of_stock"
2254 The configuration above defines one query with one result and one database. The
2255 query is then linked to the database with the B<Query> option I<within> the
2256 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2257 and you can also use the B<Include> statement to split up the configuration
2258 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2259 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2262 The following is a complete list of options:
2264 =head3 B<Query> blocks
2266 Query blocks define I<SQL> statements and how the returned data should be
2267 interpreted. They are identified by the name that is given in the opening line
2268 of the block. Thus the name needs to be unique. Other than that, the name is
2269 not used in collectd.
2271 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2272 define which column holds which value or instance information. You can use
2273 multiple B<Result> blocks to create multiple values from one returned row. This
2274 is especially useful, when queries take a long time and sending almost the same
2275 query again and again is not desirable.
2279 <Query "environment">
2280 Statement "select station, temperature, humidity from environment"
2283 # InstancePrefix "foo"
2284 InstancesFrom "station"
2285 ValuesFrom "temperature"
2289 InstancesFrom "station"
2290 ValuesFrom "humidity"
2294 The following options are accepted:
2298 =item B<Statement> I<SQL>
2300 Sets the statement that should be executed on the server. This is B<not>
2301 interpreted by collectd, but simply passed to the database server. Therefore,
2302 the SQL dialect that's used depends on the server collectd is connected to.
2304 The query has to return at least two columns, one for the instance and one
2305 value. You cannot omit the instance, even if the statement is guaranteed to
2306 always return exactly one line. In that case, you can usually specify something
2309 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2311 (That works with MySQL but may not be valid SQL according to the spec. If you
2312 use a more strict database server, you may have to select from a dummy table or
2315 Please note that some databases, for example B<Oracle>, will fail if you
2316 include a semicolon at the end of the statement.
2318 =item B<MinVersion> I<Version>
2320 =item B<MaxVersion> I<Value>
2322 Only use this query for the specified database version. You can use these
2323 options to provide multiple queries with the same name but with a slightly
2324 different syntax. The plugin will use only those queries, where the specified
2325 minimum and maximum versions fit the version of the database in use.
2327 The database version is determined by C<dbi_conn_get_engine_version>, see the
2328 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2329 for details. Basically, each part of the version is assumed to be in the range
2330 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2331 "40102", version "5.0.42" becomes "50042".
2333 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2334 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2335 happen. Don't to it! A valid example would be something along these lines:
2346 In the above example, there are three ranges that don't overlap. The last one
2347 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2348 before "4.0.0" are not specified.
2350 =item B<Type> I<Type>
2352 The B<type> that's used for each line returned. See L<types.db(5)> for more
2353 details on how types are defined. In short: A type is a predefined layout of
2354 data and the number of values and type of values has to match the type
2357 If you specify "temperature" here, you need exactly one gauge column. If you
2358 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2361 There must be exactly one B<Type> option inside each B<Result> block.
2363 =item B<InstancePrefix> I<prefix>
2365 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2366 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2367 all strings returned in the appropriate columns are concatenated together,
2368 separated by dashes I<("-")>.
2370 =item B<InstancesFrom> I<column0> [I<column1> ...]
2372 Specifies the columns whose values will be used to create the "type-instance"
2373 for each row. If you specify more than one column, the value of all columns
2374 will be joined together with dashes I<("-")> as separation characters.
2376 The plugin itself does not check whether or not all built instances are
2377 different. It's your responsibility to assure that each is unique. This is
2378 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2379 sure that only one row is returned in this case.
2381 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2384 =item B<ValuesFrom> I<column0> [I<column1> ...]
2386 Names the columns whose content is used as the actual data for the data sets
2387 that are dispatched to the daemon. How many such columns you need is determined
2388 by the B<Type> setting above. If you specify too many or not enough columns,
2389 the plugin will complain about that and no data will be submitted to the
2392 The actual data type in the columns is not that important. The plugin will
2393 automatically cast the values to the right type if it know how to do that. So
2394 it should be able to handle integer an floating point types, as well as strings
2395 (if they include a number at the beginning).
2397 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2399 =item B<MetadataFrom> [I<column0> I<column1> ...]
2401 Names the columns whose content is used as metadata for the data sets
2402 that are dispatched to the daemon.
2404 The actual data type in the columns is not that important. The plugin will
2405 automatically cast the values to the right type if it know how to do that. So
2406 it should be able to handle integer an floating point types, as well as strings
2407 (if they include a number at the beginning).
2411 =head3 B<Database> blocks
2413 Database blocks define a connection to a database and which queries should be
2414 sent to that database. Since the used "dbi" library can handle a wide variety
2415 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2416 documentationE<nbsp>- we stick as close to the terminology used there.
2418 Each database needs a "name" as string argument in the starting tag of the
2419 block. This name will be used as "PluginInstance" in the values submitted to
2420 the daemon. Other than that, that name is not used.
2424 =item B<Plugin> I<Plugin>
2426 Use I<Plugin> as the plugin name when submitting query results from
2427 this B<Database>. Defaults to C<dbi>.
2429 =item B<Interval> I<Interval>
2431 Sets the interval (in seconds) in which the values will be collected from this
2432 database. By default the global B<Interval> setting will be used.
2434 =item B<Driver> I<Driver>
2436 Specifies the driver to use to connect to the database. In many cases those
2437 drivers are named after the database they can connect to, but this is not a
2438 technical necessity. These drivers are sometimes referred to as "DBD",
2439 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2440 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2441 project at L<http://libdbi-drivers.sourceforge.net/>.
2443 You need to give the driver name as expected by the "dbi" library here. You
2444 should be able to find that in the documentation for each driver. If you
2445 mistype the driver name, the plugin will dump a list of all known driver names
2448 =item B<DriverOption> I<Key> I<Value>
2450 Sets driver-specific options. What option a driver supports can be found in the
2451 documentation for each driver, somewhere at
2452 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2453 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2455 DBDs can register two types of options: String options and numeric options. The
2456 plugin will use the C<dbi_conn_set_option> function when the configuration
2457 provides a string and the C<dbi_conn_require_option_numeric> function when the
2458 configuration provides a number. So these two lines will actually result in
2459 different calls being used:
2461 DriverOption "Port" 1234 # numeric
2462 DriverOption "Port" "1234" # string
2464 Unfortunately, drivers are not too keen to report errors when an unknown option
2465 is passed to them, so invalid settings here may go unnoticed. This is not the
2466 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2467 the driver. If a driver complains about an option, the plugin will dump a
2468 complete list of all options understood by that driver to the log. There is no
2469 way to programmatically find out if an option expects a string or a numeric
2470 argument, so you will have to refer to the appropriate DBD's documentation to
2471 find this out. Sorry.
2473 =item B<SelectDB> I<Database>
2475 In some cases, the database name you connect with is not the database name you
2476 want to use for querying data. If this option is set, the plugin will "select"
2477 (switch to) that database after the connection is established.
2479 =item B<Query> I<QueryName>
2481 Associates the query named I<QueryName> with this database connection. The
2482 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2483 blocks you want to refer to must be placed above the database block you want to
2486 =item B<Host> I<Hostname>
2488 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2489 values. Defaults to the global hostname setting.
2497 =item B<Device> I<Device>
2499 Select partitions based on the devicename.
2501 See F</"IGNORELISTS"> for details.
2503 =item B<MountPoint> I<Directory>
2505 Select partitions based on the mountpoint.
2507 See F</"IGNORELISTS"> for details.
2509 =item B<FSType> I<FSType>
2511 Select partitions based on the filesystem type.
2513 See F</"IGNORELISTS"> for details.
2515 =item B<IgnoreSelected> B<true>|B<false>
2517 Invert the selection: If set to true, all partitions B<except> the ones that
2518 match any one of the criteria are collected. By default only selected
2519 partitions are collected if a selection is made. If no selection is configured
2520 at all, B<all> partitions are selected.
2522 =item B<ReportByDevice> B<true>|B<false>
2524 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2525 (the default), it will report a disk as "root", but with it I<true>, it will be
2526 "sda1" (or whichever).
2528 =item B<ReportInodes> B<true>|B<false>
2530 Enables or disables reporting of free, reserved and used inodes. Defaults to
2531 inode collection being disabled.
2533 Enable this option if inodes are a scarce resource for you, usually because
2534 many small files are stored on the disk. This is a usual scenario for mail
2535 transfer agents and web caches.
2537 =item B<ValuesAbsolute> B<true>|B<false>
2539 Enables or disables reporting of free and used disk space in 1K-blocks.
2540 Defaults to B<true>.
2542 =item B<ValuesPercentage> B<false>|B<true>
2544 Enables or disables reporting of free and used disk space in percentage.
2545 Defaults to B<false>.
2547 This is useful for deploying I<collectd> on the cloud, where machines with
2548 different disk size may exist. Then it is more practical to configure
2549 thresholds based on relative disk size.
2553 =head2 Plugin C<disk>
2555 The C<disk> plugin collects information about the usage of physical disks and
2556 logical disks (partitions). Values collected are the number of octets written
2557 to and read from a disk or partition, the number of read/write operations
2558 issued to the disk and a rather complex "time" it took for these commands to be
2561 Using the following two options you can ignore some disks or configure the
2562 collection only of specific disks.
2566 =item B<Disk> I<Name>
2568 Select the disk I<Name>. Whether it is collected or ignored depends on the
2569 B<IgnoreSelected> setting, see below. As with other plugins that use the
2570 daemon's ignorelist functionality, a string that starts and ends with a slash
2571 is interpreted as a regular expression. Examples:
2576 See F</"IGNORELISTS"> for details.
2578 =item B<IgnoreSelected> B<true>|B<false>
2580 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2581 statements, are ignored or if all other disks are ignored. The behavior
2582 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2583 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2584 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2585 is set to B<true>, all disks are collected B<except> the ones matched.
2587 =item B<UseBSDName> B<true>|B<false>
2589 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2590 default major/minor numbers. Requires collectd to be built with Apple's
2593 =item B<UdevNameAttr> I<Attribute>
2595 Attempt to override disk instance name with the value of a specified udev
2596 attribute when built with B<libudev>. If the attribute is not defined for the
2597 given device, the default name is used. Example:
2599 UdevNameAttr "DM_NAME"
2603 =head2 Plugin C<dns>
2607 =item B<Interface> I<Interface>
2609 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2610 option sets the interface that should be used. If this option is not set, or
2611 set to "any", the plugin will try to get packets from B<all> interfaces. This
2612 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2614 =item B<IgnoreSource> I<IP-address>
2616 Ignore packets that originate from this address.
2618 =item B<SelectNumericQueryTypes> B<true>|B<false>
2620 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2624 =head2 Plugin C<dpdkevents>
2626 The I<dpdkevents plugin> collects events from DPDK such as link status of
2627 network ports and Keep Alive status of DPDK logical cores.
2628 In order to get Keep Alive events following requirements must be met:
2630 - support for Keep Alive implemented in DPDK application. More details can
2631 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2635 <Plugin "dpdkevents">
2641 <Event "link_status">
2642 SendEventsOnUpdate true
2643 EnabledPortMask 0xffff
2644 PortName "interface1"
2645 PortName "interface2"
2646 SendNotification false
2648 <Event "keep_alive">
2649 SendEventsOnUpdate true
2651 KeepAliveShmName "/dpdk_keepalive_shm_name"
2652 SendNotification false
2659 =head3 The EAL block
2663 =item B<Coremask> I<Mask>
2665 =item B<Memorychannels> I<Channels>
2667 Number of memory channels per processor socket.
2669 =item B<FilePrefix> I<File>
2671 The prefix text used for hugepage filenames. The filename will be set to
2672 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2676 =head3 The Event block
2678 The B<Event> block defines configuration for specific event. It accepts a
2679 single argument which specifies the name of the event.
2681 =head4 Link Status event
2685 =item B<SendEventOnUpdate> I<true|false>
2687 If set to true link status value will be dispatched only when it is
2688 different from previously read value. This is an optional argument - default
2691 =item B<EnabledPortMask> I<Mask>
2693 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2694 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2695 that all ports will be enabled. This is an optional argument - by default
2696 all ports are enabled.
2698 =item B<PortName> I<Name>
2700 A string containing an optional name for the enabled DPDK ports. Each PortName
2701 option should contain only one port name; specify as many PortName options as
2702 desired. Default naming convention will be used if PortName is blank. If there
2703 are less PortName options than there are enabled ports, the default naming
2704 convention will be used for the additional ports.
2706 =item B<SendNotification> I<true|false>
2708 If set to true, link status notifications are sent, instead of link status
2709 being collected as a statistic. This is an optional argument - default
2714 =head4 Keep Alive event
2718 =item B<SendEventOnUpdate> I<true|false>
2720 If set to true keep alive value will be dispatched only when it is
2721 different from previously read value. This is an optional argument - default
2724 =item B<LCoreMask> I<Mask>
2726 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2728 =item B<KeepAliveShmName> I<Name>
2730 Shared memory name identifier that is used by secondary process to monitor
2731 the keep alive cores state.
2733 =item B<SendNotification> I<true|false>
2735 If set to true, keep alive notifications are sent, instead of keep alive
2736 information being collected as a statistic. This is an optional
2737 argument - default value is false.
2741 =head2 Plugin C<dpdkstat>
2743 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2744 extended NIC stats API in DPDK.
2755 RteDriverLibPath "/usr/lib/dpdk-pmd"
2757 SharedMemObj "dpdk_collectd_stats_0"
2758 EnabledPortMask 0xffff
2759 PortName "interface1"
2760 PortName "interface2"
2765 =head3 The EAL block
2769 =item B<Coremask> I<Mask>
2771 A string containing an hexadecimal bit mask of the cores to run on. Note that
2772 core numbering can change between platforms and should be determined beforehand.
2774 =item B<Memorychannels> I<Channels>
2776 A string containing a number of memory channels per processor socket.
2778 =item B<FilePrefix> I<File>
2780 The prefix text used for hugepage filenames. The filename will be set to
2781 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2783 =item B<SocketMemory> I<MB>
2785 A string containing amount of Memory to allocate from hugepages on specific
2786 sockets in MB. This is an optional value.
2788 =item B<LogLevel> I<LogLevel_number>
2790 A string containing log level number. This parameter is optional.
2791 If parameter is not present then default value "7" - (INFO) is used.
2792 Value "8" - (DEBUG) can be set to enable debug traces.
2794 =item B<RteDriverLibPath> I<Path>
2796 A string containing path to shared pmd driver lib or path to directory,
2797 where shared pmd driver libs are available. This parameter is optional.
2798 This parameter enable loading of shared pmd driver libs from defined path.
2799 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2800 or "/usr/lib/dpdk-pmd"
2806 =item B<SharedMemObj> I<Mask>
2808 A string containing the name of the shared memory object that should be used to
2809 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2810 Defaults to dpdk_collectd_stats if no other value is configured.
2812 =item B<EnabledPortMask> I<Mask>
2814 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2815 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2816 that all ports will be enabled. This is an optional argument - default
2817 is all ports enabled.
2819 =item B<PortName> I<Name>
2821 A string containing an optional name for the enabled DPDK ports. Each PortName
2822 option should contain only one port name; specify as many PortName options as
2823 desired. Default naming convention will be used if PortName is blank. If there
2824 are less PortName options than there are enabled ports, the default naming
2825 convention will be used for the additional ports.
2829 =head2 Plugin C<email>
2833 =item B<SocketFile> I<Path>
2835 Sets the socket-file which is to be created.
2837 =item B<SocketGroup> I<Group>
2839 If running as root change the group of the UNIX-socket after it has been
2840 created. Defaults to B<collectd>.
2842 =item B<SocketPerms> I<Permissions>
2844 Change the file permissions of the UNIX-socket after it has been created. The
2845 permissions must be given as a numeric, octal value as you would pass to
2846 L<chmod(1)>. Defaults to B<0770>.
2848 =item B<MaxConns> I<Number>
2850 Sets the maximum number of connections that can be handled in parallel. Since
2851 this many threads will be started immediately setting this to a very high
2852 value will waste valuable resources. Defaults to B<5> and will be forced to be
2853 at most B<16384> to prevent typos and dumb mistakes.
2857 =head2 Plugin C<ethstat>
2859 The I<ethstat plugin> collects information about network interface cards (NICs)
2860 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2866 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2867 Map "multicast" "if_multicast"
2874 =item B<Interface> I<Name>
2876 Collect statistical information about interface I<Name>.
2878 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2880 By default, the plugin will submit values as type C<derive> and I<type
2881 instance> set to I<Name>, the name of the metric as reported by the driver. If
2882 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2883 I<TypeInstance> will be used.
2885 =item B<MappedOnly> B<true>|B<false>
2887 When set to B<true>, only metrics that can be mapped to a I<type> will be
2888 collected, all other metrics will be ignored. Defaults to B<false>.
2892 =head2 Plugin C<exec>
2894 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2895 contains valuable information on when the executable is executed and the
2896 output that is expected from it.
2900 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2902 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2904 Execute the executable I<Executable> as user I<User>. If the user name is
2905 followed by a colon and a group name, the effective group is set to that group.
2906 The real group and saved-set group will be set to the default group of that
2907 user. If no group is given the effective group ID will be the same as the real
2910 Please note that in order to change the user and/or group the daemon needs
2911 superuser privileges. If the daemon is run as an unprivileged user you must
2912 specify the same user/group here. If the daemon is run with superuser
2913 privileges, you must supply a non-root user here.
2915 The executable may be followed by optional arguments that are passed to the
2916 program. Please note that due to the configuration parsing numbers and boolean
2917 values may be changed. If you want to be absolutely sure that something is
2918 passed as-is please enclose it in quotes.
2920 The B<Exec> and B<NotificationExec> statements change the semantics of the
2921 programs executed, i.E<nbsp>e. the data passed to them and the response
2922 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2926 =head2 Plugin C<fhcount>
2928 The C<fhcount> plugin provides statistics about used, unused and total number of
2929 file handles on Linux.
2931 The I<fhcount plugin> provides the following configuration options:
2935 =item B<ValuesAbsolute> B<true>|B<false>
2937 Enables or disables reporting of file handles usage in absolute numbers,
2938 e.g. file handles used. Defaults to B<true>.
2940 =item B<ValuesPercentage> B<false>|B<true>
2942 Enables or disables reporting of file handles usage in percentages, e.g.
2943 percent of file handles used. Defaults to B<false>.
2947 =head2 Plugin C<filecount>
2949 The C<filecount> plugin counts the number of files in a certain directory (and
2950 its subdirectories) and their combined size. The configuration is very straight
2953 <Plugin "filecount">
2954 <Directory "/var/qmail/queue/mess">
2955 Instance "qmail-message"
2957 <Directory "/var/qmail/queue/todo">
2958 Instance "qmail-todo"
2960 <Directory "/var/lib/php5">
2961 Instance "php5-sessions"
2966 The example above counts the number of files in QMail's queue directories and
2967 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2968 QMail has not yet looked at, the "message" queue holds the messages that were
2969 classified into "local" and "remote".
2971 As you can see, the configuration consists of one or more C<Directory> blocks,
2972 each of which specifies a directory in which to count the files. Within those
2973 blocks, the following options are recognized:
2977 =item B<Plugin> I<Plugin>
2979 Use I<Plugin> as the plugin name when submitting values.
2980 Defaults to B<filecount>.
2982 =item B<Instance> I<Instance>
2984 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2985 the directory name with all slashes replaced by underscores and all leading
2986 underscores removed. Empty value is allowed.
2988 =item B<Name> I<Pattern>
2990 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2991 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2992 against the pattern, not the entire path. In case this makes it easier for you:
2993 This option has been named after the B<-name> parameter to L<find(1)>.
2995 =item B<MTime> I<Age>
2997 Count only files of a specific age: If I<Age> is greater than zero, only files
2998 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2999 a negative number, this is inversed. For example, if B<-60> is specified, only
3000 files that have been modified in the last minute will be counted.
3002 The number can also be followed by a "multiplier" to easily specify a larger
3003 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3004 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3005 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3006 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3007 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3010 =item B<Size> I<Size>
3012 Count only files of a specific size. When I<Size> is a positive number, only
3013 files that are at least this big are counted. If I<Size> is a negative number,
3014 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3015 I<Size> are counted.
3017 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3018 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3019 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3020 note that there are 1000 bytes in a kilobyte, not 1024.
3022 =item B<Recursive> I<true>|I<false>
3024 Controls whether or not to recurse into subdirectories. Enabled by default.
3026 =item B<IncludeHidden> I<true>|I<false>
3028 Controls whether or not to include "hidden" files and directories in the count.
3029 "Hidden" files and directories are those, whose name begins with a dot.
3030 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3032 =item B<RegularOnly> I<true>|I<false>
3034 Controls whether or not to include only regular files in the count.
3035 Defaults to I<true>, i.e. by default non regular files are ignored.
3037 =item B<FilesSizeType> I<Type>
3039 Sets the type used to dispatch files combined size. Empty value ("") disables
3040 reporting. Defaults to B<bytes>.
3042 =item B<FilesCountType> I<Type>
3044 Sets the type used to dispatch number of files. Empty value ("") disables
3045 reporting. Defaults to B<files>.
3047 =item B<TypeInstance> I<Instance>
3049 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3050 (no plugin instance).
3054 =head2 Plugin C<GenericJMX>
3056 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3057 L<collectd-java(5)>.
3059 =head2 Plugin C<gmond>
3061 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3062 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3063 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3068 MCReceiveFrom "239.2.11.71" "8649"
3069 <Metric "swap_total">
3071 TypeInstance "total"
3074 <Metric "swap_free">
3081 The following metrics are built-in:
3087 load_one, load_five, load_fifteen
3091 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3095 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3107 Available configuration options:
3111 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3113 Sets sets the multicast group and UDP port to which to subscribe.
3115 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3117 =item E<lt>B<Metric> I<Name>E<gt>
3119 These blocks add a new metric conversion to the internal table. I<Name>, the
3120 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3124 =item B<Type> I<Type>
3126 Type to map this metric to. Required.
3128 =item B<TypeInstance> I<Instance>
3130 Type-instance to use. Optional.
3132 =item B<DataSource> I<Name>
3134 Data source to map this metric to. If the configured type has exactly one data
3135 source, this is optional. Otherwise the option is required.
3141 =head2 Plugin C<gps>
3143 The C<gps plugin> connects to gpsd on the host machine.
3144 The host, port, timeout and pause are configurable.
3146 This is useful if you run an NTP server using a GPS for source and you want to
3149 Mind your GPS must send $--GSA for having the data reported!
3151 The following elements are collected:
3157 Number of satellites used for fix (type instance "used") and in view (type
3158 instance "visible"). 0 means no GPS satellites are visible.
3160 =item B<dilution_of_precision>
3162 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3163 It should be between 0 and 3.
3164 Look at the documentation of your GPS to know more.
3172 # Connect to localhost on gpsd regular port:
3177 # PauseConnect of 5 sec. between connection attempts.
3181 Available configuration options:
3185 =item B<Host> I<Host>
3187 The host on which gpsd daemon runs. Defaults to B<localhost>.
3189 =item B<Port> I<Port>
3191 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3193 =item B<Timeout> I<Seconds>
3195 Timeout in seconds (default 0.015 sec).
3197 The GPS data stream is fetch by the plugin form the daemon.
3198 It waits for data to be available, if none arrives it times out
3199 and loop for another reading.
3200 Mind to put a low value gpsd expects value in the micro-seconds area
3201 (recommended is 500 us) since the waiting function is blocking.
3202 Value must be between 500 us and 5 sec., if outside that range the
3203 default value is applied.
3205 This only applies from gpsd release-2.95.
3207 =item B<PauseConnect> I<Seconds>
3209 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3213 =head2 Plugin C<gpu_nvidia>
3215 Efficiently collects various statistics from the system's NVIDIA GPUs using the
3216 NVML library. Currently collected are fan speed, core temperature, percent
3217 load, percent memory used, compute and memory frequencies, and power
3224 If one or more of these options is specified, only GPUs at that index (as
3225 determined by nvidia-utils through I<nvidia-smi>) have statistics collected.
3226 If no instance of this option is specified, all GPUs are monitored.
3228 =item B<IgnoreSelected>
3230 If set to true, all detected GPUs B<except> the ones at indices specified by
3231 B<GPUIndex> entries are collected. For greater clarity, setting IgnoreSelected
3232 without any GPUIndex directives will result in B<no> statistics being
3237 =head2 Plugin C<grpc>
3239 The I<grpc> plugin provides an RPC interface to submit values to or query
3240 values from collectd based on the open source gRPC framework. It exposes an
3241 end-point for dispatching values to the daemon.
3243 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3247 =item B<Server> I<Host> I<Port>
3249 The B<Server> statement sets the address of a server to which to send metrics
3250 via the C<DispatchValues> function.
3252 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3254 Optionally, B<Server> may be specified as a configuration block which supports
3255 the following options:
3259 =item B<EnableSSL> B<false>|B<true>
3261 Whether to require SSL for outgoing 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
3274 =item B<Listen> I<Host> I<Port>
3276 The B<Listen> statement sets the network address to bind to. When multiple
3277 statements are specified, the daemon will bind to all of them. If none are
3278 specified, it defaults to B<0.0.0.0:50051>.
3280 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3282 Optionally, B<Listen> may be specified as a configuration block which
3283 supports the following options:
3287 =item B<EnableSSL> I<true>|I<false>
3289 Whether to enable SSL for incoming connections. Default: false.
3291 =item B<SSLCACertificateFile> I<Filename>
3293 =item B<SSLCertificateFile> I<Filename>
3295 =item B<SSLCertificateKeyFile> I<Filename>
3297 Filenames specifying SSL certificate and key material to be used with SSL
3300 =item B<VerifyPeer> B<true>|B<false>
3302 When enabled, a valid client certificate is required to connect to the server.
3303 When disabled, a client certifiacte is not requested and any unsolicited client
3304 certificate is accepted.
3311 =head2 Plugin C<hddtemp>
3313 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3314 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3315 default values, see below. C<hddtemp> has to be running to work correctly. If
3316 C<hddtemp> is not running timeouts may appear which may interfere with other
3319 The B<hddtemp> homepage can be found at
3320 L<http://www.guzu.net/linux/hddtemp.php>.
3324 =item B<Host> I<Hostname>
3326 Hostname to connect to. Defaults to B<127.0.0.1>.
3328 =item B<Port> I<Port>
3330 TCP-Port to connect to. Defaults to B<7634>.
3334 =head2 Plugin C<hugepages>
3336 To collect B<hugepages> information, collectd reads directories
3337 "/sys/devices/system/node/*/hugepages" and
3338 "/sys/kernel/mm/hugepages".
3339 Reading of these directories can be disabled by the following
3340 options (default is enabled).
3344 =item B<ReportPerNodeHP> B<true>|B<false>
3346 If enabled, information will be collected from the hugepage
3347 counters in "/sys/devices/system/node/*/hugepages".
3348 This is used to check the per-node hugepage statistics on
3351 =item B<ReportRootHP> B<true>|B<false>
3353 If enabled, information will be collected from the hugepage
3354 counters in "/sys/kernel/mm/hugepages".
3355 This can be used on both NUMA and non-NUMA systems to check
3356 the overall hugepage statistics.
3358 =item B<ValuesPages> B<true>|B<false>
3360 Whether to report hugepages metrics in number of pages.
3361 Defaults to B<true>.
3363 =item B<ValuesBytes> B<false>|B<true>
3365 Whether to report hugepages metrics in bytes.
3366 Defaults to B<false>.
3368 =item B<ValuesPercentage> B<false>|B<true>
3370 Whether to report hugepages metrics as percentage.
3371 Defaults to B<false>.
3375 =head2 Plugin C<intel_pmu>
3377 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3378 Linux perf interface. All events are reported on a per core basis.
3383 ReportHardwareCacheEvents true
3384 ReportKernelPMUEvents true
3385 ReportSoftwareEvents true
3386 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3387 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3388 Cores "0-3" "4,6" "[12-15]"
3395 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3397 Enable or disable measuring of hardware CPU cache events:
3399 - L1-dcache-load-misses
3401 - L1-dcache-store-misses
3402 - L1-dcache-prefetches
3403 - L1-dcache-prefetch-misses
3405 - L1-icache-load-misses
3406 - L1-icache-prefetches
3407 - L1-icache-prefetch-misses
3413 - LLC-prefetch-misses
3419 - dTLB-prefetch-misses
3423 - branch-load-misses
3425 =item B<ReportKernelPMUEvents> B<false>|B<true>
3427 Enable or disable measuring of the following events:
3436 =item B<ReportSoftwareEvents> B<false>|B<true>
3438 Enable or disable measuring of software events provided by kernel:
3449 =item B<EventList> I<filename>
3451 JSON performance counter event list file name. To be able to monitor all Intel
3452 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3453 event_download.py script to download event list for current CPU.
3455 =item B<HardwareEvents> I<events>
3457 This field is a list of event names or groups of comma separated event names.
3458 This option requires B<EventList> option to be configured.
3460 =item B<Cores> I<cores groups>
3462 All events are reported on a per core basis. Monitoring of the events can be
3463 configured for a group of cores (aggregated statistics). This field defines
3464 groups of cores on which to monitor supported events. The field is represented
3465 as list of strings with core group values. Each string represents a list of
3466 cores in a group. If a group is enclosed in square brackets each core is added
3467 individually to a separate group (that is statistics are not aggregated).
3468 Allowed formats are:
3474 If an empty string is provided as value for this field default cores
3475 configuration is applied - that is separate group is created for each core.
3479 =head2 Plugin C<intel_rdt>
3481 The I<intel_rdt> plugin collects information provided by monitoring features of
3482 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3483 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3484 information about utilization of shared resources. CMT monitors last level cache
3485 occupancy (LLC). MBM supports two types of events reporting local and remote
3486 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3487 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3488 reports the bandwidth of accessing the remote socket. Also this technology
3489 allows to monitor instructions per clock (IPC).
3490 Monitor events are hardware dependant. Monitoring capabilities are detected on
3491 plugin initialization and only supported events are monitored.
3493 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3494 require an additional capability to be enabled if collectd is run as a service.
3495 Please refer to I<contrib/systemd.collectd.service> file for more details.
3499 <Plugin "intel_rdt">
3500 Cores "0-2" "3,4,6" "8-10,15"
3507 =item B<Interval> I<seconds>
3509 The interval within which to retrieve statistics on monitored events in seconds.
3510 For milliseconds divide the time by 1000 for example if the desired interval
3511 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3512 recommended to set interval higher than 1 sec.
3514 =item B<Cores> I<cores groups>
3516 All events are reported on a per core basis. Monitoring of the events can be
3517 configured for group of cores (aggregated statistics). This field defines groups
3518 of cores on which to monitor supported events. The field is represented as list
3519 of strings with core group values. Each string represents a list of cores in a
3520 group. Allowed formats are:
3525 If an empty string is provided as value for this field default cores
3526 configuration is applied - a separate group is created for each core.
3530 B<Note:> By default global interval is used to retrieve statistics on monitored
3531 events. To configure a plugin specific interval use B<Interval> option of the
3532 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3533 example if the desired interval is 50ms, set interval to 0.05.
3534 Due to limited capacity of counters it is not recommended to set interval higher
3537 =head2 Plugin C<interface>
3541 =item B<Interface> I<Interface>
3543 Select this interface. By default these interfaces will then be collected. For
3544 a more detailed description see B<IgnoreSelected> below.
3546 See F</"IGNORELISTS"> for details.
3548 =item B<IgnoreSelected> I<true>|I<false>
3550 If no configuration is given, the B<interface>-plugin will collect data from
3551 all interfaces. This may not be practical, especially for loopback- and
3552 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3553 interfaces you're interested in. Sometimes, however, it's easier/preferred
3554 to collect all interfaces I<except> a few ones. This option enables you to
3555 do that: By setting B<IgnoreSelected> to I<true> the effect of
3556 B<Interface> is inverted: All selected interfaces are ignored and all
3557 other interfaces are collected.
3559 It is possible to use regular expressions to match interface names, if the
3560 name is surrounded by I</.../> and collectd was compiled with support for
3561 regexps. This is useful if there's a need to collect (or ignore) data
3562 for a group of interfaces that are similarly named, without the need to
3563 explicitly list all of them (especially useful if the list is dynamic).
3568 Interface "/^tun[0-9]+/"
3569 IgnoreSelected "true"
3571 This will ignore the loopback interface, all interfaces with names starting
3572 with I<veth> and all interfaces with names starting with I<tun> followed by
3575 =item B<ReportInactive> I<true>|I<false>
3577 When set to I<false>, only interfaces with non-zero traffic will be
3578 reported. Note that the check is done by looking into whether a
3579 package was sent at any time from boot and the corresponding counter
3580 is non-zero. So, if the interface has been sending data in the past
3581 since boot, but not during the reported time-interval, it will still
3584 The default value is I<true> and results in collection of the data
3585 from all interfaces that are selected by B<Interface> and
3586 B<IgnoreSelected> options.
3588 =item B<UniqueName> I<true>|I<false>
3590 Interface name is not unique on Solaris (KSTAT), interface name is unique
3591 only within a module/instance. Following tuple is considered unique:
3592 (ks_module, ks_instance, ks_name)
3593 If this option is set to true, interface name contains above three fields
3594 separated by an underscore. For more info on KSTAT, visit
3595 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3597 This option is only available on Solaris.
3601 =head2 Plugin C<ipmi>
3603 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3604 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3606 The plugin configuration consists of one or more B<Instance> blocks which
3607 specify one I<ipmi> connection each. Each block requires one unique string
3608 argument as the instance name. If instances are not configured, an instance with
3609 the default option values will be created.
3611 For backwards compatibility, any option other than B<Instance> block will trigger
3612 legacy config handling and it will be treated as an option within B<Instance>
3613 block. This support will go away in the next major version of Collectd.
3615 Within the B<Instance> blocks, the following options are allowed:
3619 =item B<Address> I<Address>
3621 Hostname or IP to connect to. If not specified, plugin will try to connect to
3622 local management controller (BMC).
3624 =item B<Username> I<Username>
3626 =item B<Password> I<Password>
3628 The username and the password to use for the connection to remote BMC.
3630 =item B<AuthType> I<MD5>|I<rmcp+>
3632 Forces the authentication type to use for the connection to remote BMC.
3633 By default most secure type is seleted.
3635 =item B<Host> I<Hostname>
3637 Sets the B<host> field of dispatched values. Defaults to the global hostname
3640 =item B<Sensor> I<Sensor>
3642 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3644 See F</"IGNORELISTS"> for details.
3646 =item B<IgnoreSelected> I<true>|I<false>
3648 If no configuration if given, the B<ipmi> plugin will collect data from all
3649 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3650 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3651 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3652 all other sensors are collected.
3654 =item B<NotifySensorAdd> I<true>|I<false>
3656 If a sensor appears after initialization time of a minute a notification
3659 =item B<NotifySensorRemove> I<true>|I<false>
3661 If a sensor disappears a notification is sent.
3663 =item B<NotifySensorNotPresent> I<true>|I<false>
3665 If you have for example dual power supply and one of them is (un)plugged then
3666 a notification is sent.
3668 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3670 If a IPMI connection state changes after initialization time of a minute
3671 a notification is sent. Defaults to B<false>.
3673 =item B<SELEnabled> I<true>|I<false>
3675 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3676 and discrete events. When event is received the notification is sent.
3677 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3679 Defaults to B<false>.
3681 =item B<SELSensor> I<SELSensor>
3683 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3685 See F</"IGNORELISTS"> for details.
3687 =item B<SELIgnoreSelected> I<true>|I<false>
3689 If no configuration is given, the B<ipmi> plugin will pass events from all
3690 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3691 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3692 sensors are ignored and all events from other sensors are passed.
3694 =item B<SELClearEvent> I<true>|I<false>
3696 If SEL clear event is enabled, plugin will delete event from SEL list after
3697 it is received and successfully handled. In this case other tools that are
3698 subscribed for SEL events will receive an empty event.
3699 Defaults to B<false>.
3703 =head2 Plugin C<iptables>
3707 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3709 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3711 Select the iptables/ip6tables filter rules to count packets and bytes from.
3713 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3714 of all rules which have a comment-match. The comment is then used as
3717 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3718 the I<n>th rule will be collected. Again, the comment (or the number) will be
3719 used as the type-instance.
3721 If I<Name> is supplied, it will be used as the type-instance instead of the
3722 comment or the number.
3726 =head2 Plugin C<irq>
3732 Select this irq. By default these irqs will then be collected. For a more
3733 detailed description see B<IgnoreSelected> below.
3735 See F</"IGNORELISTS"> for details.
3737 =item B<IgnoreSelected> I<true>|I<false>
3739 If no configuration if given, the B<irq>-plugin will collect data from all
3740 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3741 can use the B<Irq>-option to pick the interrupt you're interested in.
3742 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3743 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3744 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3745 and all other interrupts are collected.
3749 =head2 Plugin C<java>
3751 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3752 This section only discusses the syntax and semantic of the configuration
3753 options. For more in-depth information on the I<Java> plugin, please read
3754 L<collectd-java(5)>.
3759 JVMArg "-verbose:jni"
3760 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3761 LoadPlugin "org.collectd.java.Foobar"
3762 <Plugin "org.collectd.java.Foobar">
3763 # To be parsed by the plugin
3767 Available configuration options:
3771 =item B<JVMArg> I<Argument>
3773 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3774 exactly the way the arguments to the I<java> binary on the command line work.
3775 Execute C<javaE<nbsp>--help> for details.
3777 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3778 any other options! When another option is found, the JVM will be started and
3779 later options will have to be ignored!
3781 =item B<LoadPlugin> I<JavaClass>
3783 Instantiates a new I<JavaClass> object. The constructor of this object very
3784 likely then registers one or more callback methods with the server.
3786 See L<collectd-java(5)> for details.
3788 When the first such option is found, the virtual machine (JVM) is created. This
3789 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3790 B<LoadPlugin> options!
3792 =item B<Plugin> I<Name>
3794 The entire block is passed to the Java plugin as an
3795 I<org.collectd.api.OConfigItem> object.
3797 For this to work, the plugin has to register a configuration callback first,
3798 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3799 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3800 depends on the (Java) plugin registering the callback and is completely
3801 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3805 =head2 Plugin C<load>
3807 The I<Load plugin> collects the system load. These numbers give a rough overview
3808 over the utilization of a machine. The system load is defined as the number of
3809 runnable tasks in the run-queue and is provided by many operating systems as a
3810 one, five or fifteen minute average.
3812 The following configuration options are available:
3816 =item B<ReportRelative> B<false>|B<true>
3818 When enabled, system load divided by number of available CPU cores is reported
3819 for intervals 1 min, 5 min and 15 min. Defaults to false.
3824 =head2 Plugin C<logfile>
3828 =item B<LogLevel> B<debug|info|notice|warning|err>
3830 Sets the log-level. If, for example, set to B<notice>, then all events with
3831 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3833 Please note that B<debug> is only available if collectd has been compiled with
3836 =item B<File> I<File>
3838 Sets the file to write log messages to. The special strings B<stdout> and
3839 B<stderr> can be used to write to the standard output and standard error
3840 channels, respectively. This, of course, only makes much sense when I<collectd>
3841 is running in foreground- or non-daemon-mode.
3843 =item B<Timestamp> B<true>|B<false>
3845 Prefix all lines printed by the current time. Defaults to B<true>.
3847 =item B<PrintSeverity> B<true>|B<false>
3849 When enabled, all lines are prefixed by the severity of the log message, for
3850 example "warning". Defaults to B<false>.
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<log_logstash>
3860 The I<log logstash plugin> behaves like the logfile plugin but formats
3861 messages as JSON events for logstash to parse and input.
3865 =item B<LogLevel> B<debug|info|notice|warning|err>
3867 Sets the log-level. If, for example, set to B<notice>, then all events with
3868 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3870 Please note that B<debug> is only available if collectd has been compiled with
3873 =item B<File> I<File>
3875 Sets the file to write log messages to. The special strings B<stdout> and
3876 B<stderr> can be used to write to the standard output and standard error
3877 channels, respectively. This, of course, only makes much sense when I<collectd>
3878 is running in foreground- or non-daemon-mode.
3882 B<Note>: There is no need to notify the daemon after moving or removing the
3883 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3884 for each line it writes.
3886 =head2 Plugin C<lpar>
3888 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3889 virtualization technique for IBM POWER processors. It takes into account CPU
3890 time stolen from or donated to a partition, in addition to the usual user,
3891 system, I/O statistics.
3893 The following configuration options are available:
3897 =item B<CpuPoolStats> B<false>|B<true>
3899 When enabled, statistics about the processor pool are read, too. The partition
3900 needs to have pool authority in order to be able to acquire this information.
3903 =item B<ReportBySerial> B<false>|B<true>
3905 If enabled, the serial of the physical machine the partition is currently
3906 running on is reported as I<hostname> and the logical hostname of the machine
3907 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3908 used (just like other plugins) and the I<plugin instance> will be empty.
3913 =head2 Plugin C<lua>
3915 This plugin embeds a Lua interpreter into collectd and provides an interface
3916 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3919 =head2 Plugin C<mbmon>
3921 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3923 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3924 B<Host> and B<Port> options can be used to change these values, see below.
3925 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3926 timeouts may appear which may interfere with other statistics..
3928 C<mbmon> must be run with the -r option ("print TAG and Value format");
3929 Debian's F</etc/init.d/mbmon> script already does this, other people
3930 will need to ensure that this is the case.
3934 =item B<Host> I<Hostname>
3936 Hostname to connect to. Defaults to B<127.0.0.1>.
3938 =item B<Port> I<Port>
3940 TCP-Port to connect to. Defaults to B<411>.
3944 =head2 Plugin C<mcelog>
3946 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3948 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3949 mcelog server is running. When the server is running, the plugin will tail the
3950 specified logfile to retrieve machine check exception information and send a
3951 notification with the details from the logfile. The plugin will use the mcelog
3952 client protocol to retrieve memory related machine check exceptions. Note that
3953 for memory exceptions, notifications are only sent when there is a change in
3954 the number of corrected/uncorrected memory errors.
3956 =head3 The Memory block
3958 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3963 =item B<McelogClientSocket> I<Path>
3964 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3965 Defaults to B<"/var/run/mcelog-client">.
3967 =item B<PersistentNotification> B<true>|B<false>
3968 Override default configuration to only send notifications when sent when there
3969 is a change in the number of corrected/uncorrected memory errors. When set to
3970 true notifications will be sent for every read cycle. Default is false. Does
3971 not affect the stats being dispatched.
3977 =item B<McelogLogfile> I<Path>
3979 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3980 cannot be used in conjunction with the memory block options, they are mutually
3987 The C<md plugin> collects information from Linux Software-RAID devices (md).
3989 All reported values are of the type C<md_disks>. Reported type instances are
3990 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3991 I<missing> (physically absent) disks.
3995 =item B<Device> I<Device>
3997 Select md devices based on device name. The I<device name> is the basename of
3998 the device, i.e. the name of the block device without the leading C</dev/>.
3999 See B<IgnoreSelected> for more details.
4001 See F</"IGNORELISTS"> for details.
4003 =item B<IgnoreSelected> B<true>|B<false>
4005 Invert device selection: If set to B<true>, all md devices B<except> those
4006 listed using B<Device> are collected. If B<false> (the default), only those
4007 listed are collected. If no configuration is given, the B<md> plugin will
4008 collect data from all md devices.
4012 =head2 Plugin C<memcachec>
4014 The C<memcachec plugin> connects to a memcached server, queries one or more
4015 given I<pages> and parses the returned data according to user specification.
4016 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4019 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4020 library. Please note that there is another library with a very similar name,
4021 libmemcache (notice the missing `d'), which is not applicable.
4023 Synopsis of the configuration:
4025 <Plugin "memcachec">
4026 <Page "plugin_instance">
4029 Plugin "plugin_name"
4031 Regex "(\\d+) bytes sent"
4034 Instance "type_instance"
4039 The configuration options are:
4043 =item E<lt>B<Page> I<Name>E<gt>
4045 Each B<Page> block defines one I<page> to be queried from the memcached server.
4046 The block requires one string argument which is used as I<plugin instance>.
4048 =item B<Server> I<Address>
4050 Sets the server address to connect to when querying the page. Must be inside a
4055 When connected to the memcached server, asks for the page I<Key>.
4057 =item B<Plugin> I<Plugin>
4059 Use I<Plugin> as the plugin name when submitting values.
4060 Defaults to C<memcachec>.
4062 =item E<lt>B<Match>E<gt>
4064 Match blocks define which strings to look for and how matches substrings are
4065 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4069 =head2 Plugin C<memcached>
4071 The B<memcached plugin> connects to a memcached server and queries statistics
4072 about cache utilization, memory and bandwidth used.
4073 L<http://memcached.org/>
4075 <Plugin "memcached">
4077 #Host "memcache.example.com"
4083 The plugin configuration consists of one or more B<Instance> blocks which
4084 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4085 following options are allowed:
4089 =item B<Host> I<Hostname>
4091 Sets the B<host> field of dispatched values. Defaults to the global hostname
4093 For backwards compatibility, values are also dispatched with the global
4094 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4097 =item B<Address> I<Address>
4099 Hostname or IP to connect to. For backwards compatibility, defaults to the
4100 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4102 =item B<Port> I<Port>
4104 TCP port to connect to. Defaults to B<11211>.
4106 =item B<Socket> I<Path>
4108 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4109 setting is given, the B<Address> and B<Port> settings are ignored.
4113 =head2 Plugin C<mic>
4115 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4116 Intel's Many Integrated Core (MIC) systems.
4125 ShowTemperatures true
4128 IgnoreSelectedTemperature true
4133 IgnoreSelectedPower true
4136 The following options are valid inside the B<PluginE<nbsp>mic> block:
4140 =item B<ShowCPU> B<true>|B<false>
4142 If enabled (the default) a sum of the CPU usage across all cores is reported.
4144 =item B<ShowCPUCores> B<true>|B<false>
4146 If enabled (the default) per-core CPU usage is reported.
4148 =item B<ShowMemory> B<true>|B<false>
4150 If enabled (the default) the physical memory usage of the MIC system is
4153 =item B<ShowTemperatures> B<true>|B<false>
4155 If enabled (the default) various temperatures of the MIC system are reported.
4157 =item B<Temperature> I<Name>
4159 This option controls which temperatures are being reported. Whether matching
4160 temperatures are being ignored or I<only> matching temperatures are reported
4161 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4162 temperatures are reported.
4164 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4166 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4167 (the default) only temperatures matching a B<Temperature> option are reported
4168 or, if no B<Temperature> option is specified, all temperatures are reported. If
4169 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4172 Known temperature names are:
4206 =item B<ShowPower> B<true>|B<false>
4208 If enabled (the default) various temperatures of the MIC system are reported.
4210 =item B<Power> I<Name>
4212 This option controls which power readings are being reported. Whether matching
4213 power readings are being ignored or I<only> matching power readings are reported
4214 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4215 power readings are reported.
4217 =item B<IgnoreSelectedPower> B<false>|B<true>
4219 Controls the behavior of the B<Power> setting above. If set to B<false>
4220 (the default) only power readings matching a B<Power> option are reported
4221 or, if no B<Power> option is specified, all power readings are reported. If
4222 set to B<true>, matching power readings are I<ignored> and all other power readings
4225 Known power names are:
4231 Total power utilization averaged over Time Window 0 (uWatts).
4235 Total power utilization averaged over Time Window 0 (uWatts).
4239 Instantaneous power (uWatts).
4243 Max instantaneous power (uWatts).
4247 PCI-E connector power (uWatts).
4251 2x3 connector power (uWatts).
4255 2x4 connector power (uWatts).
4263 Uncore rail (uVolts).
4267 Memory subsystem rail (uVolts).
4273 =head2 Plugin C<memory>
4275 The I<memory plugin> provides the following configuration options:
4279 =item B<ValuesAbsolute> B<true>|B<false>
4281 Enables or disables reporting of physical memory usage in absolute numbers,
4282 i.e. bytes. Defaults to B<true>.
4284 =item B<ValuesPercentage> B<false>|B<true>
4286 Enables or disables reporting of physical memory usage in percentages, e.g.
4287 percent of physical memory used. Defaults to B<false>.
4289 This is useful for deploying I<collectd> in a heterogeneous environment in
4290 which the sizes of physical memory vary.
4294 =head2 Plugin C<modbus>
4296 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4297 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4298 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4299 floating point values (two registers interpreted as IEEE floats in big endian
4304 <Data "voltage-input-1">
4307 RegisterCmd ReadHolding
4314 <Data "voltage-input-2">
4317 RegisterCmd ReadHolding
4322 <Data "supply-temperature-1">
4325 RegisterCmd ReadHolding
4330 <Host "modbus.example.com">
4331 Address "192.168.0.42"
4336 Instance "power-supply"
4337 Collect "voltage-input-1"
4338 Collect "voltage-input-2"
4343 Device "/dev/ttyUSB0"
4348 Instance "temperature"
4349 Collect "supply-temperature-1"
4355 =item E<lt>B<Data> I<Name>E<gt> blocks
4357 Data blocks define a mapping between register numbers and the "types" used by
4360 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4364 =item B<RegisterBase> I<Number>
4366 Configures the base register to read from the device. If the option
4367 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4368 register will be read (the register number is increased by one).
4370 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4372 Specifies what kind of data is returned by the device. This defaults to
4373 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4374 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4375 and B<RegisterBase+1> will be read and the data is combined into one
4376 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4377 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4378 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4379 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4380 registers are swapped with the most significant 16E<nbsp>bits in
4381 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4382 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4383 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4384 B<RegisterBase+3> will be read and the data combined into one
4387 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4389 Specifies register type to be collected from device. Works only with libmodbus
4390 2.9.2 or higher. Defaults to B<ReadHolding>.
4392 =item B<Type> I<Type>
4394 Specifies the "type" (data set) to use when dispatching the value to
4395 I<collectd>. Currently, only data sets with exactly one data source are
4398 =item B<Instance> I<Instance>
4400 Sets the type instance to use when dispatching the value to I<Instance>. If
4401 unset, an empty string (no type instance) is used.
4403 =item B<Scale> I<Value>
4405 The values taken from device are multiplied by I<Value>. The field is optional
4406 and the default is B<1.0>.
4408 =item B<Shift> I<Value>
4410 I<Value> is added to values from device after they have been multiplied by
4411 B<Scale> value. The field is optional and the default value is B<0.0>.
4415 =item E<lt>B<Host> I<Name>E<gt> blocks
4417 Host blocks are used to specify to which hosts to connect and what data to read
4418 from their "slaves". The string argument I<Name> is used as hostname when
4419 dispatching the values to I<collectd>.
4421 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4425 =item B<Address> I<Hostname>
4427 For Modbus/TCP, specifies the node name (the actual network address) used to
4428 connect to the host. This may be an IP address or a hostname. Please note that
4429 the used I<libmodbus> library only supports IPv4 at the moment.
4431 =item B<Port> I<Service>
4433 for Modbus/TCP, specifies the port used to connect to the host. The port can
4434 either be given as a number or as a service name. Please note that the
4435 I<Service> argument must be a string, even if ports are given in their numerical
4436 form. Defaults to "502".
4438 =item B<Device> I<Devicenode>
4440 For Modbus/RTU, specifies the path to the serial device being used.
4442 =item B<Baudrate> I<Baudrate>
4444 For Modbus/RTU, specifies the baud rate of the serial device.
4445 Note, connections currently support only 8/N/1.
4447 =item B<Interval> I<Interval>
4449 Sets the interval (in seconds) in which the values will be collected from this
4450 host. By default the global B<Interval> setting will be used.
4452 =item E<lt>B<Slave> I<ID>E<gt>
4454 Over each connection, multiple Modbus devices may be reached. The slave ID
4455 is used to specify which device should be addressed. For each device you want
4456 to query, one B<Slave> block must be given.
4458 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4462 =item B<Instance> I<Instance>
4464 Specify the plugin instance to use when dispatching the values to I<collectd>.
4465 By default "slave_I<ID>" is used.
4467 =item B<Collect> I<DataName>
4469 Specifies which data to retrieve from the device. I<DataName> must be the same
4470 string as the I<Name> argument passed to a B<Data> block. You can specify this
4471 option multiple times to collect more than one value from a slave. At least one
4472 B<Collect> option is mandatory.
4480 =head2 Plugin C<mqtt>
4482 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4483 values from MQTT (B<Subscribe> blocks).
4489 Host "mqtt.example.com"
4493 Host "mqtt.example.com"
4498 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4499 configuring the sending and receiving direction respectively. The plugin will
4500 register a write callback named C<mqtt/I<name>> where I<name> is the string
4501 argument given to the B<Publish> block. Both types of blocks share many but not
4502 all of the following options. If an option is valid in only one of the blocks,
4503 it will be mentioned explicitly.
4509 =item B<Host> I<Hostname>
4511 Hostname of the MQTT broker to connect to.
4513 =item B<Port> I<Service>
4515 Port number or service name of the MQTT broker to connect to.
4517 =item B<User> I<UserName>
4519 Username used when authenticating to the MQTT broker.
4521 =item B<Password> I<Password>
4523 Password used when authenticating to the MQTT broker.
4525 =item B<ClientId> I<ClientId>
4527 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4529 =item B<QoS> [B<0>-B<2>]
4531 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4549 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4550 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4551 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4552 on a message is larger than the maximum accepted QoS of a subscriber, the
4553 message's QoS will be downgraded.
4555 =item B<Prefix> I<Prefix> (Publish only)
4557 This plugin will use one topic per I<value list> which will looks like a path.
4558 I<Prefix> is used as the first path element and defaults to B<collectd>.
4560 An example topic name would be:
4562 collectd/cpu-0/cpu-user
4564 =item B<Retain> B<false>|B<true> (Publish only)
4566 Controls whether the MQTT broker will retain (keep a copy of) the last message
4567 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4569 =item B<StoreRates> B<true>|B<false> (Publish only)
4571 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4572 before sending. Defaults to B<true>.
4574 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4576 Controls whether the MQTT "cleans" the session up after the subscriber
4577 disconnects or if it maintains the subscriber's subscriptions and all messages
4578 that arrive while the subscriber is disconnected. Defaults to B<true>.
4580 =item B<Topic> I<TopicName> (Subscribe only)
4582 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4583 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4584 the B<collectd> branch.
4586 =item B<CACert> I<file>
4588 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4589 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4590 port of the MQTT broker.
4591 This option enables the use of TLS.
4593 =item B<CertificateFile> I<file>
4595 Path to the PEM-encoded certificate file to use as client certificate when
4596 connecting to the MQTT broker.
4597 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4599 =item B<CertificateKeyFile> I<file>
4601 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4602 Only valid if B<CACert> and B<CertificateFile> are also set.
4604 =item B<TLSProtocol> I<protocol>
4606 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4607 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4608 version is used which depends on the version of OpenSSL the Mosquitto library
4610 Only valid if B<CACert> is set.
4612 =item B<CipherSuite> I<ciphersuite>
4614 A string describing the ciphers available for use. See L<ciphers(1)> and the
4615 C<openssl ciphers> utility for more information. If unset, the default ciphers
4617 Only valid if B<CACert> is set.
4621 =head2 Plugin C<mysql>
4623 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4624 one or more databases when started and keeps the connection up as long as
4625 possible. When the connection is interrupted for whatever reason it will try
4626 to re-connect. The plugin will complain loudly in case anything goes wrong.
4628 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4629 and collects information about MySQL network traffic, executed statements,
4630 requests, the query cache and threads by evaluating the
4631 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4632 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4633 Status Variables> for an explanation of these values.
4635 Optionally, master and slave statistics may be collected in a MySQL
4636 replication setup. In that case, information about the synchronization state
4637 of the nodes are collected by evaluating the C<Position> return value of the
4638 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4639 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4640 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4641 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4642 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4654 SSLKey "/path/to/key.pem"
4655 SSLCert "/path/to/cert.pem"
4656 SSLCA "/path/to/ca.pem"
4657 SSLCAPath "/path/to/cas/"
4658 SSLCipher "DHE-RSA-AES256-SHA"
4664 Socket "/var/run/mysql/mysqld.sock"
4666 SlaveNotifications true
4672 Socket "/var/run/mysql/mysqld.sock"
4677 A B<Database> block defines one connection to a MySQL database. It accepts a
4678 single argument which specifies the name of the database. None of the other
4679 options are required. MySQL will use default values as documented in the
4680 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4681 B<MySQL reference manual>.
4685 =item B<Alias> I<Alias>
4687 Alias to use as sender instead of hostname when reporting. This may be useful
4688 when having cryptic hostnames.
4690 =item B<Host> I<Hostname>
4692 Hostname of the database server. Defaults to B<localhost>.
4694 =item B<User> I<Username>
4696 Username to use when connecting to the database. The user does not have to be
4697 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4698 unless you want to collectd replication statistics (see B<MasterStats> and
4699 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4700 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4702 =item B<Password> I<Password>
4704 Password needed to log into the database.
4706 =item B<Database> I<Database>
4708 Select this database. Defaults to I<no database> which is a perfectly reasonable
4709 option for what this plugin does.
4711 =item B<Port> I<Port>
4713 TCP-port to connect to. The port must be specified in its numeric form, but it
4714 must be passed as a string nonetheless. For example:
4718 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4719 See the documentation for the C<mysql_real_connect> function for details.
4721 =item B<Socket> I<Socket>
4723 Specifies the path to the UNIX domain socket of the MySQL server. This option
4724 only has any effect, if B<Host> is set to B<localhost> (the default).
4725 Otherwise, use the B<Port> option above. See the documentation for the
4726 C<mysql_real_connect> function for details.
4728 =item B<InnodbStats> I<true|false>
4730 If enabled, metrics about the InnoDB storage engine are collected.
4731 Disabled by default.
4733 =item B<MasterStats> I<true|false>
4735 =item B<SlaveStats> I<true|false>
4737 Enable the collection of master / slave statistics in a replication setup. In
4738 order to be able to get access to these statistics, the user needs special
4739 privileges. See the B<User> documentation above. Defaults to B<false>.
4741 =item B<SlaveNotifications> I<true|false>
4743 If enabled, the plugin sends a notification if the replication slave I/O and /
4744 or SQL threads are not running. Defaults to B<false>.
4746 =item B<WsrepStats> I<true|false>
4748 Enable the collection of wsrep plugin statistics, used in Master-Master
4749 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4750 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4752 =item B<ConnectTimeout> I<Seconds>
4754 Sets the connect timeout for the MySQL client.
4756 =item B<SSLKey> I<Path>
4758 If provided, the X509 key in PEM format.
4760 =item B<SSLCert> I<Path>
4762 If provided, the X509 cert in PEM format.
4764 =item B<SSLCA> I<Path>
4766 If provided, the CA file in PEM format (check OpenSSL docs).
4768 =item B<SSLCAPath> I<Path>
4770 If provided, the CA directory (check OpenSSL docs).
4772 =item B<SSLCipher> I<String>
4774 If provided, the SSL cipher to use.
4778 =head2 Plugin C<netapp>
4780 The netapp plugin can collect various performance and capacity information
4781 from a NetApp filer using the NetApp API.
4783 Please note that NetApp has a wide line of products and a lot of different
4784 software versions for each of these products. This plugin was developed for a
4785 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4786 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4787 model and software version but it is very hard to test this.
4788 If you have used this plugin with other models and/or software version, feel
4789 free to send us a mail to tell us about the results, even if it's just a short
4792 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4793 basic authentication.
4795 B<Do not use a regular user for this!> Create a special collectd user with just
4796 the minimum of capabilities needed. The user only needs the "login-http-admin"
4797 capability as well as a few more depending on which data will be collected.
4798 Required capabilities are documented below.
4803 <Host "netapp1.example.com">
4827 IgnoreSelectedIO false
4829 IgnoreSelectedOps false
4830 GetLatency "volume0"
4831 IgnoreSelectedLatency false
4838 IgnoreSelectedCapacity false
4841 IgnoreSelectedSnapshot false
4869 The netapp plugin accepts the following configuration options:
4873 =item B<Host> I<Name>
4875 A host block defines one NetApp filer. It will appear in collectd with the name
4876 you specify here which does not have to be its real name nor its hostname (see
4877 the B<Address> option below).
4879 =item B<VFiler> I<Name>
4881 A B<VFiler> block may only be used inside a host block. It accepts all the
4882 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4883 will execute all NetApp API commands in the context of the specified
4884 VFiler(R). It will appear in collectd with the name you specify here which
4885 does not have to be its real name. The VFiler name may be specified using the
4886 B<VFilerName> option. If this is not specified, it will default to the name
4889 The VFiler block inherits all connection related settings from the surrounding
4890 B<Host> block (which appear before the B<VFiler> block) but they may be
4891 overwritten inside the B<VFiler> block.
4893 This feature is useful, for example, when using a VFiler as SnapVault target
4894 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4895 available in the host filer (vfiler0) but only in the respective VFiler
4898 =item B<Protocol> B<httpd>|B<http>
4900 The protocol collectd will use to query this host.
4908 Valid options: http, https
4910 =item B<Address> I<Address>
4912 The hostname or IP address of the host.
4918 Default: The "host" block's name.
4920 =item B<Port> I<Port>
4922 The TCP port to connect to on the host.
4928 Default: 80 for protocol "http", 443 for protocol "https"
4930 =item B<User> I<User>
4932 =item B<Password> I<Password>
4934 The username and password to use to login to the NetApp.
4940 =item B<VFilerName> I<Name>
4942 The name of the VFiler in which context to execute API commands. If not
4943 specified, the name provided to the B<VFiler> block will be used instead.
4949 Default: name of the B<VFiler> block
4951 B<Note:> This option may only be used inside B<VFiler> blocks.
4953 =item B<Interval> I<Interval>
4959 The following options decide what kind of data will be collected. You can
4960 either use them as a block and fine tune various parameters inside this block,
4961 use them as a single statement to just accept all default values, or omit it to
4962 not collect any data.
4964 The following options are valid inside all blocks:
4968 =item B<Interval> I<Seconds>
4970 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4971 host specific setting.
4975 =head3 The System block
4977 This will collect various performance data about the whole system.
4979 B<Note:> To get this data the collectd user needs the
4980 "api-perf-object-get-instances" capability.
4984 =item B<Interval> I<Seconds>
4986 Collect disk statistics every I<Seconds> seconds.
4988 =item B<GetCPULoad> B<true>|B<false>
4990 If you set this option to true the current CPU usage will be read. This will be
4991 the average usage between all CPUs in your NetApp without any information about
4994 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4995 returns in the "CPU" field.
5003 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5005 =item B<GetInterfaces> B<true>|B<false>
5007 If you set this option to true the current traffic of the network interfaces
5008 will be read. This will be the total traffic over all interfaces of your NetApp
5009 without any information about individual interfaces.
5011 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5012 in the "Net kB/s" field.
5022 Result: One value list of type "if_octects".
5024 =item B<GetDiskIO> B<true>|B<false>
5026 If you set this option to true the current IO throughput will be read. This
5027 will be the total IO of your NetApp without any information about individual
5028 disks, volumes or aggregates.
5030 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5031 in the "DiskE<nbsp>kB/s" field.
5039 Result: One value list of type "disk_octets".
5041 =item B<GetDiskOps> B<true>|B<false>
5043 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5044 iSCSI, etc. operations will be read. This will be the total number of
5045 operations on your NetApp without any information about individual volumes or
5048 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5049 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5057 Result: A variable number of value lists of type "disk_ops_complex". Each type
5058 of operation will result in one value list with the name of the operation as
5063 =head3 The WAFL block
5065 This will collect various performance data about the WAFL file system. At the
5066 moment this just means cache performance.
5068 B<Note:> To get this data the collectd user needs the
5069 "api-perf-object-get-instances" capability.
5071 B<Note:> The interface to get these values is classified as "Diagnostics" by
5072 NetApp. This means that it is not guaranteed to be stable even between minor
5077 =item B<Interval> I<Seconds>
5079 Collect disk statistics every I<Seconds> seconds.
5081 =item B<GetNameCache> B<true>|B<false>
5089 Result: One value list of type "cache_ratio" and type instance
5092 =item B<GetDirCache> B<true>|B<false>
5100 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5102 =item B<GetInodeCache> B<true>|B<false>
5110 Result: One value list of type "cache_ratio" and type instance
5113 =item B<GetBufferCache> B<true>|B<false>
5115 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5116 in the "Cache hit" field.
5124 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5128 =head3 The Disks block
5130 This will collect performance data about the individual disks in the NetApp.
5132 B<Note:> To get this data the collectd user needs the
5133 "api-perf-object-get-instances" capability.
5137 =item B<Interval> I<Seconds>
5139 Collect disk statistics every I<Seconds> seconds.
5141 =item B<GetBusy> B<true>|B<false>
5143 If you set this option to true the busy time of all disks will be calculated
5144 and the value of the busiest disk in the system will be written.
5146 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5147 in the "Disk util" field. Probably.
5155 Result: One value list of type "percent" and type instance "disk_busy".
5159 =head3 The VolumePerf block
5161 This will collect various performance data about the individual volumes.
5163 You can select which data to collect about which volume using the following
5164 options. They follow the standard ignorelist semantic.
5166 B<Note:> To get this data the collectd user needs the
5167 I<api-perf-object-get-instances> capability.
5171 =item B<Interval> I<Seconds>
5173 Collect volume performance data every I<Seconds> seconds.
5175 =item B<GetIO> I<Volume>
5177 =item B<GetOps> I<Volume>
5179 =item B<GetLatency> I<Volume>
5181 Select the given volume for IO, operations or latency statistics collection.
5182 The argument is the name of the volume without the C</vol/> prefix.
5184 Since the standard ignorelist functionality is used here, you can use a string
5185 starting and ending with a slash to specify regular expression matching: To
5186 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5189 GetIO "/^vol[027]$/"
5191 If no regular expression is specified, an exact match is required. Both,
5192 regular and exact matching are case sensitive.
5194 If no volume was specified at all for either of the three options, that data
5195 will be collected for all available volumes.
5197 See F</"IGNORELISTS"> for details.
5199 =item B<IgnoreSelectedIO> B<true>|B<false>
5201 =item B<IgnoreSelectedOps> B<true>|B<false>
5203 =item B<IgnoreSelectedLatency> B<true>|B<false>
5205 When set to B<true>, the volumes selected for IO, operations or latency
5206 statistics collection will be ignored and the data will be collected for all
5209 When set to B<false>, data will only be collected for the specified volumes and
5210 all other volumes will be ignored.
5212 If no volumes have been specified with the above B<Get*> options, all volumes
5213 will be collected regardless of the B<IgnoreSelected*> option.
5215 Defaults to B<false>
5219 =head3 The VolumeUsage block
5221 This will collect capacity data about the individual volumes.
5223 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5228 =item B<Interval> I<Seconds>
5230 Collect volume usage statistics every I<Seconds> seconds.
5232 =item B<GetCapacity> I<VolumeName>
5234 The current capacity of the volume will be collected. This will result in two
5235 to four value lists, depending on the configuration of the volume. All data
5236 sources are of type "df_complex" with the name of the volume as
5239 There will be type_instances "used" and "free" for the number of used and
5240 available bytes on the volume. If the volume has some space reserved for
5241 snapshots, a type_instance "snap_reserved" will be available. If the volume
5242 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5243 number of bytes saved by the SIS feature.
5245 B<Note:> The current NetApp API has a bug that results in this value being
5246 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5247 number which works most of the time. If you see strange values here, bug
5248 NetApp support to fix this.
5250 Repeat this option to specify multiple volumes.
5252 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5254 Specify whether to collect only the volumes selected by the B<GetCapacity>
5255 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5256 B<false>. However, if no B<GetCapacity> option is specified at all, all
5257 capacities will be selected anyway.
5259 =item B<GetSnapshot> I<VolumeName>
5261 Select volumes from which to collect snapshot information.
5263 Usually, the space used for snapshots is included in the space reported as
5264 "used". If snapshot information is collected as well, the space used for
5265 snapshots is subtracted from the used space.
5267 To make things even more interesting, it is possible to reserve space to be
5268 used for snapshots. If the space required for snapshots is less than that
5269 reserved space, there is "reserved free" and "reserved used" space in addition
5270 to "free" and "used". If the space required for snapshots exceeds the reserved
5271 space, that part allocated in the normal space is subtracted from the "used"
5274 Repeat this option to specify multiple volumes.
5276 =item B<IgnoreSelectedSnapshot>
5278 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5279 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5280 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5281 capacities will be selected anyway.
5285 =head3 The Quota block
5287 This will collect (tree) quota statistics (used disk space and number of used
5288 files). This mechanism is useful to get usage information for single qtrees.
5289 In case the quotas are not used for any other purpose, an entry similar to the
5290 following in C</etc/quotas> would be sufficient:
5292 /vol/volA/some_qtree tree - - - - -
5294 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5298 =item B<Interval> I<Seconds>
5300 Collect SnapVault(R) statistics every I<Seconds> seconds.
5304 =head3 The SnapVault block
5306 This will collect statistics about the time and traffic of SnapVault(R)
5311 =item B<Interval> I<Seconds>
5313 Collect SnapVault(R) statistics every I<Seconds> seconds.
5317 =head2 Plugin C<netlink>
5319 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5320 statistics of various interface and routing aspects.
5324 =item B<Interface> I<Interface>
5326 =item B<VerboseInterface> I<Interface>
5328 Instruct the plugin to collect interface statistics. This is basically the same
5329 as the statistics provided by the C<interface> plugin (see above) but
5330 potentially much more detailed.
5332 When configuring with B<Interface> only the basic statistics will be collected,
5333 namely octets, packets, and errors. These statistics are collected by
5334 the C<interface> plugin, too, so using both at the same time is no benefit.
5336 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5337 so that no data needs to be collected twice if you use the C<interface> plugin.
5338 This includes dropped packets, received multicast packets, collisions and a
5339 whole zoo of differentiated RX and TX errors. You can try the following command
5340 to get an idea of what awaits you:
5344 If I<Interface> is B<All>, all interfaces will be selected.
5346 =item B<QDisc> I<Interface> [I<QDisc>]
5348 =item B<Class> I<Interface> [I<Class>]
5350 =item B<Filter> I<Interface> [I<Filter>]
5352 Collect the octets and packets that pass a certain qdisc, class or filter.
5354 QDiscs and classes are identified by their type and handle (or classid).
5355 Filters don't necessarily have a handle, therefore the parent's handle is used.
5356 The notation used in collectd differs from that used in tc(1) in that it
5357 doesn't skip the major or minor number if it's zero and doesn't print special
5358 ids by their name. So, for example, a qdisc may be identified by
5359 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5360 thus not displayed by tc(1).
5362 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5363 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5364 associated with that interface will be collected.
5366 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5367 used. This may lead to problems when more than one filter is attached to a
5368 qdisc or class. This isn't nice, but we don't know how this could be done any
5369 better. If you have a idea, please don't hesitate to tell us.
5371 As with the B<Interface> option you can specify B<All> as the interface,
5372 meaning all interfaces.
5374 Here are some examples to help you understand the above text more easily:
5377 VerboseInterface "All"
5378 QDisc "eth0" "pfifo_fast-1:0"
5380 Class "ppp0" "htb-1:10"
5381 Filter "ppp0" "u32-1:0"
5384 See F</"IGNORELISTS"> for details.
5386 =item B<IgnoreSelected>
5388 The behavior is the same as with all other similar plugins: If nothing is
5389 selected at all, everything is collected. If some things are selected using the
5390 options described above, only these statistics are collected. If you set
5391 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5392 specified statistics will not be collected.
5396 =head2 Plugin C<network>
5398 The Network plugin sends data to a remote instance of collectd, receives data
5399 from a remote instance, or both at the same time. Data which has been received
5400 from the network is usually not transmitted again, but this can be activated, see
5401 the B<Forward> option below.
5403 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5404 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5406 Both, B<Server> and B<Listen> can be used as single option or as block. When
5407 used as block, given options are valid for this socket only. The following
5408 example will export the metrics twice: Once to an "internal" server (without
5409 encryption and signing) and one to an external server (with cryptographic
5413 # Export to an internal server
5414 # (demonstrates usage without additional options)
5415 Server "collectd.internal.tld"
5417 # Export to an external server
5418 # (demonstrates usage with signature options)
5419 <Server "collectd.external.tld">
5420 SecurityLevel "sign"
5421 Username "myhostname"
5428 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5430 The B<Server> statement/block sets the server to send datagrams to. The
5431 statement may occur multiple times to send each datagram to multiple
5434 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5435 optional second argument specifies a port number or a service name. If not
5436 given, the default, B<25826>, is used.
5438 The following options are recognized within B<Server> blocks:
5442 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5444 Set the security you require for network communication. When the security level
5445 has been set to B<Encrypt>, data sent over the network will be encrypted using
5446 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5447 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5448 authentication code. When set to B<None>, data is sent without any security.
5450 This feature is only available if the I<network> plugin was linked with
5453 =item B<Username> I<Username>
5455 Sets the username to transmit. This is used by the server to lookup the
5456 password. See B<AuthFile> below. All security levels except B<None> require
5459 This feature is only available if the I<network> plugin was linked with
5462 =item B<Password> I<Password>
5464 Sets a password (shared secret) for this socket. All security levels except
5465 B<None> require this setting.
5467 This feature is only available if the I<network> plugin was linked with
5470 =item B<Interface> I<Interface name>
5472 Set the outgoing interface for IP packets. This applies at least
5473 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5474 undefined or a non-existent interface name is specified, the default
5475 behavior is to let the kernel choose the appropriate interface. Be warned
5476 that the manual selection of an interface for unicast traffic is only
5477 necessary in rare cases.
5479 =item B<BindAddress> I<IP Address>
5481 Set the outgoing IP address for IP packets. This option can be used instead of
5482 the I<Interface> option to explicitly define the IP address which will be used
5483 to send Packets to the remote server.
5485 =item B<ResolveInterval> I<Seconds>
5487 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5488 useful to force a regular DNS lookup to support a high availability setup. If
5489 not specified, re-resolves are never attempted.
5493 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5495 The B<Listen> statement sets the interfaces to bind to. When multiple
5496 statements are found the daemon will bind to multiple interfaces.
5498 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5499 the argument is a multicast address the daemon will join that multicast group.
5500 The optional second argument specifies a port number or a service name. If not
5501 given, the default, B<25826>, is used.
5503 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5507 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5509 Set the security you require for network communication. When the security level
5510 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5511 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5512 signed and encrypted data is accepted. When set to B<None>, all data will be
5513 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5514 decrypted if possible.
5516 This feature is only available if the I<network> plugin was linked with
5519 =item B<AuthFile> I<Filename>
5521 Sets a file in which usernames are mapped to passwords. These passwords are
5522 used to verify signatures and to decrypt encrypted network packets. If
5523 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5524 verified and encrypted packets are decrypted. Otherwise, signed data is
5525 accepted without checking the signature and encrypted data cannot be decrypted.
5526 For the other security levels this option is mandatory.
5528 The file format is very simple: Each line consists of a username followed by a
5529 colon and any number of spaces followed by the password. To demonstrate, an
5530 example file could look like this:
5535 Each time a packet is received, the modification time of the file is checked
5536 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5537 the file is being read, it is locked using L<fcntl(2)>.
5539 =item B<Interface> I<Interface name>
5541 Set the incoming interface for IP packets explicitly. This applies at least
5542 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5543 undefined or a non-existent interface name is specified, the default
5544 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5545 traffic gets only accepted, if it arrives on the given interface.
5549 =item B<TimeToLive> I<1-255>
5551 Set the time-to-live of sent packets. This applies to all, unicast and
5552 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5553 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5556 =item B<MaxPacketSize> I<1024-65535>
5558 Set the maximum size for datagrams received over the network. Packets larger
5559 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5560 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5563 On the server side, this limit should be set to the largest value used on
5564 I<any> client. Likewise, the value on the client must not be larger than the
5565 value on the server, or data will be lost.
5567 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5568 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5569 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5572 =item B<Forward> I<true|false>
5574 If set to I<true>, write packets that were received via the network plugin to
5575 the sending sockets. This should only be activated when the B<Listen>- and
5576 B<Server>-statements differ. Otherwise packets may be send multiple times to
5577 the same multicast group. While this results in more network traffic than
5578 necessary it's not a huge problem since the plugin has a duplicate detection,
5579 so the values will not loop.
5581 =item B<ReportStats> B<true>|B<false>
5583 The network plugin cannot only receive and send statistics, it can also create
5584 statistics about itself. Collectd data included the number of received and
5585 sent octets and packets, the length of the receive queue and the number of
5586 values handled. When set to B<true>, the I<Network plugin> will make these
5587 statistics available. Defaults to B<false>.
5591 =head2 Plugin C<nfs>
5593 The I<nfs plugin> collects information about the usage of the Network File
5594 System (NFS). It counts the number of procedure calls for each procedure,
5595 grouped by version and whether the system runs as server or client.
5597 It is possibly to omit metrics for a specific NFS version by setting one or
5598 more of the following options to B<false> (all of them default to B<true>).
5602 =item B<ReportV2> B<true>|B<false>
5604 =item B<ReportV3> B<true>|B<false>
5606 =item B<ReportV4> B<true>|B<false>
5610 =head2 Plugin C<nginx>
5612 This plugin collects the number of connections and requests handled by the
5613 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5614 queries the page provided by the C<ngx_http_stub_status_module> module, which
5615 isn't compiled by default. Please refer to
5616 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5617 how to compile and configure nginx and this module.
5619 The following options are accepted by the C<nginx plugin>:
5623 =item B<URL> I<http://host/nginx_status>
5625 Sets the URL of the C<ngx_http_stub_status_module> output.
5627 =item B<User> I<Username>
5629 Optional user name needed for authentication.
5631 =item B<Password> I<Password>
5633 Optional password needed for authentication.
5635 =item B<VerifyPeer> B<true|false>
5637 Enable or disable peer SSL certificate verification. See
5638 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5640 =item B<VerifyHost> B<true|false>
5642 Enable or disable peer host name verification. If enabled, the plugin checks
5643 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5644 certificate matches the host name provided by the B<URL> option. If this
5645 identity check fails, the connection is aborted. Obviously, only works when
5646 connecting to a SSL enabled server. Enabled by default.
5648 =item B<CACert> I<File>
5650 File that holds one or more SSL certificates. If you want to use HTTPS you will
5651 possibly need this option. What CA certificates come bundled with C<libcurl>
5652 and are checked by default depends on the distribution you use.
5654 =item B<Timeout> I<Milliseconds>
5656 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5657 milliseconds. By default, the configured B<Interval> is used to set the
5662 =head2 Plugin C<notify_desktop>
5664 This plugin sends a desktop notification to a notification daemon, as defined
5665 in the Desktop Notification Specification. To actually display the
5666 notifications, B<notification-daemon> is required and B<collectd> has to be
5667 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5668 environment variables have to be set correctly) and the D-Bus message bus.
5670 The Desktop Notification Specification can be found at
5671 L<http://www.galago-project.org/specs/notification/>.
5675 =item B<OkayTimeout> I<timeout>
5677 =item B<WarningTimeout> I<timeout>
5679 =item B<FailureTimeout> I<timeout>
5681 Set the I<timeout>, in milliseconds, after which to expire the notification
5682 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5683 been specified, the displayed notification will not be closed at all - the
5684 user has to do so herself. These options default to 5000. If a negative number
5685 has been specified, the default is used as well.
5689 =head2 Plugin C<notify_email>
5691 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5692 configured email address.
5694 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5696 Available configuration options:
5700 =item B<From> I<Address>
5702 Email address from which the emails should appear to come from.
5704 Default: C<root@localhost>
5706 =item B<Recipient> I<Address>
5708 Configures the email address(es) to which the notifications should be mailed.
5709 May be repeated to send notifications to multiple addresses.
5711 At least one B<Recipient> must be present for the plugin to work correctly.
5713 =item B<SMTPServer> I<Hostname>
5715 Hostname of the SMTP server to connect to.
5717 Default: C<localhost>
5719 =item B<SMTPPort> I<Port>
5721 TCP port to connect to.
5725 =item B<SMTPUser> I<Username>
5727 Username for ASMTP authentication. Optional.
5729 =item B<SMTPPassword> I<Password>
5731 Password for ASMTP authentication. Optional.
5733 =item B<Subject> I<Subject>
5735 Subject-template to use when sending emails. There must be exactly two
5736 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5737 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5740 Default: C<Collectd notify: %s@%s>
5744 =head2 Plugin C<notify_nagios>
5746 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5747 a I<passive service check result>.
5749 Available configuration options:
5753 =item B<CommandFile> I<Path>
5755 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5759 =head2 Plugin C<ntpd>
5761 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5764 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5765 the wire - using B<mode 7> specific requests. This mode is deprecated with
5766 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5767 correctly with them, the ntp daemon must be explicitly configured to
5768 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5769 manual page for details.
5771 Available configuration options for the C<ntpd> plugin:
5775 =item B<Host> I<Hostname>
5777 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5779 =item B<Port> I<Port>
5781 UDP-Port to connect to. Defaults to B<123>.
5783 =item B<ReverseLookups> B<true>|B<false>
5785 Sets whether or not to perform reverse lookups on peers. Since the name or
5786 IP-address may be used in a filename it is recommended to disable reverse
5787 lookups. The default is to do reverse lookups to preserve backwards
5788 compatibility, though.
5790 =item B<IncludeUnitID> B<true>|B<false>
5792 When a peer is a refclock, include the unit ID in the I<type instance>.
5793 Defaults to B<false> for backward compatibility.
5795 If two refclock peers use the same driver and this is B<false>, the plugin will
5796 try to write simultaneous measurements from both to the same type instance.
5797 This will result in error messages in the log and only one set of measurements
5802 =head2 Plugin C<nut>
5806 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5808 Add a UPS to collect data from. The format is identical to the one accepted by
5811 =item B<ForceSSL> B<true>|B<false>
5813 Stops connections from falling back to unsecured if an SSL connection
5814 cannot be established. Defaults to false if undeclared.
5816 =item B<VerifyPeer> I<true>|I<false>
5818 If set to true, requires a CAPath be provided. Will use the CAPath to find
5819 certificates to use as Trusted Certificates to validate a upsd server certificate.
5820 If validation of the upsd server certificate fails, the connection will not be
5821 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5822 will override and set ForceSSL to true.
5824 =item B<CAPath> I/path/to/certs/folder
5826 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5827 The folder pointed at must contain certificate(s) named according to their hash.
5828 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5829 occur because two different certs have the same hash value, Y can be incremented
5830 in order to avoid conflict. To create a symbolic link to a certificate the following
5831 command can be used from within the directory where the cert resides:
5833 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5835 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5836 generate links like the one described above for ALL certs in a given folder.
5838 C<c_rehash /path/to/certs/folder>
5840 =item B<ConnectTimeout> I<Milliseconds>
5842 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5843 By default, the configured B<Interval> is used to set the timeout.
5847 =head2 Plugin C<olsrd>
5849 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5850 the Optimized Link State Routing daemon and reads information about the current
5851 state of the meshed network.
5853 The following configuration options are understood:
5857 =item B<Host> I<Host>
5859 Connect to I<Host>. Defaults to B<"localhost">.
5861 =item B<Port> I<Port>
5863 Specifies the port to connect to. This must be a string, even if you give the
5864 port as a number rather than a service name. Defaults to B<"2006">.
5866 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5868 Specifies what information to collect about links, i.E<nbsp>e. direct
5869 connections of the daemon queried. If set to B<No>, no information is
5870 collected. If set to B<Summary>, the number of links and the average of all
5871 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5872 If set to B<Detail> LQ and NLQ are collected per link.
5874 Defaults to B<Detail>.
5876 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5878 Specifies what information to collect about routes of the daemon queried. If
5879 set to B<No>, no information is collected. If set to B<Summary>, the number of
5880 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5881 metric and ETX are collected per route.
5883 Defaults to B<Summary>.
5885 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5887 Specifies what information to collect about the global topology. If set to
5888 B<No>, no information is collected. If set to B<Summary>, the number of links
5889 in the entire topology and the average I<link quality> (LQ) is calculated.
5890 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5892 Defaults to B<Summary>.
5896 =head2 Plugin C<onewire>
5898 B<EXPERIMENTAL!> See notes below.
5900 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5901 L<http://owfs.org/> to read sensors connected via the onewire bus.
5903 It can be used in two possible modes - standard or advanced.
5905 In the standard mode only temperature sensors (sensors with the family code
5906 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5907 other sensors you would like to have included, please send a sort request to
5908 the mailing list. You can select sensors to be read or to be ignored depending
5909 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5910 walked and all sensors are read.
5912 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5913 experimental, below.
5915 In the advanced mode you can configure any sensor to be read (only numerical
5916 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5917 In this mode you have to list all the sensors. Neither default bus walk nor
5918 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5919 the path automatically and should produce compatible structure with the "standard"
5920 mode (basically the path is expected as for example
5921 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5922 "F10FCA000800" and the rest after the slash is considered the type - here
5924 There are two advantages to this mode - you can access virtually any sensor
5925 (not just temperature), select whether to use cached or directly read values
5926 and it is slighlty faster. The downside is more complex configuration.
5928 The two modes are distinguished automatically by the format of the address.
5929 It is not possible to mix the two modes. Once a full path is detected in any
5930 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5931 (and as standard addresses will fail parsing they will be ignored).
5935 =item B<Device> I<Device>
5937 Sets the device to read the values from. This can either be a "real" hardware
5938 device, such as a serial port or an USB port, or the address of the
5939 L<owserver(1)> socket, usually B<localhost:4304>.
5941 Though the documentation claims to automatically recognize the given address
5942 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5943 with that version, the following configuration worked for us:
5946 Device "-s localhost:4304"
5949 This directive is B<required> and does not have a default value.
5951 =item B<Sensor> I<Sensor>
5953 In the standard mode selects sensors to collect or to ignore
5954 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5955 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5956 and B<not> include the leading C<10.> family byte and point.
5957 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5958 sensors (see above) are read.
5960 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5961 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5962 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5964 As there can be multiple devices on the bus you can list multiple sensor (use
5965 multiple B<Sensor> elements).
5967 See F</"IGNORELISTS"> for details.
5969 =item B<IgnoreSelected> I<true>|I<false>
5971 If no configuration is given, the B<onewire> plugin will collect data from all
5972 sensors found. This may not be practical, especially if sensors are added and
5973 removed regularly. Sometimes, however, it's easier/preferred to collect only
5974 specific sensors or all sensors I<except> a few specified ones. This option
5975 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5976 B<Sensor> is inverted: All selected interfaces are ignored and all other
5977 interfaces are collected.
5979 Used only in the standard mode - see above.
5981 =item B<Interval> I<Seconds>
5983 Sets the interval in which all sensors should be read. If not specified, the
5984 global B<Interval> setting is used.
5988 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5989 work with big setups. It works with one sensor being attached to one
5990 controller, but as soon as you throw in a couple more senors and maybe a hub
5991 or two, reading all values will take more than ten seconds (the default
5992 interval). We will probably add some separate thread for reading the sensors
5993 and some cache or something like that, but it's not done yet. We will try to
5994 maintain backwards compatibility in the future, but we can't promise. So in
5995 short: If it works for you: Great! But keep in mind that the config I<might>
5996 change, though this is unlikely. Oh, and if you want to help improving this
5997 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5999 =head2 Plugin C<openldap>
6001 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
6002 server correctly. The backend database C<monitor> needs to be loaded and
6003 working. See slapd-monitor(5) for the details.
6005 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6006 blocks. Each block requires one string argument as the instance name. For
6011 URL "ldap://localhost/"
6014 URL "ldaps://localhost/"
6018 The instance name will be used as the I<plugin instance>. To emulate the old
6019 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6020 plugin to work correctly, each instance name must be unique. This is not
6021 enforced by the plugin and it is your responsibility to ensure it is.
6023 The following options are accepted within each B<Instance> block:
6027 =item B<URL> I<ldap://host/binddn>
6029 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6032 =item B<BindDN> I<BindDN>
6034 Name in the form of an LDAP distinguished name intended to be used for
6035 authentication. Defaults to empty string to establish an anonymous authorization.
6037 =item B<Password> I<Password>
6039 Password for simple bind authentication. If this option is not set,
6040 unauthenticated bind operation is used.
6042 =item B<StartTLS> B<true|false>
6044 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6045 Disabled by default.
6047 =item B<VerifyHost> B<true|false>
6049 Enables or disables peer host name verification. If enabled, the plugin checks
6050 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6051 certificate matches the host name provided by the B<URL> option. If this
6052 identity check fails, the connection is aborted. Enabled by default.
6054 =item B<CACert> I<File>
6056 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6057 may possibly need this option. What CA certificates are checked by default
6058 depends on the distribution you use and can be changed with the usual ldap
6059 client configuration mechanisms. See ldap.conf(5) for the details.
6061 =item B<Timeout> I<Seconds>
6063 Sets the timeout value for ldap operations, in seconds. By default, the
6064 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6067 =item B<Version> I<Version>
6069 An integer which sets the LDAP protocol version number to use when connecting
6070 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6074 =head2 Plugin C<openvpn>
6076 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6077 traffic statistics about connected clients.
6079 To set up OpenVPN to write to the status file periodically, use the
6080 B<--status> option of OpenVPN.
6082 So, in a nutshell you need:
6084 openvpn $OTHER_OPTIONS \
6085 --status "/var/run/openvpn-status" 10
6091 =item B<StatusFile> I<File>
6093 Specifies the location of the status file.
6095 =item B<ImprovedNamingSchema> B<true>|B<false>
6097 When enabled, the filename of the status file will be used as plugin instance
6098 and the client's "common name" will be used as type instance. This is required
6099 when reading multiple status files. Enabling this option is recommended, but to
6100 maintain backwards compatibility this option is disabled by default.
6102 =item B<CollectCompression> B<true>|B<false>
6104 Sets whether or not statistics about the compression used by OpenVPN should be
6105 collected. This information is only available in I<single> mode. Enabled by
6108 =item B<CollectIndividualUsers> B<true>|B<false>
6110 Sets whether or not traffic information is collected for each connected client
6111 individually. If set to false, currently no traffic data is collected at all
6112 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6114 =item B<CollectUserCount> B<true>|B<false>
6116 When enabled, the number of currently connected clients or users is collected.
6117 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6118 can be configured independently from that option. Defaults to B<false>.
6122 =head2 Plugin C<oracle>
6124 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6125 Oracle® Database and lets you execute SQL statements there. It is very similar
6126 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6127 plugin's documentation above for details.
6130 <Query "out_of_stock">
6131 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6134 # InstancePrefix "foo"
6135 InstancesFrom "category"
6139 <Database "product_information">
6144 Query "out_of_stock"
6148 =head3 B<Query> blocks
6150 The Query blocks are handled identically to the Query blocks of the "dbi"
6151 plugin. Please see its documentation above for details on how to specify
6154 =head3 B<Database> blocks
6156 Database blocks define a connection to a database and which queries should be
6157 sent to that database. Each database needs a "name" as string argument in the
6158 starting tag of the block. This name will be used as "PluginInstance" in the
6159 values submitted to the daemon. Other than that, that name is not used.
6163 =item B<Plugin> I<Plugin>
6165 Use I<Plugin> as the plugin name when submitting query results from
6166 this B<Database>. Defaults to C<oracle>.
6168 =item B<ConnectID> I<ID>
6170 Defines the "database alias" or "service name" to connect to. Usually, these
6171 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6173 =item B<Host> I<Host>
6175 Hostname to use when dispatching values for this database. Defaults to using
6176 the global hostname of the I<collectd> instance.
6178 =item B<Username> I<Username>
6180 Username used for authentication.
6182 =item B<Password> I<Password>
6184 Password used for authentication.
6186 =item B<Query> I<QueryName>
6188 Associates the query named I<QueryName> with this database connection. The
6189 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6190 blocks you want to refer to must be placed above the database block you want to
6195 =head2 Plugin C<ovs_events>
6197 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6198 connected interfaces, dispatches the values to collectd and sends the
6199 notification whenever the link state change occurs. This plugin uses OVS
6200 database to get a link state change notification.
6204 <Plugin "ovs_events">
6207 Socket "/var/run/openvswitch/db.sock"
6208 Interfaces "br0" "veth0"
6209 SendNotification true
6210 DispatchValues false
6213 The plugin provides the following configuration options:
6217 =item B<Address> I<node>
6219 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6220 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6221 option. See L<ovsdb-server(1)> for more details. The option may be either
6222 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6223 format. Defaults to C<localhost>.
6225 =item B<Port> I<service>
6227 TCP-port to connect to. Either a service name or a port number may be given.
6228 Defaults to B<6640>.
6230 =item B<Socket> I<path>
6232 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6233 plugin. To enable the interface, the OVS DB daemon should be running with
6234 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6235 option is set, B<Address> and B<Port> options are ignored.
6237 =item B<Interfaces> [I<ifname> ...]
6239 List of interface names to be monitored by this plugin. If this option is not
6240 specified or is empty then all OVS connected interfaces on all bridges are
6243 Default: empty (all interfaces on all bridges are monitored)
6245 =item B<SendNotification> I<true|false>
6247 If set to true, OVS link notifications (interface status and OVS DB connection
6248 terminate) are sent to collectd. Default value is true.
6250 =item B<DispatchValues> I<true|false>
6252 Dispatch the OVS DB interface link status value with configured plugin interval.
6253 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6254 options are false, no OVS information will be provided by the plugin.
6258 B<Note:> By default, the global interval setting is used within which to
6259 retrieve the OVS link status. To configure a plugin-specific interval, please
6260 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6261 simple divide the time by 1000 for example if the desired interval is 50ms, set
6264 =head2 Plugin C<ovs_stats>
6266 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6267 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6268 statistics from OVSDB
6272 <Plugin "ovs_stats">
6275 Socket "/var/run/openvswitch/db.sock"
6276 Bridges "br0" "br_ext"
6277 InterfaceStats false
6280 The plugin provides the following configuration options:
6284 =item B<Address> I<node>
6286 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6287 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6288 option. See L<ovsdb-server(1)> for more details. The option may be either
6289 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6290 format. Defaults to C<localhost>.
6292 =item B<Port> I<service>
6294 TCP-port to connect to. Either a service name or a port number may be given.
6295 Defaults to B<6640>.
6297 =item B<Socket> I<path>
6299 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6300 plugin. To enable the interface, the OVS DB daemon should be running with
6301 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6302 option is set, B<Address> and B<Port> options are ignored.
6304 =item B<Bridges> [I<brname> ...]
6306 List of OVS bridge names to be monitored by this plugin. If this option is
6307 omitted or is empty then all OVS bridges will be monitored.
6309 Default: empty (monitor all bridges)
6311 =item B<InterfaceStats> B<false>|B<true>
6313 Indicates that the plugin should gather statistics for individual interfaces
6314 in addition to ports. This can be useful when monitoring an OVS setup with
6315 bond ports, where you might wish to know individual statistics for the
6316 interfaces included in the bonds. Defaults to B<false>.
6320 =head2 Plugin C<pcie_errors>
6322 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6323 structure and from Advanced Error Reporting Extended Capability where available.
6324 At every read it polls config space of PCI Express devices and dispatches
6325 notification for every error that is set. It checks for new errors at every read.
6326 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6327 Errors are divided into categories indicated by type_instance: "correctable", and
6328 for uncorrectable errors "non_fatal" or "fatal".
6329 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6333 <Plugin "pcie_errors">
6335 AccessDir "/sys/bus/pci"
6337 PersistentNotifications false
6344 =item B<Source> B<sysfs>|B<proc>
6346 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6347 The default value is B<sysfs>.
6349 =item B<AccessDir> I<dir>
6351 Directory used to access device config space. It is optional and defaults to
6352 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6354 =item B<ReportMasked> B<false>|B<true>
6356 If true plugin will notify about errors that are set to masked in Error Mask register.
6357 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6359 =item B<PersistentNotifications> B<false>|B<true>
6361 If false plugin will dispatch notification only on set/clear of error.
6362 The ones already reported will be ignored. Defaults to B<false>.
6366 =head2 Plugin C<perl>
6368 This plugin embeds a Perl-interpreter into collectd and provides an interface
6369 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6371 =head2 Plugin C<pinba>
6373 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6374 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6375 PHP-based webpage has been delivered, the extension will send a UDP packet
6376 containing timing information, peak memory usage and so on. The plugin will
6377 wait for such packets, parse them and account the provided information, which
6378 is then dispatched to the daemon once per interval.
6385 # Overall statistics for the website.
6387 Server "www.example.com"
6389 # Statistics for www-a only
6391 Host "www-a.example.com"
6392 Server "www.example.com"
6394 # Statistics for www-b only
6396 Host "www-b.example.com"
6397 Server "www.example.com"
6401 The plugin provides the following configuration options:
6405 =item B<Address> I<Node>
6407 Configures the address used to open a listening socket. By default, plugin will
6408 bind to the I<any> address C<::0>.
6410 =item B<Port> I<Service>
6412 Configures the port (service) to bind to. By default the default Pinba port
6413 "30002" will be used. The option accepts service names in addition to port
6414 numbers and thus requires a I<string> argument.
6416 =item E<lt>B<View> I<Name>E<gt> block
6418 The packets sent by the Pinba extension include the hostname of the server, the
6419 server name (the name of the virtual host) and the script that was executed.
6420 Using B<View> blocks it is possible to separate the data into multiple groups
6421 to get more meaningful statistics. Each packet is added to all matching groups,
6422 so that a packet may be accounted for more than once.
6426 =item B<Host> I<Host>
6428 Matches the hostname of the system the webserver / script is running on. This
6429 will contain the result of the L<gethostname(2)> system call. If not
6430 configured, all hostnames will be accepted.
6432 =item B<Server> I<Server>
6434 Matches the name of the I<virtual host>, i.e. the contents of the
6435 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6436 server names will be accepted.
6438 =item B<Script> I<Script>
6440 Matches the name of the I<script name>, i.e. the contents of the
6441 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6442 script names will be accepted.
6448 =head2 Plugin C<ping>
6450 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6451 configured hosts periodically and measures the network latency. Whenever the
6452 C<read> function of the plugin is called, it submits the average latency, the
6453 standard deviation and the drop rate for each host.
6455 Available configuration options:
6459 =item B<Host> I<IP-address>
6461 Host to ping periodically. This option may be repeated several times to ping
6464 =item B<Interval> I<Seconds>
6466 Sets the interval in which to send ICMP echo packets to the configured hosts.
6467 This is B<not> the interval in which metrics are read from the plugin but the
6468 interval in which the hosts are "pinged". Therefore, the setting here should be
6469 smaller than or equal to the global B<Interval> setting. Fractional times, such
6470 as "1.24" are allowed.
6474 =item B<Timeout> I<Seconds>
6476 Time to wait for a response from the host to which an ICMP packet had been
6477 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6478 to be down or the packet to be dropped. This setting must be smaller than the
6479 B<Interval> setting above for the plugin to work correctly. Fractional
6480 arguments are accepted.
6484 =item B<TTL> I<0-255>
6486 Sets the Time-To-Live of generated ICMP packets.
6488 =item B<Size> I<size>
6490 Sets the size of the data payload in ICMP packet to specified I<size> (it
6491 will be filled with regular ASCII pattern). If not set, default 56 byte
6492 long string is used so that the packet size of an ICMPv4 packet is exactly
6493 64 bytes, similar to the behaviour of normal ping(1) command.
6495 =item B<SourceAddress> I<host>
6497 Sets the source address to use. I<host> may either be a numerical network
6498 address or a network hostname.
6500 =item B<AddressFamily> I<af>
6502 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6503 option will be ignored if you set a B<SourceAddress>.
6505 =item B<Device> I<name>
6507 Sets the outgoing network device to be used. I<name> has to specify an
6508 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6511 =item B<MaxMissed> I<Packets>
6513 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6514 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6516 Default: B<-1> (disabled)
6520 =head2 Plugin C<postgresql>
6522 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6523 keeps a persistent connection to all configured databases and tries to
6524 reconnect if the connection has been interrupted. A database is configured by
6525 specifying a B<Database> block as described below. The default statistics are
6526 collected from PostgreSQL's B<statistics collector> which thus has to be
6527 enabled for this plugin to work correctly. This should usually be the case by
6528 default. See the section "The Statistics Collector" of the B<PostgreSQL
6529 Documentation> for details.
6531 By specifying custom database queries using a B<Query> block as described
6532 below, you may collect any data that is available from some PostgreSQL
6533 database. This way, you are able to access statistics of external daemons
6534 which are available in a PostgreSQL database or use future or special
6535 statistics provided by PostgreSQL without the need to upgrade your collectd
6538 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6539 PostgreSQL databases as well. This has been implemented in a generic way. You
6540 need to specify an SQL statement which will then be executed by collectd in
6541 order to write the data (see below for details). The benefit of that approach
6542 is that there is no fixed database layout. Rather, the layout may be optimized
6543 for the current setup.
6545 The B<PostgreSQL Documentation> manual can be found at
6546 L<http://www.postgresql.org/docs/manuals/>.
6550 Statement "SELECT magic FROM wizard WHERE host = $1;"
6554 InstancePrefix "magic"
6559 <Query rt36_tickets>
6560 Statement "SELECT COUNT(type) AS count, type \
6562 WHEN resolved = 'epoch' THEN 'open' \
6563 ELSE 'resolved' END AS type \
6564 FROM tickets) type \
6568 InstancePrefix "rt36_tickets"
6569 InstancesFrom "type"
6575 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6586 KRBSrvName "kerberos_service_name"
6592 Service "service_name"
6593 Query backends # predefined
6604 The B<Query> block defines one database query which may later be used by a
6605 database definition. It accepts a single mandatory argument which specifies
6606 the name of the query. The names of all queries have to be unique (see the
6607 B<MinVersion> and B<MaxVersion> options below for an exception to this
6610 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6611 B<Result> blocks may be used to extract multiple values from a single query.
6613 The following configuration options are available to define the query:
6617 =item B<Statement> I<sql query statement>
6619 Specify the I<sql query statement> which the plugin should execute. The string
6620 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6621 first, second, etc. parameter. The value of the parameters is specified by the
6622 B<Param> configuration option - see below for details. To include a literal
6623 B<$> character followed by a number, surround it with single quotes (B<'>).
6625 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6626 allowed. Note, however, that only a single command may be used. Semicolons are
6627 allowed as long as a single non-empty command has been specified only.
6629 The returned lines will be handled separately one after another.
6631 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6633 Specify the parameters which should be passed to the SQL query. The parameters
6634 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6635 they appear in the configuration file. The value of the parameter is
6636 determined depending on the value of the B<Param> option as follows:
6642 The configured hostname of the database connection. If a UNIX domain socket is
6643 used, the parameter expands to "localhost".
6647 The name of the database of the current connection.
6651 The name of the database plugin instance. See the B<Instance> option of the
6652 database specification below for details.
6656 The username used to connect to the database.
6660 The interval with which this database is queried (as specified by the database
6661 specific or global B<Interval> options).
6665 Please note that parameters are only supported by PostgreSQL's protocol
6666 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6668 =item B<PluginInstanceFrom> I<column>
6670 Specify how to create the "PluginInstance" for reporting this query results.
6671 Only one column is supported. You may concatenate fields and string values in
6672 the query statement to get the required results.
6674 =item B<MinVersion> I<version>
6676 =item B<MaxVersion> I<version>
6678 Specify the minimum or maximum version of PostgreSQL that this query should be
6679 used with. Some statistics might only be available with certain versions of
6680 PostgreSQL. This allows you to specify multiple queries with the same name but
6681 which apply to different versions, thus allowing you to use the same
6682 configuration in a heterogeneous environment.
6684 The I<version> has to be specified as the concatenation of the major, minor
6685 and patch-level versions, each represented as two-decimal-digit numbers. For
6686 example, version 8.2.3 will become 80203.
6690 The B<Result> block defines how to handle the values returned from the query.
6691 It defines which column holds which value and how to dispatch that value to
6696 =item B<Type> I<type>
6698 The I<type> name to be used when dispatching the values. The type describes
6699 how to handle the data and where to store it. See L<types.db(5)> for more
6700 details on types and their configuration. The number and type of values (as
6701 selected by the B<ValuesFrom> option) has to match the type of the given name.
6703 This option is mandatory.
6705 =item B<InstancePrefix> I<prefix>
6707 =item B<InstancesFrom> I<column0> [I<column1> ...]
6709 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6710 B<InstancePrefix> defines a static prefix that will be prepended to all type
6711 instances. B<InstancesFrom> defines the column names whose values will be used
6712 to create the type instance. Multiple values will be joined together using the
6713 hyphen (C<->) as separation character.
6715 The plugin itself does not check whether or not all built instances are
6716 different. It is your responsibility to assure that each is unique.
6718 Both options are optional. If none is specified, the type instance will be
6721 =item B<ValuesFrom> I<column0> [I<column1> ...]
6723 Names the columns whose content is used as the actual data for the data sets
6724 that are dispatched to the daemon. How many such columns you need is
6725 determined by the B<Type> setting as explained above. If you specify too many
6726 or not enough columns, the plugin will complain about that and no data will be
6727 submitted to the daemon.
6729 The actual data type, as seen by PostgreSQL, is not that important as long as
6730 it represents numbers. The plugin will automatically cast the values to the
6731 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6732 L<strtod(3)> functions, so anything supported by those functions is supported
6733 by the plugin as well.
6735 This option is required inside a B<Result> block and may be specified multiple
6736 times. If multiple B<ValuesFrom> options are specified, the columns are read
6741 The following predefined queries are available (the definitions can be found
6742 in the F<postgresql_default.conf> file which, by default, is available at
6743 C<I<prefix>/share/collectd/>):
6749 This query collects the number of backends, i.E<nbsp>e. the number of
6752 =item B<transactions>
6754 This query collects the numbers of committed and rolled-back transactions of
6759 This query collects the numbers of various table modifications (i.E<nbsp>e.
6760 insertions, updates, deletions) of the user tables.
6762 =item B<query_plans>
6764 This query collects the numbers of various table scans and returned tuples of
6767 =item B<table_states>
6769 This query collects the numbers of live and dead rows in the user tables.
6773 This query collects disk block access counts for user tables.
6777 This query collects the on-disk size of the database in bytes.
6781 In addition, the following detailed queries are available by default. Please
6782 note that each of those queries collects information B<by table>, thus,
6783 potentially producing B<a lot> of data. For details see the description of the
6784 non-by_table queries above.
6788 =item B<queries_by_table>
6790 =item B<query_plans_by_table>
6792 =item B<table_states_by_table>
6794 =item B<disk_io_by_table>
6798 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6799 mandatory argument specifying the name of the writer. This will then be used
6800 in the B<Database> specification in order to activate the writer instance. The
6801 names of all writers have to be unique. The following options may be
6806 =item B<Statement> I<sql statement>
6808 This mandatory option specifies the SQL statement that will be executed for
6809 each submitted value. A single SQL statement is allowed only. Anything after
6810 the first semicolon will be ignored.
6812 Nine parameters will be passed to the statement and should be specified as
6813 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6814 values are made available through those parameters:
6820 The timestamp of the queried value as an RFC 3339-formatted local time.
6824 The hostname of the queried value.
6828 The plugin name of the queried value.
6832 The plugin instance of the queried value. This value may be B<NULL> if there
6833 is no plugin instance.
6837 The type of the queried value (cf. L<types.db(5)>).
6841 The type instance of the queried value. This value may be B<NULL> if there is
6846 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6847 sources of the submitted value-list).
6851 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6852 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6853 B<StoreRates> is enabled (which is the default, see below), all types will be
6858 An array of the submitted values. The dimensions of the value name and value
6863 In general, it is advisable to create and call a custom function in the
6864 PostgreSQL database for this purpose. Any procedural language supported by
6865 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6868 =item B<StoreRates> B<false>|B<true>
6870 If set to B<true> (the default), convert counter values to rates. If set to
6871 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6876 The B<Database> block defines one PostgreSQL database for which to collect
6877 statistics. It accepts a single mandatory argument which specifies the
6878 database name. None of the other options are required. PostgreSQL will use
6879 default values as documented in the section "CONNECTING TO A DATABASE" in the
6880 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6881 the user collectd is run as and special environment variables. See the manpage
6886 =item B<Interval> I<seconds>
6888 Specify the interval with which the database should be queried. The default is
6889 to use the global B<Interval> setting.
6891 =item B<CommitInterval> I<seconds>
6893 This option may be used for database connections which have "writers" assigned
6894 (see above). If specified, it causes a writer to put several updates into a
6895 single transaction. This transaction will last for the specified amount of
6896 time. By default, each update will be executed in a separate transaction. Each
6897 transaction generates a fair amount of overhead which can, thus, be reduced by
6898 activating this option. The draw-back is, that data covering the specified
6899 amount of time will be lost, for example, if a single statement within the
6900 transaction fails or if the database server crashes.
6902 =item B<Plugin> I<Plugin>
6904 Use I<Plugin> as the plugin name when submitting query results from
6905 this B<Database>. Defaults to C<postgresql>.
6907 =item B<Instance> I<name>
6909 Specify the plugin instance name that should be used instead of the database
6910 name (which is the default, if this option has not been specified). This
6911 allows one to query multiple databases of the same name on the same host (e.g.
6912 when running multiple database server versions in parallel).
6913 The plugin instance name can also be set from the query result using
6914 the B<PluginInstanceFrom> option in B<Query> block.
6916 =item B<Host> I<hostname>
6918 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6919 value begins with a slash, it is interpreted as the directory name in which to
6920 look for the UNIX domain socket.
6922 This option is also used to determine the hostname that is associated with a
6923 collected data set. If it has been omitted or either begins with with a slash
6924 or equals B<localhost> it will be replaced with the global hostname definition
6925 of collectd. Any other value will be passed literally to collectd when
6926 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6928 =item B<Port> I<port>
6930 Specify the TCP port or the local UNIX domain socket file extension of the
6933 =item B<User> I<username>
6935 Specify the username to be used when connecting to the server.
6937 =item B<Password> I<password>
6939 Specify the password to be used when connecting to the server.
6941 =item B<ExpireDelay> I<delay>
6943 Skip expired values in query output.
6945 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6947 Specify whether to use an SSL connection when contacting the server. The
6948 following modes are supported:
6954 Do not use SSL at all.
6958 First, try to connect without using SSL. If that fails, try using SSL.
6960 =item I<prefer> (default)
6962 First, try to connect using SSL. If that fails, try without using SSL.
6970 =item B<Instance> I<name>
6972 Specify the plugin instance name that should be used instead of the database
6973 name (which is the default, if this option has not been specified). This
6974 allows one to query multiple databases of the same name on the same host (e.g.
6975 when running multiple database server versions in parallel).
6977 =item B<KRBSrvName> I<kerberos_service_name>
6979 Specify the Kerberos service name to use when authenticating with Kerberos 5
6980 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6981 B<PostgreSQL Documentation> for details.
6983 =item B<Service> I<service_name>
6985 Specify the PostgreSQL service name to use for additional parameters. That
6986 service has to be defined in F<pg_service.conf> and holds additional
6987 connection parameters. See the section "The Connection Service File" in the
6988 B<PostgreSQL Documentation> for details.
6990 =item B<Query> I<query>
6992 Specifies a I<query> which should be executed in the context of the database
6993 connection. This may be any of the predefined or user-defined queries. If no
6994 such option is given, it defaults to "backends", "transactions", "queries",
6995 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6996 has been specified). Else, the specified queries are used only.
6998 =item B<Writer> I<writer>
7000 Assigns the specified I<writer> backend to the database connection. This
7001 causes all collected data to be send to the database using the settings
7002 defined in the writer configuration (see the section "FILTER CONFIGURATION"
7003 below for details on how to selectively send data to certain plugins).
7005 Each writer will register a flush callback which may be used when having long
7006 transactions enabled (see the B<CommitInterval> option above). When issuing
7007 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
7008 transaction will be committed right away. Two different kinds of flush
7009 callbacks are available with the C<postgresql> plugin:
7015 Flush all writer backends.
7017 =item B<postgresql->I<database>
7019 Flush all writers of the specified I<database> only.
7025 =head2 Plugin C<powerdns>
7027 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7028 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7029 values, many of which are probably meaningless to most users, but may be useful
7030 for some. So you may chose which values to collect, but if you don't, some
7031 reasonable defaults will be collected.
7034 <Server "server_name">
7036 Collect "udp-answers" "udp-queries"
7037 Socket "/var/run/pdns.controlsocket"
7039 <Recursor "recursor_name">
7041 Collect "cache-hits" "cache-misses"
7042 Socket "/var/run/pdns_recursor.controlsocket"
7044 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7049 =item B<Server> and B<Recursor> block
7051 The B<Server> block defines one authoritative server to query, the B<Recursor>
7052 does the same for an recursing server. The possible options in both blocks are
7053 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7058 =item B<Collect> I<Field>
7060 Using the B<Collect> statement you can select which values to collect. Here,
7061 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7062 C<dlg-only-drops>, C<answers10-100>.
7064 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7065 When querying the server a C<SHOW *> command is issued in any case, because
7066 that's the only way of getting multiple values out of the server at once.
7067 collectd then picks out the values you have selected. When querying the
7068 recursor, a command is generated to query exactly these values. So if you
7069 specify invalid fields when querying the recursor, a syntax error may be
7070 returned by the daemon and collectd may not collect any values at all.
7072 If no B<Collect> statement is given, the following B<Server> values will be
7079 =item packetcache-hit
7081 =item packetcache-miss
7083 =item packetcache-size
7085 =item query-cache-hit
7087 =item query-cache-miss
7089 =item recursing-answers
7091 =item recursing-questions
7103 The following B<Recursor> values will be collected by default:
7107 =item noerror-answers
7109 =item nxdomain-answers
7111 =item servfail-answers
7129 Please note that up to that point collectd doesn't know what values are
7130 available on the server and values that are added do not need a change of the
7131 mechanism so far. However, the values must be mapped to collectd's naming
7132 scheme, which is done using a lookup table that lists all known values. If
7133 values are added in the future and collectd does not know about them, you will
7134 get an error much like this:
7136 powerdns plugin: submit: Not found in lookup table: foobar = 42
7138 In this case please file a bug report with the collectd team.
7140 =item B<Socket> I<Path>
7142 Configures the path to the UNIX domain socket to be used when connecting to the
7143 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7144 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7145 will be used for the recursor.
7149 =item B<LocalSocket> I<Path>
7151 Querying the recursor is done using UDP. When using UDP over UNIX domain
7152 sockets, the client socket needs a name in the file system, too. You can set
7153 this local name to I<Path> using the B<LocalSocket> option. The default is
7154 C<I<prefix>/var/run/collectd-powerdns>.
7158 =head2 Plugin C<processes>
7160 Collects information about processes of local system.
7162 By default, with no process matches configured, only general statistics is
7163 collected: the number of processes in each state and fork rate.
7165 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7166 These may also be a block in which further options may be specified.
7168 The statistics collected for matched processes are:
7169 - size of the resident segment size (RSS)
7170 - user- and system-time used
7171 - number of processes
7173 - number of open files (under Linux)
7174 - number of memory mapped files (under Linux)
7175 - io data (where available)
7176 - context switches (under Linux)
7177 - minor and major pagefaults
7178 - Delay Accounting information (Linux only, requires libmnl)
7183 CollectFileDescriptor true
7184 CollectContextSwitch true
7185 CollectDelayAccounting false
7187 ProcessMatch "name" "regex"
7188 <Process "collectd">
7189 CollectFileDescriptor false
7190 CollectContextSwitch false
7191 CollectDelayAccounting true
7193 <ProcessMatch "name" "regex">
7194 CollectFileDescriptor false
7195 CollectContextSwitch true
7201 =item B<Process> I<Name>
7203 Select more detailed statistics of processes matching this name.
7205 Some platforms have a limit on the length of process names.
7206 I<Name> must stay below this limit.
7208 =item B<ProcessMatch> I<name> I<regex>
7210 Select more detailed statistics of processes matching the specified I<regex>
7211 (see L<regex(7)> for details). The statistics of all matching processes are
7212 summed up and dispatched to the daemon using the specified I<name> as an
7213 identifier. This allows one to "group" several processes together.
7214 I<name> must not contain slashes.
7216 =item B<CollectContextSwitch> I<Boolean>
7218 Collect the number of context switches for matched processes.
7219 Disabled by default.
7221 =item B<CollectDelayAccounting> I<Boolean>
7223 If enabled, collect Linux Delay Accounding information for matching processes.
7224 Delay Accounting provides the time processes wait for the CPU to become
7225 available, for I/O operations to finish, for pages to be swapped in and for
7226 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7227 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7228 Disabled by default.
7230 This option is only available on Linux, requires the C<libmnl> library and
7231 requires the C<CAP_NET_ADMIN> capability at runtime.
7233 =item B<CollectFileDescriptor> I<Boolean>
7235 Collect number of file descriptors of matched processes.
7236 Disabled by default.
7238 =item B<CollectMemoryMaps> I<Boolean>
7240 Collect the number of memory mapped files of the process.
7241 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7246 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7247 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7248 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7249 reporting the corresponding processes only. Outside of B<Process> and
7250 B<ProcessMatch> blocks these options set the default value for subsequent
7253 =head2 Plugin C<protocols>
7255 Collects a lot of information about various network protocols, such as I<IP>,
7256 I<TCP>, I<UDP>, etc.
7258 Available configuration options:
7262 =item B<Value> I<Selector>
7264 Selects whether or not to select a specific value. The string being matched is
7265 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7266 plugin instance and I<ValueName> will be used as type instance. An example of
7267 the string being used would be C<Tcp:RetransSegs>.
7269 You can use regular expressions to match a large number of values with just one
7270 configuration option. To select all "extended" I<TCP> values, you could use the
7271 following statement:
7275 Whether only matched values are selected or all matched values are ignored
7276 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7277 If no value is configured at all, all values will be selected.
7279 See F</"IGNORELISTS"> for details.
7281 =item B<IgnoreSelected> B<true>|B<false>
7283 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7284 matching values will be ignored.
7288 =head2 Plugin C<python>
7290 This plugin embeds a Python-interpreter into collectd and provides an interface
7291 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7293 =head2 Plugin C<routeros>
7295 The C<routeros> plugin connects to a device running I<RouterOS>, the
7296 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7297 I<librouteros> to connect and reads information about the interfaces and
7298 wireless connections of the device. The configuration supports querying
7303 Host "router0.example.com"
7306 CollectInterface true
7311 Host "router1.example.com"
7314 CollectInterface true
7315 CollectRegistrationTable true
7322 As you can see above, the configuration of the I<routeros> plugin consists of
7323 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7324 options are understood:
7328 =item B<Host> I<Host>
7330 Hostname or IP-address of the router to connect to.
7332 =item B<Port> I<Port>
7334 Port name or port number used when connecting. If left unspecified, the default
7335 will be chosen by I<librouteros>, currently "8728". This option expects a
7336 string argument, even when a numeric port number is given.
7338 =item B<User> I<User>
7340 Use the user name I<User> to authenticate. Defaults to "admin".
7342 =item B<Password> I<Password>
7344 Set the password used to authenticate.
7346 =item B<CollectInterface> B<true>|B<false>
7348 When set to B<true>, interface statistics will be collected for all interfaces
7349 present on the device. Defaults to B<false>.
7351 =item B<CollectRegistrationTable> B<true>|B<false>
7353 When set to B<true>, information about wireless LAN connections will be
7354 collected. Defaults to B<false>.
7356 =item B<CollectCPULoad> B<true>|B<false>
7358 When set to B<true>, information about the CPU usage will be collected. The
7359 number is a dimensionless value where zero indicates no CPU usage at all.
7360 Defaults to B<false>.
7362 =item B<CollectMemory> B<true>|B<false>
7364 When enabled, the amount of used and free memory will be collected. How used
7365 memory is calculated is unknown, for example whether or not caches are counted
7367 Defaults to B<false>.
7369 =item B<CollectDF> B<true>|B<false>
7371 When enabled, the amount of used and free disk space will be collected.
7372 Defaults to B<false>.
7374 =item B<CollectDisk> B<true>|B<false>
7376 When enabled, the number of sectors written and bad blocks will be collected.
7377 Defaults to B<false>.
7379 =item B<CollectHealth> B<true>|B<false>
7381 When enabled, the health statistics will be collected. This includes the
7382 voltage and temperature on supported hardware.
7383 Defaults to B<false>.
7387 =head2 Plugin C<redis>
7389 The I<Redis plugin> connects to one or more Redis servers, gathers
7390 information about each server's state and executes user-defined queries.
7391 For each server there is a I<Node> block which configures the connection
7392 parameters and set of user-defined queries for this node.
7398 #Socket "/var/run/redis/redis.sock"
7400 ReportCommandStats false
7402 <Query "LLEN myqueue">
7412 =item B<Node> I<Nodename>
7414 The B<Node> block identifies a new Redis node, that is a new Redis instance
7415 running in an specified host and port. The name for node is a canonical
7416 identifier which is used as I<plugin instance>. It is limited to
7417 128E<nbsp>characters in length.
7419 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7421 =item B<Host> I<Hostname>
7423 The B<Host> option is the hostname or IP-address where the Redis instance is
7426 =item B<Port> I<Port>
7428 The B<Port> option is the TCP port on which the Redis instance accepts
7429 connections. Either a service name of a port number may be given. Please note
7430 that numerical port numbers must be given as a string, too.
7432 =item B<Socket> I<Path>
7434 Connect to Redis using the UNIX domain socket at I<Path>. If this
7435 setting is given, the B<Hostname> and B<Port> settings are ignored.
7437 =item B<Password> I<Password>
7439 Use I<Password> to authenticate when connecting to I<Redis>.
7441 =item B<Timeout> I<Milliseconds>
7443 The B<Timeout> option set the socket timeout for node response. Since the Redis
7444 read function is blocking, you should keep this value as low as possible.
7445 It is expected what B<Timeout> values should be lower than B<Interval> defined
7448 Defaults to 2000 (2 seconds).
7450 =item B<ReportCommandStats> B<false>|B<true>
7452 Enables or disables reporting of statistics based on the command type, including
7453 rate of command calls and average CPU time consumed by command processing.
7454 Defaults to B<false>.
7456 =item B<ReportCpuUsage> B<true>|B<false>
7458 Enables or disables reporting of CPU consumption statistics.
7459 Defaults to B<true>.
7461 =item B<Query> I<Querystring>
7463 The B<Query> block identifies a query to execute against the redis server.
7464 There may be an arbitrary number of queries to execute. Each query should
7465 return single string or integer.
7467 =item B<Type> I<Collectd type>
7469 Within a query definition, a valid I<collectd type> to use as when submitting
7470 the result of the query. When not supplied, will default to B<gauge>.
7472 Currently only types with one datasource are supported.
7473 See L<types.db(5)> for more details on types and their configuration.
7475 =item B<Instance> I<Type instance>
7477 Within a query definition, an optional type instance to use when submitting
7478 the result of the query. When not supplied will default to the escaped
7479 command, up to 128 chars.
7481 =item B<Database> I<Index>
7483 This index selects the Redis logical database to use for query. Defaults
7488 =head2 Plugin C<rrdcached>
7490 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7491 to store values to RRD files in an efficient manner. The combination of the
7492 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7493 way the C<rrdtool> plugin works (see below). The added abstraction layer
7494 provides a number of benefits, though: Because the cache is not within
7495 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7496 restarted. This results in much shorter (if any) gaps in graphs, especially
7497 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7498 daemon so that it can flush values to disk automatically when needed. This
7499 allows one to integrate automated flushing of values into graphing solutions
7502 There are disadvantages, though: The daemon may reside on a different host, so
7503 it may not be possible for C<collectd> to create the appropriate RRD files
7504 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7505 different base directory, so relative paths may do weird stuff if you're not
7508 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7509 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7510 setting should be set to an absolute path, so that a changed base directory
7511 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7515 =item B<DaemonAddress> I<Address>
7517 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7518 library. See L<rrdcached(1)> for details. Example:
7520 <Plugin "rrdcached">
7521 DaemonAddress "unix:/var/run/rrdcached.sock"
7524 =item B<DataDir> I<Directory>
7526 Set the base directory in which the RRD files reside. If this is a relative
7527 path, it is relative to the working base directory of the C<rrdcached> daemon!
7528 Use of an absolute path is recommended.
7530 =item B<CreateFiles> B<true>|B<false>
7532 Enables or disables the creation of RRD files. If the daemon is not running
7533 locally, or B<DataDir> is set to a relative path, this will not work as
7534 expected. Default is B<true>.
7536 =item B<CreateFilesAsync> B<false>|B<true>
7538 When enabled, new RRD files are enabled asynchronously, using a separate thread
7539 that runs in the background. This prevents writes to block, which is a problem
7540 especially when many hundreds of files need to be created at once. However,
7541 since the purpose of creating the files asynchronously is I<not> to block until
7542 the file is available, values before the file is available will be discarded.
7543 When disabled (the default) files are created synchronously, blocking for a
7544 short while, while the file is being written.
7546 =item B<StepSize> I<Seconds>
7548 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7549 this setting is unset and the stepsize is set to the interval in which the data
7550 is collected. Do not use this option unless you absolutely have to for some
7551 reason. Setting this option may cause problems with the C<snmp plugin>, the
7552 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7554 =item B<HeartBeat> I<Seconds>
7556 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7557 in which case the heartbeat is set to twice the B<StepSize> which should equal
7558 the interval in which data is collected. Do not set this option unless you have
7559 a very good reason to do so.
7561 =item B<RRARows> I<NumRows>
7563 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7564 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7565 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7566 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7567 week, one month, and one year.
7569 So for each timespan, it calculates how many PDPs need to be consolidated into
7570 one CDP by calculating:
7571 number of PDPs = timespan / (stepsize * rrarows)
7573 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7576 =item B<RRATimespan> I<Seconds>
7578 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7579 more then one RRA. If this option is never used, the built-in default of (3600,
7580 86400, 604800, 2678400, 31622400) is used.
7582 For more information on how RRA-sizes are calculated see B<RRARows> above.
7584 =item B<XFF> I<Factor>
7586 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7587 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7590 =item B<CollectStatistics> B<false>|B<true>
7592 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7593 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7595 Statistics are read via I<rrdcached>s socket using the STATS command.
7596 See L<rrdcached(1)> for details.
7600 =head2 Plugin C<rrdtool>
7602 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7603 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7604 using these settings. If you don't want to dive into the depths of RRDtool, you
7605 can safely ignore these settings.
7609 =item B<DataDir> I<Directory>
7611 Set the directory to store RRD files under. By default RRD files are generated
7612 beneath the daemon's working directory, i.e. the B<BaseDir>.
7614 =item B<CreateFilesAsync> B<false>|B<true>
7616 When enabled, new RRD files are enabled asynchronously, using a separate thread
7617 that runs in the background. This prevents writes to block, which is a problem
7618 especially when many hundreds of files need to be created at once. However,
7619 since the purpose of creating the files asynchronously is I<not> to block until
7620 the file is available, values before the file is available will be discarded.
7621 When disabled (the default) files are created synchronously, blocking for a
7622 short while, while the file is being written.
7624 =item B<StepSize> I<Seconds>
7626 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7627 this setting is unset and the stepsize is set to the interval in which the data
7628 is collected. Do not use this option unless you absolutely have to for some
7629 reason. Setting this option may cause problems with the C<snmp plugin>, the
7630 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7632 =item B<HeartBeat> I<Seconds>
7634 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7635 in which case the heartbeat is set to twice the B<StepSize> which should equal
7636 the interval in which data is collected. Do not set this option unless you have
7637 a very good reason to do so.
7639 =item B<RRARows> I<NumRows>
7641 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7642 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7643 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7644 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7645 week, one month, and one year.
7647 So for each timespan, it calculates how many PDPs need to be consolidated into
7648 one CDP by calculating:
7649 number of PDPs = timespan / (stepsize * rrarows)
7651 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7654 =item B<RRATimespan> I<Seconds>
7656 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7657 more then one RRA. If this option is never used, the built-in default of (3600,
7658 86400, 604800, 2678400, 31622400) is used.
7660 For more information on how RRA-sizes are calculated see B<RRARows> above.
7662 =item B<XFF> I<Factor>
7664 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7665 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7668 =item B<CacheFlush> I<Seconds>
7670 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7671 it writes all values for a certain RRD-file if the oldest value is older than
7672 (or equal to) the number of seconds specified by B<CacheTimeout>.
7673 That check happens on new values arriwal. If some RRD-file is not updated
7674 anymore for some reason (the computer was shut down, the network is broken,
7675 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7676 every I<Seconds> seconds the entire cache is searched for entries older than
7677 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7678 disk. Since scanning the entire cache is kind of expensive and does nothing
7679 under normal circumstances, this value should not be too small. 900 seconds
7680 might be a good value, though setting this to 7200 seconds doesn't normally
7681 do much harm either.
7683 Defaults to 10x B<CacheTimeout>.
7684 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7685 above default is used.
7687 =item B<CacheTimeout> I<Seconds>
7689 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7690 save values in a cache, as described above. Writing multiple values at once
7691 reduces IO-operations and thus lessens the load produced by updating the files.
7692 The trade off is that the graphs kind of "drag behind" and that more memory is
7695 =item B<WritesPerSecond> I<Updates>
7697 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7698 will run serious performance problems. The B<CacheFlush> setting and the
7699 internal update queue assert that collectd continues to work just fine even
7700 under heavy load, but the system may become very unresponsive and slow. This is
7701 a problem especially if you create graphs from the RRD files on the same
7702 machine, for example using the C<graph.cgi> script included in the
7703 C<contrib/collection3/> directory.
7705 This setting is designed for very large setups. Setting this option to a value
7706 between 25 and 80 updates per second, depending on your hardware, will leave
7707 the server responsive enough to draw graphs even while all the cached values
7708 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7709 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7710 written as fast as possible, so that web frontends have up to date data when
7713 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7714 updates per second, writing all values to disk will take approximately
7715 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7716 "collection3" you'll end up with a responsive and fast system, up to date
7717 graphs and basically a "backup" of your values every hour.
7719 =item B<RandomTimeout> I<Seconds>
7721 When set, the actual timeout for each value is chosen randomly between
7722 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7723 intention is to avoid high load situations that appear when many values timeout
7724 at the same time. This is especially a problem shortly after the daemon starts,
7725 because all values were added to the internal cache at roughly the same time.
7729 =head2 Plugin C<sensors>
7731 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7732 that all the needed modules have to be loaded and lm_sensors has to be
7733 configured (most likely by editing F</etc/sensors.conf>. Read
7734 L<sensors.conf(5)> for details.
7736 The B<lm_sensors> homepage can be found at
7737 L<http://secure.netroedge.com/~lm78/>.
7741 =item B<SensorConfigFile> I<File>
7743 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7744 the library's default will be used.
7746 =item B<Sensor> I<chip-bus-address/type-feature>
7748 Selects the name of the sensor which you want to collect or ignore, depending
7749 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7750 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7751 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7753 See F</"IGNORELISTS"> for details.
7755 =item B<IgnoreSelected> I<true>|I<false>
7757 If no configuration if given, the B<sensors>-plugin will collect data from all
7758 sensors. This may not be practical, especially for uninteresting sensors.
7759 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7760 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7761 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7762 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7763 and all other sensors are collected.
7765 =item B<UseLabels> I<true>|I<false>
7767 Configures how sensor readings are reported. When set to I<true>, sensor
7768 readings are reported using their descriptive label (e.g. "VCore"). When set to
7769 I<false> (the default) the sensor name is used ("in0").
7773 =head2 Plugin C<sigrok>
7775 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7776 supported by the L<sigrok|http://sigrok.org/> project.
7782 <Device "AC Voltage">
7787 <Device "Sound Level">
7788 Driver "cem-dt-885x"
7795 =item B<LogLevel> B<0-5>
7797 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7798 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7799 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7800 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7801 their level, are always submitted to I<collectd> at its INFO log level.
7803 =item E<lt>B<Device> I<Name>E<gt>
7805 A sigrok-supported device, uniquely identified by this section's options. The
7806 I<Name> is passed to I<collectd> as the I<plugin instance>.
7808 =item B<Driver> I<DriverName>
7810 The sigrok driver to use for this device.
7812 =item B<Conn> I<ConnectionSpec>
7814 If the device cannot be auto-discovered, or more than one might be discovered
7815 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7816 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7817 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7818 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7819 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7821 =item B<SerialComm> I<SerialSpec>
7823 For serial devices with non-standard port settings, this option can be used
7824 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7825 This should not be necessary; drivers know how to communicate with devices they
7828 =item B<MinimumInterval> I<Seconds>
7830 Specifies the minimum time between measurement dispatches to I<collectd>, in
7831 seconds. Since some I<sigrok> supported devices can acquire measurements many
7832 times per second, it may be necessary to throttle these. For example, the
7833 I<RRD plugin> cannot process writes more than once per second.
7835 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7836 device are always dispatched to I<collectd>. When throttled, unused
7837 measurements are discarded.
7841 =head2 Plugin C<smart>
7843 The C<smart> plugin collects SMART information from physical
7844 disks. Values collectd include temperature, power cycle count, poweron
7845 time and bad sectors. Also, all SMART attributes are collected along
7846 with the normalized current value, the worst value, the threshold and
7847 a human readable value.
7849 Using the following two options you can ignore some disks or configure the
7850 collection only of specific disks.
7854 =item B<Disk> I<Name>
7856 Select the disk I<Name>. Whether it is collected or ignored depends on the
7857 B<IgnoreSelected> setting, see below. As with other plugins that use the
7858 daemon's ignorelist functionality, a string that starts and ends with a slash
7859 is interpreted as a regular expression. Examples:
7864 See F</"IGNORELISTS"> for details.
7866 =item B<IgnoreSelected> B<true>|B<false>
7868 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7869 statements, are ignored or if all other disks are ignored. The behavior
7870 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7871 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7872 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7873 is set to B<true>, all disks are collected B<except> the ones matched.
7875 =item B<IgnoreSleepMode> B<true>|B<false>
7877 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7878 This option disables the sleep mode check and allows the plugin to collect data
7879 from these disks anyway. This is useful in cases where libatasmart mistakenly
7880 reports disks as asleep because it has not been updated to incorporate support
7881 for newer idle states in the ATA spec.
7883 =item B<UseSerial> B<true>|B<false>
7885 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7886 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7887 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7888 storing data. This ensures that the data for a given disk will be kept together
7889 even if the kernel name changes.
7893 =head2 Plugin C<snmp>
7895 Since the configuration of the C<snmp plugin> is a little more complicated than
7896 other plugins, its documentation has been moved to an own manpage,
7897 L<collectd-snmp(5)>. Please see there for details.
7899 =head2 Plugin C<snmp_agent>
7901 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7902 from SNMP master agent and returns the data collected by read plugins.
7903 The I<snmp_agent> plugin handles requests only for OIDs specified in
7904 configuration file. To handle SNMP queries the plugin gets data from collectd
7905 and translates requested values from collectd's internal format to SNMP format.
7906 This plugin is a generic plugin and cannot work without configuration.
7907 For more details on AgentX subagent see
7908 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7913 <Data "memAvailReal">
7915 #PluginInstance "some"
7918 OIDs "1.3.6.1.4.1.2021.4.6.0"
7921 IndexOID "IF-MIB::ifIndex"
7922 SizeOID "IF-MIB::ifNumber"
7925 Source "PluginInstance"
7928 OIDs "IF-MIB::ifDescr"
7934 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7937 <Table "CPUAffinityTable">
7940 Source "PluginInstance"
7943 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
7948 Source "TypeInstance"
7949 Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
7952 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
7957 Source "TypeInstance"
7958 Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
7961 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
7963 <Data "CPUAffinity">
7966 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
7971 There are two types of blocks that can be contained in the
7972 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7974 =head3 B<Data> block
7976 The B<Data> block defines a list OIDs that are to be handled. This block can
7977 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7978 block it reperesents table OIDs.
7979 The following options can be set:
7983 =item B<IndexKey> block
7985 B<IndexKey> block contains all data needed for proper index build of snmp table.
7987 one table B<Data> block has B<IndexKey> block present then multiple key index is
7988 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
7993 =item B<Source> I<String>
7995 B<Source> can be set to one of the following values: "Hostname", "Plugin",
7996 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
7997 corresponding collectd metric is taken as a SNMP table index.
7999 =item B<Regex> I<String>
8001 B<Regex> option can also be used to parse strings or numbers out of
8002 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
8003 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
8006 =item B<Group> I<Number>
8008 B<Group> number can be specified in case groups are used in regex.
8012 =item B<Plugin> I<String>
8014 Read plugin name whose collected data will be mapped to specified OIDs.
8016 =item B<PluginInstance> I<String>
8018 Read plugin instance whose collected data will be mapped to specified OIDs.
8019 The field is optional and by default there is no plugin instance check.
8020 Allowed only if B<Data> block defines scalar data type.
8022 =item B<Type> I<String>
8024 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
8025 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
8027 =item B<TypeInstance> I<String>
8029 Collectd's type-instance that is to be used for specified OID.
8031 =item B<OIDs> I<OID> [I<OID> ...]
8033 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8034 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8035 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8036 configured should correspond to number of values in specified B<Type>.
8037 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8038 "rx" and "tx" values of "if_octets" type.
8040 =item B<Scale> I<Value>
8042 The values taken from collectd are multiplied by I<Value>. The field is optional
8043 and the default is B<1.0>.
8045 =item B<Shift> I<Value>
8047 I<Value> is added to values from collectd after they have been multiplied by
8048 B<Scale> value. The field is optional and the default value is B<0.0>.
8052 =head3 The B<Table> block
8054 The B<Table> block defines a collection of B<Data> blocks that belong to one
8055 snmp table. In addition to multiple B<Data> blocks the following options can be
8060 =item B<IndexOID> I<OID>
8062 OID that is handled by the plugin and is mapped to numerical index value that is
8063 generated by the plugin for each table record.
8065 =item B<SizeOID> I<OID>
8067 OID that is handled by the plugin. Returned value is the number of records in
8068 the table. The field is optional.
8072 =head2 Plugin C<statsd>
8074 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8075 protocol and dispatches rates or other aggregates of these numbers
8078 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8079 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8080 C<objects> respectively.
8082 The following configuration options are valid:
8086 =item B<Host> I<Host>
8088 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8089 "any" address, i.e. accept packets sent to any of the hosts addresses.
8091 =item B<Port> I<Port>
8093 UDP port to listen to. This can be either a service name or a port number.
8094 Defaults to C<8125>.
8096 =item B<DeleteCounters> B<false>|B<true>
8098 =item B<DeleteTimers> B<false>|B<true>
8100 =item B<DeleteGauges> B<false>|B<true>
8102 =item B<DeleteSets> B<false>|B<true>
8104 These options control what happens if metrics are not updated in an interval.
8105 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8106 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8107 are unchanged. If set to B<True>, the such metrics are not dispatched and
8108 removed from the internal cache.
8110 =item B<CounterSum> B<false>|B<true>
8112 When enabled, creates a C<count> metric which reports the change since the last
8113 read. This option primarily exists for compatibility with the I<statsd>
8114 implementation by Etsy.
8116 =item B<TimerPercentile> I<Percent>
8118 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8119 that I<Percent> of all reported timers are smaller than or equal to the
8120 computed latency. This is useful for cutting off the long tail latency, as it's
8121 often done in I<Service Level Agreements> (SLAs).
8123 Different percentiles can be calculated by setting this option several times.
8124 If none are specified, no percentiles are calculated / dispatched.
8126 =item B<TimerLower> B<false>|B<true>
8128 =item B<TimerUpper> B<false>|B<true>
8130 =item B<TimerSum> B<false>|B<true>
8132 =item B<TimerCount> B<false>|B<true>
8134 Calculate and dispatch various values out of I<Timer> metrics received during
8135 an interval. If set to B<False>, the default, these values aren't calculated /
8138 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8142 =head2 Plugin C<swap>
8144 The I<Swap plugin> collects information about used and available swap space. On
8145 I<Linux> and I<Solaris>, the following options are available:
8149 =item B<ReportByDevice> B<false>|B<true>
8151 Configures how to report physical swap devices. If set to B<false> (the
8152 default), the summary over all swap devices is reported only, i.e. the globally
8153 used and available space over all devices. If B<true> is configured, the used
8154 and available space of each device will be reported separately.
8156 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8157 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8159 =item B<ReportBytes> B<false>|B<true>
8161 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8162 I<swap I/O> is reported in pages. This option is available under Linux only.
8164 =item B<ValuesAbsolute> B<true>|B<false>
8166 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8167 available and used. Defaults to B<true>.
8169 =item B<ValuesPercentage> B<false>|B<true>
8171 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8172 available and free. Defaults to B<false>.
8174 This is useful for deploying I<collectd> in a heterogeneous environment, where
8175 swap sizes differ and you want to specify generic thresholds or similar.
8177 =item B<ReportIO> B<true>|B<false>
8179 Enables or disables reporting swap IO. Defaults to B<true>.
8181 This is useful for the cases when swap IO is not neccessary, is not available,
8186 =head2 Plugin C<syslog>
8190 =item B<LogLevel> B<debug|info|notice|warning|err>
8192 Sets the log-level. If, for example, set to B<notice>, then all events with
8193 severity B<notice>, B<warning>, or B<err> will be submitted to the
8196 Please note that B<debug> is only available if collectd has been compiled with
8199 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8201 Controls which notifications should be sent to syslog. The default behaviour is
8202 not to send any. Less severe notifications always imply logging more severe
8203 notifications: Setting this to B<OKAY> means all notifications will be sent to
8204 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8205 notifications but will dismiss B<OKAY> notifications. Setting this option to
8206 B<FAILURE> will only send failures to syslog.
8210 =head2 Plugin C<table>
8212 The C<table plugin> provides generic means to parse tabular data and dispatch
8213 user specified values. Values are selected based on column numbers. For
8214 example, this plugin may be used to get values from the Linux L<proc(5)>
8215 filesystem or CSV (comma separated values) files.
8218 <Table "/proc/slabinfo">
8224 InstancePrefix "active_objs"
8230 InstancePrefix "objperslab"
8237 The configuration consists of one or more B<Table> blocks, each of which
8238 configures one file to parse. Within each B<Table> block, there are one or
8239 more B<Result> blocks, which configure which data to select and how to
8242 The following options are available inside a B<Table> block:
8246 =item B<Plugin> I<Plugin>
8248 If specified, I<Plugin> is used as the plugin name when submitting values.
8249 Defaults to B<table>.
8251 =item B<Instance> I<instance>
8253 If specified, I<instance> is used as the plugin instance. If omitted, the
8254 filename of the table is used instead, with all special characters replaced
8255 with an underscore (C<_>).
8257 =item B<Separator> I<string>
8259 Any character of I<string> is interpreted as a delimiter between the different
8260 columns of the table. A sequence of two or more contiguous delimiters in the
8261 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8262 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8263 of a table - see its documentation for more details. This option is mandatory.
8265 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8266 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8267 required because of collectd's config parsing.
8271 The following options are available inside a B<Result> block:
8275 =item B<Type> I<type>
8277 Sets the type used to dispatch the values to the daemon. Detailed information
8278 about types and their configuration can be found in L<types.db(5)>. This
8279 option is mandatory.
8281 =item B<InstancePrefix> I<prefix>
8283 If specified, prepend I<prefix> to the type instance. If omitted, only the
8284 B<InstancesFrom> option is considered for the type instance.
8286 =item B<InstancesFrom> I<column0> [I<column1> ...]
8288 If specified, the content of the given columns (identified by the column
8289 number starting at zero) will be used to create the type instance for each
8290 row. Multiple values (and the instance prefix) will be joined together with
8291 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8292 option is considered for the type instance.
8294 The plugin itself does not check whether or not all built instances are
8295 different. It’s your responsibility to assure that each is unique. This is
8296 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8297 sure that the table only contains one row.
8299 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8302 =item B<ValuesFrom> I<column0> [I<column1> ...]
8304 Specifies the columns (identified by the column numbers starting at zero)
8305 whose content is used as the actual data for the data sets that are dispatched
8306 to the daemon. How many such columns you need is determined by the B<Type>
8307 setting above. If you specify too many or not enough columns, the plugin will
8308 complain about that and no data will be submitted to the daemon. The plugin
8309 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8310 respectively, so anything supported by those functions is supported by the
8311 plugin as well. This option is mandatory.
8315 =head2 Plugin C<tail>
8317 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8318 each line and dispatches found values. What is matched can be configured by the
8319 user using (extended) regular expressions, as described in L<regex(7)>.
8322 <File "/var/log/exim4/mainlog">
8327 Regex "S=([1-9][0-9]*)"
8333 Regex "\\<R=local_user\\>"
8334 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8337 Instance "local_user"
8340 Regex "l=([0-9]*\\.[0-9]*)"
8341 <DSType "Distribution">
8344 #BucketType "bucket"
8352 The config consists of one or more B<File> blocks, each of which configures one
8353 logfile to parse. Within each B<File> block, there are one or more B<Match>
8354 blocks, which configure a regular expression to search for.
8356 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8357 the plugin name and instance respectively. So in the above example the plugin name
8358 C<mail-exim> would be used.
8360 These options are applied for all B<Match> blocks that B<follow> it, until the
8361 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8362 instances from one logfile, handy when parsing syslog and the like.
8364 The B<Interval> option allows you to define the length of time between reads. If
8365 this is not set, the default Interval will be used.
8367 Each B<Match> block has the following options to describe how the match should
8372 =item B<Regex> I<regex>
8374 Sets the regular expression to use for matching against a line. The first
8375 subexpression has to match something that can be turned into a number by
8376 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8377 below. Because B<extended> regular expressions are used, you do not need to use
8378 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8379 collectd's config parsing you need to escape backslashes, though. So if you
8380 want to match literal parentheses you need to do the following:
8382 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8384 =item B<ExcludeRegex> I<regex>
8386 Sets an optional regular expression to use for excluding lines from the match.
8387 An example which excludes all connections from localhost from the match:
8389 ExcludeRegex "127\\.0\\.0\\.1"
8391 =item B<DSType> I<Type>
8393 Sets how the values are cumulated. I<Type> is one of:
8397 =item B<GaugeAverage>
8399 Calculate the average.
8403 Use the smallest number only.
8407 Use the greatest number only.
8411 Use the last number found.
8413 =item B<GaugePersist>
8415 Use the last number found. The number is not reset at the end of an interval.
8416 It is continously reported until another number is matched. This is intended
8417 for cases in which only state changes are reported, for example a thermometer
8418 that only reports the temperature when it changes.
8424 =item B<AbsoluteSet>
8426 The matched number is a counter. Simply I<sets> the internal counter to this
8427 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8435 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8436 matched number may be negative, which will effectively subtract from the
8445 Increase the internal counter by one. These B<DSType> are the only ones that do
8446 not use the matched subexpression, but simply count the number of matched
8447 lines. Thus, you may use a regular expression without submatch in this case.
8449 =item B<Distribution>
8451 Type to do calculations based on the distribution of values, primarily
8452 calculating percentiles. This is primarily geared towards latency, but can be
8453 used for other metrics as well. The range of values tracked with this setting
8454 must be in the range (0–2^34) and can be fractional. Please note that neither
8455 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8458 This option must be used together with the B<Percentile> and/or B<Bucket>
8463 <DSType "Distribution">
8471 =item B<Percentile> I<Percent>
8473 Calculate and dispatch the configured percentile, i.e. compute the value, so
8474 that I<Percent> of all matched values are smaller than or equal to the computed
8477 Metrics are reported with the I<type> B<Type> (the value of the above option)
8478 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8480 This option may be repeated to calculate more than one percentile.
8482 =item B<Bucket> I<lower_bound> I<upper_bound>
8484 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8485 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8486 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8487 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8488 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8491 To export the entire (0–inf) range without overlap, use the upper bound of the
8492 previous range as the lower bound of the following range. In other words, use
8493 the following schema:
8503 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8504 by default) and the I<type instance>
8505 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8507 This option may be repeated to calculate more than one rate.
8509 =item B<BucketType> I<Type>
8511 Sets the type used to dispatch B<Bucket> metrics.
8512 Optional, by default C<bucket> will be used.
8518 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8519 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8520 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8521 B<Derive*> types interpret the submatch as a signed integer using
8522 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8523 and it may be omitted in this case.
8525 =item B<Type> I<Type>
8527 Sets the type used to dispatch this value. Detailed information about types and
8528 their configuration can be found in L<types.db(5)>.
8530 =item B<Instance> I<TypeInstance>
8532 This optional setting sets the type instance to use.
8536 =head2 Plugin C<tail_csv>
8538 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8539 written by I<Snort>.
8544 <Metric "snort-dropped">
8549 <File "/var/log/snort/snort.stats">
8553 Collect "snort-dropped"
8558 The configuration consists of one or more B<Metric> blocks that define an index
8559 into the line of the CSV file and how this value is mapped to I<collectd's>
8560 internal representation. These are followed by one or more B<Instance> blocks
8561 which configure which file to read, in which interval and which metrics to
8566 =item E<lt>B<Metric> I<Name>E<gt>
8568 The B<Metric> block configures a new metric to be extracted from the statistics
8569 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8570 only used inside the B<Instance> blocks to refer to this block, so you can use
8571 one B<Metric> block for multiple CSV files.
8575 =item B<Type> I<Type>
8577 Configures which I<Type> to use when dispatching this metric. Types are defined
8578 in the L<types.db(5)> file, see the appropriate manual page for more
8579 information on specifying types. Only types with a single I<data source> are
8580 supported by the I<tail_csv plugin>. The information whether the value is an
8581 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8582 I<Type's> definition.
8584 =item B<Instance> I<TypeInstance>
8586 If set, I<TypeInstance> is used to populate the type instance field of the
8587 created value lists. Otherwise, no type instance is used.
8589 =item B<ValueFrom> I<Index>
8591 Configure to read the value from the field with the zero-based index I<Index>.
8592 If the value is parsed as signed integer, unsigned integer or double depends on
8593 the B<Type> setting, see above.
8597 =item E<lt>B<File> I<Path>E<gt>
8599 Each B<File> block represents one CSV file to read. There must be at least one
8600 I<File> block but there can be multiple if you have multiple CSV files.
8604 =item B<Plugin> I<Plugin>
8606 Use I<Plugin> as the plugin name when submitting values.
8607 Defaults to C<tail_csv>.
8609 =item B<Instance> I<PluginInstance>
8611 Sets the I<plugin instance> used when dispatching the values.
8613 =item B<Collect> I<Metric>
8615 Specifies which I<Metric> to collect. This option must be specified at least
8616 once, and you can use this option multiple times to specify more than one
8617 metric to be extracted from this statistic file.
8619 =item B<Interval> I<Seconds>
8621 Configures the interval in which to read values from this instance / file.
8622 Defaults to the plugin's default interval.
8624 =item B<TimeFrom> I<Index>
8626 Rather than using the local time when dispatching a value, read the timestamp
8627 from the field with the zero-based index I<Index>. The value is interpreted as
8628 seconds since epoch. The value is parsed as a double and may be factional.
8634 =head2 Plugin C<teamspeak2>
8636 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8637 polls interesting global and virtual server data. The plugin can query only one
8638 physical server but unlimited virtual servers. You can use the following
8639 options to configure it:
8643 =item B<Host> I<hostname/ip>
8645 The hostname or ip which identifies the physical server.
8648 =item B<Port> I<port>
8650 The query port of the physical server. This needs to be a string.
8653 =item B<Server> I<port>
8655 This option has to be added once for every virtual server the plugin should
8656 query. If you want to query the virtual server on port 8767 this is what the
8657 option would look like:
8661 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8662 use quotes around it! If no such statement is given only global information
8667 =head2 Plugin C<ted>
8669 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8670 measure power consumption. These devices are usually connected to a serial
8671 (RS232) or USB port. The plugin opens a configured device and tries to read the
8672 current energy readings. For more information on TED, visit
8673 L<http://www.theenergydetective.com/>.
8675 Available configuration options:
8679 =item B<Device> I<Path>
8681 Path to the device on which TED is connected. collectd will need read and write
8682 permissions on that file.
8684 Default: B</dev/ttyUSB0>
8686 =item B<Retries> I<Num>
8688 Apparently reading from TED is not that reliable. You can therefore configure a
8689 number of retries here. You only configure the I<retries> here, to if you
8690 specify zero, one reading will be performed (but no retries if that fails); if
8691 you specify three, a maximum of four readings are performed. Negative values
8698 =head2 Plugin C<tcpconns>
8700 The C<tcpconns plugin> counts the number of currently established TCP
8701 connections based on the local port and/or the remote port. Since there may be
8702 a lot of connections the default if to count all connections with a local port,
8703 for which a listening socket is opened. You can use the following options to
8704 fine-tune the ports you are interested in:
8708 =item B<ListeningPorts> I<true>|I<false>
8710 If this option is set to I<true>, statistics for all local ports for which a
8711 listening socket exists are collected. The default depends on B<LocalPort> and
8712 B<RemotePort> (see below): If no port at all is specifically selected, the
8713 default is to collect listening ports. If specific ports (no matter if local or
8714 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8715 the selected ports will be collected unless this option is set to I<true>
8718 =item B<LocalPort> I<Port>
8720 Count the connections to a specific local port. This can be used to see how
8721 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8722 You have to specify the port in numeric form, so for the mailserver example
8723 you'd need to set B<25>.
8725 =item B<RemotePort> I<Port>
8727 Count the connections to a specific remote port. This is useful to see how
8728 much a remote service is used. This is most useful if you want to know how many
8729 connections a local service has opened to remote services, e.E<nbsp>g. how many
8730 connections a mail server or news server has to other mail or news servers, or
8731 how many connections a web proxy holds to web servers. You have to give the
8732 port in numeric form.
8734 =item B<AllPortsSummary> I<true>|I<false>
8736 If this option is set to I<true> a summary of statistics from all connections
8737 are collected. This option defaults to I<false>.
8741 =head2 Plugin C<thermal>
8745 =item B<ForceUseProcfs> I<true>|I<false>
8747 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8748 C<sysfs> interface. If that is not available, the plugin falls back to the
8749 C<procfs> interface. By setting this option to I<true>, you can force the
8750 plugin to use the latter. This option defaults to I<false>.
8752 =item B<Device> I<Device>
8754 Selects the name of the thermal device that you want to collect or ignore,
8755 depending on the value of the B<IgnoreSelected> option. This option may be
8756 used multiple times to specify a list of devices.
8758 See F</"IGNORELISTS"> for details.
8760 =item B<IgnoreSelected> I<true>|I<false>
8762 Invert the selection: If set to true, all devices B<except> the ones that
8763 match the device names specified by the B<Device> option are collected. By
8764 default only selected devices are collected if a selection is made. If no
8765 selection is configured at all, B<all> devices are selected.
8769 =head2 Plugin C<threshold>
8771 The I<Threshold plugin> checks values collected or received by I<collectd>
8772 against a configurable I<threshold> and issues I<notifications> if values are
8775 Documentation for this plugin is available in the L<collectd-threshold(5)>
8778 =head2 Plugin C<tokyotyrant>
8780 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8781 couple metrics: number of records, and database size on disk.
8785 =item B<Host> I<Hostname/IP>
8787 The hostname or IP which identifies the server.
8788 Default: B<127.0.0.1>
8790 =item B<Port> I<Service/Port>
8792 The query port of the server. This needs to be a string, even if the port is
8793 given in its numeric form.
8798 =head2 Plugin C<turbostat>
8800 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8801 Intel processors by using I<Model Specific Registers>.
8805 =item B<CoreCstates> I<Bitmask(Integer)>
8807 Bit mask of the list of core C-states supported by the processor.
8808 This option should only be used if the automated detection fails.
8809 Default value extracted from the CPU model and family.
8811 Currently supported C-states (by this plugin): 3, 6, 7
8815 All states (3, 6 and 7):
8816 (1<<3) + (1<<6) + (1<<7) = 392
8818 =item B<PackageCstates> I<Bitmask(Integer)>
8820 Bit mask of the list of packages C-states supported by the processor. This
8821 option should only be used if the automated detection fails. Default value
8822 extracted from the CPU model and family.
8824 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8828 States 2, 3, 6 and 7:
8829 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8831 =item B<SystemManagementInterrupt> I<true>|I<false>
8833 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8834 This option should only be used if the automated detection fails or if you want
8835 to disable this feature.
8837 =item B<DigitalTemperatureSensor> I<true>|I<false>
8839 Boolean enabling the collection of the temperature of each core. This option
8840 should only be used if the automated detection fails or if you want to disable
8843 =item B<TCCActivationTemp> I<Temperature>
8845 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8846 temperature is used when collecting the temperature of cores or packages. This
8847 option should only be used if the automated detection fails. Default value
8848 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8850 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8852 Bit mask of the list of elements to be thermally monitored. This option should
8853 only be used if the automated detection fails or if you want to disable some
8854 collections. The different bits of this bit mask accepted by this plugin are:
8858 =item 0 ('1'): Package
8862 =item 2 ('4'): Cores
8864 =item 3 ('8'): Embedded graphic device
8868 =item B<LogicalCoreNames> I<true>|I<false>
8870 Boolean enabling the use of logical core numbering for per core statistics.
8871 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8872 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8873 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8874 more than one, where I<n> is the n-th core of package I<m>.
8876 =item B<RestoreAffinityPolicy> I<AllCPUs>|I<Restore>
8878 Reading data from CPU has side-effect: collectd process's CPU affinity mask
8879 changes. After reading data is completed, affinity mask needs to be restored.
8880 This option allows to set restore policy.
8882 B<AllCPUs> (the default): Restore the affinity by setting affinity to any/all
8885 B<Restore>: Save affinity using sched_getaffinity() before reading data and
8888 On some systems, sched_getaffinity() will fail due to inconsistency of the CPU
8889 set size between userspace and kernel. In these cases plugin will detect the
8890 unsuccessful call and fail with an error, preventing data collection.
8891 Most of configurations does not need to save affinity as Collectd process is
8892 allowed to run on any/all available CPUs.
8894 If you need to save and restore affinity and get errors like 'Unable to save
8895 the CPU affinity', setting 'possible_cpus' kernel boot option may also help.
8897 See following links for details:
8899 L<https://github.com/collectd/collectd/issues/1593>
8900 L<https://sourceware.org/bugzilla/show_bug.cgi?id=15630>
8901 L<https://bugzilla.kernel.org/show_bug.cgi?id=151821>
8905 =head2 Plugin C<unixsock>
8909 =item B<SocketFile> I<Path>
8911 Sets the socket-file which is to be created.
8913 =item B<SocketGroup> I<Group>
8915 If running as root change the group of the UNIX-socket after it has been
8916 created. Defaults to B<collectd>.
8918 =item B<SocketPerms> I<Permissions>
8920 Change the file permissions of the UNIX-socket after it has been created. The
8921 permissions must be given as a numeric, octal value as you would pass to
8922 L<chmod(1)>. Defaults to B<0770>.
8924 =item B<DeleteSocket> B<false>|B<true>
8926 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8927 with the given name already exists. If I<collectd> crashes a socket file may be
8928 left over, preventing the daemon from opening a new socket when restarted.
8929 Since this is potentially dangerous, this defaults to B<false>.
8933 =head2 Plugin C<uuid>
8935 This plugin, if loaded, causes the Hostname to be taken from the machine's
8936 UUID. The UUID is a universally unique designation for the machine, usually
8937 taken from the machine's BIOS. This is most useful if the machine is running in
8938 a virtual environment such as Xen, in which case the UUID is preserved across
8939 shutdowns and migration.
8941 The following methods are used to find the machine's UUID, in order:
8947 Check I</etc/uuid> (or I<UUIDFile>).
8951 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8956 Check for UUID from C<dmidecode> / SMBIOS.
8960 Check for UUID from Xen hypervisor.
8964 If no UUID can be found then the hostname is not modified.
8968 =item B<UUIDFile> I<Path>
8970 Take the UUID from the given file (default I</etc/uuid>).
8974 =head2 Plugin C<varnish>
8976 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8977 It collects a subset of the values displayed by L<varnishstat(1)>, and
8978 organizes them in categories which can be enabled or disabled. Currently only
8979 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8980 meaning of each metric can be found in L<varnish-counters(7)>.
8985 <Instance "example">
8989 CollectConnections true
8990 CollectDirectorDNS false
8994 CollectObjects false
8996 CollectSession false
9006 CollectWorkers false
9008 CollectMempool false
9009 CollectManagement false
9016 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
9017 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
9018 will collectd statistics from the default "varnishd" instance (this should work
9019 fine in most cases).
9021 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
9025 =item B<CollectBackend> B<true>|B<false>
9027 Back-end connection statistics, such as successful, reused,
9028 and closed connections. True by default.
9030 =item B<CollectBan> B<true>|B<false>
9032 Statistics about ban operations, such as number of bans added, retired, and
9033 number of objects tested against ban operations. Only available with Varnish
9034 3.x and above. False by default.
9036 =item B<CollectCache> B<true>|B<false>
9038 Cache hits and misses. True by default.
9040 =item B<CollectConnections> B<true>|B<false>
9042 Number of client connections received, accepted and dropped. True by default.
9044 =item B<CollectDirectorDNS> B<true>|B<false>
9046 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
9049 =item B<CollectESI> B<true>|B<false>
9051 Edge Side Includes (ESI) parse statistics. False by default.
9053 =item B<CollectFetch> B<true>|B<false>
9055 Statistics about fetches (HTTP requests sent to the backend). False by default.
9057 =item B<CollectHCB> B<true>|B<false>
9059 Inserts and look-ups in the crit bit tree based hash. Look-ups are
9060 divided into locked and unlocked look-ups. False by default.
9062 =item B<CollectObjects> B<true>|B<false>
9064 Statistics on cached objects: number of objects expired, nuked (prematurely
9065 expired), saved, moved, etc. False by default.
9067 =item B<CollectPurge> B<true>|B<false>
9069 Statistics about purge operations, such as number of purges added, retired, and
9070 number of objects tested against purge operations. Only available with Varnish
9071 2.x. False by default.
9073 =item B<CollectSession> B<true>|B<false>
9075 Client session statistics. Number of past and current sessions, session herd and
9076 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9077 metrics found in the Connections and Threads sections with previous versions of
9078 Varnish have been moved here.
9080 =item B<CollectSHM> B<true>|B<false>
9082 Statistics about the shared memory log, a memory region to store
9083 log messages which is flushed to disk when full. True by default.
9085 =item B<CollectSMA> B<true>|B<false>
9087 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9088 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9089 only the one used by the Varnish instance. Only available with Varnish 2.x.
9092 =item B<CollectSMS> B<true>|B<false>
9094 synth (synthetic content) storage statistics. This storage
9095 component is used internally only. False by default.
9097 =item B<CollectSM> B<true>|B<false>
9099 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9100 in varnish 4.x. use CollectSMF.
9103 =item B<CollectStruct> B<true>|B<false>
9105 Current varnish internal state statistics. Number of current sessions, objects
9106 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9109 =item B<CollectTotals> B<true>|B<false>
9111 Collects overview counters, such as the number of sessions created,
9112 the number of requests and bytes transferred. False by default.
9114 =item B<CollectUptime> B<true>|B<false>
9116 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9118 =item B<CollectVCL> B<true>|B<false>
9120 Number of total (available + discarded) VCL (config files). False by default.
9122 =item B<CollectVSM> B<true>|B<false>
9124 Collect statistics about Varnish's shared memory usage (used by the logging and
9125 statistics subsystems). Only available with Varnish 4.x. False by default.
9127 =item B<CollectWorkers> B<true>|B<false>
9129 Collect statistics about worker threads. False by default.
9131 =item B<CollectVBE> B<true>|B<false>
9133 Backend counters. Only available with Varnish 4.x. False by default.
9135 =item B<CollectSMF> B<true>|B<false>
9137 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9138 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9139 instance. Used to be called SM in Varnish 2.x. False by default.
9141 =item B<CollectManagement> B<true>|B<false>
9143 Management process counters. Only available with Varnish 4.x. False by default.
9145 =item B<CollectLock> B<true>|B<false>
9147 Lock counters. Only available with Varnish 4.x. False by default.
9149 =item B<CollectMempool> B<true>|B<false>
9151 Memory pool counters. Only available with Varnish 4.x. False by default.
9153 =item B<CollectMSE> B<true>|B<false>
9155 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9156 Varnish, replacing the traditional malloc and file storages. Only available
9157 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9158 one used by the Varnish instance. False by default.
9162 =head2 Plugin C<virt>
9164 This plugin allows CPU, disk, network load and other metrics to be collected for
9165 virtualized guests on the machine. The statistics are collected through libvirt
9166 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9167 installing any additional software on guests, especially I<collectd>, which runs
9168 only on the host system.
9170 Only I<Connection> is required.
9172 Consider the following example config:
9175 Connection "qemu:///system"
9176 HostnameFormat "hostname"
9177 InterfaceFormat "address"
9178 PluginInstanceFormat "name"
9181 It will generate the following values:
9183 node42.example.com/virt-instance-0006f26c/disk_octets-vda
9184 node42.example.com/virt-instance-0006f26c/disk_ops-vda
9185 node42.example.com/virt-instance-0006f26c/if_dropped-ca:fe:ca:fe:ca:fe
9186 node42.example.com/virt-instance-0006f26c/if_errors-ca:fe:ca:fe:ca:fe
9187 node42.example.com/virt-instance-0006f26c/if_octets-ca:fe:ca:fe:ca:fe
9188 node42.example.com/virt-instance-0006f26c/if_packets-ca:fe:ca:fe:ca:fe
9189 node42.example.com/virt-instance-0006f26c/memory-actual_balloon
9190 node42.example.com/virt-instance-0006f26c/memory-available
9191 node42.example.com/virt-instance-0006f26c/memory-last_update
9192 node42.example.com/virt-instance-0006f26c/memory-major_fault
9193 node42.example.com/virt-instance-0006f26c/memory-minor_fault
9194 node42.example.com/virt-instance-0006f26c/memory-rss
9195 node42.example.com/virt-instance-0006f26c/memory-swap_in
9196 node42.example.com/virt-instance-0006f26c/memory-swap_out
9197 node42.example.com/virt-instance-0006f26c/memory-total
9198 node42.example.com/virt-instance-0006f26c/memory-unused
9199 node42.example.com/virt-instance-0006f26c/memory-usable
9200 node42.example.com/virt-instance-0006f26c/virt_cpu_total
9201 node42.example.com/virt-instance-0006f26c/virt_vcpu-0
9203 You can get information on the metric's units from the online libvirt documentation.
9204 For instance, I<virt_cpu_total> is in nanoseconds.
9208 =item B<Connection> I<uri>
9210 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9212 Connection "xen:///"
9214 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9216 =item B<RefreshInterval> I<seconds>
9218 Refresh the list of domains and devices every I<seconds>. The default is 60
9219 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9220 the list of domains and devices to be refreshed on every iteration.
9222 Refreshing the devices in particular is quite a costly operation, so if your
9223 virtualization setup is static you might consider increasing this. If this
9224 option is set to 0, refreshing is disabled completely.
9226 =item B<Domain> I<name>
9228 =item B<BlockDevice> I<name:dev>
9230 =item B<InterfaceDevice> I<name:dev>
9232 =item B<IgnoreSelected> B<true>|B<false>
9234 Select which domains and devices are collected.
9236 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9237 disk/network devices are collected.
9239 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9240 domains and disk/network devices are ignored, while the rest are collected.
9242 The domain name and device names may use a regular expression, if the name is
9243 surrounded by I</.../> and collectd was compiled with support for regexps.
9245 The default is to collect statistics for all domains and all their devices.
9249 BlockDevice "/:hdb/"
9250 IgnoreSelected "true"
9252 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9255 =item B<BlockDeviceFormat> B<target>|B<source>
9257 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9258 seen by the guest will be used for reporting metrics.
9259 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9262 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9263 using the path of the source, e.g. an image file.
9264 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9269 If the domain XML have the following device defined:
9271 <disk type='block' device='disk'>
9272 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9273 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9274 <target dev='sda' bus='scsi'/>
9276 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9279 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9281 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9282 to C<var_lib_libvirt_images_image1.qcow2>.
9284 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9286 The B<BlockDeviceFormatBasename> controls whether the full path or the
9287 L<basename(1)> of the source is being used as the I<type instance> when
9288 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9292 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9293 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9294 be set to C<var_lib_libvirt_images_image1.qcow2>.
9295 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9296 set to C<image1.qcow2>.
9298 =item B<HostnameFormat> B<name|uuid|hostname|metadata...>
9300 When the virt plugin logs data, it sets the hostname of the collected data
9301 according to this setting. The default is to use the guest name as provided by
9302 the hypervisor, which is equal to setting B<name>.
9304 B<uuid> means use the guest's UUID. This is useful if you want to track the
9305 same guest across migrations.
9307 B<hostname> means to use the global B<Hostname> setting, which is probably not
9308 useful on its own because all guests will appear to have the same name. This is
9309 useful in conjunction with B<PluginInstanceFormat> though.
9311 B<metadata> means use information from guest's metadata. Use
9312 B<HostnameMetadataNS> and B<HostnameMetadataXPath> to localize this information.
9314 You can also specify combinations of these fields. For example B<name uuid>
9315 means to concatenate the guest name and UUID (with a literal colon character
9316 between, thus I<"foo:1234-1234-1234-1234">).
9318 At the moment of writing (collectd-5.5), hostname string is limited to 62
9319 characters. In case when combination of fields exceeds 62 characters,
9320 hostname will be truncated without a warning.
9322 =item B<InterfaceFormat> B<name>|B<address>|B<number>
9324 When the virt plugin logs interface data, it sets the name of the collected
9325 data according to this setting. The default is to use the path as provided by
9326 the hypervisor (the "dev" property of the target node), which is equal to
9329 B<address> means use the interface's mac address. This is useful since the
9330 interface path might change between reboots of a guest or across migrations.
9332 B<number> means use the interface's number in guest.
9334 =item B<PluginInstanceFormat> B<name|uuid|metadata|none>
9336 When the virt plugin logs data, it sets the plugin_instance of the collected
9337 data according to this setting. The default is to not set the plugin_instance.
9339 B<name> means use the guest's name as provided by the hypervisor.
9340 B<uuid> means use the guest's UUID.
9341 B<metadata> means use information from guest's metadata.
9343 You can also specify combinations of the B<name> and B<uuid> fields.
9344 For example B<name uuid> means to concatenate the guest name and UUID
9345 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9347 =item B<HostnameMetadataNS> B<string>
9349 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9350 selects in which metadata namespace we will pick the hostname. The default is
9351 I<http://openstack.org/xmlns/libvirt/nova/1.0>.
9353 =item B<HostnameMetadataXPath> B<string>
9355 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9356 describes where the hostname is located in the libvirt metadata. The default is
9357 I</instance/name/text()>.
9359 =item B<ExtraStats> B<string>
9361 Report additional extra statistics. The default is no extra statistics, preserving
9362 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9363 allows the plugin to reported more detailed statistics about the behaviour of
9364 Virtual Machines. The argument is a space-separated list of selectors.
9366 Currently supported selectors are:
9370 =item B<cpu_util>: report CPU utilization per domain in percentage.
9372 =item B<disk>: report extra statistics like number of flush operations and total
9373 service time for read, write and flush operations. Requires libvirt API version
9376 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9379 =item B<domain_state>: report domain state and reason in human-readable format as
9380 a notification. If libvirt API version I<0.9.2> or later is available, domain
9381 reason will be included in notification.
9383 =item B<fs_info>: report file system information as a notification. Requires
9384 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9385 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9386 version supports retrieving file system information.
9388 =item B<job_stats_background>: report statistics about progress of a background
9389 job on a domain. Only one type of job statistics can be collected at the same time.
9390 Requires libvirt API version I<1.2.9> or later.
9392 =item B<job_stats_completed>: report statistics about a recently completed job on
9393 a domain. Only one type of job statistics can be collected at the same time.
9394 Requires libvirt API version I<1.2.9> or later.
9396 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9397 Requires libvirt API version I<0.9.11> or later.
9399 =item B<perf>: report performance monitoring events. To collect performance
9400 metrics they must be enabled for domain and supported by the platform. Requires
9401 libvirt API version I<1.3.3> or later.
9402 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9404 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9408 =item B<PersistentNotification> B<true>|B<false>
9410 Override default configuration to only send notifications when there is a change
9411 in the lifecycle state of a domain. When set to true notifications will be sent
9412 for every read cycle. Default is false. Does not affect the stats being
9415 =item B<Instances> B<integer>
9417 How many read instances you want to use for this plugin. The default is one,
9418 and the sensible setting is a multiple of the B<ReadThreads> value.
9420 This option is only useful then domains are specially tagged.
9421 If you are not sure, just use the default setting.
9423 The reader instance will only query the domains with attached a matching tag.
9424 Tags should have the form of 'virt-X' where X is reader instance number,
9427 The special-purpose reader instance #0, guaranteed to be always present,
9428 will query all the domains with missing or unrecognized tag, so no domain will
9431 Domain tagging is done with custom attribute in the libvirt domain metadata
9432 section. Value is taken by XPath I</domain/metadata/ovirtmap/tag/text()>
9433 expression in I<http://ovirt.org/ovirtmap/tag/1.0> namespace.
9434 (XPath and namespace values are not configurable yet).
9436 Tagging could be used by management application to evenly spread the
9437 load among the reader threads, or to pin on the same threads all
9438 the libvirt domains which use the same shared storage, to minimize
9439 the disruption in presence of storage outages.
9443 =head2 Plugin C<vmem>
9445 The C<vmem> plugin collects information about the usage of virtual memory.
9446 Since the statistics provided by the Linux kernel are very detailed, they are
9447 collected very detailed. However, to get all the details, you have to switch
9448 them on manually. Most people just want an overview over, such as the number of
9449 pages read from swap space.
9453 =item B<Verbose> B<true>|B<false>
9455 Enables verbose collection of information. This will start collecting page
9456 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9457 Part of these statistics are collected on a "per zone" basis.
9461 =head2 Plugin C<vserver>
9463 This plugin doesn't have any options. B<VServer> support is only available for
9464 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9465 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9466 need to apply the patches and compile your own kernel, which will then provide
9467 the F</proc/virtual> filesystem that is required by this plugin.
9469 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9471 B<Note>: The traffic collected by this plugin accounts for the amount of
9472 traffic passing a socket which might be a lot less than the actual on-wire
9473 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9474 collect on-wire traffic you could, for example, use the logging facilities of
9475 iptables to feed data for the guest IPs into the iptables plugin.
9477 =head2 Plugin C<write_graphite>
9479 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9480 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9481 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9482 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9483 of at most 1428 bytes to minimize the number of network packets.
9487 <Plugin write_graphite>
9498 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9499 blocks. Inside the B<Node> blocks, the following options are recognized:
9503 =item B<Host> I<Address>
9505 Hostname or address to connect to. Defaults to C<localhost>.
9507 =item B<Port> I<Service>
9509 Service name or port number to connect to. Defaults to C<2003>.
9511 =item B<Protocol> I<String>
9513 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9515 =item B<ReconnectInterval> I<Seconds>
9517 When set to non-zero, forces the connection to the Graphite backend to be
9518 closed and re-opend periodically. This behavior is desirable in environments
9519 where the connection to the Graphite backend is done through load balancers,
9520 for example. When set to zero, the default, the connetion is kept open for as
9523 =item B<LogSendErrors> B<false>|B<true>
9525 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9526 If set to B<false>, it will not log the errors. This is especially useful when
9527 using Protocol UDP since many times we want to use the "fire-and-forget"
9528 approach and logging errors fills syslog with unneeded messages.
9530 =item B<Prefix> I<String>
9532 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9533 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9535 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9538 =item B<Postfix> I<String>
9540 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9541 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9542 (before the first ; that separates the name from the tags).
9544 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9547 =item B<EscapeCharacter> I<Char>
9549 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9550 in the identifier. The B<EscapeCharacter> option determines which character
9551 dots, whitespace and control characters are replaced with. Defaults to
9554 =item B<StoreRates> B<false>|B<true>
9556 If set to B<true> (the default), convert counter values to rates. If set to
9557 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9560 =item B<SeparateInstances> B<false>|B<true>
9562 If set to B<true>, the plugin instance and type instance will be in their own
9563 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9564 default), the plugin and plugin instance (and likewise the type and type
9565 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9567 Option value is not used when B<UseTags> is I<true>.
9569 =item B<AlwaysAppendDS> B<false>|B<true>
9571 If set to 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
9575 =item B<PreserveSeparator> B<false>|B<true>
9577 If set to B<false> (the default) the C<.> (dot) character is replaced with
9578 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9579 is preserved, i.e. passed through.
9581 Option value is not used when B<UseTags> is I<true>.
9583 =item B<DropDuplicateFields> B<false>|B<true>
9585 If set to B<true>, detect and remove duplicate components in Graphite metric
9586 names. For example, the metric name C<host.load.load.shortterm> will
9587 be shortened to C<host.load.shortterm>.
9589 =item B<UseTags> B<false>|B<true>
9591 If set to B<true>, Graphite metric names will be generated as tagged series.
9592 This allows for much more flexibility than the traditional hierarchical layout.
9595 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9597 You can use B<Postfix> option to add more tags by specifying it like
9598 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9601 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9604 Default value: B<false>.
9608 =head2 Plugin C<write_log>
9610 The C<write_log> plugin writes metrics as INFO log messages.
9612 This plugin supports two output formats: I<Graphite> and I<JSON>.
9622 =item B<Format> I<Format>
9624 The output format to use. Can be one of C<Graphite> or C<JSON>.
9628 =head2 Plugin C<write_tsdb>
9630 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9631 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9632 state daemon that ingests metrics and stores them in HBase. The plugin uses
9633 I<TCP> over the "line based" protocol with a default port 4242. The data will
9634 be sent in blocks of at most 1428 bytes to minimize the number of network
9643 Host "tsd-1.my.domain"
9645 HostTags "status=production"
9649 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9650 blocks and global directives.
9652 Global directives are:
9656 =item B<ResolveInterval> I<seconds>
9658 =item B<ResolveJitter> I<seconds>
9660 When I<collectd> connects to a TSDB node, it will request the hostname from
9661 DNS. This can become a problem if the TSDB node is unavailable or badly
9662 configured because collectd will request DNS in order to reconnect for every
9663 metric, which can flood your DNS. So you can cache the last value for
9664 I<ResolveInterval> seconds.
9665 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9667 You can also define a jitter, a random interval to wait in addition to
9668 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9669 hostname at the same time when the connection fails.
9670 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9672 B<Note:> If the DNS resolution has already been successful when the socket
9673 closes, the plugin will try to reconnect immediately with the cached
9674 information. DNS is queried only when the socket is closed for a longer than
9675 I<ResolveInterval> + I<ResolveJitter> seconds.
9679 Inside the B<Node> blocks, the following options are recognized:
9683 =item B<Host> I<Address>
9685 Hostname or address to connect to. Defaults to C<localhost>.
9687 =item B<Port> I<Service>
9689 Service name or port number to connect to. Defaults to C<4242>.
9692 =item B<HostTags> I<String>
9694 When set, I<HostTags> is added to the end of the metric. It is intended to be
9695 used for name=value pairs that the TSD will tag the metric with. Dots and
9696 whitespace are I<not> escaped in this string.
9698 =item B<StoreRates> B<false>|B<true>
9700 If set to B<true>, convert counter values to rates. If set to B<false>
9701 (the default) counter values are stored as is, as an increasing
9704 =item B<AlwaysAppendDS> B<false>|B<true>
9706 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9707 identifier. If set to B<false> (the default), this is only done when there is
9712 =head2 Plugin C<write_mongodb>
9714 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9719 <Plugin "write_mongodb">
9728 The plugin can send values to multiple instances of I<MongoDB> by specifying
9729 one B<Node> block for each instance. Within the B<Node> blocks, the following
9730 options are available:
9734 =item B<Host> I<Address>
9736 Hostname or address to connect to. Defaults to C<localhost>.
9738 =item B<Port> I<Service>
9740 Service name or port number to connect to. Defaults to C<27017>.
9742 =item B<Timeout> I<Milliseconds>
9744 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9745 Setting this option to zero means no timeout, which is the default.
9747 =item B<StoreRates> B<false>|B<true>
9749 If set to B<true> (the default), convert counter values to rates. If set to
9750 B<false> counter values are stored as is, i.e. as an increasing integer
9753 =item B<Database> I<Database>
9755 =item B<User> I<User>
9757 =item B<Password> I<Password>
9759 Sets the information used when authenticating to a I<MongoDB> database. The
9760 fields are optional (in which case no authentication is attempted), but if you
9761 want to use authentication all three fields must be set.
9765 =head2 Plugin C<write_prometheus>
9767 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9768 using I<Prometheus>.
9774 =item B<Host> I<Host>
9776 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
9777 "any" address, i.e. accept packets sent to any of the hosts addresses.
9779 This option is supported only for libmicrohttpd newer than 0.9.0.
9781 =item B<Port> I<Port>
9783 Port the embedded webserver should listen on. Defaults to B<9103>.
9785 =item B<StalenessDelta> I<Seconds>
9787 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9788 hasn't seen any update for it. This value must match the setting in Prometheus.
9789 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9793 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9794 which time a metric without updates is considered "stale". This setting
9795 effectively puts an upper limit on the interval in which metrics are reported.
9797 When the I<write_prometheus plugin> encounters a metric with an interval
9798 exceeding this limit, it will inform you, the user, and provide the metric to
9799 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9800 metric "fresh" each time it is scraped, with the time of the scrape being
9801 considered the time of the update. The result is that there appear more
9802 datapoints in I<Prometheus> than were actually created, but at least the metric
9803 doesn't disappear periodically.
9807 =head2 Plugin C<write_http>
9809 This output plugin submits values to an HTTP server using POST requests and
9810 encoding metrics with JSON or using the C<PUTVAL> command described in
9811 L<collectd-unixsock(5)>.
9815 <Plugin "write_http">
9817 URL "http://example.com/post-collectd"
9824 The plugin can send values to multiple HTTP servers by specifying one
9825 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9826 block, the following options are available:
9832 URL to which the values are submitted to. Mandatory.
9834 =item B<User> I<Username>
9836 Optional user name needed for authentication.
9838 =item B<Password> I<Password>
9840 Optional password needed for authentication.
9842 =item B<VerifyPeer> B<true>|B<false>
9844 Enable or disable peer SSL certificate verification. See
9845 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9847 =item B<VerifyHost> B<true|false>
9849 Enable or disable peer host name verification. If enabled, the plugin checks if
9850 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9851 matches the host name provided by the B<URL> option. If this identity check
9852 fails, the connection is aborted. Obviously, only works when connecting to a
9853 SSL enabled server. Enabled by default.
9855 =item B<CACert> I<File>
9857 File that holds one or more SSL certificates. If you want to use HTTPS you will
9858 possibly need this option. What CA certificates come bundled with C<libcurl>
9859 and are checked by default depends on the distribution you use.
9861 =item B<CAPath> I<Directory>
9863 Directory holding one or more CA certificate files. You can use this if for
9864 some reason all the needed CA certificates aren't in the same file and can't be
9865 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9868 =item B<ClientKey> I<File>
9870 File that holds the private key in PEM format to be used for certificate-based
9873 =item B<ClientCert> I<File>
9875 File that holds the SSL certificate to be used for certificate-based
9878 =item B<ClientKeyPass> I<Password>
9880 Password required to load the private key in B<ClientKey>.
9882 =item B<Header> I<Header>
9884 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9886 Header "X-Custom-Header: custom_value"
9888 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9890 Define which SSL protocol version must be used. By default C<libcurl> will
9891 attempt to figure out the remote SSL protocol version. See
9892 L<curl_easy_setopt(3)> for more details.
9894 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9896 Format of the output to generate. If set to B<Command>, will create output that
9897 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9898 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9899 , will create output in the KairosDB format.
9901 Defaults to B<Command>.
9903 =item B<Attribute> I<String> I<String>
9905 Only available for the KAIROSDB output format.
9907 Consider the two given strings to be the key and value of an additional tag for
9908 each metric being sent out.
9910 You can add multiple B<Attribute>.
9914 Only available for the KAIROSDB output format.
9916 Sets the Cassandra ttl for the data points.
9918 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9920 =item B<Prefix> I<String>
9922 Only available for the KAIROSDB output format.
9924 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9926 =item B<Metrics> B<true>|B<false>
9928 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9930 =item B<Notifications> B<false>|B<true>
9932 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9934 =item B<StoreRates> B<true|false>
9936 If set to B<true>, convert counter values to rates. If set to B<false> (the
9937 default) counter values are stored as is, i.e. as an increasing integer number.
9939 =item B<BufferSize> I<Bytes>
9941 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9942 requests will be generated, but more metrics will be batched / metrics are
9943 cached for longer before being sent, introducing additional delay until they
9944 are available on the server side. I<Bytes> must be at least 1024 and cannot
9945 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9946 Defaults to C<4096>.
9948 =item B<LowSpeedLimit> I<Bytes per Second>
9950 Sets the minimal transfer rate in I<Bytes per Second> below which the
9951 connection with the HTTP server will be considered too slow and aborted. All
9952 the data submitted over this connection will probably be lost. Defaults to 0,
9953 which means no minimum transfer rate is enforced.
9955 =item B<Timeout> I<Timeout>
9957 Sets the maximum time in milliseconds given for HTTP POST operations to
9958 complete. When this limit is reached, the POST operation will be aborted, and
9959 all the data in the current send buffer will probably be lost. Defaults to 0,
9960 which means the connection never times out.
9962 =item B<LogHttpError> B<false>|B<true>
9964 Enables printing of HTTP error code to log. Turned off by default.
9966 The C<write_http> plugin regularly submits the collected values to the HTTP
9967 server. How frequently this happens depends on how much data you are collecting
9968 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9969 slightly below this interval, which you can estimate by monitoring the network
9970 traffic between collectd and the HTTP server.
9974 =head2 Plugin C<write_kafka>
9976 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9980 <Plugin "write_kafka">
9981 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9987 The following options are understood by the I<write_kafka plugin>:
9991 =item E<lt>B<Topic> I<Name>E<gt>
9993 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9994 is given a unique I<Name> and specifies one kafka producer.
9995 Inside the B<Topic> block, the following per-topic options are
10000 =item B<Property> I<String> I<String>
10002 Configure the named property for the current topic. Properties are
10003 forwarded to the kafka producer library B<librdkafka>.
10005 =item B<Key> I<String>
10007 Use the specified string as a partitioning key for the topic. Kafka breaks
10008 topic into partitions and guarantees that for a given topology, the same
10009 consumer will be used for a specific key. The special (case insensitive)
10010 string B<Random> can be used to specify that an arbitrary partition should
10013 =item B<Format> B<Command>|B<JSON>|B<Graphite>
10015 Selects the format in which messages are sent to the broker. If set to
10016 B<Command> (the default), values are sent as C<PUTVAL> commands which are
10017 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
10019 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
10020 an easy and straight forward exchange format.
10022 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
10023 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
10025 =item B<StoreRates> B<true>|B<false>
10027 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
10028 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
10029 default), no conversion is performed. Otherwise the conversion is performed
10030 using the internal value cache.
10032 Please note that currently this option is only used if the B<Format> option has
10033 been set to B<JSON>.
10035 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
10037 A prefix can be added in the metric name when outputting in the I<Graphite>
10040 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
10041 Metric name will be
10042 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>>
10044 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
10046 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
10048 A postfix can be added in the metric name when outputting in the I<Graphite>
10051 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
10052 Metric name will be
10053 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>>
10055 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
10056 name (before the first ; that separates the name from the tags).
10058 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
10060 Specify a character to replace dots (.) in the host part of the metric name.
10061 In I<Graphite> metric name, dots are used as separators between different
10062 metric parts (host, plugin, type).
10063 Default is C<_> (I<Underscore>).
10065 =item B<GraphiteSeparateInstances> B<false>|B<true>
10067 If set to B<true>, the plugin instance and type instance will be in their own
10068 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
10069 default), the plugin and plugin instance (and likewise the type and type
10070 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
10072 Option value is not used when B<GraphiteUseTags> is I<true>.
10074 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
10076 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10077 identifier. If set to B<false> (the default), this is only done when there is
10080 =item B<GraphitePreserveSeparator> B<false>|B<true>
10082 If set to B<false> (the default) the C<.> (dot) character is replaced with
10083 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
10084 is preserved, i.e. passed through.
10086 Option value is not used when B<GraphiteUseTags> is I<true>.
10088 =item B<GraphiteUseTags> B<false>|B<true>
10090 If set to B<true> Graphite metric names will be generated as tagged series.
10092 Default value: B<false>.
10094 =item B<StoreRates> B<true>|B<false>
10096 If set to B<true> (the default), convert counter values to rates. If set to
10097 B<false> counter values are stored as is, i.e. as an increasing integer number.
10099 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10100 converted values will have "rate" appended to the data source type, e.g.
10101 C<ds_type:derive:rate>.
10105 =item B<Property> I<String> I<String>
10107 Configure the kafka producer through properties, you almost always will
10108 want to set B<metadata.broker.list> to your Kafka broker list.
10112 =head2 Plugin C<write_redis>
10114 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
10118 <Plugin "write_redis">
10131 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
10132 the timestamp as the score. Retrieving a date range can then be done using the
10133 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
10134 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
10135 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
10136 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
10137 with the B<Database> parameter (default is C<0>). See
10138 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
10141 The information shown in the synopsis above is the I<default configuration>
10142 which is used by the plugin if no configuration is present.
10144 The plugin can send values to multiple instances of I<Redis> by specifying
10145 one B<Node> block for each instance. Within the B<Node> blocks, the following
10146 options are available:
10150 =item B<Node> I<Nodename>
10152 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10153 instance running on a specified host and port. The node name is a
10154 canonical identifier which is used as I<plugin instance>. It is limited to
10155 51E<nbsp>characters in length.
10157 =item B<Host> I<Hostname>
10159 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10162 =item B<Port> I<Port>
10164 The B<Port> option is the TCP port on which the Redis instance accepts
10165 connections. Either a service name of a port number may be given. Please note
10166 that numerical port numbers must be given as a string, too.
10168 =item B<Timeout> I<Milliseconds>
10170 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10172 =item B<Prefix> I<Prefix>
10174 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10175 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10176 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10177 is recommended but not required to include a trailing slash in I<Prefix>.
10179 =item B<Database> I<Index>
10181 This index selects the redis database to use for writing operations. Defaults
10184 =item B<MaxSetSize> I<Items>
10186 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10187 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10189 =item B<MaxSetDuration> I<Seconds>
10191 The B<MaxSetDuration> option limits the duration of items that the
10192 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10193 is the default behavior.
10195 =item B<StoreRates> B<true>|B<false>
10197 If set to B<true> (the default), convert counter values to rates. If set to
10198 B<false> counter values are stored as is, i.e. as an increasing integer number.
10202 =head2 Plugin C<write_riemann>
10204 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10205 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10206 I<Riemann> using UDP packets.
10210 <Plugin "write_riemann">
10216 AlwaysAppendDS false
10220 Attribute "foo" "bar"
10223 The following options are understood by the I<write_riemann plugin>:
10227 =item E<lt>B<Node> I<Name>E<gt>
10229 The plugin's configuration consists of one or more B<Node> blocks. Each block
10230 is given a unique I<Name> and specifies one connection to an instance of
10231 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10236 =item B<Host> I<Address>
10238 Hostname or address to connect to. Defaults to C<localhost>.
10240 =item B<Port> I<Service>
10242 Service name or port number to connect to. Defaults to C<5555>.
10244 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10246 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10249 =item B<TLSCertFile> I<Path>
10251 When using the B<TLS> protocol, path to a PEM certificate to present
10254 =item B<TLSCAFile> I<Path>
10256 When using the B<TLS> protocol, path to a PEM CA certificate to
10257 use to validate the remote hosts's identity.
10259 =item B<TLSKeyFile> I<Path>
10261 When using the B<TLS> protocol, path to a PEM private key associated
10262 with the certificate defined by B<TLSCertFile>.
10264 =item B<Batch> B<true>|B<false>
10266 If set to B<true> and B<Protocol> is set to B<TCP>,
10267 events will be batched in memory and flushed at
10268 regular intervals or when B<BatchMaxSize> is exceeded.
10270 Notifications are not batched and sent as soon as possible.
10272 When enabled, it can occur that events get processed by the Riemann server
10273 close to or after their expiration time. Tune the B<TTLFactor> and
10274 B<BatchMaxSize> settings according to the amount of values collected, if this
10279 =item B<BatchMaxSize> I<size>
10281 Maximum payload size for a riemann packet. Defaults to 8192
10283 =item B<BatchFlushTimeout> I<seconds>
10285 Maximum amount of seconds to wait in between to batch flushes.
10286 No timeout by default.
10288 =item B<StoreRates> B<true>|B<false>
10290 If set to B<true> (the default), convert counter values to rates. If set to
10291 B<false> counter values are stored as is, i.e. as an increasing integer number.
10293 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10294 converted values will have "rate" appended to the data source type, e.g.
10295 C<ds_type:derive:rate>.
10297 =item B<AlwaysAppendDS> B<false>|B<true>
10299 If set to B<true>, append the name of the I<Data Source> (DS) to the
10300 "service", i.e. the field that, together with the "host" field, uniquely
10301 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10302 only done when there is more than one DS.
10304 =item B<TTLFactor> I<Factor>
10306 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10307 event is considered active. I<collectd> populates this field based on the
10308 metrics interval setting. This setting controls the factor with which the
10309 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10310 know exactly what you're doing, you should only increase this setting from its
10313 =item B<Notifications> B<false>|B<true>
10315 If set to B<true>, create riemann events for notifications. This is B<true>
10316 by default. When processing thresholds from write_riemann, it might prove
10317 useful to avoid getting notification events.
10319 =item B<CheckThresholds> B<false>|B<true>
10321 If set to B<true>, attach state to events based on thresholds defined
10322 in the B<Threshold> plugin. Defaults to B<false>.
10324 =item B<EventServicePrefix> I<String>
10326 Add the given string as a prefix to the event service name.
10327 If B<EventServicePrefix> not set or set to an empty string (""),
10328 no prefix will be used.
10332 =item B<Tag> I<String>
10334 Add the given string as an additional tag to the metric being sent to
10337 =item B<Attribute> I<String> I<String>
10339 Consider the two given strings to be the key and value of an additional
10340 attribute for each metric being sent out to I<Riemann>.
10344 =head2 Plugin C<write_sensu>
10346 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10347 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10348 a local I<Sensu> client using a TCP socket.
10350 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10351 parameter so it is not possible to use one collectd instance as a gateway for
10352 others. Each collectd host must pair with one I<Sensu> client.
10356 <Plugin "write_sensu">
10361 AlwaysAppendDS false
10362 MetricHandler "influx"
10363 MetricHandler "default"
10364 NotificationHandler "flapjack"
10365 NotificationHandler "howling_monkey"
10369 Attribute "foo" "bar"
10372 The following options are understood by the I<write_sensu plugin>:
10376 =item E<lt>B<Node> I<Name>E<gt>
10378 The plugin's configuration consists of one or more B<Node> blocks. Each block
10379 is given a unique I<Name> and specifies one connection to an instance of
10380 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10385 =item B<Host> I<Address>
10387 Hostname or address to connect to. Defaults to C<localhost>.
10389 =item B<Port> I<Service>
10391 Service name or port number to connect to. Defaults to C<3030>.
10393 =item B<StoreRates> B<true>|B<false>
10395 If set to B<true> (the default), convert counter values to rates. If set to
10396 B<false> counter values are stored as is, i.e. as an increasing integer number.
10398 This will be reflected in the C<collectd_data_source_type> tag: If
10399 B<StoreRates> is enabled, converted values will have "rate" appended to the
10400 data source type, e.g. C<collectd_data_source_type:derive:rate>.
10402 =item B<AlwaysAppendDS> B<false>|B<true>
10404 If set the B<true>, append the name of the I<Data Source> (DS) to the
10405 "service", i.e. the field that, together with the "host" field, uniquely
10406 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10407 only done when there is more than one DS.
10409 =item B<Notifications> B<false>|B<true>
10411 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10412 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10414 =item B<Metrics> B<false>|B<true>
10416 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10417 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10420 =item B<Separator> I<String>
10422 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10424 =item B<MetricHandler> I<String>
10426 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10427 several of them, one per line. Defaults to no handler.
10429 =item B<NotificationHandler> I<String>
10431 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10432 add several of them, one per line. Defaults to no handler.
10434 =item B<EventServicePrefix> I<String>
10436 Add the given string as a prefix to the event service name.
10437 If B<EventServicePrefix> not set or set to an empty string (""),
10438 no prefix will be used.
10442 =item B<Tag> I<String>
10444 Add the given string as an additional tag to the metric being sent to
10447 =item B<Attribute> I<String> I<String>
10449 Consider the two given strings to be the key and value of an additional
10450 attribute for each metric being sent out to I<Sensu>.
10454 =head2 Plugin C<write_stackdriver>
10456 The C<write_stackdriver> plugin writes metrics to the
10457 I<Google Stackdriver Monitoring> service.
10459 This plugin supports two authentication methods: When configured, credentials
10460 are read from the JSON credentials file specified with B<CredentialFile>.
10461 Alternatively, when running on
10462 I<Google Compute Engine> (GCE), an I<OAuth> token is retrieved from the
10463 I<metadata server> and used to authenticate to GCM.
10467 <Plugin write_stackdriver>
10468 CredentialFile "/path/to/service_account.json"
10469 <Resource "global">
10470 Label "project_id" "monitored_project"
10476 =item B<CredentialFile> I<file>
10478 Path to a JSON credentials file holding the credentials for a GCP service
10481 If B<CredentialFile> is not specified, the plugin uses I<Application Default
10482 Credentials>. That means which credentials are used depends on the environment:
10488 The environment variable C<GOOGLE_APPLICATION_CREDENTIALS> is checked. If this
10489 variable is specified it should point to a JSON file that defines the
10494 The path C<${HOME}/.config/gcloud/application_default_credentials.json> is
10495 checked. This where credentials used by the I<gcloud> command line utility are
10496 stored. You can use C<gcloud auth application-default login> to create these
10499 Please note that these credentials are often of your personal account, not a
10500 service account, and are therefore unfit to be used in a production
10505 When running on GCE, the built-in service account associated with the virtual
10506 machine instance is used.
10507 See also the B<Email> option below.
10511 =item B<Project> I<Project>
10513 The I<Project ID> or the I<Project Number> of the I<Stackdriver Account>. The
10514 I<Project ID> is a string identifying the GCP project, which you can chose
10515 freely when creating a new project. The I<Project Number> is a 12-digit decimal
10516 number. You can look up both on the I<Developer Console>.
10518 This setting is optional. If not set, the project ID is read from the
10519 credentials file or determined from the GCE's metadata service.
10521 =item B<Email> I<Email> (GCE only)
10523 Choses the GCE I<Service Account> used for authentication.
10525 Each GCE instance has a C<default> I<Service Account> but may also be
10526 associated with additional I<Service Accounts>. This is often used to restrict
10527 the permissions of services running on the GCE instance to the required
10528 minimum. The I<write_stackdriver plugin> requires the
10529 C<https://www.googleapis.com/auth/monitoring> scope. When multiple I<Service
10530 Accounts> are available, this option selects which one is used by
10531 I<write_stackdriver plugin>.
10533 =item B<Resource> I<ResourceType>
10535 Configures the I<Monitored Resource> to use when storing metrics.
10536 More information on I<Monitored Resources> and I<Monitored Resource Types> are
10537 available at L<https://cloud.google.com/monitoring/api/resources>.
10539 This block takes one string argument, the I<ResourceType>. Inside the block are
10540 one or more B<Label> options which configure the resource labels.
10542 This block is optional. The default value depends on the runtime environment:
10543 on GCE, the C<gce_instance> resource type is used, otherwise the C<global>
10544 resource type ist used:
10550 B<On GCE>, defaults to the equivalent of this config:
10552 <Resource "gce_instance">
10553 Label "project_id" "<project_id>"
10554 Label "instance_id" "<instance_id>"
10555 Label "zone" "<zone>"
10558 The values for I<project_id>, I<instance_id> and I<zone> are read from the GCE
10563 B<Elsewhere>, i.e. not on GCE, defaults to the equivalent of this config:
10565 <Resource "global">
10566 Label "project_id" "<Project>"
10569 Where I<Project> refers to the value of the B<Project> option or the project ID
10570 inferred from the B<CredentialFile>.
10574 =item B<Url> I<Url>
10576 URL of the I<Stackdriver Monitoring> API. Defaults to
10577 C<https://monitoring.googleapis.com/v3>.
10581 =head2 Plugin C<xencpu>
10583 This plugin collects metrics of hardware CPU load for machine running Xen
10584 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10585 Result is reported using the C<percent> type, for each CPU (core).
10587 This plugin doesn't have any options (yet).
10589 =head2 Plugin C<zookeeper>
10591 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10592 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
10597 <Plugin "zookeeper">
10604 =item B<Host> I<Address>
10606 Hostname or address to connect to. Defaults to C<localhost>.
10608 =item B<Port> I<Service>
10610 Service name or port number to connect to. Defaults to C<2181>.
10614 =head1 THRESHOLD CONFIGURATION
10616 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
10617 we mean that the values are not only stored or sent somewhere, but that they
10618 are judged and, if a problem is recognized, acted upon. The only action
10619 collectd takes itself is to generate and dispatch a "notification". Plugins can
10620 register to receive notifications and perform appropriate further actions.
10622 Since systems and what you expect them to do differ a lot, you can configure
10623 B<thresholds> for your values freely. This gives you a lot of flexibility but
10624 also a lot of responsibility.
10626 Every time a value is out of range a notification is dispatched. This means
10627 that the idle percentage of your CPU needs to be less then the configured
10628 threshold only once for a notification to be generated. There's no such thing
10629 as a moving average or similar - at least not now.
10631 Also, all values that match a threshold are considered to be relevant or
10632 "interesting". As a consequence collectd will issue a notification if they are
10633 not received for B<Timeout> iterations. The B<Timeout> configuration option is
10634 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
10635 "2" (the default) and some hosts sends it's CPU statistics to the server every
10636 60 seconds, a notification will be dispatched after about 120 seconds. It may
10637 take a little longer because the timeout is checked only once each B<Interval>
10640 When a value comes within range again or is received after it was missing, an
10641 "OKAY-notification" is dispatched.
10643 Here is a configuration example to get you started. Read below for more
10656 <Plugin "interface">
10659 FailureMax 10000000
10673 WarningMin 100000000
10679 There are basically two types of configuration statements: The C<Host>,
10680 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10681 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10682 C<Instance> option. You can combine the block by nesting the blocks, though
10683 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10684 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10685 C<Type> may not contain other blocks. If multiple blocks apply to the same
10686 value the most specific block is used.
10688 The other statements specify the threshold to configure. They B<must> be
10689 included in a C<Type> block. Currently the following statements are recognized:
10693 =item B<FailureMax> I<Value>
10695 =item B<WarningMax> I<Value>
10697 Sets the upper bound of acceptable values. If unset defaults to positive
10698 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10699 will be created. If the value is greater than B<WarningMax> but less than (or
10700 equal to) B<FailureMax> a B<WARNING> notification will be created.
10702 =item B<FailureMin> I<Value>
10704 =item B<WarningMin> I<Value>
10706 Sets the lower bound of acceptable values. If unset defaults to negative
10707 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10708 be created. If the value is less than B<WarningMin> but greater than (or equal
10709 to) B<FailureMin> a B<WARNING> notification will be created.
10711 =item B<DataSource> I<DSName>
10713 Some data sets have more than one "data source". Interesting examples are the
10714 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10715 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10716 system load data set, C<load>, even has three data sources: C<shortterm>,
10717 C<midterm>, and C<longterm>.
10719 Normally, all data sources are checked against a configured threshold. If this
10720 is undesirable, or if you want to specify different limits for each data
10721 source, you can use the B<DataSource> option to have a threshold apply only to
10724 =item B<Invert> B<true>|B<false>
10726 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10727 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10728 B<WarningMax>) are not okay. Defaults to B<false>.
10730 =item B<Persist> B<true>|B<false>
10732 Sets how often notifications are generated. If set to B<true> one notification
10733 will be generated for each value that is out of the acceptable range. If set to
10734 B<false> (the default) then a notification is only generated if a value is out
10735 of range but the previous value was okay.
10737 This applies to missing values, too: If set to B<true> a notification about a
10738 missing value is generated once every B<Interval> seconds. If set to B<false>
10739 only one such notification is generated until the value appears again.
10741 =item B<Percentage> B<true>|B<false>
10743 If set to B<true>, the minimum and maximum values given are interpreted as
10744 percentage value, relative to the other data sources. This is helpful for
10745 example for the "df" type, where you may want to issue a warning when less than
10746 5E<nbsp>% of the total space is available. Defaults to B<false>.
10748 =item B<Hits> I<Number>
10750 Delay creating the notification until the threshold has been passed I<Number>
10751 times. When a notification has been generated, or when a subsequent value is
10752 inside the threshold, the counter is reset. If, for example, a value is
10753 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10754 will be dispatched at most once every 30E<nbsp>seconds.
10756 This is useful when short bursts are not a problem. If, for example, 100% CPU
10757 usage for up to a minute is normal (and data is collected every
10758 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10760 =item B<Hysteresis> I<Number>
10762 When set to non-zero, a hysteresis value is applied when checking minimum and
10763 maximum bounds. This is useful for values that increase slowly and fluctuate a
10764 bit while doing so. When these values come close to the threshold, they may
10765 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10767 If, for example, the threshold is configures as
10772 then a I<Warning> notification is created when the value exceeds I<101> and the
10773 corresponding I<Okay> notification is only created once the value falls below
10774 I<99>, thus avoiding the "flapping".
10778 =head1 FILTER CONFIGURATION
10780 Starting with collectd 4.6 there is a powerful filtering infrastructure
10781 implemented in the daemon. The concept has mostly been copied from
10782 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10783 terminology, so that users that are familiar with iptables feel right at home.
10787 The following are the terms used in the remainder of the filter configuration
10788 documentation. For an ASCII-art schema of the mechanism, see
10789 L<"General structure"> below.
10795 A I<match> is a criteria to select specific values. Examples are, of course, the
10796 name of the value or it's current value.
10798 Matches are implemented in plugins which you have to load prior to using the
10799 match. The name of such plugins starts with the "match_" prefix.
10803 A I<target> is some action that is to be performed with data. Such actions
10804 could, for example, be to change part of the value's identifier or to ignore
10805 the value completely.
10807 Some of these targets are built into the daemon, see L<"Built-in targets">
10808 below. Other targets are implemented in plugins which you have to load prior to
10809 using the target. The name of such plugins starts with the "target_" prefix.
10813 The combination of any number of matches and at least one target is called a
10814 I<rule>. The target actions will be performed for all values for which B<all>
10815 matches apply. If the rule does not have any matches associated with it, the
10816 target action will be performed for all values.
10820 A I<chain> is a list of rules and possibly default targets. The rules are tried
10821 in order and if one matches, the associated target will be called. If a value
10822 is handled by a rule, it depends on the target whether or not any subsequent
10823 rules are considered or if traversal of the chain is aborted, see
10824 L<"Flow control"> below. After all rules have been checked, the default targets
10829 =head2 General structure
10831 The following shows the resulting structure:
10838 +---------+ +---------+ +---------+ +---------+
10839 ! Rule !->! Match !->! Match !->! Target !
10840 +---------+ +---------+ +---------+ +---------+
10843 +---------+ +---------+ +---------+
10844 ! Rule !->! Target !->! Target !
10845 +---------+ +---------+ +---------+
10852 +---------+ +---------+ +---------+
10853 ! Rule !->! Match !->! Target !
10854 +---------+ +---------+ +---------+
10862 =head2 Flow control
10864 There are four ways to control which way a value takes through the filter
10871 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10872 process the value with another chain. When the called chain finishes, usually
10873 the next target or rule after the jump is executed.
10877 The stop condition, signaled for example by the built-in target B<stop>, causes
10878 all processing of the value to be stopped immediately.
10882 Causes processing in the current chain to be aborted, but processing of the
10883 value generally will continue. This means that if the chain was called via
10884 B<Jump>, the next target or rule after the jump will be executed. If the chain
10885 was not called by another chain, control will be returned to the daemon and it
10886 may pass the value to another chain.
10890 Most targets will signal the B<continue> condition, meaning that processing
10891 should continue normally. There is no special built-in target for this
10898 The configuration reflects this structure directly:
10900 PostCacheChain "PostCache"
10901 <Chain "PostCache">
10902 <Rule "ignore_mysql_show">
10905 Type "^mysql_command$"
10906 TypeInstance "^show_"
10916 The above configuration example will ignore all values where the plugin field
10917 is "mysql", the type is "mysql_command" and the type instance begins with
10918 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10919 default target of the chain. Since this chain is run after the value has been
10920 added to the cache, the MySQL C<show_*> command statistics will be available
10921 via the C<unixsock> plugin.
10923 =head2 List of configuration options
10927 =item B<PreCacheChain> I<ChainName>
10929 =item B<PostCacheChain> I<ChainName>
10931 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10932 argument is the name of a I<chain> that should be executed before and/or after
10933 the values have been added to the cache.
10935 To understand the implications, it's important you know what is going on inside
10936 I<collectd>. The following diagram shows how values are passed from the
10937 read-plugins to the write-plugins:
10943 + - - - - V - - - - +
10944 : +---------------+ :
10947 : +-------+-------+ :
10950 : +-------+-------+ : +---------------+
10951 : ! Cache !--->! Value Cache !
10952 : ! insert ! : +---+---+-------+
10953 : +-------+-------+ : ! !
10954 : ! ,------------' !
10956 : +-------+---+---+ : +-------+-------+
10957 : ! Post-Cache +--->! Write-Plugins !
10958 : ! Chain ! : +---------------+
10959 : +---------------+ :
10961 : dispatch values :
10962 + - - - - - - - - - +
10964 After the values are passed from the "read" plugins to the dispatch functions,
10965 the pre-cache chain is run first. The values are added to the internal cache
10966 afterwards. The post-cache chain is run after the values have been added to the
10967 cache. So why is it such a huge deal if chains are run before or after the
10968 values have been added to this cache?
10970 Targets that change the identifier of a value list should be executed before
10971 the values are added to the cache, so that the name in the cache matches the
10972 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10973 this cache to receive a list of all available values. If you change the
10974 identifier after the value list has been added to the cache, this may easily
10975 lead to confusion, but it's not forbidden of course.
10977 The cache is also used to convert counter values to rates. These rates are, for
10978 example, used by the C<value> match (see below). If you use the rate stored in
10979 the cache B<before> the new value is added, you will use the old, B<previous>
10980 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10981 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10984 Last but not last, the B<stop> target makes a difference: If the pre-cache
10985 chain returns the stop condition, the value will not be added to the cache and
10986 the post-cache chain will not be run.
10988 =item B<Chain> I<Name>
10990 Adds a new chain with a certain name. This name can be used to refer to a
10991 specific chain, for example to jump to it.
10993 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10995 =item B<Rule> [I<Name>]
10997 Adds a new rule to the current chain. The name of the rule is optional and
10998 currently has no meaning for the daemon.
11000 Within the B<Rule> block, there may be any number of B<Match> blocks and there
11001 must be at least one B<Target> block.
11003 =item B<Match> I<Name>
11005 Adds a match to a B<Rule> block. The name specifies what kind of match should
11006 be performed. Available matches depend on the plugins that have been loaded.
11008 The arguments inside the B<Match> block are passed to the plugin implementing
11009 the match, so which arguments are valid here depends on the plugin being used.
11010 If you do not need any to pass any arguments to a match, you can use the
11015 Which is equivalent to:
11020 =item B<Target> I<Name>
11022 Add a target to a rule or a default target to a chain. The name specifies what
11023 kind of target is to be added. Which targets are available depends on the
11024 plugins being loaded.
11026 The arguments inside the B<Target> block are passed to the plugin implementing
11027 the target, so which arguments are valid here depends on the plugin being used.
11028 If you do not need any to pass any arguments to a target, you can use the
11033 This is the same as writing:
11040 =head2 Built-in targets
11042 The following targets are built into the core daemon and therefore need no
11043 plugins to be loaded:
11049 Signals the "return" condition, see the L<"Flow control"> section above. This
11050 causes the current chain to stop processing the value and returns control to
11051 the calling chain. The calling chain will continue processing targets and rules
11052 just after the B<jump> target (see below). This is very similar to the
11053 B<RETURN> target of iptables, see L<iptables(8)>.
11055 This target does not have any options.
11063 Signals the "stop" condition, see the L<"Flow control"> section above. This
11064 causes processing of the value to be aborted immediately. This is similar to
11065 the B<DROP> target of iptables, see L<iptables(8)>.
11067 This target does not have any options.
11075 Sends the value to "write" plugins.
11081 =item B<Plugin> I<Name>
11083 Name of the write plugin to which the data should be sent. This option may be
11084 given multiple times to send the data to more than one write plugin. If the
11085 plugin supports multiple instances, the plugin's instance(s) must also be
11090 If no plugin is explicitly specified, the values will be sent to all available
11093 Single-instance plugin example:
11099 Multi-instance plugin example:
11101 <Plugin "write_graphite">
11111 Plugin "write_graphite/foo"
11116 Starts processing the rules of another chain, see L<"Flow control"> above. If
11117 the end of that chain is reached, or a stop condition is encountered,
11118 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
11119 next target or the next rule. This is similar to the B<-j> command line option
11120 of iptables, see L<iptables(8)>.
11126 =item B<Chain> I<Name>
11128 Jumps to the chain I<Name>. This argument is required and may appear only once.
11140 =head2 Available matches
11146 Matches a value using regular expressions.
11152 =item B<Host> I<Regex>
11154 =item B<Plugin> I<Regex>
11156 =item B<PluginInstance> I<Regex>
11158 =item B<Type> I<Regex>
11160 =item B<TypeInstance> I<Regex>
11162 =item B<MetaData> I<String> I<Regex>
11164 Match values where the given regular expressions match the various fields of
11165 the identifier of a value. If multiple regular expressions are given, B<all>
11166 regexen must match for a value to match.
11168 =item B<Invert> B<false>|B<true>
11170 When set to B<true>, the result of the match is inverted, i.e. all value lists
11171 where all regular expressions apply are not matched, all other value lists are
11172 matched. Defaults to B<false>.
11179 Host "customer[0-9]+"
11185 Matches values that have a time which differs from the time on the server.
11187 This match is mainly intended for servers that receive values over the
11188 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
11189 is very sensitive to the timestamp used when updating the RRD files. In
11190 particular, the time must be ever increasing. If a misbehaving client sends one
11191 packet with a timestamp far in the future, all further packets with a correct
11192 time will be ignored because of that one packet. What's worse, such corrupted
11193 RRD files are hard to fix.
11195 This match lets one match all values B<outside> a specified time range
11196 (relative to the server's time), so you can use the B<stop> target (see below)
11197 to ignore the value, for example.
11203 =item B<Future> I<Seconds>
11205 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
11206 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11209 =item B<Past> I<Seconds>
11211 Matches all values that are I<behind> of the server's time by I<Seconds> or
11212 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11224 This example matches all values that are five minutes or more ahead of the
11225 server or one hour (or more) lagging behind.
11229 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
11230 values. If a data-set consists of more than one data-source, all data-sources
11231 must match the specified ranges for a positive match.
11237 =item B<Min> I<Value>
11239 Sets the smallest value which still results in a match. If unset, behaves like
11242 =item B<Max> I<Value>
11244 Sets the largest value which still results in a match. If unset, behaves like
11247 =item B<Invert> B<true>|B<false>
11249 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
11250 no-match is returned and vice versa. Please note that the B<Invert> setting
11251 only effects how B<Min> and B<Max> are applied to a specific value. Especially
11252 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
11254 =item B<DataSource> I<DSName> [I<DSName> ...]
11256 Select one or more of the data sources. If no data source is configured, all
11257 data sources will be checked. If the type handled by the match does not have a
11258 data source of the specified name(s), this will always result in no match
11259 (independent of the B<Invert> setting).
11261 =item B<Satisfy> B<Any>|B<All>
11263 Specifies how checking with several data sources is performed. If set to
11264 B<Any>, the match succeeds if one of the data sources is in the configured
11265 range. If set to B<All> the match only succeeds if all data sources are within
11266 the configured range. Default is B<All>.
11268 Usually B<All> is used for positive matches, B<Any> is used for negative
11269 matches. This means that with B<All> you usually check that all values are in a
11270 "good" range, while with B<Any> you check if any value is within a "bad" range
11271 (or outside the "good" range).
11275 Either B<Min> or B<Max>, but not both, may be unset.
11279 # Match all values smaller than or equal to 100. Matches only if all data
11280 # sources are below 100.
11286 # Match if the value of any data source is outside the range of 0 - 100.
11294 =item B<empty_counter>
11296 Matches all values with one or more data sources of type B<COUNTER> and where
11297 all counter values are zero. These counters usually I<never> increased since
11298 they started existing (and are therefore uninteresting), or got reset recently
11299 or overflowed and you had really, I<really> bad luck.
11301 Please keep in mind that ignoring such counters can result in confusing
11302 behavior: Counters which hardly ever increase will be zero for long periods of
11303 time. If the counter is reset for some reason (machine or service restarted,
11304 usually), the graph will be empty (NAN) for a long time. People may not
11309 Calculates a hash value of the host name and matches values according to that
11310 hash value. This makes it possible to divide all hosts into groups and match
11311 only values that are in a specific group. The intended use is in load
11312 balancing, where you want to handle only part of all data and leave the rest
11315 The hashing function used tries to distribute the hosts evenly. First, it
11316 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11319 for (i = 0; host[i] != 0; i++)
11320 hash_value = (hash_value * 251) + host[i];
11322 The constant 251 is a prime number which is supposed to make this hash value
11323 more random. The code then checks the group for this host according to the
11324 I<Total> and I<Match> arguments:
11326 if ((hash_value % Total) == Match)
11331 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11332 groups), then the least significant bit of the hash value will be the XOR of
11333 all least significant bits in the host name. One consequence is that when you
11334 have two hosts, "server0.example.com" and "server1.example.com", where the host
11335 name differs in one digit only and the digits differ by one, those hosts will
11336 never end up in the same group.
11342 =item B<Match> I<Match> I<Total>
11344 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11345 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11346 be smaller than I<Total>. I<Total> must be at least one, although only values
11347 greater than one really do make any sense.
11349 You can repeat this option to match multiple groups, for example:
11354 The above config will divide the data into seven groups and match groups three
11355 and five. One use would be to keep every value on two hosts so that if one
11356 fails the missing data can later be reconstructed from the second host.
11362 # Operate on the pre-cache chain, so that ignored values are not even in the
11367 # Divide all received hosts in seven groups and accept all hosts in
11371 # If matched: Return and continue.
11374 # If not matched: Return and stop.
11380 =head2 Available targets
11384 =item B<notification>
11386 Creates and dispatches a notification.
11392 =item B<Message> I<String>
11394 This required option sets the message of the notification. The following
11395 placeholders will be replaced by an appropriate value:
11403 =item B<%{plugin_instance}>
11407 =item B<%{type_instance}>
11409 These placeholders are replaced by the identifier field of the same name.
11411 =item B<%{ds:>I<name>B<}>
11413 These placeholders are replaced by a (hopefully) human readable representation
11414 of the current rate of this data source. If you changed the instance name
11415 (using the B<set> or B<replace> targets, see below), it may not be possible to
11416 convert counter values to rates.
11420 Please note that these placeholders are B<case sensitive>!
11422 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11424 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11431 <Target "notification">
11432 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11438 Replaces parts of the identifier using regular expressions.
11444 =item B<Host> I<Regex> I<Replacement>
11446 =item B<Plugin> I<Regex> I<Replacement>
11448 =item B<PluginInstance> I<Regex> I<Replacement>
11450 =item B<TypeInstance> I<Regex> I<Replacement>
11452 =item B<MetaData> I<String> I<Regex> I<Replacement>
11454 =item B<DeleteMetaData> I<String> I<Regex>
11456 Match the appropriate field with the given regular expression I<Regex>. If the
11457 regular expression matches, that part that matches is replaced with
11458 I<Replacement>. If multiple places of the input buffer match a given regular
11459 expression, only the first occurrence will be replaced.
11461 You can specify each option multiple times to use multiple regular expressions
11469 # Replace "example.net" with "example.com"
11470 Host "\\<example.net\\>" "example.com"
11472 # Strip "www." from hostnames
11473 Host "\\<www\\." ""
11478 Sets part of the identifier of a value to a given string.
11484 =item B<Host> I<String>
11486 =item B<Plugin> I<String>
11488 =item B<PluginInstance> I<String>
11490 =item B<TypeInstance> I<String>
11492 =item B<MetaData> I<String> I<String>
11494 Set the appropriate field to the given string. The strings for plugin instance,
11495 type instance, and meta data may be empty, the strings for host and plugin may
11496 not be empty. It's currently not possible to set the type of a value this way.
11498 The following placeholders will be replaced by an appropriate value:
11506 =item B<%{plugin_instance}>
11510 =item B<%{type_instance}>
11512 These placeholders are replaced by the identifier field of the same name.
11514 =item B<%{meta:>I<name>B<}>
11516 These placeholders are replaced by the meta data value with the given name.
11520 Please note that these placeholders are B<case sensitive>!
11522 =item B<DeleteMetaData> I<String>
11524 Delete the named meta data field.
11531 PluginInstance "coretemp"
11532 TypeInstance "core3"
11537 =head2 Backwards compatibility
11539 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11540 B<Chain> block, it will behave as it used to. This is equivalent to the
11541 following configuration:
11543 <Chain "PostCache">
11547 If you specify a B<PostCacheChain>, the B<write> target will not be added
11548 anywhere and you will have to make sure that it is called where appropriate. We
11549 suggest to add the above snippet as default target to your "PostCache" chain.
11553 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11568 B<Ignorelists> are a generic framework to either ignore some metrics or report
11569 specific metircs only. Plugins usually provide one or more options to specify
11570 the items (mounts points, devices, ...) and the boolean option
11575 =item B<Select> I<String>
11577 Selects the item I<String>. This option often has a plugin specific name, e.g.
11578 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11579 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11580 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11582 By default, this option is doing a case-sensitive full-string match. The
11583 following config will match C<foo>, but not C<Foo>:
11587 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11588 I<regular expression>. For example, so match all item starting with C<foo>, use
11589 could use the following syntax:
11593 The regular expression is I<not> anchored, i.e. the following config will match
11594 C<foobar>, C<barfoo> and C<AfooZ>:
11598 The B<Select> option may be repeated to select multiple items.
11600 =item B<IgnoreSelected> B<true>|B<false>
11602 If set to B<true>, matching metrics are I<ignored> and all other metrics are
11603 collected. If set to B<false>, matching metrics are I<collected> and all other
11604 metrics are ignored.
11611 L<collectd-exec(5)>,
11612 L<collectd-perl(5)>,
11613 L<collectd-unixsock(5)>,
11626 Florian Forster E<lt>octo@collectd.orgE<gt>