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"
1804 CACert "/path/to/ca.crt"
1805 Header "X-Custom-Header: foobar"
1808 MeasureResponseTime false
1809 MeasureResponseCode false
1812 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1813 DSType "GaugeAverage"
1814 # Note: `stock_value' is not a standard type.
1821 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1822 a web page and one or more "matches" to be performed on the returned data. The
1823 string argument to the B<Page> block is used as plugin instance.
1825 The following options are valid within B<Page> blocks:
1829 =item B<Plugin> I<Plugin>
1831 Use I<Plugin> as the plugin name when submitting values.
1832 Defaults to C<curl>.
1836 URL of the web site to retrieve. Since a regular expression will be used to
1837 extract information from this data, non-binary data is a big plus here ;)
1839 =item B<AddressFamily> I<Type>
1841 IP version to resolve URL to. Useful in cases when hostname in URL resolves
1842 to both IPv4 and IPv6 addresses, and you are interested in using one of them
1844 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6. If C<libcurl> is compiled
1845 without IPv6 support, the latter will result in a warning, and fallback to C<any>.
1846 If C<Type> cannot be parsed, C<any> will be used as well (all IP versions that
1847 your system allows).
1849 =item B<User> I<Name>
1851 Username to use if authorization is required to read the page.
1853 =item B<Password> I<Password>
1855 Password to use if authorization is required to read the page.
1857 =item B<Digest> B<true>|B<false>
1859 Enable HTTP digest authentication.
1861 =item B<VerifyPeer> B<true>|B<false>
1863 Enable or disable peer SSL certificate verification. See
1864 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1866 =item B<VerifyHost> B<true>|B<false>
1868 Enable or disable peer host name verification. If enabled, the plugin checks if
1869 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1870 matches the host name provided by the B<URL> option. If this identity check
1871 fails, the connection is aborted. Obviously, only works when connecting to a
1872 SSL enabled server. Enabled by default.
1874 =item B<CACert> I<file>
1876 File that holds one or more SSL certificates. If you want to use HTTPS you will
1877 possibly need this option. What CA certificates come bundled with C<libcurl>
1878 and are checked by default depends on the distribution you use.
1880 =item B<Header> I<Header>
1882 A HTTP header to add to the request. Multiple headers are added if this option
1883 is specified more than once.
1885 =item B<Post> I<Body>
1887 Specifies that the HTTP operation should be a POST instead of a GET. The
1888 complete data to be posted is given as the argument. This option will usually
1889 need to be accompanied by a B<Header> option to set an appropriate
1890 C<Content-Type> for the post body (e.g. to
1891 C<application/x-www-form-urlencoded>).
1893 =item B<MeasureResponseTime> B<true>|B<false>
1895 Measure response time for the request. If this setting is enabled, B<Match>
1896 blocks (see below) are optional. Disabled by default.
1898 Beware that requests will get aborted if they take too long to complete. Adjust
1899 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1902 This option is similar to enabling the B<TotalTime> statistic but it's
1903 measured by collectd instead of cURL.
1905 =item B<MeasureResponseCode> B<true>|B<false>
1907 Measure response code for the request. If this setting is enabled, B<Match>
1908 blocks (see below) are optional. Disabled by default.
1910 =item B<E<lt>StatisticsE<gt>>
1912 One B<Statistics> block can be used to specify cURL statistics to be collected
1913 for each request to the remote web site. See the section "cURL Statistics"
1914 above for details. If this setting is enabled, B<Match> blocks (see below) are
1917 =item B<E<lt>MatchE<gt>>
1919 One or more B<Match> blocks that define how to match information in the data
1920 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1921 used by the C<tail> plugin, so please see the documentation of the C<tail>
1922 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1923 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1926 =item B<Interval> I<Interval>
1928 Sets the interval (in seconds) in which the values will be collected from this
1929 URL. By default the global B<Interval> setting will be used.
1931 =item B<Timeout> I<Milliseconds>
1933 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1934 milliseconds. By default, the configured B<Interval> is used to set the
1935 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1936 indefinitely. This legacy behaviour can be achieved by setting the value of
1939 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1940 network connection will stall one read thread. Adjust the B<ReadThreads> global
1941 setting accordingly to prevent this from blocking other plugins.
1945 =head2 Plugin C<curl_json>
1947 The B<curl_json plugin> collects values from JSON data to be parsed by
1948 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1949 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1950 unix socket. The former can be used, for example, to collect values
1951 from CouchDB documents (which are stored JSON notation), and the
1952 latter to collect values from a uWSGI stats socket.
1954 The following example will collect several values from the built-in
1955 C<_stats> runtime statistics module of I<CouchDB>
1956 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1959 <URL "http://localhost:5984/_stats">
1961 <Key "httpd/requests/count">
1962 Type "http_requests"
1965 <Key "httpd_request_methods/*/count">
1966 Type "http_request_methods"
1969 <Key "httpd_status_codes/*/count">
1970 Type "http_response_codes"
1975 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1978 <Sock "/var/run/uwsgi.stats.sock">
1980 <Key "workers/*/requests">
1981 Type "http_requests"
1984 <Key "workers/*/apps/*/requests">
1985 Type "http_requests"
1990 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1991 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1992 blocks defining a unix socket to read JSON from directly. Each of
1993 these blocks may have one or more B<Key> blocks.
1995 The B<Key> string argument must be in a path format. Each component is
1996 used to match the key from a JSON map or the index of an JSON
1997 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1998 values for all map keys or array indices will be collectd.
2000 The following options are valid within B<URL> blocks:
2004 =item B<Host> I<Name>
2006 Use I<Name> as the host name when submitting values. Defaults to the global
2009 =item B<Plugin> I<Plugin>
2011 Use I<Plugin> as the plugin name when submitting values.
2012 Defaults to C<curl_json>.
2014 =item B<Instance> I<Instance>
2016 Sets the plugin instance to I<Instance>.
2018 =item B<Interval> I<Interval>
2020 Sets the interval (in seconds) in which the values will be collected from this
2021 URL. By default the global B<Interval> setting will be used.
2023 =item B<User> I<Name>
2025 =item B<Password> I<Password>
2027 =item B<Digest> B<true>|B<false>
2029 =item B<VerifyPeer> B<true>|B<false>
2031 =item B<VerifyHost> B<true>|B<false>
2033 =item B<CACert> I<file>
2035 =item B<Header> I<Header>
2037 =item B<Post> I<Body>
2039 =item B<Timeout> I<Milliseconds>
2041 These options behave exactly equivalent to the appropriate options of the
2042 I<cURL> plugin. Please see there for a detailed description.
2044 =item B<E<lt>StatisticsE<gt>>
2046 One B<Statistics> block can be used to specify cURL statistics to be collected
2047 for each request to the remote URL. See the section "cURL Statistics" above
2052 The following options are valid within B<Key> blocks:
2056 =item B<Type> I<Type>
2058 Sets the type used to dispatch the values to the daemon. Detailed information
2059 about types and their configuration can be found in L<types.db(5)>. This
2060 option is mandatory.
2062 =item B<Instance> I<Instance>
2064 Type-instance to use. Defaults to the current map key or current string array element value.
2068 =head2 Plugin C<curl_xml>
2070 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2071 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2074 <URL "http://localhost/stats.xml">
2077 Instance "some_instance"
2082 CACert "/path/to/ca.crt"
2083 Header "X-Custom-Header: foobar"
2086 <XPath "table[@id=\"magic_level\"]/tr">
2088 #InstancePrefix "prefix-"
2089 InstanceFrom "td[1]"
2090 #PluginInstanceFrom "td[1]"
2091 ValuesFrom "td[2]/span[@class=\"level\"]"
2096 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2097 URL to be fetched using libcurl. Within each B<URL> block there are
2098 options which specify the connection parameters, for example authentication
2099 information, and one or more B<XPath> blocks.
2101 Each B<XPath> block specifies how to get one type of information. The
2102 string argument must be a valid XPath expression which returns a list
2103 of "base elements". One value is dispatched for each "base element". The
2104 I<type instance> and values are looked up using further I<XPath> expressions
2105 that should be relative to the base element.
2107 Within the B<URL> block the following options are accepted:
2111 =item B<Host> I<Name>
2113 Use I<Name> as the host name when submitting values. Defaults to the global
2116 =item B<Plugin> I<Plugin>
2118 Use I<Plugin> as the plugin name when submitting values.
2119 Defaults to 'curl_xml'.
2121 =item B<Instance> I<Instance>
2123 Use I<Instance> as the plugin instance when submitting values.
2124 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2125 Defaults to an empty string (no plugin instance).
2127 =item B<Interval> I<Interval>
2129 Sets the interval (in seconds) in which the values will be collected from this
2130 URL. By default the global B<Interval> setting will be used.
2132 =item B<Namespace> I<Prefix> I<URL>
2134 If an XPath expression references namespaces, they must be specified
2135 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2136 I<URL> is the "namespace name", an URI reference uniquely identifying the
2137 namespace. The option can be repeated to register multiple namespaces.
2141 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2142 Namespace "m" "http://www.w3.org/1998/Math/MathML"
2144 =item B<User> I<User>
2146 =item B<Password> I<Password>
2148 =item B<Digest> B<true>|B<false>
2150 =item B<VerifyPeer> B<true>|B<false>
2152 =item B<VerifyHost> B<true>|B<false>
2154 =item B<CACert> I<CA Cert File>
2156 =item B<Header> I<Header>
2158 =item B<Post> I<Body>
2160 =item B<Timeout> I<Milliseconds>
2162 These options behave exactly equivalent to the appropriate options of the
2163 I<cURL plugin>. Please see there for a detailed description.
2165 =item B<E<lt>StatisticsE<gt>>
2167 One B<Statistics> block can be used to specify cURL statistics to be collected
2168 for each request to the remote URL. See the section "cURL Statistics" above
2171 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2173 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2174 B<XPath> block specifies how to get one type of information. The string
2175 argument must be a valid XPath expression which returns a list of "base
2176 elements". One value is dispatched for each "base element".
2178 Within the B<XPath> block the following options are accepted:
2182 =item B<Type> I<Type>
2184 Specifies the I<Type> used for submitting patches. This determines the number
2185 of values that are required / expected and whether the strings are parsed as
2186 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2187 This option is required.
2189 =item B<InstancePrefix> I<InstancePrefix>
2191 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2192 concatenated together without any separator.
2193 This option is optional.
2195 =item B<InstanceFrom> I<InstanceFrom>
2197 Specifies a XPath expression to use for determining the I<type instance>. The
2198 XPath expression must return exactly one element. The element's value is then
2199 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2201 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2203 Specifies a XPath expression to use for determining the I<plugin instance>. The
2204 XPath expression must return exactly one element. The element's value is then
2205 used as I<plugin instance>.
2209 If the "base XPath expression" (the argument to the B<XPath> block) returns
2210 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2211 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2215 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2217 Specifies one or more XPath expression to use for reading the values. The
2218 number of XPath expressions must match the number of data sources in the
2219 I<type> specified with B<Type> (see above). Each XPath expression must return
2220 exactly one element. The element's value is then parsed as a number and used as
2221 value for the appropriate value in the value list dispatched to the daemon.
2222 This option is required.
2228 =head2 Plugin C<dbi>
2230 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2231 connect to various databases, execute I<SQL> statements and read back the
2232 results. I<dbi> is an acronym for "database interface" in case you were
2233 wondering about the name. You can configure how each column is to be
2234 interpreted and the plugin will generate one or more data sets from each row
2235 returned according to these rules.
2237 Because the plugin is very generic, the configuration is a little more complex
2238 than those of other plugins. It usually looks something like this:
2241 <Query "out_of_stock">
2242 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2243 # Use with MySQL 5.0.0 or later
2247 InstancePrefix "out_of_stock"
2248 InstancesFrom "category"
2252 <Database "product_information">
2256 DriverOption "host" "localhost"
2257 DriverOption "username" "collectd"
2258 DriverOption "password" "aZo6daiw"
2259 DriverOption "dbname" "prod_info"
2260 SelectDB "prod_info"
2261 Query "out_of_stock"
2265 The configuration above defines one query with one result and one database. The
2266 query is then linked to the database with the B<Query> option I<within> the
2267 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2268 and you can also use the B<Include> statement to split up the configuration
2269 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2270 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2273 The following is a complete list of options:
2275 =head3 B<Query> blocks
2277 Query blocks define I<SQL> statements and how the returned data should be
2278 interpreted. They are identified by the name that is given in the opening line
2279 of the block. Thus the name needs to be unique. Other than that, the name is
2280 not used in collectd.
2282 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2283 define which column holds which value or instance information. You can use
2284 multiple B<Result> blocks to create multiple values from one returned row. This
2285 is especially useful, when queries take a long time and sending almost the same
2286 query again and again is not desirable.
2290 <Query "environment">
2291 Statement "select station, temperature, humidity from environment"
2294 # InstancePrefix "foo"
2295 InstancesFrom "station"
2296 ValuesFrom "temperature"
2300 InstancesFrom "station"
2301 ValuesFrom "humidity"
2305 The following options are accepted:
2309 =item B<Statement> I<SQL>
2311 Sets the statement that should be executed on the server. This is B<not>
2312 interpreted by collectd, but simply passed to the database server. Therefore,
2313 the SQL dialect that's used depends on the server collectd is connected to.
2315 The query has to return at least two columns, one for the instance and one
2316 value. You cannot omit the instance, even if the statement is guaranteed to
2317 always return exactly one line. In that case, you can usually specify something
2320 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2322 (That works with MySQL but may not be valid SQL according to the spec. If you
2323 use a more strict database server, you may have to select from a dummy table or
2326 Please note that some databases, for example B<Oracle>, will fail if you
2327 include a semicolon at the end of the statement.
2329 =item B<MinVersion> I<Version>
2331 =item B<MaxVersion> I<Value>
2333 Only use this query for the specified database version. You can use these
2334 options to provide multiple queries with the same name but with a slightly
2335 different syntax. The plugin will use only those queries, where the specified
2336 minimum and maximum versions fit the version of the database in use.
2338 The database version is determined by C<dbi_conn_get_engine_version>, see the
2339 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2340 for details. Basically, each part of the version is assumed to be in the range
2341 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2342 "40102", version "5.0.42" becomes "50042".
2344 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2345 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2346 happen. Don't to it! A valid example would be something along these lines:
2357 In the above example, there are three ranges that don't overlap. The last one
2358 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2359 before "4.0.0" are not specified.
2361 =item B<Type> I<Type>
2363 The B<type> that's used for each line returned. See L<types.db(5)> for more
2364 details on how types are defined. In short: A type is a predefined layout of
2365 data and the number of values and type of values has to match the type
2368 If you specify "temperature" here, you need exactly one gauge column. If you
2369 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2372 There must be exactly one B<Type> option inside each B<Result> block.
2374 =item B<InstancePrefix> I<prefix>
2376 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2377 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2378 all strings returned in the appropriate columns are concatenated together,
2379 separated by dashes I<("-")>.
2381 =item B<InstancesFrom> I<column0> [I<column1> ...]
2383 Specifies the columns whose values will be used to create the "type-instance"
2384 for each row. If you specify more than one column, the value of all columns
2385 will be joined together with dashes I<("-")> as separation characters.
2387 The plugin itself does not check whether or not all built instances are
2388 different. It's your responsibility to assure that each is unique. This is
2389 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2390 sure that only one row is returned in this case.
2392 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2395 =item B<ValuesFrom> I<column0> [I<column1> ...]
2397 Names the columns whose content is used as the actual data for the data sets
2398 that are dispatched to the daemon. How many such columns you need is determined
2399 by the B<Type> setting above. If you specify too many or not enough columns,
2400 the plugin will complain about that and no data will be submitted to the
2403 The actual data type in the columns is not that important. The plugin will
2404 automatically cast the values to the right type if it know how to do that. So
2405 it should be able to handle integer an floating point types, as well as strings
2406 (if they include a number at the beginning).
2408 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2410 =item B<MetadataFrom> [I<column0> I<column1> ...]
2412 Names the columns whose content is used as metadata for the data sets
2413 that are dispatched to the daemon.
2415 The actual data type in the columns is not that important. The plugin will
2416 automatically cast the values to the right type if it know how to do that. So
2417 it should be able to handle integer an floating point types, as well as strings
2418 (if they include a number at the beginning).
2422 =head3 B<Database> blocks
2424 Database blocks define a connection to a database and which queries should be
2425 sent to that database. Since the used "dbi" library can handle a wide variety
2426 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2427 documentationE<nbsp>- we stick as close to the terminology used there.
2429 Each database needs a "name" as string argument in the starting tag of the
2430 block. This name will be used as "PluginInstance" in the values submitted to
2431 the daemon. Other than that, that name is not used.
2435 =item B<Plugin> I<Plugin>
2437 Use I<Plugin> as the plugin name when submitting query results from
2438 this B<Database>. Defaults to C<dbi>.
2440 =item B<Interval> I<Interval>
2442 Sets the interval (in seconds) in which the values will be collected from this
2443 database. By default the global B<Interval> setting will be used.
2445 =item B<Driver> I<Driver>
2447 Specifies the driver to use to connect to the database. In many cases those
2448 drivers are named after the database they can connect to, but this is not a
2449 technical necessity. These drivers are sometimes referred to as "DBD",
2450 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2451 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2452 project at L<http://libdbi-drivers.sourceforge.net/>.
2454 You need to give the driver name as expected by the "dbi" library here. You
2455 should be able to find that in the documentation for each driver. If you
2456 mistype the driver name, the plugin will dump a list of all known driver names
2459 =item B<DriverOption> I<Key> I<Value>
2461 Sets driver-specific options. What option a driver supports can be found in the
2462 documentation for each driver, somewhere at
2463 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2464 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2466 DBDs can register two types of options: String options and numeric options. The
2467 plugin will use the C<dbi_conn_set_option> function when the configuration
2468 provides a string and the C<dbi_conn_require_option_numeric> function when the
2469 configuration provides a number. So these two lines will actually result in
2470 different calls being used:
2472 DriverOption "Port" 1234 # numeric
2473 DriverOption "Port" "1234" # string
2475 Unfortunately, drivers are not too keen to report errors when an unknown option
2476 is passed to them, so invalid settings here may go unnoticed. This is not the
2477 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2478 the driver. If a driver complains about an option, the plugin will dump a
2479 complete list of all options understood by that driver to the log. There is no
2480 way to programmatically find out if an option expects a string or a numeric
2481 argument, so you will have to refer to the appropriate DBD's documentation to
2482 find this out. Sorry.
2484 =item B<SelectDB> I<Database>
2486 In some cases, the database name you connect with is not the database name you
2487 want to use for querying data. If this option is set, the plugin will "select"
2488 (switch to) that database after the connection is established.
2490 =item B<Query> I<QueryName>
2492 Associates the query named I<QueryName> with this database connection. The
2493 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2494 blocks you want to refer to must be placed above the database block you want to
2497 =item B<Host> I<Hostname>
2499 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2500 values. Defaults to the global hostname setting.
2508 =item B<Device> I<Device>
2510 Select partitions based on the devicename.
2512 See F</"IGNORELISTS"> for details.
2514 =item B<MountPoint> I<Directory>
2516 Select partitions based on the mountpoint.
2518 See F</"IGNORELISTS"> for details.
2520 =item B<FSType> I<FSType>
2522 Select partitions based on the filesystem type.
2524 See F</"IGNORELISTS"> for details.
2526 =item B<IgnoreSelected> B<true>|B<false>
2528 Invert the selection: If set to true, all partitions B<except> the ones that
2529 match any one of the criteria are collected. By default only selected
2530 partitions are collected if a selection is made. If no selection is configured
2531 at all, B<all> partitions are selected.
2533 =item B<ReportByDevice> B<true>|B<false>
2535 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2536 (the default), it will report a disk as "root", but with it I<true>, it will be
2537 "sda1" (or whichever).
2539 =item B<ReportInodes> B<true>|B<false>
2541 Enables or disables reporting of free, reserved and used inodes. Defaults to
2542 inode collection being disabled.
2544 Enable this option if inodes are a scarce resource for you, usually because
2545 many small files are stored on the disk. This is a usual scenario for mail
2546 transfer agents and web caches.
2548 =item B<ValuesAbsolute> B<true>|B<false>
2550 Enables or disables reporting of free and used disk space in 1K-blocks.
2551 Defaults to B<true>.
2553 =item B<ValuesPercentage> B<false>|B<true>
2555 Enables or disables reporting of free and used disk space in percentage.
2556 Defaults to B<false>.
2558 This is useful for deploying I<collectd> on the cloud, where machines with
2559 different disk size may exist. Then it is more practical to configure
2560 thresholds based on relative disk size.
2564 =head2 Plugin C<disk>
2566 The C<disk> plugin collects information about the usage of physical disks and
2567 logical disks (partitions). Values collected are the number of octets written
2568 to and read from a disk or partition, the number of read/write operations
2569 issued to the disk and a rather complex "time" it took for these commands to be
2572 Using the following two options you can ignore some disks or configure the
2573 collection only of specific disks.
2577 =item B<Disk> I<Name>
2579 Select the disk I<Name>. Whether it is collected or ignored depends on the
2580 B<IgnoreSelected> setting, see below. As with other plugins that use the
2581 daemon's ignorelist functionality, a string that starts and ends with a slash
2582 is interpreted as a regular expression. Examples:
2587 See F</"IGNORELISTS"> for details.
2589 =item B<IgnoreSelected> B<true>|B<false>
2591 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2592 statements, are ignored or if all other disks are ignored. The behavior
2593 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2594 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2595 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2596 is set to B<true>, all disks are collected B<except> the ones matched.
2598 =item B<UseBSDName> B<true>|B<false>
2600 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2601 default major/minor numbers. Requires collectd to be built with Apple's
2604 =item B<UdevNameAttr> I<Attribute>
2606 Attempt to override disk instance name with the value of a specified udev
2607 attribute when built with B<libudev>. If the attribute is not defined for the
2608 given device, the default name is used. Example:
2610 UdevNameAttr "DM_NAME"
2614 =head2 Plugin C<dns>
2618 =item B<Interface> I<Interface>
2620 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2621 option sets the interface that should be used. If this option is not set, or
2622 set to "any", the plugin will try to get packets from B<all> interfaces. This
2623 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2625 =item B<IgnoreSource> I<IP-address>
2627 Ignore packets that originate from this address.
2629 =item B<SelectNumericQueryTypes> B<true>|B<false>
2631 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2635 =head2 Plugin C<dpdkevents>
2637 The I<dpdkevents plugin> collects events from DPDK such as link status of
2638 network ports and Keep Alive status of DPDK logical cores.
2639 In order to get Keep Alive events following requirements must be met:
2641 - support for Keep Alive implemented in DPDK application. More details can
2642 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2646 <Plugin "dpdkevents">
2652 <Event "link_status">
2653 SendEventsOnUpdate true
2654 EnabledPortMask 0xffff
2655 PortName "interface1"
2656 PortName "interface2"
2657 SendNotification false
2659 <Event "keep_alive">
2660 SendEventsOnUpdate true
2662 KeepAliveShmName "/dpdk_keepalive_shm_name"
2663 SendNotification false
2670 =head3 The EAL block
2674 =item B<Coremask> I<Mask>
2676 =item B<Memorychannels> I<Channels>
2678 Number of memory channels per processor socket.
2680 =item B<FilePrefix> I<File>
2682 The prefix text used for hugepage filenames. The filename will be set to
2683 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2687 =head3 The Event block
2689 The B<Event> block defines configuration for specific event. It accepts a
2690 single argument which specifies the name of the event.
2692 =head4 Link Status event
2696 =item B<SendEventOnUpdate> I<true|false>
2698 If set to true link status value will be dispatched only when it is
2699 different from previously read value. This is an optional argument - default
2702 =item B<EnabledPortMask> I<Mask>
2704 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2705 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2706 that all ports will be enabled. This is an optional argument - by default
2707 all ports are enabled.
2709 =item B<PortName> I<Name>
2711 A string containing an optional name for the enabled DPDK ports. Each PortName
2712 option should contain only one port name; specify as many PortName options as
2713 desired. Default naming convention will be used if PortName is blank. If there
2714 are less PortName options than there are enabled ports, the default naming
2715 convention will be used for the additional ports.
2717 =item B<SendNotification> I<true|false>
2719 If set to true, link status notifications are sent, instead of link status
2720 being collected as a statistic. This is an optional argument - default
2725 =head4 Keep Alive event
2729 =item B<SendEventOnUpdate> I<true|false>
2731 If set to true keep alive value will be dispatched only when it is
2732 different from previously read value. This is an optional argument - default
2735 =item B<LCoreMask> I<Mask>
2737 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2739 =item B<KeepAliveShmName> I<Name>
2741 Shared memory name identifier that is used by secondary process to monitor
2742 the keep alive cores state.
2744 =item B<SendNotification> I<true|false>
2746 If set to true, keep alive notifications are sent, instead of keep alive
2747 information being collected as a statistic. This is an optional
2748 argument - default value is false.
2752 =head2 Plugin C<dpdkstat>
2754 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2755 extended NIC stats API in DPDK.
2766 RteDriverLibPath "/usr/lib/dpdk-pmd"
2768 SharedMemObj "dpdk_collectd_stats_0"
2769 EnabledPortMask 0xffff
2770 PortName "interface1"
2771 PortName "interface2"
2776 =head3 The EAL block
2780 =item B<Coremask> I<Mask>
2782 A string containing an hexadecimal bit mask of the cores to run on. Note that
2783 core numbering can change between platforms and should be determined beforehand.
2785 =item B<Memorychannels> I<Channels>
2787 A string containing a number of memory channels per processor socket.
2789 =item B<FilePrefix> I<File>
2791 The prefix text used for hugepage filenames. The filename will be set to
2792 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2794 =item B<SocketMemory> I<MB>
2796 A string containing amount of Memory to allocate from hugepages on specific
2797 sockets in MB. This is an optional value.
2799 =item B<LogLevel> I<LogLevel_number>
2801 A string containing log level number. This parameter is optional.
2802 If parameter is not present then default value "7" - (INFO) is used.
2803 Value "8" - (DEBUG) can be set to enable debug traces.
2805 =item B<RteDriverLibPath> I<Path>
2807 A string containing path to shared pmd driver lib or path to directory,
2808 where shared pmd driver libs are available. This parameter is optional.
2809 This parameter enable loading of shared pmd driver libs from defined path.
2810 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2811 or "/usr/lib/dpdk-pmd"
2817 =item B<SharedMemObj> I<Mask>
2819 A string containing the name of the shared memory object that should be used to
2820 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2821 Defaults to dpdk_collectd_stats if no other value is configured.
2823 =item B<EnabledPortMask> I<Mask>
2825 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2826 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2827 that all ports will be enabled. This is an optional argument - default
2828 is all ports enabled.
2830 =item B<PortName> I<Name>
2832 A string containing an optional name for the enabled DPDK ports. Each PortName
2833 option should contain only one port name; specify as many PortName options as
2834 desired. Default naming convention will be used if PortName is blank. If there
2835 are less PortName options than there are enabled ports, the default naming
2836 convention will be used for the additional ports.
2840 =head2 Plugin C<email>
2844 =item B<SocketFile> I<Path>
2846 Sets the socket-file which is to be created.
2848 =item B<SocketGroup> I<Group>
2850 If running as root change the group of the UNIX-socket after it has been
2851 created. Defaults to B<collectd>.
2853 =item B<SocketPerms> I<Permissions>
2855 Change the file permissions of the UNIX-socket after it has been created. The
2856 permissions must be given as a numeric, octal value as you would pass to
2857 L<chmod(1)>. Defaults to B<0770>.
2859 =item B<MaxConns> I<Number>
2861 Sets the maximum number of connections that can be handled in parallel. Since
2862 this many threads will be started immediately setting this to a very high
2863 value will waste valuable resources. Defaults to B<5> and will be forced to be
2864 at most B<16384> to prevent typos and dumb mistakes.
2868 =head2 Plugin C<ethstat>
2870 The I<ethstat plugin> collects information about network interface cards (NICs)
2871 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2877 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2878 Map "multicast" "if_multicast"
2885 =item B<Interface> I<Name>
2887 Collect statistical information about interface I<Name>.
2889 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2891 By default, the plugin will submit values as type C<derive> and I<type
2892 instance> set to I<Name>, the name of the metric as reported by the driver. If
2893 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2894 I<TypeInstance> will be used.
2896 =item B<MappedOnly> B<true>|B<false>
2898 When set to B<true>, only metrics that can be mapped to a I<type> will be
2899 collected, all other metrics will be ignored. Defaults to B<false>.
2903 =head2 Plugin C<exec>
2905 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2906 contains valuable information on when the executable is executed and the
2907 output that is expected from it.
2911 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2913 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2915 Execute the executable I<Executable> as user I<User>. If the user name is
2916 followed by a colon and a group name, the effective group is set to that group.
2917 The real group and saved-set group will be set to the default group of that
2918 user. If no group is given the effective group ID will be the same as the real
2921 Please note that in order to change the user and/or group the daemon needs
2922 superuser privileges. If the daemon is run as an unprivileged user you must
2923 specify the same user/group here. If the daemon is run with superuser
2924 privileges, you must supply a non-root user here.
2926 The executable may be followed by optional arguments that are passed to the
2927 program. Please note that due to the configuration parsing numbers and boolean
2928 values may be changed. If you want to be absolutely sure that something is
2929 passed as-is please enclose it in quotes.
2931 The B<Exec> and B<NotificationExec> statements change the semantics of the
2932 programs executed, i.E<nbsp>e. the data passed to them and the response
2933 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2937 =head2 Plugin C<fhcount>
2939 The C<fhcount> plugin provides statistics about used, unused and total number of
2940 file handles on Linux.
2942 The I<fhcount plugin> provides the following configuration options:
2946 =item B<ValuesAbsolute> B<true>|B<false>
2948 Enables or disables reporting of file handles usage in absolute numbers,
2949 e.g. file handles used. Defaults to B<true>.
2951 =item B<ValuesPercentage> B<false>|B<true>
2953 Enables or disables reporting of file handles usage in percentages, e.g.
2954 percent of file handles used. Defaults to B<false>.
2958 =head2 Plugin C<filecount>
2960 The C<filecount> plugin counts the number of files in a certain directory (and
2961 its subdirectories) and their combined size. The configuration is very straight
2964 <Plugin "filecount">
2965 <Directory "/var/qmail/queue/mess">
2966 Instance "qmail-message"
2968 <Directory "/var/qmail/queue/todo">
2969 Instance "qmail-todo"
2971 <Directory "/var/lib/php5">
2972 Instance "php5-sessions"
2977 The example above counts the number of files in QMail's queue directories and
2978 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2979 QMail has not yet looked at, the "message" queue holds the messages that were
2980 classified into "local" and "remote".
2982 As you can see, the configuration consists of one or more C<Directory> blocks,
2983 each of which specifies a directory in which to count the files. Within those
2984 blocks, the following options are recognized:
2988 =item B<Plugin> I<Plugin>
2990 Use I<Plugin> as the plugin name when submitting values.
2991 Defaults to B<filecount>.
2993 =item B<Instance> I<Instance>
2995 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2996 the directory name with all slashes replaced by underscores and all leading
2997 underscores removed. Empty value is allowed.
2999 =item B<Name> I<Pattern>
3001 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
3002 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
3003 against the pattern, not the entire path. In case this makes it easier for you:
3004 This option has been named after the B<-name> parameter to L<find(1)>.
3006 =item B<MTime> I<Age>
3008 Count only files of a specific age: If I<Age> is greater than zero, only files
3009 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
3010 a negative number, this is inversed. For example, if B<-60> is specified, only
3011 files that have been modified in the last minute will be counted.
3013 The number can also be followed by a "multiplier" to easily specify a larger
3014 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3015 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3016 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3017 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3018 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3021 =item B<Size> I<Size>
3023 Count only files of a specific size. When I<Size> is a positive number, only
3024 files that are at least this big are counted. If I<Size> is a negative number,
3025 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3026 I<Size> are counted.
3028 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3029 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3030 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3031 note that there are 1000 bytes in a kilobyte, not 1024.
3033 =item B<Recursive> I<true>|I<false>
3035 Controls whether or not to recurse into subdirectories. Enabled by default.
3037 =item B<IncludeHidden> I<true>|I<false>
3039 Controls whether or not to include "hidden" files and directories in the count.
3040 "Hidden" files and directories are those, whose name begins with a dot.
3041 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3043 =item B<RegularOnly> I<true>|I<false>
3045 Controls whether or not to include only regular files in the count.
3046 Defaults to I<true>, i.e. by default non regular files are ignored.
3048 =item B<FilesSizeType> I<Type>
3050 Sets the type used to dispatch files combined size. Empty value ("") disables
3051 reporting. Defaults to B<bytes>.
3053 =item B<FilesCountType> I<Type>
3055 Sets the type used to dispatch number of files. Empty value ("") disables
3056 reporting. Defaults to B<files>.
3058 =item B<TypeInstance> I<Instance>
3060 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3061 (no plugin instance).
3065 =head2 Plugin C<GenericJMX>
3067 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3068 L<collectd-java(5)>.
3070 =head2 Plugin C<gmond>
3072 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3073 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3074 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3079 MCReceiveFrom "239.2.11.71" "8649"
3080 <Metric "swap_total">
3082 TypeInstance "total"
3085 <Metric "swap_free">
3092 The following metrics are built-in:
3098 load_one, load_five, load_fifteen
3102 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3106 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3118 Available configuration options:
3122 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3124 Sets sets the multicast group and UDP port to which to subscribe.
3126 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3128 =item E<lt>B<Metric> I<Name>E<gt>
3130 These blocks add a new metric conversion to the internal table. I<Name>, the
3131 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3135 =item B<Type> I<Type>
3137 Type to map this metric to. Required.
3139 =item B<TypeInstance> I<Instance>
3141 Type-instance to use. Optional.
3143 =item B<DataSource> I<Name>
3145 Data source to map this metric to. If the configured type has exactly one data
3146 source, this is optional. Otherwise the option is required.
3152 =head2 Plugin C<gps>
3154 The C<gps plugin> connects to gpsd on the host machine.
3155 The host, port, timeout and pause are configurable.
3157 This is useful if you run an NTP server using a GPS for source and you want to
3160 Mind your GPS must send $--GSA for having the data reported!
3162 The following elements are collected:
3168 Number of satellites used for fix (type instance "used") and in view (type
3169 instance "visible"). 0 means no GPS satellites are visible.
3171 =item B<dilution_of_precision>
3173 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3174 It should be between 0 and 3.
3175 Look at the documentation of your GPS to know more.
3183 # Connect to localhost on gpsd regular port:
3188 # PauseConnect of 5 sec. between connection attempts.
3192 Available configuration options:
3196 =item B<Host> I<Host>
3198 The host on which gpsd daemon runs. Defaults to B<localhost>.
3200 =item B<Port> I<Port>
3202 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3204 =item B<Timeout> I<Seconds>
3206 Timeout in seconds (default 0.015 sec).
3208 The GPS data stream is fetch by the plugin form the daemon.
3209 It waits for data to be available, if none arrives it times out
3210 and loop for another reading.
3211 Mind to put a low value gpsd expects value in the micro-seconds area
3212 (recommended is 500 us) since the waiting function is blocking.
3213 Value must be between 500 us and 5 sec., if outside that range the
3214 default value is applied.
3216 This only applies from gpsd release-2.95.
3218 =item B<PauseConnect> I<Seconds>
3220 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3224 =head2 Plugin C<gpu_nvidia>
3226 Efficiently collects various statistics from the system's NVIDIA GPUs using the
3227 NVML library. Currently collected are fan speed, core temperature, percent
3228 load, percent memory used, compute and memory frequencies, and power
3235 If one or more of these options is specified, only GPUs at that index (as
3236 determined by nvidia-utils through I<nvidia-smi>) have statistics collected.
3237 If no instance of this option is specified, all GPUs are monitored.
3239 =item B<IgnoreSelected>
3241 If set to true, all detected GPUs B<except> the ones at indices specified by
3242 B<GPUIndex> entries are collected. For greater clarity, setting IgnoreSelected
3243 without any GPUIndex directives will result in B<no> statistics being
3248 =head2 Plugin C<grpc>
3250 The I<grpc> plugin provides an RPC interface to submit values to or query
3251 values from collectd based on the open source gRPC framework. It exposes an
3252 end-point for dispatching values to the daemon.
3254 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3258 =item B<Server> I<Host> I<Port>
3260 The B<Server> statement sets the address of a server to which to send metrics
3261 via the C<DispatchValues> function.
3263 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3265 Optionally, B<Server> may be specified as a configuration block which supports
3266 the following options:
3270 =item B<EnableSSL> B<false>|B<true>
3272 Whether to require SSL for outgoing connections. Default: false.
3274 =item B<SSLCACertificateFile> I<Filename>
3276 =item B<SSLCertificateFile> I<Filename>
3278 =item B<SSLCertificateKeyFile> I<Filename>
3280 Filenames specifying SSL certificate and key material to be used with SSL
3285 =item B<Listen> I<Host> I<Port>
3287 The B<Listen> statement sets the network address to bind to. When multiple
3288 statements are specified, the daemon will bind to all of them. If none are
3289 specified, it defaults to B<0.0.0.0:50051>.
3291 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3293 Optionally, B<Listen> may be specified as a configuration block which
3294 supports the following options:
3298 =item B<EnableSSL> I<true>|I<false>
3300 Whether to enable SSL for incoming connections. Default: false.
3302 =item B<SSLCACertificateFile> I<Filename>
3304 =item B<SSLCertificateFile> I<Filename>
3306 =item B<SSLCertificateKeyFile> I<Filename>
3308 Filenames specifying SSL certificate and key material to be used with SSL
3311 =item B<VerifyPeer> B<true>|B<false>
3313 When enabled, a valid client certificate is required to connect to the server.
3314 When disabled, a client certifiacte is not requested and any unsolicited client
3315 certificate is accepted.
3322 =head2 Plugin C<hddtemp>
3324 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3325 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3326 default values, see below. C<hddtemp> has to be running to work correctly. If
3327 C<hddtemp> is not running timeouts may appear which may interfere with other
3330 The B<hddtemp> homepage can be found at
3331 L<http://www.guzu.net/linux/hddtemp.php>.
3335 =item B<Host> I<Hostname>
3337 Hostname to connect to. Defaults to B<127.0.0.1>.
3339 =item B<Port> I<Port>
3341 TCP-Port to connect to. Defaults to B<7634>.
3345 =head2 Plugin C<hugepages>
3347 To collect B<hugepages> information, collectd reads directories
3348 "/sys/devices/system/node/*/hugepages" and
3349 "/sys/kernel/mm/hugepages".
3350 Reading of these directories can be disabled by the following
3351 options (default is enabled).
3355 =item B<ReportPerNodeHP> B<true>|B<false>
3357 If enabled, information will be collected from the hugepage
3358 counters in "/sys/devices/system/node/*/hugepages".
3359 This is used to check the per-node hugepage statistics on
3362 =item B<ReportRootHP> B<true>|B<false>
3364 If enabled, information will be collected from the hugepage
3365 counters in "/sys/kernel/mm/hugepages".
3366 This can be used on both NUMA and non-NUMA systems to check
3367 the overall hugepage statistics.
3369 =item B<ValuesPages> B<true>|B<false>
3371 Whether to report hugepages metrics in number of pages.
3372 Defaults to B<true>.
3374 =item B<ValuesBytes> B<false>|B<true>
3376 Whether to report hugepages metrics in bytes.
3377 Defaults to B<false>.
3379 =item B<ValuesPercentage> B<false>|B<true>
3381 Whether to report hugepages metrics as percentage.
3382 Defaults to B<false>.
3386 =head2 Plugin C<intel_pmu>
3388 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3389 Linux perf interface. All events are reported on a per core basis.
3394 ReportHardwareCacheEvents true
3395 ReportKernelPMUEvents true
3396 ReportSoftwareEvents true
3397 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3398 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3399 Cores "0-3" "4,6" "[12-15]"
3406 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3408 Enable or disable measuring of hardware CPU cache events:
3410 - L1-dcache-load-misses
3412 - L1-dcache-store-misses
3413 - L1-dcache-prefetches
3414 - L1-dcache-prefetch-misses
3416 - L1-icache-load-misses
3417 - L1-icache-prefetches
3418 - L1-icache-prefetch-misses
3424 - LLC-prefetch-misses
3430 - dTLB-prefetch-misses
3434 - branch-load-misses
3436 =item B<ReportKernelPMUEvents> B<false>|B<true>
3438 Enable or disable measuring of the following events:
3447 =item B<ReportSoftwareEvents> B<false>|B<true>
3449 Enable or disable measuring of software events provided by kernel:
3460 =item B<EventList> I<filename>
3462 JSON performance counter event list file name. To be able to monitor all Intel
3463 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3464 event_download.py script to download event list for current CPU.
3466 =item B<HardwareEvents> I<events>
3468 This field is a list of event names or groups of comma separated event names.
3469 This option requires B<EventList> option to be configured.
3471 =item B<Cores> I<cores groups>
3473 All events are reported on a per core basis. Monitoring of the events can be
3474 configured for a group of cores (aggregated statistics). This field defines
3475 groups of cores on which to monitor supported events. The field is represented
3476 as list of strings with core group values. Each string represents a list of
3477 cores in a group. If a group is enclosed in square brackets each core is added
3478 individually to a separate group (that is statistics are not aggregated).
3479 Allowed formats are:
3485 If an empty string is provided as value for this field default cores
3486 configuration is applied - that is separate group is created for each core.
3490 =head2 Plugin C<intel_rdt>
3492 The I<intel_rdt> plugin collects information provided by monitoring features of
3493 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3494 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3495 information about utilization of shared resources. CMT monitors last level cache
3496 occupancy (LLC). MBM supports two types of events reporting local and remote
3497 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3498 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3499 reports the bandwidth of accessing the remote socket. Also this technology
3500 allows to monitor instructions per clock (IPC).
3501 Monitor events are hardware dependant. Monitoring capabilities are detected on
3502 plugin initialization and only supported events are monitored.
3504 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3505 require an additional capability to be enabled if collectd is run as a service.
3506 Please refer to I<contrib/systemd.collectd.service> file for more details.
3510 <Plugin "intel_rdt">
3511 Cores "0-2" "3,4,6" "8-10,15"
3518 =item B<Interval> I<seconds>
3520 The interval within which to retrieve statistics on monitored events in seconds.
3521 For milliseconds divide the time by 1000 for example if the desired interval
3522 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3523 recommended to set interval higher than 1 sec.
3525 =item B<Cores> I<cores groups>
3527 All events are reported on a per core basis. Monitoring of the events can be
3528 configured for group of cores (aggregated statistics). This field defines groups
3529 of cores on which to monitor supported events. The field is represented as list
3530 of strings with core group values. Each string represents a list of cores in a
3531 group. Allowed formats are:
3536 If an empty string is provided as value for this field default cores
3537 configuration is applied - a separate group is created for each core.
3541 B<Note:> By default global interval is used to retrieve statistics on monitored
3542 events. To configure a plugin specific interval use B<Interval> option of the
3543 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3544 example if the desired interval is 50ms, set interval to 0.05.
3545 Due to limited capacity of counters it is not recommended to set interval higher
3548 =head2 Plugin C<interface>
3552 =item B<Interface> I<Interface>
3554 Select this interface. By default these interfaces will then be collected. For
3555 a more detailed description see B<IgnoreSelected> below.
3557 See F</"IGNORELISTS"> for details.
3559 =item B<IgnoreSelected> I<true>|I<false>
3561 If no configuration is given, the B<interface>-plugin will collect data from
3562 all interfaces. This may not be practical, especially for loopback- and
3563 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3564 interfaces you're interested in. Sometimes, however, it's easier/preferred
3565 to collect all interfaces I<except> a few ones. This option enables you to
3566 do that: By setting B<IgnoreSelected> to I<true> the effect of
3567 B<Interface> is inverted: All selected interfaces are ignored and all
3568 other interfaces are collected.
3570 It is possible to use regular expressions to match interface names, if the
3571 name is surrounded by I</.../> and collectd was compiled with support for
3572 regexps. This is useful if there's a need to collect (or ignore) data
3573 for a group of interfaces that are similarly named, without the need to
3574 explicitly list all of them (especially useful if the list is dynamic).
3579 Interface "/^tun[0-9]+/"
3580 IgnoreSelected "true"
3582 This will ignore the loopback interface, all interfaces with names starting
3583 with I<veth> and all interfaces with names starting with I<tun> followed by
3586 =item B<ReportInactive> I<true>|I<false>
3588 When set to I<false>, only interfaces with non-zero traffic will be
3589 reported. Note that the check is done by looking into whether a
3590 package was sent at any time from boot and the corresponding counter
3591 is non-zero. So, if the interface has been sending data in the past
3592 since boot, but not during the reported time-interval, it will still
3595 The default value is I<true> and results in collection of the data
3596 from all interfaces that are selected by B<Interface> and
3597 B<IgnoreSelected> options.
3599 =item B<UniqueName> I<true>|I<false>
3601 Interface name is not unique on Solaris (KSTAT), interface name is unique
3602 only within a module/instance. Following tuple is considered unique:
3603 (ks_module, ks_instance, ks_name)
3604 If this option is set to true, interface name contains above three fields
3605 separated by an underscore. For more info on KSTAT, visit
3606 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3608 This option is only available on Solaris.
3612 =head2 Plugin C<ipmi>
3614 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3615 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3617 The plugin configuration consists of one or more B<Instance> blocks which
3618 specify one I<ipmi> connection each. Each block requires one unique string
3619 argument as the instance name. If instances are not configured, an instance with
3620 the default option values will be created.
3622 For backwards compatibility, any option other than B<Instance> block will trigger
3623 legacy config handling and it will be treated as an option within B<Instance>
3624 block. This support will go away in the next major version of Collectd.
3626 Within the B<Instance> blocks, the following options are allowed:
3630 =item B<Address> I<Address>
3632 Hostname or IP to connect to. If not specified, plugin will try to connect to
3633 local management controller (BMC).
3635 =item B<Username> I<Username>
3637 =item B<Password> I<Password>
3639 The username and the password to use for the connection to remote BMC.
3641 =item B<AuthType> I<MD5>|I<rmcp+>
3643 Forces the authentication type to use for the connection to remote BMC.
3644 By default most secure type is seleted.
3646 =item B<Host> I<Hostname>
3648 Sets the B<host> field of dispatched values. Defaults to the global hostname
3651 =item B<Sensor> I<Sensor>
3653 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3655 See F</"IGNORELISTS"> for details.
3657 =item B<IgnoreSelected> I<true>|I<false>
3659 If no configuration if given, the B<ipmi> plugin will collect data from all
3660 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3661 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3662 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3663 all other sensors are collected.
3665 =item B<NotifySensorAdd> I<true>|I<false>
3667 If a sensor appears after initialization time of a minute a notification
3670 =item B<NotifySensorRemove> I<true>|I<false>
3672 If a sensor disappears a notification is sent.
3674 =item B<NotifySensorNotPresent> I<true>|I<false>
3676 If you have for example dual power supply and one of them is (un)plugged then
3677 a notification is sent.
3679 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3681 If a IPMI connection state changes after initialization time of a minute
3682 a notification is sent. Defaults to B<false>.
3684 =item B<SELEnabled> I<true>|I<false>
3686 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3687 and discrete events. When event is received the notification is sent.
3688 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3690 Defaults to B<false>.
3692 =item B<SELSensor> I<SELSensor>
3694 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3696 See F</"IGNORELISTS"> for details.
3698 =item B<SELIgnoreSelected> I<true>|I<false>
3700 If no configuration is given, the B<ipmi> plugin will pass events from all
3701 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3702 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3703 sensors are ignored and all events from other sensors are passed.
3705 =item B<SELClearEvent> I<true>|I<false>
3707 If SEL clear event is enabled, plugin will delete event from SEL list after
3708 it is received and successfully handled. In this case other tools that are
3709 subscribed for SEL events will receive an empty event.
3710 Defaults to B<false>.
3714 =head2 Plugin C<iptables>
3718 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3720 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3722 Select the iptables/ip6tables filter rules to count packets and bytes from.
3724 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3725 of all rules which have a comment-match. The comment is then used as
3728 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3729 the I<n>th rule will be collected. Again, the comment (or the number) will be
3730 used as the type-instance.
3732 If I<Name> is supplied, it will be used as the type-instance instead of the
3733 comment or the number.
3737 =head2 Plugin C<irq>
3743 Select this irq. By default these irqs will then be collected. For a more
3744 detailed description see B<IgnoreSelected> below.
3746 See F</"IGNORELISTS"> for details.
3748 =item B<IgnoreSelected> I<true>|I<false>
3750 If no configuration if given, the B<irq>-plugin will collect data from all
3751 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3752 can use the B<Irq>-option to pick the interrupt you're interested in.
3753 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3754 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3755 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3756 and all other interrupts are collected.
3760 =head2 Plugin C<java>
3762 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3763 This section only discusses the syntax and semantic of the configuration
3764 options. For more in-depth information on the I<Java> plugin, please read
3765 L<collectd-java(5)>.
3770 JVMArg "-verbose:jni"
3771 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3772 LoadPlugin "org.collectd.java.Foobar"
3773 <Plugin "org.collectd.java.Foobar">
3774 # To be parsed by the plugin
3778 Available configuration options:
3782 =item B<JVMArg> I<Argument>
3784 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3785 exactly the way the arguments to the I<java> binary on the command line work.
3786 Execute C<javaE<nbsp>--help> for details.
3788 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3789 any other options! When another option is found, the JVM will be started and
3790 later options will have to be ignored!
3792 =item B<LoadPlugin> I<JavaClass>
3794 Instantiates a new I<JavaClass> object. The constructor of this object very
3795 likely then registers one or more callback methods with the server.
3797 See L<collectd-java(5)> for details.
3799 When the first such option is found, the virtual machine (JVM) is created. This
3800 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3801 B<LoadPlugin> options!
3803 =item B<Plugin> I<Name>
3805 The entire block is passed to the Java plugin as an
3806 I<org.collectd.api.OConfigItem> object.
3808 For this to work, the plugin has to register a configuration callback first,
3809 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3810 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3811 depends on the (Java) plugin registering the callback and is completely
3812 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3816 =head2 Plugin C<load>
3818 The I<Load plugin> collects the system load. These numbers give a rough overview
3819 over the utilization of a machine. The system load is defined as the number of
3820 runnable tasks in the run-queue and is provided by many operating systems as a
3821 one, five or fifteen minute average.
3823 The following configuration options are available:
3827 =item B<ReportRelative> B<false>|B<true>
3829 When enabled, system load divided by number of available CPU cores is reported
3830 for intervals 1 min, 5 min and 15 min. Defaults to false.
3835 =head2 Plugin C<logfile>
3839 =item B<LogLevel> B<debug|info|notice|warning|err>
3841 Sets the log-level. If, for example, set to B<notice>, then all events with
3842 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3844 Please note that B<debug> is only available if collectd has been compiled with
3847 =item B<File> I<File>
3849 Sets the file to write log messages to. The special strings B<stdout> and
3850 B<stderr> can be used to write to the standard output and standard error
3851 channels, respectively. This, of course, only makes much sense when I<collectd>
3852 is running in foreground- or non-daemon-mode.
3854 =item B<Timestamp> B<true>|B<false>
3856 Prefix all lines printed by the current time. Defaults to B<true>.
3858 =item B<PrintSeverity> B<true>|B<false>
3860 When enabled, all lines are prefixed by the severity of the log message, for
3861 example "warning". Defaults to B<false>.
3865 B<Note>: There is no need to notify the daemon after moving or removing the
3866 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3867 for each line it writes.
3869 =head2 Plugin C<log_logstash>
3871 The I<log logstash plugin> behaves like the logfile plugin but formats
3872 messages as JSON events for logstash to parse and input.
3876 =item B<LogLevel> B<debug|info|notice|warning|err>
3878 Sets the log-level. If, for example, set to B<notice>, then all events with
3879 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3881 Please note that B<debug> is only available if collectd has been compiled with
3884 =item B<File> I<File>
3886 Sets the file to write log messages to. The special strings B<stdout> and
3887 B<stderr> can be used to write to the standard output and standard error
3888 channels, respectively. This, of course, only makes much sense when I<collectd>
3889 is running in foreground- or non-daemon-mode.
3893 B<Note>: There is no need to notify the daemon after moving or removing the
3894 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3895 for each line it writes.
3897 =head2 Plugin C<lpar>
3899 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3900 virtualization technique for IBM POWER processors. It takes into account CPU
3901 time stolen from or donated to a partition, in addition to the usual user,
3902 system, I/O statistics.
3904 The following configuration options are available:
3908 =item B<CpuPoolStats> B<false>|B<true>
3910 When enabled, statistics about the processor pool are read, too. The partition
3911 needs to have pool authority in order to be able to acquire this information.
3914 =item B<ReportBySerial> B<false>|B<true>
3916 If enabled, the serial of the physical machine the partition is currently
3917 running on is reported as I<hostname> and the logical hostname of the machine
3918 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3919 used (just like other plugins) and the I<plugin instance> will be empty.
3924 =head2 Plugin C<lua>
3926 This plugin embeds a Lua interpreter into collectd and provides an interface
3927 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3930 =head2 Plugin C<mbmon>
3932 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3934 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3935 B<Host> and B<Port> options can be used to change these values, see below.
3936 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3937 timeouts may appear which may interfere with other statistics..
3939 C<mbmon> must be run with the -r option ("print TAG and Value format");
3940 Debian's F</etc/init.d/mbmon> script already does this, other people
3941 will need to ensure that this is the case.
3945 =item B<Host> I<Hostname>
3947 Hostname to connect to. Defaults to B<127.0.0.1>.
3949 =item B<Port> I<Port>
3951 TCP-Port to connect to. Defaults to B<411>.
3955 =head2 Plugin C<mcelog>
3957 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3959 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3960 mcelog server is running. When the server is running, the plugin will tail the
3961 specified logfile to retrieve machine check exception information and send a
3962 notification with the details from the logfile. The plugin will use the mcelog
3963 client protocol to retrieve memory related machine check exceptions. Note that
3964 for memory exceptions, notifications are only sent when there is a change in
3965 the number of corrected/uncorrected memory errors.
3967 =head3 The Memory block
3969 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3974 =item B<McelogClientSocket> I<Path>
3975 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3976 Defaults to B<"/var/run/mcelog-client">.
3978 =item B<PersistentNotification> B<true>|B<false>
3979 Override default configuration to only send notifications when sent when there
3980 is a change in the number of corrected/uncorrected memory errors. When set to
3981 true notifications will be sent for every read cycle. Default is false. Does
3982 not affect the stats being dispatched.
3988 =item B<McelogLogfile> I<Path>
3990 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3991 cannot be used in conjunction with the memory block options, they are mutually
3998 The C<md plugin> collects information from Linux Software-RAID devices (md).
4000 All reported values are of the type C<md_disks>. Reported type instances are
4001 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
4002 I<missing> (physically absent) disks.
4006 =item B<Device> I<Device>
4008 Select md devices based on device name. The I<device name> is the basename of
4009 the device, i.e. the name of the block device without the leading C</dev/>.
4010 See B<IgnoreSelected> for more details.
4012 See F</"IGNORELISTS"> for details.
4014 =item B<IgnoreSelected> B<true>|B<false>
4016 Invert device selection: If set to B<true>, all md devices B<except> those
4017 listed using B<Device> are collected. If B<false> (the default), only those
4018 listed are collected. If no configuration is given, the B<md> plugin will
4019 collect data from all md devices.
4023 =head2 Plugin C<memcachec>
4025 The C<memcachec plugin> connects to a memcached server, queries one or more
4026 given I<pages> and parses the returned data according to user specification.
4027 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4030 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4031 library. Please note that there is another library with a very similar name,
4032 libmemcache (notice the missing `d'), which is not applicable.
4034 Synopsis of the configuration:
4036 <Plugin "memcachec">
4037 <Page "plugin_instance">
4040 Plugin "plugin_name"
4042 Regex "(\\d+) bytes sent"
4045 Instance "type_instance"
4050 The configuration options are:
4054 =item E<lt>B<Page> I<Name>E<gt>
4056 Each B<Page> block defines one I<page> to be queried from the memcached server.
4057 The block requires one string argument which is used as I<plugin instance>.
4059 =item B<Server> I<Address>
4061 Sets the server address to connect to when querying the page. Must be inside a
4066 When connected to the memcached server, asks for the page I<Key>.
4068 =item B<Plugin> I<Plugin>
4070 Use I<Plugin> as the plugin name when submitting values.
4071 Defaults to C<memcachec>.
4073 =item E<lt>B<Match>E<gt>
4075 Match blocks define which strings to look for and how matches substrings are
4076 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4080 =head2 Plugin C<memcached>
4082 The B<memcached plugin> connects to a memcached server and queries statistics
4083 about cache utilization, memory and bandwidth used.
4084 L<http://memcached.org/>
4086 <Plugin "memcached">
4088 #Host "memcache.example.com"
4094 The plugin configuration consists of one or more B<Instance> blocks which
4095 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4096 following options are allowed:
4100 =item B<Host> I<Hostname>
4102 Sets the B<host> field of dispatched values. Defaults to the global hostname
4104 For backwards compatibility, values are also dispatched with the global
4105 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4108 =item B<Address> I<Address>
4110 Hostname or IP to connect to. For backwards compatibility, defaults to the
4111 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4113 =item B<Port> I<Port>
4115 TCP port to connect to. Defaults to B<11211>.
4117 =item B<Socket> I<Path>
4119 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4120 setting is given, the B<Address> and B<Port> settings are ignored.
4124 =head2 Plugin C<mic>
4126 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4127 Intel's Many Integrated Core (MIC) systems.
4136 ShowTemperatures true
4139 IgnoreSelectedTemperature true
4144 IgnoreSelectedPower true
4147 The following options are valid inside the B<PluginE<nbsp>mic> block:
4151 =item B<ShowCPU> B<true>|B<false>
4153 If enabled (the default) a sum of the CPU usage across all cores is reported.
4155 =item B<ShowCPUCores> B<true>|B<false>
4157 If enabled (the default) per-core CPU usage is reported.
4159 =item B<ShowMemory> B<true>|B<false>
4161 If enabled (the default) the physical memory usage of the MIC system is
4164 =item B<ShowTemperatures> B<true>|B<false>
4166 If enabled (the default) various temperatures of the MIC system are reported.
4168 =item B<Temperature> I<Name>
4170 This option controls which temperatures are being reported. Whether matching
4171 temperatures are being ignored or I<only> matching temperatures are reported
4172 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4173 temperatures are reported.
4175 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4177 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4178 (the default) only temperatures matching a B<Temperature> option are reported
4179 or, if no B<Temperature> option is specified, all temperatures are reported. If
4180 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4183 Known temperature names are:
4217 =item B<ShowPower> B<true>|B<false>
4219 If enabled (the default) various temperatures of the MIC system are reported.
4221 =item B<Power> I<Name>
4223 This option controls which power readings are being reported. Whether matching
4224 power readings are being ignored or I<only> matching power readings are reported
4225 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4226 power readings are reported.
4228 =item B<IgnoreSelectedPower> B<false>|B<true>
4230 Controls the behavior of the B<Power> setting above. If set to B<false>
4231 (the default) only power readings matching a B<Power> option are reported
4232 or, if no B<Power> option is specified, all power readings are reported. If
4233 set to B<true>, matching power readings are I<ignored> and all other power readings
4236 Known power names are:
4242 Total power utilization averaged over Time Window 0 (uWatts).
4246 Total power utilization averaged over Time Window 0 (uWatts).
4250 Instantaneous power (uWatts).
4254 Max instantaneous power (uWatts).
4258 PCI-E connector power (uWatts).
4262 2x3 connector power (uWatts).
4266 2x4 connector power (uWatts).
4274 Uncore rail (uVolts).
4278 Memory subsystem rail (uVolts).
4284 =head2 Plugin C<memory>
4286 The I<memory plugin> provides the following configuration options:
4290 =item B<ValuesAbsolute> B<true>|B<false>
4292 Enables or disables reporting of physical memory usage in absolute numbers,
4293 i.e. bytes. Defaults to B<true>.
4295 =item B<ValuesPercentage> B<false>|B<true>
4297 Enables or disables reporting of physical memory usage in percentages, e.g.
4298 percent of physical memory used. Defaults to B<false>.
4300 This is useful for deploying I<collectd> in a heterogeneous environment in
4301 which the sizes of physical memory vary.
4305 =head2 Plugin C<modbus>
4307 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4308 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4309 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4310 floating point values (two registers interpreted as IEEE floats in big endian
4315 <Data "voltage-input-1">
4318 RegisterCmd ReadHolding
4325 <Data "voltage-input-2">
4328 RegisterCmd ReadHolding
4333 <Data "supply-temperature-1">
4336 RegisterCmd ReadHolding
4341 <Host "modbus.example.com">
4342 Address "192.168.0.42"
4347 Instance "power-supply"
4348 Collect "voltage-input-1"
4349 Collect "voltage-input-2"
4354 Device "/dev/ttyUSB0"
4359 Instance "temperature"
4360 Collect "supply-temperature-1"
4366 =item E<lt>B<Data> I<Name>E<gt> blocks
4368 Data blocks define a mapping between register numbers and the "types" used by
4371 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4375 =item B<RegisterBase> I<Number>
4377 Configures the base register to read from the device. If the option
4378 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4379 register will be read (the register number is increased by one).
4381 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4383 Specifies what kind of data is returned by the device. This defaults to
4384 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4385 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4386 and B<RegisterBase+1> will be read and the data is combined into one
4387 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4388 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4389 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4390 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4391 registers are swapped with the most significant 16E<nbsp>bits in
4392 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4393 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4394 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4395 B<RegisterBase+3> will be read and the data combined into one
4398 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4400 Specifies register type to be collected from device. Works only with libmodbus
4401 2.9.2 or higher. Defaults to B<ReadHolding>.
4403 =item B<Type> I<Type>
4405 Specifies the "type" (data set) to use when dispatching the value to
4406 I<collectd>. Currently, only data sets with exactly one data source are
4409 =item B<Instance> I<Instance>
4411 Sets the type instance to use when dispatching the value to I<Instance>. If
4412 unset, an empty string (no type instance) is used.
4414 =item B<Scale> I<Value>
4416 The values taken from device are multiplied by I<Value>. The field is optional
4417 and the default is B<1.0>.
4419 =item B<Shift> I<Value>
4421 I<Value> is added to values from device after they have been multiplied by
4422 B<Scale> value. The field is optional and the default value is B<0.0>.
4426 =item E<lt>B<Host> I<Name>E<gt> blocks
4428 Host blocks are used to specify to which hosts to connect and what data to read
4429 from their "slaves". The string argument I<Name> is used as hostname when
4430 dispatching the values to I<collectd>.
4432 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4436 =item B<Address> I<Hostname>
4438 For Modbus/TCP, specifies the node name (the actual network address) used to
4439 connect to the host. This may be an IP address or a hostname. Please note that
4440 the used I<libmodbus> library only supports IPv4 at the moment.
4442 =item B<Port> I<Service>
4444 for Modbus/TCP, specifies the port used to connect to the host. The port can
4445 either be given as a number or as a service name. Please note that the
4446 I<Service> argument must be a string, even if ports are given in their numerical
4447 form. Defaults to "502".
4449 =item B<Device> I<Devicenode>
4451 For Modbus/RTU, specifies the path to the serial device being used.
4453 =item B<Baudrate> I<Baudrate>
4455 For Modbus/RTU, specifies the baud rate of the serial device.
4456 Note, connections currently support only 8/N/1.
4458 =item B<Interval> I<Interval>
4460 Sets the interval (in seconds) in which the values will be collected from this
4461 host. By default the global B<Interval> setting will be used.
4463 =item E<lt>B<Slave> I<ID>E<gt>
4465 Over each connection, multiple Modbus devices may be reached. The slave ID
4466 is used to specify which device should be addressed. For each device you want
4467 to query, one B<Slave> block must be given.
4469 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4473 =item B<Instance> I<Instance>
4475 Specify the plugin instance to use when dispatching the values to I<collectd>.
4476 By default "slave_I<ID>" is used.
4478 =item B<Collect> I<DataName>
4480 Specifies which data to retrieve from the device. I<DataName> must be the same
4481 string as the I<Name> argument passed to a B<Data> block. You can specify this
4482 option multiple times to collect more than one value from a slave. At least one
4483 B<Collect> option is mandatory.
4491 =head2 Plugin C<mqtt>
4493 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4494 values from MQTT (B<Subscribe> blocks).
4500 Host "mqtt.example.com"
4504 Host "mqtt.example.com"
4509 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4510 configuring the sending and receiving direction respectively. The plugin will
4511 register a write callback named C<mqtt/I<name>> where I<name> is the string
4512 argument given to the B<Publish> block. Both types of blocks share many but not
4513 all of the following options. If an option is valid in only one of the blocks,
4514 it will be mentioned explicitly.
4520 =item B<Host> I<Hostname>
4522 Hostname of the MQTT broker to connect to.
4524 =item B<Port> I<Service>
4526 Port number or service name of the MQTT broker to connect to.
4528 =item B<User> I<UserName>
4530 Username used when authenticating to the MQTT broker.
4532 =item B<Password> I<Password>
4534 Password used when authenticating to the MQTT broker.
4536 =item B<ClientId> I<ClientId>
4538 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4540 =item B<QoS> [B<0>-B<2>]
4542 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4560 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4561 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4562 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4563 on a message is larger than the maximum accepted QoS of a subscriber, the
4564 message's QoS will be downgraded.
4566 =item B<Prefix> I<Prefix> (Publish only)
4568 This plugin will use one topic per I<value list> which will looks like a path.
4569 I<Prefix> is used as the first path element and defaults to B<collectd>.
4571 An example topic name would be:
4573 collectd/cpu-0/cpu-user
4575 =item B<Retain> B<false>|B<true> (Publish only)
4577 Controls whether the MQTT broker will retain (keep a copy of) the last message
4578 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4580 =item B<StoreRates> B<true>|B<false> (Publish only)
4582 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4583 before sending. Defaults to B<true>.
4585 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4587 Controls whether the MQTT "cleans" the session up after the subscriber
4588 disconnects or if it maintains the subscriber's subscriptions and all messages
4589 that arrive while the subscriber is disconnected. Defaults to B<true>.
4591 =item B<Topic> I<TopicName> (Subscribe only)
4593 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4594 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4595 the B<collectd> branch.
4597 =item B<CACert> I<file>
4599 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4600 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4601 port of the MQTT broker.
4602 This option enables the use of TLS.
4604 =item B<CertificateFile> I<file>
4606 Path to the PEM-encoded certificate file to use as client certificate when
4607 connecting to the MQTT broker.
4608 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4610 =item B<CertificateKeyFile> I<file>
4612 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4613 Only valid if B<CACert> and B<CertificateFile> are also set.
4615 =item B<TLSProtocol> I<protocol>
4617 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4618 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4619 version is used which depends on the version of OpenSSL the Mosquitto library
4621 Only valid if B<CACert> is set.
4623 =item B<CipherSuite> I<ciphersuite>
4625 A string describing the ciphers available for use. See L<ciphers(1)> and the
4626 C<openssl ciphers> utility for more information. If unset, the default ciphers
4628 Only valid if B<CACert> is set.
4632 =head2 Plugin C<mysql>
4634 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4635 one or more databases when started and keeps the connection up as long as
4636 possible. When the connection is interrupted for whatever reason it will try
4637 to re-connect. The plugin will complain loudly in case anything goes wrong.
4639 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4640 and collects information about MySQL network traffic, executed statements,
4641 requests, the query cache and threads by evaluating the
4642 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4643 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4644 Status Variables> for an explanation of these values.
4646 Optionally, master and slave statistics may be collected in a MySQL
4647 replication setup. In that case, information about the synchronization state
4648 of the nodes are collected by evaluating the C<Position> return value of the
4649 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4650 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4651 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4652 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4653 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4665 SSLKey "/path/to/key.pem"
4666 SSLCert "/path/to/cert.pem"
4667 SSLCA "/path/to/ca.pem"
4668 SSLCAPath "/path/to/cas/"
4669 SSLCipher "DHE-RSA-AES256-SHA"
4675 Socket "/var/run/mysql/mysqld.sock"
4677 SlaveNotifications true
4683 Socket "/var/run/mysql/mysqld.sock"
4688 A B<Database> block defines one connection to a MySQL database. It accepts a
4689 single argument which specifies the name of the database. None of the other
4690 options are required. MySQL will use default values as documented in the
4691 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4692 B<MySQL reference manual>.
4696 =item B<Alias> I<Alias>
4698 Alias to use as sender instead of hostname when reporting. This may be useful
4699 when having cryptic hostnames.
4701 =item B<Host> I<Hostname>
4703 Hostname of the database server. Defaults to B<localhost>.
4705 =item B<User> I<Username>
4707 Username to use when connecting to the database. The user does not have to be
4708 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4709 unless you want to collectd replication statistics (see B<MasterStats> and
4710 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4711 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4713 =item B<Password> I<Password>
4715 Password needed to log into the database.
4717 =item B<Database> I<Database>
4719 Select this database. Defaults to I<no database> which is a perfectly reasonable
4720 option for what this plugin does.
4722 =item B<Port> I<Port>
4724 TCP-port to connect to. The port must be specified in its numeric form, but it
4725 must be passed as a string nonetheless. For example:
4729 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4730 See the documentation for the C<mysql_real_connect> function for details.
4732 =item B<Socket> I<Socket>
4734 Specifies the path to the UNIX domain socket of the MySQL server. This option
4735 only has any effect, if B<Host> is set to B<localhost> (the default).
4736 Otherwise, use the B<Port> option above. See the documentation for the
4737 C<mysql_real_connect> function for details.
4739 =item B<InnodbStats> I<true|false>
4741 If enabled, metrics about the InnoDB storage engine are collected.
4742 Disabled by default.
4744 =item B<MasterStats> I<true|false>
4746 =item B<SlaveStats> I<true|false>
4748 Enable the collection of master / slave statistics in a replication setup. In
4749 order to be able to get access to these statistics, the user needs special
4750 privileges. See the B<User> documentation above. Defaults to B<false>.
4752 =item B<SlaveNotifications> I<true|false>
4754 If enabled, the plugin sends a notification if the replication slave I/O and /
4755 or SQL threads are not running. Defaults to B<false>.
4757 =item B<WsrepStats> I<true|false>
4759 Enable the collection of wsrep plugin statistics, used in Master-Master
4760 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4761 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4763 =item B<ConnectTimeout> I<Seconds>
4765 Sets the connect timeout for the MySQL client.
4767 =item B<SSLKey> I<Path>
4769 If provided, the X509 key in PEM format.
4771 =item B<SSLCert> I<Path>
4773 If provided, the X509 cert in PEM format.
4775 =item B<SSLCA> I<Path>
4777 If provided, the CA file in PEM format (check OpenSSL docs).
4779 =item B<SSLCAPath> I<Path>
4781 If provided, the CA directory (check OpenSSL docs).
4783 =item B<SSLCipher> I<String>
4785 If provided, the SSL cipher to use.
4789 =head2 Plugin C<netapp>
4791 The netapp plugin can collect various performance and capacity information
4792 from a NetApp filer using the NetApp API.
4794 Please note that NetApp has a wide line of products and a lot of different
4795 software versions for each of these products. This plugin was developed for a
4796 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4797 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4798 model and software version but it is very hard to test this.
4799 If you have used this plugin with other models and/or software version, feel
4800 free to send us a mail to tell us about the results, even if it's just a short
4803 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4804 basic authentication.
4806 B<Do not use a regular user for this!> Create a special collectd user with just
4807 the minimum of capabilities needed. The user only needs the "login-http-admin"
4808 capability as well as a few more depending on which data will be collected.
4809 Required capabilities are documented below.
4814 <Host "netapp1.example.com">
4838 IgnoreSelectedIO false
4840 IgnoreSelectedOps false
4841 GetLatency "volume0"
4842 IgnoreSelectedLatency false
4849 IgnoreSelectedCapacity false
4852 IgnoreSelectedSnapshot false
4880 The netapp plugin accepts the following configuration options:
4884 =item B<Host> I<Name>
4886 A host block defines one NetApp filer. It will appear in collectd with the name
4887 you specify here which does not have to be its real name nor its hostname (see
4888 the B<Address> option below).
4890 =item B<VFiler> I<Name>
4892 A B<VFiler> block may only be used inside a host block. It accepts all the
4893 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4894 will execute all NetApp API commands in the context of the specified
4895 VFiler(R). It will appear in collectd with the name you specify here which
4896 does not have to be its real name. The VFiler name may be specified using the
4897 B<VFilerName> option. If this is not specified, it will default to the name
4900 The VFiler block inherits all connection related settings from the surrounding
4901 B<Host> block (which appear before the B<VFiler> block) but they may be
4902 overwritten inside the B<VFiler> block.
4904 This feature is useful, for example, when using a VFiler as SnapVault target
4905 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4906 available in the host filer (vfiler0) but only in the respective VFiler
4909 =item B<Protocol> B<httpd>|B<http>
4911 The protocol collectd will use to query this host.
4919 Valid options: http, https
4921 =item B<Address> I<Address>
4923 The hostname or IP address of the host.
4929 Default: The "host" block's name.
4931 =item B<Port> I<Port>
4933 The TCP port to connect to on the host.
4939 Default: 80 for protocol "http", 443 for protocol "https"
4941 =item B<User> I<User>
4943 =item B<Password> I<Password>
4945 The username and password to use to login to the NetApp.
4951 =item B<VFilerName> I<Name>
4953 The name of the VFiler in which context to execute API commands. If not
4954 specified, the name provided to the B<VFiler> block will be used instead.
4960 Default: name of the B<VFiler> block
4962 B<Note:> This option may only be used inside B<VFiler> blocks.
4964 =item B<Interval> I<Interval>
4970 The following options decide what kind of data will be collected. You can
4971 either use them as a block and fine tune various parameters inside this block,
4972 use them as a single statement to just accept all default values, or omit it to
4973 not collect any data.
4975 The following options are valid inside all blocks:
4979 =item B<Interval> I<Seconds>
4981 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4982 host specific setting.
4986 =head3 The System block
4988 This will collect various performance data about the whole system.
4990 B<Note:> To get this data the collectd user needs the
4991 "api-perf-object-get-instances" capability.
4995 =item B<Interval> I<Seconds>
4997 Collect disk statistics every I<Seconds> seconds.
4999 =item B<GetCPULoad> B<true>|B<false>
5001 If you set this option to true the current CPU usage will be read. This will be
5002 the average usage between all CPUs in your NetApp without any information about
5005 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5006 returns in the "CPU" field.
5014 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5016 =item B<GetInterfaces> B<true>|B<false>
5018 If you set this option to true the current traffic of the network interfaces
5019 will be read. This will be the total traffic over all interfaces of your NetApp
5020 without any information about individual interfaces.
5022 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5023 in the "Net kB/s" field.
5033 Result: One value list of type "if_octects".
5035 =item B<GetDiskIO> B<true>|B<false>
5037 If you set this option to true the current IO throughput will be read. This
5038 will be the total IO of your NetApp without any information about individual
5039 disks, volumes or aggregates.
5041 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5042 in the "DiskE<nbsp>kB/s" field.
5050 Result: One value list of type "disk_octets".
5052 =item B<GetDiskOps> B<true>|B<false>
5054 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5055 iSCSI, etc. operations will be read. This will be the total number of
5056 operations on your NetApp without any information about individual volumes or
5059 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5060 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5068 Result: A variable number of value lists of type "disk_ops_complex". Each type
5069 of operation will result in one value list with the name of the operation as
5074 =head3 The WAFL block
5076 This will collect various performance data about the WAFL file system. At the
5077 moment this just means cache performance.
5079 B<Note:> To get this data the collectd user needs the
5080 "api-perf-object-get-instances" capability.
5082 B<Note:> The interface to get these values is classified as "Diagnostics" by
5083 NetApp. This means that it is not guaranteed to be stable even between minor
5088 =item B<Interval> I<Seconds>
5090 Collect disk statistics every I<Seconds> seconds.
5092 =item B<GetNameCache> B<true>|B<false>
5100 Result: One value list of type "cache_ratio" and type instance
5103 =item B<GetDirCache> B<true>|B<false>
5111 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5113 =item B<GetInodeCache> B<true>|B<false>
5121 Result: One value list of type "cache_ratio" and type instance
5124 =item B<GetBufferCache> B<true>|B<false>
5126 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5127 in the "Cache hit" field.
5135 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5139 =head3 The Disks block
5141 This will collect performance data about the individual disks in the NetApp.
5143 B<Note:> To get this data the collectd user needs the
5144 "api-perf-object-get-instances" capability.
5148 =item B<Interval> I<Seconds>
5150 Collect disk statistics every I<Seconds> seconds.
5152 =item B<GetBusy> B<true>|B<false>
5154 If you set this option to true the busy time of all disks will be calculated
5155 and the value of the busiest disk in the system will be written.
5157 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5158 in the "Disk util" field. Probably.
5166 Result: One value list of type "percent" and type instance "disk_busy".
5170 =head3 The VolumePerf block
5172 This will collect various performance data about the individual volumes.
5174 You can select which data to collect about which volume using the following
5175 options. They follow the standard ignorelist semantic.
5177 B<Note:> To get this data the collectd user needs the
5178 I<api-perf-object-get-instances> capability.
5182 =item B<Interval> I<Seconds>
5184 Collect volume performance data every I<Seconds> seconds.
5186 =item B<GetIO> I<Volume>
5188 =item B<GetOps> I<Volume>
5190 =item B<GetLatency> I<Volume>
5192 Select the given volume for IO, operations or latency statistics collection.
5193 The argument is the name of the volume without the C</vol/> prefix.
5195 Since the standard ignorelist functionality is used here, you can use a string
5196 starting and ending with a slash to specify regular expression matching: To
5197 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5200 GetIO "/^vol[027]$/"
5202 If no regular expression is specified, an exact match is required. Both,
5203 regular and exact matching are case sensitive.
5205 If no volume was specified at all for either of the three options, that data
5206 will be collected for all available volumes.
5208 See F</"IGNORELISTS"> for details.
5210 =item B<IgnoreSelectedIO> B<true>|B<false>
5212 =item B<IgnoreSelectedOps> B<true>|B<false>
5214 =item B<IgnoreSelectedLatency> B<true>|B<false>
5216 When set to B<true>, the volumes selected for IO, operations or latency
5217 statistics collection will be ignored and the data will be collected for all
5220 When set to B<false>, data will only be collected for the specified volumes and
5221 all other volumes will be ignored.
5223 If no volumes have been specified with the above B<Get*> options, all volumes
5224 will be collected regardless of the B<IgnoreSelected*> option.
5226 Defaults to B<false>
5230 =head3 The VolumeUsage block
5232 This will collect capacity data about the individual volumes.
5234 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5239 =item B<Interval> I<Seconds>
5241 Collect volume usage statistics every I<Seconds> seconds.
5243 =item B<GetCapacity> I<VolumeName>
5245 The current capacity of the volume will be collected. This will result in two
5246 to four value lists, depending on the configuration of the volume. All data
5247 sources are of type "df_complex" with the name of the volume as
5250 There will be type_instances "used" and "free" for the number of used and
5251 available bytes on the volume. If the volume has some space reserved for
5252 snapshots, a type_instance "snap_reserved" will be available. If the volume
5253 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5254 number of bytes saved by the SIS feature.
5256 B<Note:> The current NetApp API has a bug that results in this value being
5257 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5258 number which works most of the time. If you see strange values here, bug
5259 NetApp support to fix this.
5261 Repeat this option to specify multiple volumes.
5263 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5265 Specify whether to collect only the volumes selected by the B<GetCapacity>
5266 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5267 B<false>. However, if no B<GetCapacity> option is specified at all, all
5268 capacities will be selected anyway.
5270 =item B<GetSnapshot> I<VolumeName>
5272 Select volumes from which to collect snapshot information.
5274 Usually, the space used for snapshots is included in the space reported as
5275 "used". If snapshot information is collected as well, the space used for
5276 snapshots is subtracted from the used space.
5278 To make things even more interesting, it is possible to reserve space to be
5279 used for snapshots. If the space required for snapshots is less than that
5280 reserved space, there is "reserved free" and "reserved used" space in addition
5281 to "free" and "used". If the space required for snapshots exceeds the reserved
5282 space, that part allocated in the normal space is subtracted from the "used"
5285 Repeat this option to specify multiple volumes.
5287 =item B<IgnoreSelectedSnapshot>
5289 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5290 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5291 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5292 capacities will be selected anyway.
5296 =head3 The Quota block
5298 This will collect (tree) quota statistics (used disk space and number of used
5299 files). This mechanism is useful to get usage information for single qtrees.
5300 In case the quotas are not used for any other purpose, an entry similar to the
5301 following in C</etc/quotas> would be sufficient:
5303 /vol/volA/some_qtree tree - - - - -
5305 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5309 =item B<Interval> I<Seconds>
5311 Collect SnapVault(R) statistics every I<Seconds> seconds.
5315 =head3 The SnapVault block
5317 This will collect statistics about the time and traffic of SnapVault(R)
5322 =item B<Interval> I<Seconds>
5324 Collect SnapVault(R) statistics every I<Seconds> seconds.
5328 =head2 Plugin C<netlink>
5330 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5331 statistics of various interface and routing aspects.
5335 =item B<Interface> I<Interface>
5337 =item B<VerboseInterface> I<Interface>
5339 Instruct the plugin to collect interface statistics. This is basically the same
5340 as the statistics provided by the C<interface> plugin (see above) but
5341 potentially much more detailed.
5343 When configuring with B<Interface> only the basic statistics will be collected,
5344 namely octets, packets, and errors. These statistics are collected by
5345 the C<interface> plugin, too, so using both at the same time is no benefit.
5347 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5348 so that no data needs to be collected twice if you use the C<interface> plugin.
5349 This includes dropped packets, received multicast packets, collisions and a
5350 whole zoo of differentiated RX and TX errors. You can try the following command
5351 to get an idea of what awaits you:
5355 If I<Interface> is B<All>, all interfaces will be selected.
5357 =item B<QDisc> I<Interface> [I<QDisc>]
5359 =item B<Class> I<Interface> [I<Class>]
5361 =item B<Filter> I<Interface> [I<Filter>]
5363 Collect the octets and packets that pass a certain qdisc, class or filter.
5365 QDiscs and classes are identified by their type and handle (or classid).
5366 Filters don't necessarily have a handle, therefore the parent's handle is used.
5367 The notation used in collectd differs from that used in tc(1) in that it
5368 doesn't skip the major or minor number if it's zero and doesn't print special
5369 ids by their name. So, for example, a qdisc may be identified by
5370 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5371 thus not displayed by tc(1).
5373 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5374 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5375 associated with that interface will be collected.
5377 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5378 used. This may lead to problems when more than one filter is attached to a
5379 qdisc or class. This isn't nice, but we don't know how this could be done any
5380 better. If you have a idea, please don't hesitate to tell us.
5382 As with the B<Interface> option you can specify B<All> as the interface,
5383 meaning all interfaces.
5385 Here are some examples to help you understand the above text more easily:
5388 VerboseInterface "All"
5389 QDisc "eth0" "pfifo_fast-1:0"
5391 Class "ppp0" "htb-1:10"
5392 Filter "ppp0" "u32-1:0"
5395 See F</"IGNORELISTS"> for details.
5397 =item B<IgnoreSelected>
5399 The behavior is the same as with all other similar plugins: If nothing is
5400 selected at all, everything is collected. If some things are selected using the
5401 options described above, only these statistics are collected. If you set
5402 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5403 specified statistics will not be collected.
5407 =head2 Plugin C<network>
5409 The Network plugin sends data to a remote instance of collectd, receives data
5410 from a remote instance, or both at the same time. Data which has been received
5411 from the network is usually not transmitted again, but this can be activated, see
5412 the B<Forward> option below.
5414 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5415 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5417 Both, B<Server> and B<Listen> can be used as single option or as block. When
5418 used as block, given options are valid for this socket only. The following
5419 example will export the metrics twice: Once to an "internal" server (without
5420 encryption and signing) and one to an external server (with cryptographic
5424 # Export to an internal server
5425 # (demonstrates usage without additional options)
5426 Server "collectd.internal.tld"
5428 # Export to an external server
5429 # (demonstrates usage with signature options)
5430 <Server "collectd.external.tld">
5431 SecurityLevel "sign"
5432 Username "myhostname"
5439 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5441 The B<Server> statement/block sets the server to send datagrams to. The
5442 statement may occur multiple times to send each datagram to multiple
5445 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5446 optional second argument specifies a port number or a service name. If not
5447 given, the default, B<25826>, is used.
5449 The following options are recognized within B<Server> blocks:
5453 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5455 Set the security you require for network communication. When the security level
5456 has been set to B<Encrypt>, data sent over the network will be encrypted using
5457 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5458 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5459 authentication code. When set to B<None>, data is sent without any security.
5461 This feature is only available if the I<network> plugin was linked with
5464 =item B<Username> I<Username>
5466 Sets the username to transmit. This is used by the server to lookup the
5467 password. See B<AuthFile> below. All security levels except B<None> require
5470 This feature is only available if the I<network> plugin was linked with
5473 =item B<Password> I<Password>
5475 Sets a password (shared secret) for this socket. All security levels except
5476 B<None> require this setting.
5478 This feature is only available if the I<network> plugin was linked with
5481 =item B<Interface> I<Interface name>
5483 Set the outgoing interface for IP packets. This applies at least
5484 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5485 undefined or a non-existent interface name is specified, the default
5486 behavior is to let the kernel choose the appropriate interface. Be warned
5487 that the manual selection of an interface for unicast traffic is only
5488 necessary in rare cases.
5490 =item B<BindAddress> I<IP Address>
5492 Set the outgoing IP address for IP packets. This option can be used instead of
5493 the I<Interface> option to explicitly define the IP address which will be used
5494 to send Packets to the remote server.
5496 =item B<ResolveInterval> I<Seconds>
5498 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5499 useful to force a regular DNS lookup to support a high availability setup. If
5500 not specified, re-resolves are never attempted.
5504 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5506 The B<Listen> statement sets the interfaces to bind to. When multiple
5507 statements are found the daemon will bind to multiple interfaces.
5509 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5510 the argument is a multicast address the daemon will join that multicast group.
5511 The optional second argument specifies a port number or a service name. If not
5512 given, the default, B<25826>, is used.
5514 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5518 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5520 Set the security you require for network communication. When the security level
5521 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5522 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5523 signed and encrypted data is accepted. When set to B<None>, all data will be
5524 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5525 decrypted if possible.
5527 This feature is only available if the I<network> plugin was linked with
5530 =item B<AuthFile> I<Filename>
5532 Sets a file in which usernames are mapped to passwords. These passwords are
5533 used to verify signatures and to decrypt encrypted network packets. If
5534 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5535 verified and encrypted packets are decrypted. Otherwise, signed data is
5536 accepted without checking the signature and encrypted data cannot be decrypted.
5537 For the other security levels this option is mandatory.
5539 The file format is very simple: Each line consists of a username followed by a
5540 colon and any number of spaces followed by the password. To demonstrate, an
5541 example file could look like this:
5546 Each time a packet is received, the modification time of the file is checked
5547 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5548 the file is being read, it is locked using L<fcntl(2)>.
5550 =item B<Interface> I<Interface name>
5552 Set the incoming interface for IP packets explicitly. This applies at least
5553 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5554 undefined or a non-existent interface name is specified, the default
5555 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5556 traffic gets only accepted, if it arrives on the given interface.
5560 =item B<TimeToLive> I<1-255>
5562 Set the time-to-live of sent packets. This applies to all, unicast and
5563 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5564 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5567 =item B<MaxPacketSize> I<1024-65535>
5569 Set the maximum size for datagrams received over the network. Packets larger
5570 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5571 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5574 On the server side, this limit should be set to the largest value used on
5575 I<any> client. Likewise, the value on the client must not be larger than the
5576 value on the server, or data will be lost.
5578 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5579 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5580 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5583 =item B<Forward> I<true|false>
5585 If set to I<true>, write packets that were received via the network plugin to
5586 the sending sockets. This should only be activated when the B<Listen>- and
5587 B<Server>-statements differ. Otherwise packets may be send multiple times to
5588 the same multicast group. While this results in more network traffic than
5589 necessary it's not a huge problem since the plugin has a duplicate detection,
5590 so the values will not loop.
5592 =item B<ReportStats> B<true>|B<false>
5594 The network plugin cannot only receive and send statistics, it can also create
5595 statistics about itself. Collectd data included the number of received and
5596 sent octets and packets, the length of the receive queue and the number of
5597 values handled. When set to B<true>, the I<Network plugin> will make these
5598 statistics available. Defaults to B<false>.
5602 =head2 Plugin C<nfs>
5604 The I<nfs plugin> collects information about the usage of the Network File
5605 System (NFS). It counts the number of procedure calls for each procedure,
5606 grouped by version and whether the system runs as server or client.
5608 It is possibly to omit metrics for a specific NFS version by setting one or
5609 more of the following options to B<false> (all of them default to B<true>).
5613 =item B<ReportV2> B<true>|B<false>
5615 =item B<ReportV3> B<true>|B<false>
5617 =item B<ReportV4> B<true>|B<false>
5621 =head2 Plugin C<nginx>
5623 This plugin collects the number of connections and requests handled by the
5624 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5625 queries the page provided by the C<ngx_http_stub_status_module> module, which
5626 isn't compiled by default. Please refer to
5627 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5628 how to compile and configure nginx and this module.
5630 The following options are accepted by the C<nginx plugin>:
5634 =item B<URL> I<http://host/nginx_status>
5636 Sets the URL of the C<ngx_http_stub_status_module> output.
5638 =item B<User> I<Username>
5640 Optional user name needed for authentication.
5642 =item B<Password> I<Password>
5644 Optional password needed for authentication.
5646 =item B<VerifyPeer> B<true|false>
5648 Enable or disable peer SSL certificate verification. See
5649 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5651 =item B<VerifyHost> B<true|false>
5653 Enable or disable peer host name verification. If enabled, the plugin checks
5654 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5655 certificate matches the host name provided by the B<URL> option. If this
5656 identity check fails, the connection is aborted. Obviously, only works when
5657 connecting to a SSL enabled server. Enabled by default.
5659 =item B<CACert> I<File>
5661 File that holds one or more SSL certificates. If you want to use HTTPS you will
5662 possibly need this option. What CA certificates come bundled with C<libcurl>
5663 and are checked by default depends on the distribution you use.
5665 =item B<Timeout> I<Milliseconds>
5667 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5668 milliseconds. By default, the configured B<Interval> is used to set the
5673 =head2 Plugin C<notify_desktop>
5675 This plugin sends a desktop notification to a notification daemon, as defined
5676 in the Desktop Notification Specification. To actually display the
5677 notifications, B<notification-daemon> is required and B<collectd> has to be
5678 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5679 environment variables have to be set correctly) and the D-Bus message bus.
5681 The Desktop Notification Specification can be found at
5682 L<http://www.galago-project.org/specs/notification/>.
5686 =item B<OkayTimeout> I<timeout>
5688 =item B<WarningTimeout> I<timeout>
5690 =item B<FailureTimeout> I<timeout>
5692 Set the I<timeout>, in milliseconds, after which to expire the notification
5693 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5694 been specified, the displayed notification will not be closed at all - the
5695 user has to do so herself. These options default to 5000. If a negative number
5696 has been specified, the default is used as well.
5700 =head2 Plugin C<notify_email>
5702 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5703 configured email address.
5705 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5707 Available configuration options:
5711 =item B<From> I<Address>
5713 Email address from which the emails should appear to come from.
5715 Default: C<root@localhost>
5717 =item B<Recipient> I<Address>
5719 Configures the email address(es) to which the notifications should be mailed.
5720 May be repeated to send notifications to multiple addresses.
5722 At least one B<Recipient> must be present for the plugin to work correctly.
5724 =item B<SMTPServer> I<Hostname>
5726 Hostname of the SMTP server to connect to.
5728 Default: C<localhost>
5730 =item B<SMTPPort> I<Port>
5732 TCP port to connect to.
5736 =item B<SMTPUser> I<Username>
5738 Username for ASMTP authentication. Optional.
5740 =item B<SMTPPassword> I<Password>
5742 Password for ASMTP authentication. Optional.
5744 =item B<Subject> I<Subject>
5746 Subject-template to use when sending emails. There must be exactly two
5747 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5748 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5751 Default: C<Collectd notify: %s@%s>
5755 =head2 Plugin C<notify_nagios>
5757 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5758 a I<passive service check result>.
5760 Available configuration options:
5764 =item B<CommandFile> I<Path>
5766 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5770 =head2 Plugin C<ntpd>
5772 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5775 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5776 the wire - using B<mode 7> specific requests. This mode is deprecated with
5777 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5778 correctly with them, the ntp daemon must be explicitly configured to
5779 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5780 manual page for details.
5782 Available configuration options for the C<ntpd> plugin:
5786 =item B<Host> I<Hostname>
5788 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5790 =item B<Port> I<Port>
5792 UDP-Port to connect to. Defaults to B<123>.
5794 =item B<ReverseLookups> B<true>|B<false>
5796 Sets whether or not to perform reverse lookups on peers. Since the name or
5797 IP-address may be used in a filename it is recommended to disable reverse
5798 lookups. The default is to do reverse lookups to preserve backwards
5799 compatibility, though.
5801 =item B<IncludeUnitID> B<true>|B<false>
5803 When a peer is a refclock, include the unit ID in the I<type instance>.
5804 Defaults to B<false> for backward compatibility.
5806 If two refclock peers use the same driver and this is B<false>, the plugin will
5807 try to write simultaneous measurements from both to the same type instance.
5808 This will result in error messages in the log and only one set of measurements
5813 =head2 Plugin C<nut>
5817 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5819 Add a UPS to collect data from. The format is identical to the one accepted by
5822 =item B<ForceSSL> B<true>|B<false>
5824 Stops connections from falling back to unsecured if an SSL connection
5825 cannot be established. Defaults to false if undeclared.
5827 =item B<VerifyPeer> I<true>|I<false>
5829 If set to true, requires a CAPath be provided. Will use the CAPath to find
5830 certificates to use as Trusted Certificates to validate a upsd server certificate.
5831 If validation of the upsd server certificate fails, the connection will not be
5832 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5833 will override and set ForceSSL to true.
5835 =item B<CAPath> I/path/to/certs/folder
5837 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5838 The folder pointed at must contain certificate(s) named according to their hash.
5839 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5840 occur because two different certs have the same hash value, Y can be incremented
5841 in order to avoid conflict. To create a symbolic link to a certificate the following
5842 command can be used from within the directory where the cert resides:
5844 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5846 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5847 generate links like the one described above for ALL certs in a given folder.
5849 C<c_rehash /path/to/certs/folder>
5851 =item B<ConnectTimeout> I<Milliseconds>
5853 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5854 By default, the configured B<Interval> is used to set the timeout.
5858 =head2 Plugin C<olsrd>
5860 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5861 the Optimized Link State Routing daemon and reads information about the current
5862 state of the meshed network.
5864 The following configuration options are understood:
5868 =item B<Host> I<Host>
5870 Connect to I<Host>. Defaults to B<"localhost">.
5872 =item B<Port> I<Port>
5874 Specifies the port to connect to. This must be a string, even if you give the
5875 port as a number rather than a service name. Defaults to B<"2006">.
5877 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5879 Specifies what information to collect about links, i.E<nbsp>e. direct
5880 connections of the daemon queried. If set to B<No>, no information is
5881 collected. If set to B<Summary>, the number of links and the average of all
5882 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5883 If set to B<Detail> LQ and NLQ are collected per link.
5885 Defaults to B<Detail>.
5887 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5889 Specifies what information to collect about routes of the daemon queried. If
5890 set to B<No>, no information is collected. If set to B<Summary>, the number of
5891 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5892 metric and ETX are collected per route.
5894 Defaults to B<Summary>.
5896 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5898 Specifies what information to collect about the global topology. If set to
5899 B<No>, no information is collected. If set to B<Summary>, the number of links
5900 in the entire topology and the average I<link quality> (LQ) is calculated.
5901 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5903 Defaults to B<Summary>.
5907 =head2 Plugin C<onewire>
5909 B<EXPERIMENTAL!> See notes below.
5911 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5912 L<http://owfs.org/> to read sensors connected via the onewire bus.
5914 It can be used in two possible modes - standard or advanced.
5916 In the standard mode only temperature sensors (sensors with the family code
5917 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5918 other sensors you would like to have included, please send a sort request to
5919 the mailing list. You can select sensors to be read or to be ignored depending
5920 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5921 walked and all sensors are read.
5923 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5924 experimental, below.
5926 In the advanced mode you can configure any sensor to be read (only numerical
5927 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5928 In this mode you have to list all the sensors. Neither default bus walk nor
5929 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5930 the path automatically and should produce compatible structure with the "standard"
5931 mode (basically the path is expected as for example
5932 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5933 "F10FCA000800" and the rest after the slash is considered the type - here
5935 There are two advantages to this mode - you can access virtually any sensor
5936 (not just temperature), select whether to use cached or directly read values
5937 and it is slighlty faster. The downside is more complex configuration.
5939 The two modes are distinguished automatically by the format of the address.
5940 It is not possible to mix the two modes. Once a full path is detected in any
5941 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5942 (and as standard addresses will fail parsing they will be ignored).
5946 =item B<Device> I<Device>
5948 Sets the device to read the values from. This can either be a "real" hardware
5949 device, such as a serial port or an USB port, or the address of the
5950 L<owserver(1)> socket, usually B<localhost:4304>.
5952 Though the documentation claims to automatically recognize the given address
5953 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5954 with that version, the following configuration worked for us:
5957 Device "-s localhost:4304"
5960 This directive is B<required> and does not have a default value.
5962 =item B<Sensor> I<Sensor>
5964 In the standard mode selects sensors to collect or to ignore
5965 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5966 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5967 and B<not> include the leading C<10.> family byte and point.
5968 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5969 sensors (see above) are read.
5971 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5972 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5973 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5975 As there can be multiple devices on the bus you can list multiple sensor (use
5976 multiple B<Sensor> elements).
5978 See F</"IGNORELISTS"> for details.
5980 =item B<IgnoreSelected> I<true>|I<false>
5982 If no configuration is given, the B<onewire> plugin will collect data from all
5983 sensors found. This may not be practical, especially if sensors are added and
5984 removed regularly. Sometimes, however, it's easier/preferred to collect only
5985 specific sensors or all sensors I<except> a few specified ones. This option
5986 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5987 B<Sensor> is inverted: All selected interfaces are ignored and all other
5988 interfaces are collected.
5990 Used only in the standard mode - see above.
5992 =item B<Interval> I<Seconds>
5994 Sets the interval in which all sensors should be read. If not specified, the
5995 global B<Interval> setting is used.
5999 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
6000 work with big setups. It works with one sensor being attached to one
6001 controller, but as soon as you throw in a couple more senors and maybe a hub
6002 or two, reading all values will take more than ten seconds (the default
6003 interval). We will probably add some separate thread for reading the sensors
6004 and some cache or something like that, but it's not done yet. We will try to
6005 maintain backwards compatibility in the future, but we can't promise. So in
6006 short: If it works for you: Great! But keep in mind that the config I<might>
6007 change, though this is unlikely. Oh, and if you want to help improving this
6008 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
6010 =head2 Plugin C<openldap>
6012 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
6013 server correctly. The backend database C<monitor> needs to be loaded and
6014 working. See slapd-monitor(5) for the details.
6016 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6017 blocks. Each block requires one string argument as the instance name. For
6022 URL "ldap://localhost/"
6025 URL "ldaps://localhost/"
6029 The instance name will be used as the I<plugin instance>. To emulate the old
6030 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6031 plugin to work correctly, each instance name must be unique. This is not
6032 enforced by the plugin and it is your responsibility to ensure it is.
6034 The following options are accepted within each B<Instance> block:
6038 =item B<URL> I<ldap://host/binddn>
6040 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6043 =item B<BindDN> I<BindDN>
6045 Name in the form of an LDAP distinguished name intended to be used for
6046 authentication. Defaults to empty string to establish an anonymous authorization.
6048 =item B<Password> I<Password>
6050 Password for simple bind authentication. If this option is not set,
6051 unauthenticated bind operation is used.
6053 =item B<StartTLS> B<true|false>
6055 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6056 Disabled by default.
6058 =item B<VerifyHost> B<true|false>
6060 Enables or disables peer host name verification. If enabled, the plugin checks
6061 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6062 certificate matches the host name provided by the B<URL> option. If this
6063 identity check fails, the connection is aborted. Enabled by default.
6065 =item B<CACert> I<File>
6067 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6068 may possibly need this option. What CA certificates are checked by default
6069 depends on the distribution you use and can be changed with the usual ldap
6070 client configuration mechanisms. See ldap.conf(5) for the details.
6072 =item B<Timeout> I<Seconds>
6074 Sets the timeout value for ldap operations, in seconds. By default, the
6075 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6078 =item B<Version> I<Version>
6080 An integer which sets the LDAP protocol version number to use when connecting
6081 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6085 =head2 Plugin C<openvpn>
6087 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6088 traffic statistics about connected clients.
6090 To set up OpenVPN to write to the status file periodically, use the
6091 B<--status> option of OpenVPN.
6093 So, in a nutshell you need:
6095 openvpn $OTHER_OPTIONS \
6096 --status "/var/run/openvpn-status" 10
6102 =item B<StatusFile> I<File>
6104 Specifies the location of the status file.
6106 =item B<ImprovedNamingSchema> B<true>|B<false>
6108 When enabled, the filename of the status file will be used as plugin instance
6109 and the client's "common name" will be used as type instance. This is required
6110 when reading multiple status files. Enabling this option is recommended, but to
6111 maintain backwards compatibility this option is disabled by default.
6113 =item B<CollectCompression> B<true>|B<false>
6115 Sets whether or not statistics about the compression used by OpenVPN should be
6116 collected. This information is only available in I<single> mode. Enabled by
6119 =item B<CollectIndividualUsers> B<true>|B<false>
6121 Sets whether or not traffic information is collected for each connected client
6122 individually. If set to false, currently no traffic data is collected at all
6123 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6125 =item B<CollectUserCount> B<true>|B<false>
6127 When enabled, the number of currently connected clients or users is collected.
6128 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6129 can be configured independently from that option. Defaults to B<false>.
6133 =head2 Plugin C<oracle>
6135 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6136 Oracle® Database and lets you execute SQL statements there. It is very similar
6137 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6138 plugin's documentation above for details.
6141 <Query "out_of_stock">
6142 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6145 # InstancePrefix "foo"
6146 InstancesFrom "category"
6150 <Database "product_information">
6155 Query "out_of_stock"
6159 =head3 B<Query> blocks
6161 The Query blocks are handled identically to the Query blocks of the "dbi"
6162 plugin. Please see its documentation above for details on how to specify
6165 =head3 B<Database> blocks
6167 Database blocks define a connection to a database and which queries should be
6168 sent to that database. Each database needs a "name" as string argument in the
6169 starting tag of the block. This name will be used as "PluginInstance" in the
6170 values submitted to the daemon. Other than that, that name is not used.
6174 =item B<Plugin> I<Plugin>
6176 Use I<Plugin> as the plugin name when submitting query results from
6177 this B<Database>. Defaults to C<oracle>.
6179 =item B<ConnectID> I<ID>
6181 Defines the "database alias" or "service name" to connect to. Usually, these
6182 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6184 =item B<Host> I<Host>
6186 Hostname to use when dispatching values for this database. Defaults to using
6187 the global hostname of the I<collectd> instance.
6189 =item B<Username> I<Username>
6191 Username used for authentication.
6193 =item B<Password> I<Password>
6195 Password used for authentication.
6197 =item B<Query> I<QueryName>
6199 Associates the query named I<QueryName> with this database connection. The
6200 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6201 blocks you want to refer to must be placed above the database block you want to
6206 =head2 Plugin C<ovs_events>
6208 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6209 connected interfaces, dispatches the values to collectd and sends the
6210 notification whenever the link state change occurs. This plugin uses OVS
6211 database to get a link state change notification.
6215 <Plugin "ovs_events">
6218 Socket "/var/run/openvswitch/db.sock"
6219 Interfaces "br0" "veth0"
6220 SendNotification true
6221 DispatchValues false
6224 The plugin provides the following configuration options:
6228 =item B<Address> I<node>
6230 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6231 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6232 option. See L<ovsdb-server(1)> for more details. The option may be either
6233 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6234 format. Defaults to C<localhost>.
6236 =item B<Port> I<service>
6238 TCP-port to connect to. Either a service name or a port number may be given.
6239 Defaults to B<6640>.
6241 =item B<Socket> I<path>
6243 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6244 plugin. To enable the interface, the OVS DB daemon should be running with
6245 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6246 option is set, B<Address> and B<Port> options are ignored.
6248 =item B<Interfaces> [I<ifname> ...]
6250 List of interface names to be monitored by this plugin. If this option is not
6251 specified or is empty then all OVS connected interfaces on all bridges are
6254 Default: empty (all interfaces on all bridges are monitored)
6256 =item B<SendNotification> I<true|false>
6258 If set to true, OVS link notifications (interface status and OVS DB connection
6259 terminate) are sent to collectd. Default value is true.
6261 =item B<DispatchValues> I<true|false>
6263 Dispatch the OVS DB interface link status value with configured plugin interval.
6264 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6265 options are false, no OVS information will be provided by the plugin.
6269 B<Note:> By default, the global interval setting is used within which to
6270 retrieve the OVS link status. To configure a plugin-specific interval, please
6271 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6272 simple divide the time by 1000 for example if the desired interval is 50ms, set
6275 =head2 Plugin C<ovs_stats>
6277 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6278 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6279 statistics from OVSDB
6283 <Plugin "ovs_stats">
6286 Socket "/var/run/openvswitch/db.sock"
6287 Bridges "br0" "br_ext"
6290 The plugin provides the following configuration options:
6294 =item B<Address> I<node>
6296 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6297 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6298 option. See L<ovsdb-server(1)> for more details. The option may be either
6299 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6300 format. Defaults to C<localhost>.
6302 =item B<Port> I<service>
6304 TCP-port to connect to. Either a service name or a port number may be given.
6305 Defaults to B<6640>.
6307 =item B<Socket> I<path>
6309 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6310 plugin. To enable the interface, the OVS DB daemon should be running with
6311 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6312 option is set, B<Address> and B<Port> options are ignored.
6314 =item B<Bridges> [I<brname> ...]
6316 List of OVS bridge names to be monitored by this plugin. If this option is
6317 omitted or is empty then all OVS bridges will be monitored.
6319 Default: empty (monitor all bridges)
6323 =head2 Plugin C<pcie_errors>
6325 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6326 structure and from Advanced Error Reporting Extended Capability where available.
6327 At every read it polls config space of PCI Express devices and dispatches
6328 notification for every error that is set. It checks for new errors at every read.
6329 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6330 Errors are divided into categories indicated by type_instance: "correctable", and
6331 for uncorrectable errors "non_fatal" or "fatal".
6332 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6336 <Plugin "pcie_errors">
6338 AccessDir "/sys/bus/pci"
6340 PersistentNotifications false
6347 =item B<Source> B<sysfs>|B<proc>
6349 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6350 The default value is B<sysfs>.
6352 =item B<AccessDir> I<dir>
6354 Directory used to access device config space. It is optional and defaults to
6355 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6357 =item B<ReportMasked> B<false>|B<true>
6359 If true plugin will notify about errors that are set to masked in Error Mask register.
6360 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6362 =item B<PersistentNotifications> B<false>|B<true>
6364 If false plugin will dispatch notification only on set/clear of error.
6365 The ones already reported will be ignored. Defaults to B<false>.
6369 =head2 Plugin C<perl>
6371 This plugin embeds a Perl-interpreter into collectd and provides an interface
6372 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6374 =head2 Plugin C<pinba>
6376 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6377 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6378 PHP-based webpage has been delivered, the extension will send a UDP packet
6379 containing timing information, peak memory usage and so on. The plugin will
6380 wait for such packets, parse them and account the provided information, which
6381 is then dispatched to the daemon once per interval.
6388 # Overall statistics for the website.
6390 Server "www.example.com"
6392 # Statistics for www-a only
6394 Host "www-a.example.com"
6395 Server "www.example.com"
6397 # Statistics for www-b only
6399 Host "www-b.example.com"
6400 Server "www.example.com"
6404 The plugin provides the following configuration options:
6408 =item B<Address> I<Node>
6410 Configures the address used to open a listening socket. By default, plugin will
6411 bind to the I<any> address C<::0>.
6413 =item B<Port> I<Service>
6415 Configures the port (service) to bind to. By default the default Pinba port
6416 "30002" will be used. The option accepts service names in addition to port
6417 numbers and thus requires a I<string> argument.
6419 =item E<lt>B<View> I<Name>E<gt> block
6421 The packets sent by the Pinba extension include the hostname of the server, the
6422 server name (the name of the virtual host) and the script that was executed.
6423 Using B<View> blocks it is possible to separate the data into multiple groups
6424 to get more meaningful statistics. Each packet is added to all matching groups,
6425 so that a packet may be accounted for more than once.
6429 =item B<Host> I<Host>
6431 Matches the hostname of the system the webserver / script is running on. This
6432 will contain the result of the L<gethostname(2)> system call. If not
6433 configured, all hostnames will be accepted.
6435 =item B<Server> I<Server>
6437 Matches the name of the I<virtual host>, i.e. the contents of the
6438 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6439 server names will be accepted.
6441 =item B<Script> I<Script>
6443 Matches the name of the I<script name>, i.e. the contents of the
6444 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6445 script names will be accepted.
6451 =head2 Plugin C<ping>
6453 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6454 configured hosts periodically and measures the network latency. Whenever the
6455 C<read> function of the plugin is called, it submits the average latency, the
6456 standard deviation and the drop rate for each host.
6458 Available configuration options:
6462 =item B<Host> I<IP-address>
6464 Host to ping periodically. This option may be repeated several times to ping
6467 =item B<Interval> I<Seconds>
6469 Sets the interval in which to send ICMP echo packets to the configured hosts.
6470 This is B<not> the interval in which metrics are read from the plugin but the
6471 interval in which the hosts are "pinged". Therefore, the setting here should be
6472 smaller than or equal to the global B<Interval> setting. Fractional times, such
6473 as "1.24" are allowed.
6477 =item B<Timeout> I<Seconds>
6479 Time to wait for a response from the host to which an ICMP packet had been
6480 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6481 to be down or the packet to be dropped. This setting must be smaller than the
6482 B<Interval> setting above for the plugin to work correctly. Fractional
6483 arguments are accepted.
6487 =item B<TTL> I<0-255>
6489 Sets the Time-To-Live of generated ICMP packets.
6491 =item B<Size> I<size>
6493 Sets the size of the data payload in ICMP packet to specified I<size> (it
6494 will be filled with regular ASCII pattern). If not set, default 56 byte
6495 long string is used so that the packet size of an ICMPv4 packet is exactly
6496 64 bytes, similar to the behaviour of normal ping(1) command.
6498 =item B<SourceAddress> I<host>
6500 Sets the source address to use. I<host> may either be a numerical network
6501 address or a network hostname.
6503 =item B<AddressFamily> I<af>
6505 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6506 option will be ignored if you set a B<SourceAddress>.
6508 =item B<Device> I<name>
6510 Sets the outgoing network device to be used. I<name> has to specify an
6511 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6514 =item B<MaxMissed> I<Packets>
6516 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6517 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6519 Default: B<-1> (disabled)
6523 =head2 Plugin C<postgresql>
6525 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6526 keeps a persistent connection to all configured databases and tries to
6527 reconnect if the connection has been interrupted. A database is configured by
6528 specifying a B<Database> block as described below. The default statistics are
6529 collected from PostgreSQL's B<statistics collector> which thus has to be
6530 enabled for this plugin to work correctly. This should usually be the case by
6531 default. See the section "The Statistics Collector" of the B<PostgreSQL
6532 Documentation> for details.
6534 By specifying custom database queries using a B<Query> block as described
6535 below, you may collect any data that is available from some PostgreSQL
6536 database. This way, you are able to access statistics of external daemons
6537 which are available in a PostgreSQL database or use future or special
6538 statistics provided by PostgreSQL without the need to upgrade your collectd
6541 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6542 PostgreSQL databases as well. This has been implemented in a generic way. You
6543 need to specify an SQL statement which will then be executed by collectd in
6544 order to write the data (see below for details). The benefit of that approach
6545 is that there is no fixed database layout. Rather, the layout may be optimized
6546 for the current setup.
6548 The B<PostgreSQL Documentation> manual can be found at
6549 L<http://www.postgresql.org/docs/manuals/>.
6553 Statement "SELECT magic FROM wizard WHERE host = $1;"
6557 InstancePrefix "magic"
6562 <Query rt36_tickets>
6563 Statement "SELECT COUNT(type) AS count, type \
6565 WHEN resolved = 'epoch' THEN 'open' \
6566 ELSE 'resolved' END AS type \
6567 FROM tickets) type \
6571 InstancePrefix "rt36_tickets"
6572 InstancesFrom "type"
6578 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6589 KRBSrvName "kerberos_service_name"
6595 Service "service_name"
6596 Query backends # predefined
6607 The B<Query> block defines one database query which may later be used by a
6608 database definition. It accepts a single mandatory argument which specifies
6609 the name of the query. The names of all queries have to be unique (see the
6610 B<MinVersion> and B<MaxVersion> options below for an exception to this
6613 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6614 B<Result> blocks may be used to extract multiple values from a single query.
6616 The following configuration options are available to define the query:
6620 =item B<Statement> I<sql query statement>
6622 Specify the I<sql query statement> which the plugin should execute. The string
6623 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6624 first, second, etc. parameter. The value of the parameters is specified by the
6625 B<Param> configuration option - see below for details. To include a literal
6626 B<$> character followed by a number, surround it with single quotes (B<'>).
6628 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6629 allowed. Note, however, that only a single command may be used. Semicolons are
6630 allowed as long as a single non-empty command has been specified only.
6632 The returned lines will be handled separately one after another.
6634 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6636 Specify the parameters which should be passed to the SQL query. The parameters
6637 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6638 they appear in the configuration file. The value of the parameter is
6639 determined depending on the value of the B<Param> option as follows:
6645 The configured hostname of the database connection. If a UNIX domain socket is
6646 used, the parameter expands to "localhost".
6650 The name of the database of the current connection.
6654 The name of the database plugin instance. See the B<Instance> option of the
6655 database specification below for details.
6659 The username used to connect to the database.
6663 The interval with which this database is queried (as specified by the database
6664 specific or global B<Interval> options).
6668 Please note that parameters are only supported by PostgreSQL's protocol
6669 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6671 =item B<PluginInstanceFrom> I<column>
6673 Specify how to create the "PluginInstance" for reporting this query results.
6674 Only one column is supported. You may concatenate fields and string values in
6675 the query statement to get the required results.
6677 =item B<MinVersion> I<version>
6679 =item B<MaxVersion> I<version>
6681 Specify the minimum or maximum version of PostgreSQL that this query should be
6682 used with. Some statistics might only be available with certain versions of
6683 PostgreSQL. This allows you to specify multiple queries with the same name but
6684 which apply to different versions, thus allowing you to use the same
6685 configuration in a heterogeneous environment.
6687 The I<version> has to be specified as the concatenation of the major, minor
6688 and patch-level versions, each represented as two-decimal-digit numbers. For
6689 example, version 8.2.3 will become 80203.
6693 The B<Result> block defines how to handle the values returned from the query.
6694 It defines which column holds which value and how to dispatch that value to
6699 =item B<Type> I<type>
6701 The I<type> name to be used when dispatching the values. The type describes
6702 how to handle the data and where to store it. See L<types.db(5)> for more
6703 details on types and their configuration. The number and type of values (as
6704 selected by the B<ValuesFrom> option) has to match the type of the given name.
6706 This option is mandatory.
6708 =item B<InstancePrefix> I<prefix>
6710 =item B<InstancesFrom> I<column0> [I<column1> ...]
6712 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6713 B<InstancePrefix> defines a static prefix that will be prepended to all type
6714 instances. B<InstancesFrom> defines the column names whose values will be used
6715 to create the type instance. Multiple values will be joined together using the
6716 hyphen (C<->) as separation character.
6718 The plugin itself does not check whether or not all built instances are
6719 different. It is your responsibility to assure that each is unique.
6721 Both options are optional. If none is specified, the type instance will be
6724 =item B<ValuesFrom> I<column0> [I<column1> ...]
6726 Names the columns whose content is used as the actual data for the data sets
6727 that are dispatched to the daemon. How many such columns you need is
6728 determined by the B<Type> setting as explained above. If you specify too many
6729 or not enough columns, the plugin will complain about that and no data will be
6730 submitted to the daemon.
6732 The actual data type, as seen by PostgreSQL, is not that important as long as
6733 it represents numbers. The plugin will automatically cast the values to the
6734 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6735 L<strtod(3)> functions, so anything supported by those functions is supported
6736 by the plugin as well.
6738 This option is required inside a B<Result> block and may be specified multiple
6739 times. If multiple B<ValuesFrom> options are specified, the columns are read
6744 The following predefined queries are available (the definitions can be found
6745 in the F<postgresql_default.conf> file which, by default, is available at
6746 C<I<prefix>/share/collectd/>):
6752 This query collects the number of backends, i.E<nbsp>e. the number of
6755 =item B<transactions>
6757 This query collects the numbers of committed and rolled-back transactions of
6762 This query collects the numbers of various table modifications (i.E<nbsp>e.
6763 insertions, updates, deletions) of the user tables.
6765 =item B<query_plans>
6767 This query collects the numbers of various table scans and returned tuples of
6770 =item B<table_states>
6772 This query collects the numbers of live and dead rows in the user tables.
6776 This query collects disk block access counts for user tables.
6780 This query collects the on-disk size of the database in bytes.
6784 In addition, the following detailed queries are available by default. Please
6785 note that each of those queries collects information B<by table>, thus,
6786 potentially producing B<a lot> of data. For details see the description of the
6787 non-by_table queries above.
6791 =item B<queries_by_table>
6793 =item B<query_plans_by_table>
6795 =item B<table_states_by_table>
6797 =item B<disk_io_by_table>
6801 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6802 mandatory argument specifying the name of the writer. This will then be used
6803 in the B<Database> specification in order to activate the writer instance. The
6804 names of all writers have to be unique. The following options may be
6809 =item B<Statement> I<sql statement>
6811 This mandatory option specifies the SQL statement that will be executed for
6812 each submitted value. A single SQL statement is allowed only. Anything after
6813 the first semicolon will be ignored.
6815 Nine parameters will be passed to the statement and should be specified as
6816 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6817 values are made available through those parameters:
6823 The timestamp of the queried value as an RFC 3339-formatted local time.
6827 The hostname of the queried value.
6831 The plugin name of the queried value.
6835 The plugin instance of the queried value. This value may be B<NULL> if there
6836 is no plugin instance.
6840 The type of the queried value (cf. L<types.db(5)>).
6844 The type instance of the queried value. This value may be B<NULL> if there is
6849 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6850 sources of the submitted value-list).
6854 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6855 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6856 B<StoreRates> is enabled (which is the default, see below), all types will be
6861 An array of the submitted values. The dimensions of the value name and value
6866 In general, it is advisable to create and call a custom function in the
6867 PostgreSQL database for this purpose. Any procedural language supported by
6868 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6871 =item B<StoreRates> B<false>|B<true>
6873 If set to B<true> (the default), convert counter values to rates. If set to
6874 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6879 The B<Database> block defines one PostgreSQL database for which to collect
6880 statistics. It accepts a single mandatory argument which specifies the
6881 database name. None of the other options are required. PostgreSQL will use
6882 default values as documented in the section "CONNECTING TO A DATABASE" in the
6883 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6884 the user collectd is run as and special environment variables. See the manpage
6889 =item B<Interval> I<seconds>
6891 Specify the interval with which the database should be queried. The default is
6892 to use the global B<Interval> setting.
6894 =item B<CommitInterval> I<seconds>
6896 This option may be used for database connections which have "writers" assigned
6897 (see above). If specified, it causes a writer to put several updates into a
6898 single transaction. This transaction will last for the specified amount of
6899 time. By default, each update will be executed in a separate transaction. Each
6900 transaction generates a fair amount of overhead which can, thus, be reduced by
6901 activating this option. The draw-back is, that data covering the specified
6902 amount of time will be lost, for example, if a single statement within the
6903 transaction fails or if the database server crashes.
6905 =item B<Plugin> I<Plugin>
6907 Use I<Plugin> as the plugin name when submitting query results from
6908 this B<Database>. Defaults to C<postgresql>.
6910 =item B<Instance> I<name>
6912 Specify the plugin instance name that should be used instead of the database
6913 name (which is the default, if this option has not been specified). This
6914 allows one to query multiple databases of the same name on the same host (e.g.
6915 when running multiple database server versions in parallel).
6916 The plugin instance name can also be set from the query result using
6917 the B<PluginInstanceFrom> option in B<Query> block.
6919 =item B<Host> I<hostname>
6921 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6922 value begins with a slash, it is interpreted as the directory name in which to
6923 look for the UNIX domain socket.
6925 This option is also used to determine the hostname that is associated with a
6926 collected data set. If it has been omitted or either begins with with a slash
6927 or equals B<localhost> it will be replaced with the global hostname definition
6928 of collectd. Any other value will be passed literally to collectd when
6929 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6931 =item B<Port> I<port>
6933 Specify the TCP port or the local UNIX domain socket file extension of the
6936 =item B<User> I<username>
6938 Specify the username to be used when connecting to the server.
6940 =item B<Password> I<password>
6942 Specify the password to be used when connecting to the server.
6944 =item B<ExpireDelay> I<delay>
6946 Skip expired values in query output.
6948 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6950 Specify whether to use an SSL connection when contacting the server. The
6951 following modes are supported:
6957 Do not use SSL at all.
6961 First, try to connect without using SSL. If that fails, try using SSL.
6963 =item I<prefer> (default)
6965 First, try to connect using SSL. If that fails, try without using SSL.
6973 =item B<Instance> I<name>
6975 Specify the plugin instance name that should be used instead of the database
6976 name (which is the default, if this option has not been specified). This
6977 allows one to query multiple databases of the same name on the same host (e.g.
6978 when running multiple database server versions in parallel).
6980 =item B<KRBSrvName> I<kerberos_service_name>
6982 Specify the Kerberos service name to use when authenticating with Kerberos 5
6983 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6984 B<PostgreSQL Documentation> for details.
6986 =item B<Service> I<service_name>
6988 Specify the PostgreSQL service name to use for additional parameters. That
6989 service has to be defined in F<pg_service.conf> and holds additional
6990 connection parameters. See the section "The Connection Service File" in the
6991 B<PostgreSQL Documentation> for details.
6993 =item B<Query> I<query>
6995 Specifies a I<query> which should be executed in the context of the database
6996 connection. This may be any of the predefined or user-defined queries. If no
6997 such option is given, it defaults to "backends", "transactions", "queries",
6998 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6999 has been specified). Else, the specified queries are used only.
7001 =item B<Writer> I<writer>
7003 Assigns the specified I<writer> backend to the database connection. This
7004 causes all collected data to be send to the database using the settings
7005 defined in the writer configuration (see the section "FILTER CONFIGURATION"
7006 below for details on how to selectively send data to certain plugins).
7008 Each writer will register a flush callback which may be used when having long
7009 transactions enabled (see the B<CommitInterval> option above). When issuing
7010 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
7011 transaction will be committed right away. Two different kinds of flush
7012 callbacks are available with the C<postgresql> plugin:
7018 Flush all writer backends.
7020 =item B<postgresql->I<database>
7022 Flush all writers of the specified I<database> only.
7028 =head2 Plugin C<powerdns>
7030 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7031 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7032 values, many of which are probably meaningless to most users, but may be useful
7033 for some. So you may chose which values to collect, but if you don't, some
7034 reasonable defaults will be collected.
7037 <Server "server_name">
7039 Collect "udp-answers" "udp-queries"
7040 Socket "/var/run/pdns.controlsocket"
7042 <Recursor "recursor_name">
7044 Collect "cache-hits" "cache-misses"
7045 Socket "/var/run/pdns_recursor.controlsocket"
7047 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7052 =item B<Server> and B<Recursor> block
7054 The B<Server> block defines one authoritative server to query, the B<Recursor>
7055 does the same for an recursing server. The possible options in both blocks are
7056 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7061 =item B<Collect> I<Field>
7063 Using the B<Collect> statement you can select which values to collect. Here,
7064 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7065 C<dlg-only-drops>, C<answers10-100>.
7067 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7068 When querying the server a C<SHOW *> command is issued in any case, because
7069 that's the only way of getting multiple values out of the server at once.
7070 collectd then picks out the values you have selected. When querying the
7071 recursor, a command is generated to query exactly these values. So if you
7072 specify invalid fields when querying the recursor, a syntax error may be
7073 returned by the daemon and collectd may not collect any values at all.
7075 If no B<Collect> statement is given, the following B<Server> values will be
7082 =item packetcache-hit
7084 =item packetcache-miss
7086 =item packetcache-size
7088 =item query-cache-hit
7090 =item query-cache-miss
7092 =item recursing-answers
7094 =item recursing-questions
7106 The following B<Recursor> values will be collected by default:
7110 =item noerror-answers
7112 =item nxdomain-answers
7114 =item servfail-answers
7132 Please note that up to that point collectd doesn't know what values are
7133 available on the server and values that are added do not need a change of the
7134 mechanism so far. However, the values must be mapped to collectd's naming
7135 scheme, which is done using a lookup table that lists all known values. If
7136 values are added in the future and collectd does not know about them, you will
7137 get an error much like this:
7139 powerdns plugin: submit: Not found in lookup table: foobar = 42
7141 In this case please file a bug report with the collectd team.
7143 =item B<Socket> I<Path>
7145 Configures the path to the UNIX domain socket to be used when connecting to the
7146 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7147 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7148 will be used for the recursor.
7152 =item B<LocalSocket> I<Path>
7154 Querying the recursor is done using UDP. When using UDP over UNIX domain
7155 sockets, the client socket needs a name in the file system, too. You can set
7156 this local name to I<Path> using the B<LocalSocket> option. The default is
7157 C<I<prefix>/var/run/collectd-powerdns>.
7161 =head2 Plugin C<processes>
7163 Collects information about processes of local system.
7165 By default, with no process matches configured, only general statistics is
7166 collected: the number of processes in each state and fork rate.
7168 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7169 These may also be a block in which further options may be specified.
7171 The statistics collected for matched processes are:
7172 - size of the resident segment size (RSS)
7173 - user- and system-time used
7174 - number of processes
7176 - number of open files (under Linux)
7177 - number of memory mapped files (under Linux)
7178 - io data (where available)
7179 - context switches (under Linux)
7180 - minor and major pagefaults
7181 - Delay Accounting information (Linux only, requires libmnl)
7186 CollectFileDescriptor true
7187 CollectContextSwitch true
7188 CollectDelayAccounting false
7190 ProcessMatch "name" "regex"
7191 <Process "collectd">
7192 CollectFileDescriptor false
7193 CollectContextSwitch false
7194 CollectDelayAccounting true
7196 <ProcessMatch "name" "regex">
7197 CollectFileDescriptor false
7198 CollectContextSwitch true
7204 =item B<Process> I<Name>
7206 Select more detailed statistics of processes matching this name.
7208 Some platforms have a limit on the length of process names.
7209 I<Name> must stay below this limit.
7211 =item B<ProcessMatch> I<name> I<regex>
7213 Select more detailed statistics of processes matching the specified I<regex>
7214 (see L<regex(7)> for details). The statistics of all matching processes are
7215 summed up and dispatched to the daemon using the specified I<name> as an
7216 identifier. This allows one to "group" several processes together.
7217 I<name> must not contain slashes.
7219 =item B<CollectContextSwitch> I<Boolean>
7221 Collect the number of context switches for matched processes.
7222 Disabled by default.
7224 =item B<CollectDelayAccounting> I<Boolean>
7226 If enabled, collect Linux Delay Accounding information for matching processes.
7227 Delay Accounting provides the time processes wait for the CPU to become
7228 available, for I/O operations to finish, for pages to be swapped in and for
7229 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7230 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7231 Disabled by default.
7233 This option is only available on Linux, requires the C<libmnl> library and
7234 requires the C<CAP_NET_ADMIN> capability at runtime.
7236 =item B<CollectFileDescriptor> I<Boolean>
7238 Collect number of file descriptors of matched processes.
7239 Disabled by default.
7241 =item B<CollectMemoryMaps> I<Boolean>
7243 Collect the number of memory mapped files of the process.
7244 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7249 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7250 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7251 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7252 reporting the corresponding processes only. Outside of B<Process> and
7253 B<ProcessMatch> blocks these options set the default value for subsequent
7256 =head2 Plugin C<protocols>
7258 Collects a lot of information about various network protocols, such as I<IP>,
7259 I<TCP>, I<UDP>, etc.
7261 Available configuration options:
7265 =item B<Value> I<Selector>
7267 Selects whether or not to select a specific value. The string being matched is
7268 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7269 plugin instance and I<ValueName> will be used as type instance. An example of
7270 the string being used would be C<Tcp:RetransSegs>.
7272 You can use regular expressions to match a large number of values with just one
7273 configuration option. To select all "extended" I<TCP> values, you could use the
7274 following statement:
7278 Whether only matched values are selected or all matched values are ignored
7279 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7280 If no value is configured at all, all values will be selected.
7282 See F</"IGNORELISTS"> for details.
7284 =item B<IgnoreSelected> B<true>|B<false>
7286 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7287 matching values will be ignored.
7291 =head2 Plugin C<python>
7293 This plugin embeds a Python-interpreter into collectd and provides an interface
7294 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7296 =head2 Plugin C<routeros>
7298 The C<routeros> plugin connects to a device running I<RouterOS>, the
7299 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7300 I<librouteros> to connect and reads information about the interfaces and
7301 wireless connections of the device. The configuration supports querying
7306 Host "router0.example.com"
7309 CollectInterface true
7314 Host "router1.example.com"
7317 CollectInterface true
7318 CollectRegistrationTable true
7325 As you can see above, the configuration of the I<routeros> plugin consists of
7326 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7327 options are understood:
7331 =item B<Host> I<Host>
7333 Hostname or IP-address of the router to connect to.
7335 =item B<Port> I<Port>
7337 Port name or port number used when connecting. If left unspecified, the default
7338 will be chosen by I<librouteros>, currently "8728". This option expects a
7339 string argument, even when a numeric port number is given.
7341 =item B<User> I<User>
7343 Use the user name I<User> to authenticate. Defaults to "admin".
7345 =item B<Password> I<Password>
7347 Set the password used to authenticate.
7349 =item B<CollectInterface> B<true>|B<false>
7351 When set to B<true>, interface statistics will be collected for all interfaces
7352 present on the device. Defaults to B<false>.
7354 =item B<CollectRegistrationTable> B<true>|B<false>
7356 When set to B<true>, information about wireless LAN connections will be
7357 collected. Defaults to B<false>.
7359 =item B<CollectCPULoad> B<true>|B<false>
7361 When set to B<true>, information about the CPU usage will be collected. The
7362 number is a dimensionless value where zero indicates no CPU usage at all.
7363 Defaults to B<false>.
7365 =item B<CollectMemory> B<true>|B<false>
7367 When enabled, the amount of used and free memory will be collected. How used
7368 memory is calculated is unknown, for example whether or not caches are counted
7370 Defaults to B<false>.
7372 =item B<CollectDF> B<true>|B<false>
7374 When enabled, the amount of used and free disk space will be collected.
7375 Defaults to B<false>.
7377 =item B<CollectDisk> B<true>|B<false>
7379 When enabled, the number of sectors written and bad blocks will be collected.
7380 Defaults to B<false>.
7382 =item B<CollectHealth> B<true>|B<false>
7384 When enabled, the health statistics will be collected. This includes the
7385 voltage and temperature on supported hardware.
7386 Defaults to B<false>.
7390 =head2 Plugin C<redis>
7392 The I<Redis plugin> connects to one or more Redis servers, gathers
7393 information about each server's state and executes user-defined queries.
7394 For each server there is a I<Node> block which configures the connection
7395 parameters and set of user-defined queries for this node.
7401 #Socket "/var/run/redis/redis.sock"
7403 ReportCommandStats false
7405 <Query "LLEN myqueue">
7415 =item B<Node> I<Nodename>
7417 The B<Node> block identifies a new Redis node, that is a new Redis instance
7418 running in an specified host and port. The name for node is a canonical
7419 identifier which is used as I<plugin instance>. It is limited to
7420 128E<nbsp>characters in length.
7422 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7424 =item B<Host> I<Hostname>
7426 The B<Host> option is the hostname or IP-address where the Redis instance is
7429 =item B<Port> I<Port>
7431 The B<Port> option is the TCP port on which the Redis instance accepts
7432 connections. Either a service name of a port number may be given. Please note
7433 that numerical port numbers must be given as a string, too.
7435 =item B<Socket> I<Path>
7437 Connect to Redis using the UNIX domain socket at I<Path>. If this
7438 setting is given, the B<Hostname> and B<Port> settings are ignored.
7440 =item B<Password> I<Password>
7442 Use I<Password> to authenticate when connecting to I<Redis>.
7444 =item B<Timeout> I<Milliseconds>
7446 The B<Timeout> option set the socket timeout for node response. Since the Redis
7447 read function is blocking, you should keep this value as low as possible.
7448 It is expected what B<Timeout> values should be lower than B<Interval> defined
7451 Defaults to 2000 (2 seconds).
7453 =item B<ReportCommandStats> B<false>|B<true>
7455 Enables or disables reporting of statistics based on the command type, including
7456 rate of command calls and average CPU time consumed by command processing.
7457 Defaults to B<false>.
7459 =item B<ReportCpuUsage> B<true>|B<false>
7461 Enables or disables reporting of CPU consumption statistics.
7462 Defaults to B<true>.
7464 =item B<Query> I<Querystring>
7466 The B<Query> block identifies a query to execute against the redis server.
7467 There may be an arbitrary number of queries to execute. Each query should
7468 return single string or integer.
7470 =item B<Type> I<Collectd type>
7472 Within a query definition, a valid I<collectd type> to use as when submitting
7473 the result of the query. When not supplied, will default to B<gauge>.
7475 Currently only types with one datasource are supported.
7476 See L<types.db(5)> for more details on types and their configuration.
7478 =item B<Instance> I<Type instance>
7480 Within a query definition, an optional type instance to use when submitting
7481 the result of the query. When not supplied will default to the escaped
7482 command, up to 128 chars.
7484 =item B<Database> I<Index>
7486 This index selects the Redis logical database to use for query. Defaults
7491 =head2 Plugin C<rrdcached>
7493 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7494 to store values to RRD files in an efficient manner. The combination of the
7495 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7496 way the C<rrdtool> plugin works (see below). The added abstraction layer
7497 provides a number of benefits, though: Because the cache is not within
7498 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7499 restarted. This results in much shorter (if any) gaps in graphs, especially
7500 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7501 daemon so that it can flush values to disk automatically when needed. This
7502 allows one to integrate automated flushing of values into graphing solutions
7505 There are disadvantages, though: The daemon may reside on a different host, so
7506 it may not be possible for C<collectd> to create the appropriate RRD files
7507 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7508 different base directory, so relative paths may do weird stuff if you're not
7511 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7512 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7513 setting should be set to an absolute path, so that a changed base directory
7514 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7518 =item B<DaemonAddress> I<Address>
7520 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7521 library. See L<rrdcached(1)> for details. Example:
7523 <Plugin "rrdcached">
7524 DaemonAddress "unix:/var/run/rrdcached.sock"
7527 =item B<DataDir> I<Directory>
7529 Set the base directory in which the RRD files reside. If this is a relative
7530 path, it is relative to the working base directory of the C<rrdcached> daemon!
7531 Use of an absolute path is recommended.
7533 =item B<CreateFiles> B<true>|B<false>
7535 Enables or disables the creation of RRD files. If the daemon is not running
7536 locally, or B<DataDir> is set to a relative path, this will not work as
7537 expected. Default is B<true>.
7539 =item B<CreateFilesAsync> B<false>|B<true>
7541 When enabled, new RRD files are enabled asynchronously, using a separate thread
7542 that runs in the background. This prevents writes to block, which is a problem
7543 especially when many hundreds of files need to be created at once. However,
7544 since the purpose of creating the files asynchronously is I<not> to block until
7545 the file is available, values before the file is available will be discarded.
7546 When disabled (the default) files are created synchronously, blocking for a
7547 short while, while the file is being written.
7549 =item B<StepSize> I<Seconds>
7551 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7552 this setting is unset and the stepsize is set to the interval in which the data
7553 is collected. Do not use this option unless you absolutely have to for some
7554 reason. Setting this option may cause problems with the C<snmp plugin>, the
7555 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7557 =item B<HeartBeat> I<Seconds>
7559 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7560 in which case the heartbeat is set to twice the B<StepSize> which should equal
7561 the interval in which data is collected. Do not set this option unless you have
7562 a very good reason to do so.
7564 =item B<RRARows> I<NumRows>
7566 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7567 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7568 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7569 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7570 week, one month, and one year.
7572 So for each timespan, it calculates how many PDPs need to be consolidated into
7573 one CDP by calculating:
7574 number of PDPs = timespan / (stepsize * rrarows)
7576 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7579 =item B<RRATimespan> I<Seconds>
7581 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7582 more then one RRA. If this option is never used, the built-in default of (3600,
7583 86400, 604800, 2678400, 31622400) is used.
7585 For more information on how RRA-sizes are calculated see B<RRARows> above.
7587 =item B<XFF> I<Factor>
7589 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7590 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7593 =item B<CollectStatistics> B<false>|B<true>
7595 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7596 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7598 Statistics are read via I<rrdcached>s socket using the STATS command.
7599 See L<rrdcached(1)> for details.
7603 =head2 Plugin C<rrdtool>
7605 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7606 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7607 using these settings. If you don't want to dive into the depths of RRDtool, you
7608 can safely ignore these settings.
7612 =item B<DataDir> I<Directory>
7614 Set the directory to store RRD files under. By default RRD files are generated
7615 beneath the daemon's working directory, i.e. the B<BaseDir>.
7617 =item B<CreateFilesAsync> B<false>|B<true>
7619 When enabled, new RRD files are enabled asynchronously, using a separate thread
7620 that runs in the background. This prevents writes to block, which is a problem
7621 especially when many hundreds of files need to be created at once. However,
7622 since the purpose of creating the files asynchronously is I<not> to block until
7623 the file is available, values before the file is available will be discarded.
7624 When disabled (the default) files are created synchronously, blocking for a
7625 short while, while the file is being written.
7627 =item B<StepSize> I<Seconds>
7629 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7630 this setting is unset and the stepsize is set to the interval in which the data
7631 is collected. Do not use this option unless you absolutely have to for some
7632 reason. Setting this option may cause problems with the C<snmp plugin>, the
7633 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7635 =item B<HeartBeat> I<Seconds>
7637 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7638 in which case the heartbeat is set to twice the B<StepSize> which should equal
7639 the interval in which data is collected. Do not set this option unless you have
7640 a very good reason to do so.
7642 =item B<RRARows> I<NumRows>
7644 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7645 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7646 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7647 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7648 week, one month, and one year.
7650 So for each timespan, it calculates how many PDPs need to be consolidated into
7651 one CDP by calculating:
7652 number of PDPs = timespan / (stepsize * rrarows)
7654 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7657 =item B<RRATimespan> I<Seconds>
7659 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7660 more then one RRA. If this option is never used, the built-in default of (3600,
7661 86400, 604800, 2678400, 31622400) is used.
7663 For more information on how RRA-sizes are calculated see B<RRARows> above.
7665 =item B<XFF> I<Factor>
7667 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7668 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7671 =item B<CacheFlush> I<Seconds>
7673 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7674 it writes all values for a certain RRD-file if the oldest value is older than
7675 (or equal to) the number of seconds specified by B<CacheTimeout>.
7676 That check happens on new values arriwal. If some RRD-file is not updated
7677 anymore for some reason (the computer was shut down, the network is broken,
7678 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7679 every I<Seconds> seconds the entire cache is searched for entries older than
7680 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7681 disk. Since scanning the entire cache is kind of expensive and does nothing
7682 under normal circumstances, this value should not be too small. 900 seconds
7683 might be a good value, though setting this to 7200 seconds doesn't normally
7684 do much harm either.
7686 Defaults to 10x B<CacheTimeout>.
7687 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7688 above default is used.
7690 =item B<CacheTimeout> I<Seconds>
7692 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7693 save values in a cache, as described above. Writing multiple values at once
7694 reduces IO-operations and thus lessens the load produced by updating the files.
7695 The trade off is that the graphs kind of "drag behind" and that more memory is
7698 =item B<WritesPerSecond> I<Updates>
7700 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7701 will run serious performance problems. The B<CacheFlush> setting and the
7702 internal update queue assert that collectd continues to work just fine even
7703 under heavy load, but the system may become very unresponsive and slow. This is
7704 a problem especially if you create graphs from the RRD files on the same
7705 machine, for example using the C<graph.cgi> script included in the
7706 C<contrib/collection3/> directory.
7708 This setting is designed for very large setups. Setting this option to a value
7709 between 25 and 80 updates per second, depending on your hardware, will leave
7710 the server responsive enough to draw graphs even while all the cached values
7711 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7712 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7713 written as fast as possible, so that web frontends have up to date data when
7716 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7717 updates per second, writing all values to disk will take approximately
7718 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7719 "collection3" you'll end up with a responsive and fast system, up to date
7720 graphs and basically a "backup" of your values every hour.
7722 =item B<RandomTimeout> I<Seconds>
7724 When set, the actual timeout for each value is chosen randomly between
7725 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7726 intention is to avoid high load situations that appear when many values timeout
7727 at the same time. This is especially a problem shortly after the daemon starts,
7728 because all values were added to the internal cache at roughly the same time.
7732 =head2 Plugin C<sensors>
7734 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7735 that all the needed modules have to be loaded and lm_sensors has to be
7736 configured (most likely by editing F</etc/sensors.conf>. Read
7737 L<sensors.conf(5)> for details.
7739 The B<lm_sensors> homepage can be found at
7740 L<http://secure.netroedge.com/~lm78/>.
7744 =item B<SensorConfigFile> I<File>
7746 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7747 the library's default will be used.
7749 =item B<Sensor> I<chip-bus-address/type-feature>
7751 Selects the name of the sensor which you want to collect or ignore, depending
7752 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7753 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7754 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7756 See F</"IGNORELISTS"> for details.
7758 =item B<IgnoreSelected> I<true>|I<false>
7760 If no configuration if given, the B<sensors>-plugin will collect data from all
7761 sensors. This may not be practical, especially for uninteresting sensors.
7762 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7763 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7764 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7765 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7766 and all other sensors are collected.
7768 =item B<UseLabels> I<true>|I<false>
7770 Configures how sensor readings are reported. When set to I<true>, sensor
7771 readings are reported using their descriptive label (e.g. "VCore"). When set to
7772 I<false> (the default) the sensor name is used ("in0").
7776 =head2 Plugin C<sigrok>
7778 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7779 supported by the L<sigrok|http://sigrok.org/> project.
7785 <Device "AC Voltage">
7790 <Device "Sound Level">
7791 Driver "cem-dt-885x"
7798 =item B<LogLevel> B<0-5>
7800 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7801 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7802 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7803 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7804 their level, are always submitted to I<collectd> at its INFO log level.
7806 =item E<lt>B<Device> I<Name>E<gt>
7808 A sigrok-supported device, uniquely identified by this section's options. The
7809 I<Name> is passed to I<collectd> as the I<plugin instance>.
7811 =item B<Driver> I<DriverName>
7813 The sigrok driver to use for this device.
7815 =item B<Conn> I<ConnectionSpec>
7817 If the device cannot be auto-discovered, or more than one might be discovered
7818 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7819 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7820 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7821 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7822 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7824 =item B<SerialComm> I<SerialSpec>
7826 For serial devices with non-standard port settings, this option can be used
7827 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7828 This should not be necessary; drivers know how to communicate with devices they
7831 =item B<MinimumInterval> I<Seconds>
7833 Specifies the minimum time between measurement dispatches to I<collectd>, in
7834 seconds. Since some I<sigrok> supported devices can acquire measurements many
7835 times per second, it may be necessary to throttle these. For example, the
7836 I<RRD plugin> cannot process writes more than once per second.
7838 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7839 device are always dispatched to I<collectd>. When throttled, unused
7840 measurements are discarded.
7844 =head2 Plugin C<smart>
7846 The C<smart> plugin collects SMART information from physical
7847 disks. Values collectd include temperature, power cycle count, poweron
7848 time and bad sectors. Also, all SMART attributes are collected along
7849 with the normalized current value, the worst value, the threshold and
7850 a human readable value.
7852 Using the following two options you can ignore some disks or configure the
7853 collection only of specific disks.
7857 =item B<Disk> I<Name>
7859 Select the disk I<Name>. Whether it is collected or ignored depends on the
7860 B<IgnoreSelected> setting, see below. As with other plugins that use the
7861 daemon's ignorelist functionality, a string that starts and ends with a slash
7862 is interpreted as a regular expression. Examples:
7867 See F</"IGNORELISTS"> for details.
7869 =item B<IgnoreSelected> B<true>|B<false>
7871 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7872 statements, are ignored or if all other disks are ignored. The behavior
7873 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7874 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7875 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7876 is set to B<true>, all disks are collected B<except> the ones matched.
7878 =item B<IgnoreSleepMode> B<true>|B<false>
7880 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7881 This option disables the sleep mode check and allows the plugin to collect data
7882 from these disks anyway. This is useful in cases where libatasmart mistakenly
7883 reports disks as asleep because it has not been updated to incorporate support
7884 for newer idle states in the ATA spec.
7886 =item B<UseSerial> B<true>|B<false>
7888 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7889 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7890 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7891 storing data. This ensures that the data for a given disk will be kept together
7892 even if the kernel name changes.
7896 =head2 Plugin C<snmp>
7898 Since the configuration of the C<snmp plugin> is a little more complicated than
7899 other plugins, its documentation has been moved to an own manpage,
7900 L<collectd-snmp(5)>. Please see there for details.
7902 =head2 Plugin C<snmp_agent>
7904 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7905 from SNMP master agent and returns the data collected by read plugins.
7906 The I<snmp_agent> plugin handles requests only for OIDs specified in
7907 configuration file. To handle SNMP queries the plugin gets data from collectd
7908 and translates requested values from collectd's internal format to SNMP format.
7909 This plugin is a generic plugin and cannot work without configuration.
7910 For more details on AgentX subagent see
7911 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7916 <Data "memAvailReal">
7918 #PluginInstance "some"
7921 OIDs "1.3.6.1.4.1.2021.4.6.0"
7924 IndexOID "IF-MIB::ifIndex"
7925 SizeOID "IF-MIB::ifNumber"
7928 Source "PluginInstance"
7931 OIDs "IF-MIB::ifDescr"
7937 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7940 <Table "CPUAffinityTable">
7943 Source "PluginInstance"
7946 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
7951 Source "TypeInstance"
7952 Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
7955 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
7960 Source "TypeInstance"
7961 Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
7964 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
7966 <Data "CPUAffinity">
7969 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
7974 There are two types of blocks that can be contained in the
7975 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7977 =head3 B<Data> block
7979 The B<Data> block defines a list OIDs that are to be handled. This block can
7980 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7981 block it reperesents table OIDs.
7982 The following options can be set:
7986 =item B<IndexKey> block
7988 B<IndexKey> block contains all data needed for proper index build of snmp table.
7990 one table B<Data> block has B<IndexKey> block present then multiple key index is
7991 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
7996 =item B<Source> I<String>
7998 B<Source> can be set to one of the following values: "Hostname", "Plugin",
7999 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
8000 corresponding collectd metric is taken as a SNMP table index.
8002 =item B<Regex> I<String>
8004 B<Regex> option can also be used to parse strings or numbers out of
8005 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
8006 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
8009 =item B<Group> I<Number>
8011 B<Group> number can be specified in case groups are used in regex.
8015 =item B<Plugin> I<String>
8017 Read plugin name whose collected data will be mapped to specified OIDs.
8019 =item B<PluginInstance> I<String>
8021 Read plugin instance whose collected data will be mapped to specified OIDs.
8022 The field is optional and by default there is no plugin instance check.
8023 Allowed only if B<Data> block defines scalar data type.
8025 =item B<Type> I<String>
8027 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
8028 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
8030 =item B<TypeInstance> I<String>
8032 Collectd's type-instance that is to be used for specified OID.
8034 =item B<OIDs> I<OID> [I<OID> ...]
8036 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8037 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8038 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8039 configured should correspond to number of values in specified B<Type>.
8040 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8041 "rx" and "tx" values of "if_octets" type.
8043 =item B<Scale> I<Value>
8045 The values taken from collectd are multiplied by I<Value>. The field is optional
8046 and the default is B<1.0>.
8048 =item B<Shift> I<Value>
8050 I<Value> is added to values from collectd after they have been multiplied by
8051 B<Scale> value. The field is optional and the default value is B<0.0>.
8055 =head3 The B<Table> block
8057 The B<Table> block defines a collection of B<Data> blocks that belong to one
8058 snmp table. In addition to multiple B<Data> blocks the following options can be
8063 =item B<IndexOID> I<OID>
8065 OID that is handled by the plugin and is mapped to numerical index value that is
8066 generated by the plugin for each table record.
8068 =item B<SizeOID> I<OID>
8070 OID that is handled by the plugin. Returned value is the number of records in
8071 the table. The field is optional.
8075 =head2 Plugin C<statsd>
8077 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8078 protocol and dispatches rates or other aggregates of these numbers
8081 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8082 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8083 C<objects> respectively.
8085 The following configuration options are valid:
8089 =item B<Host> I<Host>
8091 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8092 "any" address, i.e. accept packets sent to any of the hosts addresses.
8094 =item B<Port> I<Port>
8096 UDP port to listen to. This can be either a service name or a port number.
8097 Defaults to C<8125>.
8099 =item B<DeleteCounters> B<false>|B<true>
8101 =item B<DeleteTimers> B<false>|B<true>
8103 =item B<DeleteGauges> B<false>|B<true>
8105 =item B<DeleteSets> B<false>|B<true>
8107 These options control what happens if metrics are not updated in an interval.
8108 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8109 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8110 are unchanged. If set to B<True>, the such metrics are not dispatched and
8111 removed from the internal cache.
8113 =item B<CounterSum> B<false>|B<true>
8115 When enabled, creates a C<count> metric which reports the change since the last
8116 read. This option primarily exists for compatibility with the I<statsd>
8117 implementation by Etsy.
8119 =item B<TimerPercentile> I<Percent>
8121 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8122 that I<Percent> of all reported timers are smaller than or equal to the
8123 computed latency. This is useful for cutting off the long tail latency, as it's
8124 often done in I<Service Level Agreements> (SLAs).
8126 Different percentiles can be calculated by setting this option several times.
8127 If none are specified, no percentiles are calculated / dispatched.
8129 =item B<TimerLower> B<false>|B<true>
8131 =item B<TimerUpper> B<false>|B<true>
8133 =item B<TimerSum> B<false>|B<true>
8135 =item B<TimerCount> B<false>|B<true>
8137 Calculate and dispatch various values out of I<Timer> metrics received during
8138 an interval. If set to B<False>, the default, these values aren't calculated /
8141 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8145 =head2 Plugin C<swap>
8147 The I<Swap plugin> collects information about used and available swap space. On
8148 I<Linux> and I<Solaris>, the following options are available:
8152 =item B<ReportByDevice> B<false>|B<true>
8154 Configures how to report physical swap devices. If set to B<false> (the
8155 default), the summary over all swap devices is reported only, i.e. the globally
8156 used and available space over all devices. If B<true> is configured, the used
8157 and available space of each device will be reported separately.
8159 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8160 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8162 =item B<ReportBytes> B<false>|B<true>
8164 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8165 I<swap I/O> is reported in pages. This option is available under Linux only.
8167 =item B<ValuesAbsolute> B<true>|B<false>
8169 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8170 available and used. Defaults to B<true>.
8172 =item B<ValuesPercentage> B<false>|B<true>
8174 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8175 available and free. Defaults to B<false>.
8177 This is useful for deploying I<collectd> in a heterogeneous environment, where
8178 swap sizes differ and you want to specify generic thresholds or similar.
8180 =item B<ReportIO> B<true>|B<false>
8182 Enables or disables reporting swap IO. Defaults to B<true>.
8184 This is useful for the cases when swap IO is not neccessary, is not available,
8189 =head2 Plugin C<syslog>
8193 =item B<LogLevel> B<debug|info|notice|warning|err>
8195 Sets the log-level. If, for example, set to B<notice>, then all events with
8196 severity B<notice>, B<warning>, or B<err> will be submitted to the
8199 Please note that B<debug> is only available if collectd has been compiled with
8202 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8204 Controls which notifications should be sent to syslog. The default behaviour is
8205 not to send any. Less severe notifications always imply logging more severe
8206 notifications: Setting this to B<OKAY> means all notifications will be sent to
8207 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8208 notifications but will dismiss B<OKAY> notifications. Setting this option to
8209 B<FAILURE> will only send failures to syslog.
8213 =head2 Plugin C<table>
8215 The C<table plugin> provides generic means to parse tabular data and dispatch
8216 user specified values. Values are selected based on column numbers. For
8217 example, this plugin may be used to get values from the Linux L<proc(5)>
8218 filesystem or CSV (comma separated values) files.
8221 <Table "/proc/slabinfo">
8227 InstancePrefix "active_objs"
8233 InstancePrefix "objperslab"
8240 The configuration consists of one or more B<Table> blocks, each of which
8241 configures one file to parse. Within each B<Table> block, there are one or
8242 more B<Result> blocks, which configure which data to select and how to
8245 The following options are available inside a B<Table> block:
8249 =item B<Plugin> I<Plugin>
8251 If specified, I<Plugin> is used as the plugin name when submitting values.
8252 Defaults to B<table>.
8254 =item B<Instance> I<instance>
8256 If specified, I<instance> is used as the plugin instance. If omitted, the
8257 filename of the table is used instead, with all special characters replaced
8258 with an underscore (C<_>).
8260 =item B<Separator> I<string>
8262 Any character of I<string> is interpreted as a delimiter between the different
8263 columns of the table. A sequence of two or more contiguous delimiters in the
8264 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8265 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8266 of a table - see its documentation for more details. This option is mandatory.
8268 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8269 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8270 required because of collectd's config parsing.
8274 The following options are available inside a B<Result> block:
8278 =item B<Type> I<type>
8280 Sets the type used to dispatch the values to the daemon. Detailed information
8281 about types and their configuration can be found in L<types.db(5)>. This
8282 option is mandatory.
8284 =item B<InstancePrefix> I<prefix>
8286 If specified, prepend I<prefix> to the type instance. If omitted, only the
8287 B<InstancesFrom> option is considered for the type instance.
8289 =item B<InstancesFrom> I<column0> [I<column1> ...]
8291 If specified, the content of the given columns (identified by the column
8292 number starting at zero) will be used to create the type instance for each
8293 row. Multiple values (and the instance prefix) will be joined together with
8294 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8295 option is considered for the type instance.
8297 The plugin itself does not check whether or not all built instances are
8298 different. It’s your responsibility to assure that each is unique. This is
8299 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8300 sure that the table only contains one row.
8302 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8305 =item B<ValuesFrom> I<column0> [I<column1> ...]
8307 Specifies the columns (identified by the column numbers starting at zero)
8308 whose content is used as the actual data for the data sets that are dispatched
8309 to the daemon. How many such columns you need is determined by the B<Type>
8310 setting above. If you specify too many or not enough columns, the plugin will
8311 complain about that and no data will be submitted to the daemon. The plugin
8312 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8313 respectively, so anything supported by those functions is supported by the
8314 plugin as well. This option is mandatory.
8318 =head2 Plugin C<tail>
8320 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8321 each line and dispatches found values. What is matched can be configured by the
8322 user using (extended) regular expressions, as described in L<regex(7)>.
8325 <File "/var/log/exim4/mainlog">
8330 Regex "S=([1-9][0-9]*)"
8336 Regex "\\<R=local_user\\>"
8337 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8340 Instance "local_user"
8343 Regex "l=([0-9]*\\.[0-9]*)"
8344 <DSType "Distribution">
8347 #BucketType "bucket"
8355 The config consists of one or more B<File> blocks, each of which configures one
8356 logfile to parse. Within each B<File> block, there are one or more B<Match>
8357 blocks, which configure a regular expression to search for.
8359 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8360 the plugin name and instance respectively. So in the above example the plugin name
8361 C<mail-exim> would be used.
8363 These options are applied for all B<Match> blocks that B<follow> it, until the
8364 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8365 instances from one logfile, handy when parsing syslog and the like.
8367 The B<Interval> option allows you to define the length of time between reads. If
8368 this is not set, the default Interval will be used.
8370 Each B<Match> block has the following options to describe how the match should
8375 =item B<Regex> I<regex>
8377 Sets the regular expression to use for matching against a line. The first
8378 subexpression has to match something that can be turned into a number by
8379 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8380 below. Because B<extended> regular expressions are used, you do not need to use
8381 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8382 collectd's config parsing you need to escape backslashes, though. So if you
8383 want to match literal parentheses you need to do the following:
8385 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8387 =item B<ExcludeRegex> I<regex>
8389 Sets an optional regular expression to use for excluding lines from the match.
8390 An example which excludes all connections from localhost from the match:
8392 ExcludeRegex "127\\.0\\.0\\.1"
8394 =item B<DSType> I<Type>
8396 Sets how the values are cumulated. I<Type> is one of:
8400 =item B<GaugeAverage>
8402 Calculate the average.
8406 Use the smallest number only.
8410 Use the greatest number only.
8414 Use the last number found.
8416 =item B<GaugePersist>
8418 Use the last number found. The number is not reset at the end of an interval.
8419 It is continously reported until another number is matched. This is intended
8420 for cases in which only state changes are reported, for example a thermometer
8421 that only reports the temperature when it changes.
8427 =item B<AbsoluteSet>
8429 The matched number is a counter. Simply I<sets> the internal counter to this
8430 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8438 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8439 matched number may be negative, which will effectively subtract from the
8448 Increase the internal counter by one. These B<DSType> are the only ones that do
8449 not use the matched subexpression, but simply count the number of matched
8450 lines. Thus, you may use a regular expression without submatch in this case.
8452 =item B<Distribution>
8454 Type to do calculations based on the distribution of values, primarily
8455 calculating percentiles. This is primarily geared towards latency, but can be
8456 used for other metrics as well. The range of values tracked with this setting
8457 must be in the range (0–2^34) and can be fractional. Please note that neither
8458 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8461 This option must be used together with the B<Percentile> and/or B<Bucket>
8466 <DSType "Distribution">
8474 =item B<Percentile> I<Percent>
8476 Calculate and dispatch the configured percentile, i.e. compute the value, so
8477 that I<Percent> of all matched values are smaller than or equal to the computed
8480 Metrics are reported with the I<type> B<Type> (the value of the above option)
8481 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8483 This option may be repeated to calculate more than one percentile.
8485 =item B<Bucket> I<lower_bound> I<upper_bound>
8487 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8488 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8489 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8490 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8491 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8494 To export the entire (0–inf) range without overlap, use the upper bound of the
8495 previous range as the lower bound of the following range. In other words, use
8496 the following schema:
8506 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8507 by default) and the I<type instance>
8508 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8510 This option may be repeated to calculate more than one rate.
8512 =item B<BucketType> I<Type>
8514 Sets the type used to dispatch B<Bucket> metrics.
8515 Optional, by default C<bucket> will be used.
8521 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8522 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8523 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8524 B<Derive*> types interpret the submatch as a signed integer using
8525 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8526 and it may be omitted in this case.
8528 =item B<Type> I<Type>
8530 Sets the type used to dispatch this value. Detailed information about types and
8531 their configuration can be found in L<types.db(5)>.
8533 =item B<Instance> I<TypeInstance>
8535 This optional setting sets the type instance to use.
8539 =head2 Plugin C<tail_csv>
8541 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8542 written by I<Snort>.
8547 <Metric "snort-dropped">
8552 <File "/var/log/snort/snort.stats">
8556 Collect "snort-dropped"
8561 The configuration consists of one or more B<Metric> blocks that define an index
8562 into the line of the CSV file and how this value is mapped to I<collectd's>
8563 internal representation. These are followed by one or more B<Instance> blocks
8564 which configure which file to read, in which interval and which metrics to
8569 =item E<lt>B<Metric> I<Name>E<gt>
8571 The B<Metric> block configures a new metric to be extracted from the statistics
8572 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8573 only used inside the B<Instance> blocks to refer to this block, so you can use
8574 one B<Metric> block for multiple CSV files.
8578 =item B<Type> I<Type>
8580 Configures which I<Type> to use when dispatching this metric. Types are defined
8581 in the L<types.db(5)> file, see the appropriate manual page for more
8582 information on specifying types. Only types with a single I<data source> are
8583 supported by the I<tail_csv plugin>. The information whether the value is an
8584 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8585 I<Type's> definition.
8587 =item B<Instance> I<TypeInstance>
8589 If set, I<TypeInstance> is used to populate the type instance field of the
8590 created value lists. Otherwise, no type instance is used.
8592 =item B<ValueFrom> I<Index>
8594 Configure to read the value from the field with the zero-based index I<Index>.
8595 If the value is parsed as signed integer, unsigned integer or double depends on
8596 the B<Type> setting, see above.
8600 =item E<lt>B<File> I<Path>E<gt>
8602 Each B<File> block represents one CSV file to read. There must be at least one
8603 I<File> block but there can be multiple if you have multiple CSV files.
8607 =item B<Plugin> I<Plugin>
8609 Use I<Plugin> as the plugin name when submitting values.
8610 Defaults to C<tail_csv>.
8612 =item B<Instance> I<PluginInstance>
8614 Sets the I<plugin instance> used when dispatching the values.
8616 =item B<Collect> I<Metric>
8618 Specifies which I<Metric> to collect. This option must be specified at least
8619 once, and you can use this option multiple times to specify more than one
8620 metric to be extracted from this statistic file.
8622 =item B<Interval> I<Seconds>
8624 Configures the interval in which to read values from this instance / file.
8625 Defaults to the plugin's default interval.
8627 =item B<TimeFrom> I<Index>
8629 Rather than using the local time when dispatching a value, read the timestamp
8630 from the field with the zero-based index I<Index>. The value is interpreted as
8631 seconds since epoch. The value is parsed as a double and may be factional.
8637 =head2 Plugin C<teamspeak2>
8639 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8640 polls interesting global and virtual server data. The plugin can query only one
8641 physical server but unlimited virtual servers. You can use the following
8642 options to configure it:
8646 =item B<Host> I<hostname/ip>
8648 The hostname or ip which identifies the physical server.
8651 =item B<Port> I<port>
8653 The query port of the physical server. This needs to be a string.
8656 =item B<Server> I<port>
8658 This option has to be added once for every virtual server the plugin should
8659 query. If you want to query the virtual server on port 8767 this is what the
8660 option would look like:
8664 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8665 use quotes around it! If no such statement is given only global information
8670 =head2 Plugin C<ted>
8672 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8673 measure power consumption. These devices are usually connected to a serial
8674 (RS232) or USB port. The plugin opens a configured device and tries to read the
8675 current energy readings. For more information on TED, visit
8676 L<http://www.theenergydetective.com/>.
8678 Available configuration options:
8682 =item B<Device> I<Path>
8684 Path to the device on which TED is connected. collectd will need read and write
8685 permissions on that file.
8687 Default: B</dev/ttyUSB0>
8689 =item B<Retries> I<Num>
8691 Apparently reading from TED is not that reliable. You can therefore configure a
8692 number of retries here. You only configure the I<retries> here, to if you
8693 specify zero, one reading will be performed (but no retries if that fails); if
8694 you specify three, a maximum of four readings are performed. Negative values
8701 =head2 Plugin C<tcpconns>
8703 The C<tcpconns plugin> counts the number of currently established TCP
8704 connections based on the local port and/or the remote port. Since there may be
8705 a lot of connections the default if to count all connections with a local port,
8706 for which a listening socket is opened. You can use the following options to
8707 fine-tune the ports you are interested in:
8711 =item B<ListeningPorts> I<true>|I<false>
8713 If this option is set to I<true>, statistics for all local ports for which a
8714 listening socket exists are collected. The default depends on B<LocalPort> and
8715 B<RemotePort> (see below): If no port at all is specifically selected, the
8716 default is to collect listening ports. If specific ports (no matter if local or
8717 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8718 the selected ports will be collected unless this option is set to I<true>
8721 =item B<LocalPort> I<Port>
8723 Count the connections to a specific local port. This can be used to see how
8724 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8725 You have to specify the port in numeric form, so for the mailserver example
8726 you'd need to set B<25>.
8728 =item B<RemotePort> I<Port>
8730 Count the connections to a specific remote port. This is useful to see how
8731 much a remote service is used. This is most useful if you want to know how many
8732 connections a local service has opened to remote services, e.E<nbsp>g. how many
8733 connections a mail server or news server has to other mail or news servers, or
8734 how many connections a web proxy holds to web servers. You have to give the
8735 port in numeric form.
8737 =item B<AllPortsSummary> I<true>|I<false>
8739 If this option is set to I<true> a summary of statistics from all connections
8740 are collected. This option defaults to I<false>.
8744 =head2 Plugin C<thermal>
8748 =item B<ForceUseProcfs> I<true>|I<false>
8750 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8751 C<sysfs> interface. If that is not available, the plugin falls back to the
8752 C<procfs> interface. By setting this option to I<true>, you can force the
8753 plugin to use the latter. This option defaults to I<false>.
8755 =item B<Device> I<Device>
8757 Selects the name of the thermal device that you want to collect or ignore,
8758 depending on the value of the B<IgnoreSelected> option. This option may be
8759 used multiple times to specify a list of devices.
8761 See F</"IGNORELISTS"> for details.
8763 =item B<IgnoreSelected> I<true>|I<false>
8765 Invert the selection: If set to true, all devices B<except> the ones that
8766 match the device names specified by the B<Device> option are collected. By
8767 default only selected devices are collected if a selection is made. If no
8768 selection is configured at all, B<all> devices are selected.
8772 =head2 Plugin C<threshold>
8774 The I<Threshold plugin> checks values collected or received by I<collectd>
8775 against a configurable I<threshold> and issues I<notifications> if values are
8778 Documentation for this plugin is available in the L<collectd-threshold(5)>
8781 =head2 Plugin C<tokyotyrant>
8783 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8784 couple metrics: number of records, and database size on disk.
8788 =item B<Host> I<Hostname/IP>
8790 The hostname or IP which identifies the server.
8791 Default: B<127.0.0.1>
8793 =item B<Port> I<Service/Port>
8795 The query port of the server. This needs to be a string, even if the port is
8796 given in its numeric form.
8801 =head2 Plugin C<turbostat>
8803 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8804 Intel processors by using I<Model Specific Registers>.
8808 =item B<CoreCstates> I<Bitmask(Integer)>
8810 Bit mask of the list of core C-states supported by the processor.
8811 This option should only be used if the automated detection fails.
8812 Default value extracted from the CPU model and family.
8814 Currently supported C-states (by this plugin): 3, 6, 7
8818 All states (3, 6 and 7):
8819 (1<<3) + (1<<6) + (1<<7) = 392
8821 =item B<PackageCstates> I<Bitmask(Integer)>
8823 Bit mask of the list of packages C-states supported by the processor. This
8824 option should only be used if the automated detection fails. Default value
8825 extracted from the CPU model and family.
8827 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8831 States 2, 3, 6 and 7:
8832 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8834 =item B<SystemManagementInterrupt> I<true>|I<false>
8836 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8837 This option should only be used if the automated detection fails or if you want
8838 to disable this feature.
8840 =item B<DigitalTemperatureSensor> I<true>|I<false>
8842 Boolean enabling the collection of the temperature of each core. This option
8843 should only be used if the automated detection fails or if you want to disable
8846 =item B<TCCActivationTemp> I<Temperature>
8848 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8849 temperature is used when collecting the temperature of cores or packages. This
8850 option should only be used if the automated detection fails. Default value
8851 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8853 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8855 Bit mask of the list of elements to be thermally monitored. This option should
8856 only be used if the automated detection fails or if you want to disable some
8857 collections. The different bits of this bit mask accepted by this plugin are:
8861 =item 0 ('1'): Package
8865 =item 2 ('4'): Cores
8867 =item 3 ('8'): Embedded graphic device
8871 =item B<LogicalCoreNames> I<true>|I<false>
8873 Boolean enabling the use of logical core numbering for per core statistics.
8874 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8875 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8876 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8877 more than one, where I<n> is the n-th core of package I<m>.
8879 =item B<RestoreAffinityPolicy> I<AllCPUs>|I<Restore>
8881 Reading data from CPU has side-effect: collectd process's CPU affinity mask
8882 changes. After reading data is completed, affinity mask needs to be restored.
8883 This option allows to set restore policy.
8885 B<AllCPUs> (the default): Restore the affinity by setting affinity to any/all
8888 B<Restore>: Save affinity using sched_getaffinity() before reading data and
8891 On some systems, sched_getaffinity() will fail due to inconsistency of the CPU
8892 set size between userspace and kernel. In these cases plugin will detect the
8893 unsuccessful call and fail with an error, preventing data collection.
8894 Most of configurations does not need to save affinity as Collectd process is
8895 allowed to run on any/all available CPUs.
8897 If you need to save and restore affinity and get errors like 'Unable to save
8898 the CPU affinity', setting 'possible_cpus' kernel boot option may also help.
8900 See following links for details:
8902 L<https://github.com/collectd/collectd/issues/1593>
8903 L<https://sourceware.org/bugzilla/show_bug.cgi?id=15630>
8904 L<https://bugzilla.kernel.org/show_bug.cgi?id=151821>
8908 =head2 Plugin C<unixsock>
8912 =item B<SocketFile> I<Path>
8914 Sets the socket-file which is to be created.
8916 =item B<SocketGroup> I<Group>
8918 If running as root change the group of the UNIX-socket after it has been
8919 created. Defaults to B<collectd>.
8921 =item B<SocketPerms> I<Permissions>
8923 Change the file permissions of the UNIX-socket after it has been created. The
8924 permissions must be given as a numeric, octal value as you would pass to
8925 L<chmod(1)>. Defaults to B<0770>.
8927 =item B<DeleteSocket> B<false>|B<true>
8929 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8930 with the given name already exists. If I<collectd> crashes a socket file may be
8931 left over, preventing the daemon from opening a new socket when restarted.
8932 Since this is potentially dangerous, this defaults to B<false>.
8936 =head2 Plugin C<uuid>
8938 This plugin, if loaded, causes the Hostname to be taken from the machine's
8939 UUID. The UUID is a universally unique designation for the machine, usually
8940 taken from the machine's BIOS. This is most useful if the machine is running in
8941 a virtual environment such as Xen, in which case the UUID is preserved across
8942 shutdowns and migration.
8944 The following methods are used to find the machine's UUID, in order:
8950 Check I</etc/uuid> (or I<UUIDFile>).
8954 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8959 Check for UUID from C<dmidecode> / SMBIOS.
8963 Check for UUID from Xen hypervisor.
8967 If no UUID can be found then the hostname is not modified.
8971 =item B<UUIDFile> I<Path>
8973 Take the UUID from the given file (default I</etc/uuid>).
8977 =head2 Plugin C<varnish>
8979 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8980 It collects a subset of the values displayed by L<varnishstat(1)>, and
8981 organizes them in categories which can be enabled or disabled. Currently only
8982 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8983 meaning of each metric can be found in L<varnish-counters(7)>.
8988 <Instance "example">
8992 CollectConnections true
8993 CollectDirectorDNS false
8997 CollectObjects false
8999 CollectSession false
9009 CollectWorkers false
9011 CollectMempool false
9012 CollectManagement false
9019 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
9020 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
9021 will collectd statistics from the default "varnishd" instance (this should work
9022 fine in most cases).
9024 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
9028 =item B<CollectBackend> B<true>|B<false>
9030 Back-end connection statistics, such as successful, reused,
9031 and closed connections. True by default.
9033 =item B<CollectBan> B<true>|B<false>
9035 Statistics about ban operations, such as number of bans added, retired, and
9036 number of objects tested against ban operations. Only available with Varnish
9037 3.x and above. False by default.
9039 =item B<CollectCache> B<true>|B<false>
9041 Cache hits and misses. True by default.
9043 =item B<CollectConnections> B<true>|B<false>
9045 Number of client connections received, accepted and dropped. True by default.
9047 =item B<CollectDirectorDNS> B<true>|B<false>
9049 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
9052 =item B<CollectESI> B<true>|B<false>
9054 Edge Side Includes (ESI) parse statistics. False by default.
9056 =item B<CollectFetch> B<true>|B<false>
9058 Statistics about fetches (HTTP requests sent to the backend). False by default.
9060 =item B<CollectHCB> B<true>|B<false>
9062 Inserts and look-ups in the crit bit tree based hash. Look-ups are
9063 divided into locked and unlocked look-ups. False by default.
9065 =item B<CollectObjects> B<true>|B<false>
9067 Statistics on cached objects: number of objects expired, nuked (prematurely
9068 expired), saved, moved, etc. False by default.
9070 =item B<CollectPurge> B<true>|B<false>
9072 Statistics about purge operations, such as number of purges added, retired, and
9073 number of objects tested against purge operations. Only available with Varnish
9074 2.x. False by default.
9076 =item B<CollectSession> B<true>|B<false>
9078 Client session statistics. Number of past and current sessions, session herd and
9079 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9080 metrics found in the Connections and Threads sections with previous versions of
9081 Varnish have been moved here.
9083 =item B<CollectSHM> B<true>|B<false>
9085 Statistics about the shared memory log, a memory region to store
9086 log messages which is flushed to disk when full. True by default.
9088 =item B<CollectSMA> B<true>|B<false>
9090 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9091 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9092 only the one used by the Varnish instance. Only available with Varnish 2.x.
9095 =item B<CollectSMS> B<true>|B<false>
9097 synth (synthetic content) storage statistics. This storage
9098 component is used internally only. False by default.
9100 =item B<CollectSM> B<true>|B<false>
9102 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9103 in varnish 4.x. use CollectSMF.
9106 =item B<CollectStruct> B<true>|B<false>
9108 Current varnish internal state statistics. Number of current sessions, objects
9109 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9112 =item B<CollectTotals> B<true>|B<false>
9114 Collects overview counters, such as the number of sessions created,
9115 the number of requests and bytes transferred. False by default.
9117 =item B<CollectUptime> B<true>|B<false>
9119 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9121 =item B<CollectVCL> B<true>|B<false>
9123 Number of total (available + discarded) VCL (config files). False by default.
9125 =item B<CollectVSM> B<true>|B<false>
9127 Collect statistics about Varnish's shared memory usage (used by the logging and
9128 statistics subsystems). Only available with Varnish 4.x. False by default.
9130 =item B<CollectWorkers> B<true>|B<false>
9132 Collect statistics about worker threads. False by default.
9134 =item B<CollectVBE> B<true>|B<false>
9136 Backend counters. Only available with Varnish 4.x. False by default.
9138 =item B<CollectSMF> B<true>|B<false>
9140 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9141 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9142 instance. Used to be called SM in Varnish 2.x. False by default.
9144 =item B<CollectManagement> B<true>|B<false>
9146 Management process counters. Only available with Varnish 4.x. False by default.
9148 =item B<CollectLock> B<true>|B<false>
9150 Lock counters. Only available with Varnish 4.x. False by default.
9152 =item B<CollectMempool> B<true>|B<false>
9154 Memory pool counters. Only available with Varnish 4.x. False by default.
9156 =item B<CollectMSE> B<true>|B<false>
9158 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9159 Varnish, replacing the traditional malloc and file storages. Only available
9160 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9161 one used by the Varnish instance. False by default.
9165 =head2 Plugin C<virt>
9167 This plugin allows CPU, disk, network load and other metrics to be collected for
9168 virtualized guests on the machine. The statistics are collected through libvirt
9169 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9170 installing any additional software on guests, especially I<collectd>, which runs
9171 only on the host system.
9173 Only I<Connection> is required.
9175 Consider the following example config:
9178 Connection "qemu:///system"
9179 HostnameFormat "hostname"
9180 InterfaceFormat "address"
9181 PluginInstanceFormat "name"
9184 It will generate the following values:
9186 node42.example.com/virt-instance-0006f26c/disk_octets-vda
9187 node42.example.com/virt-instance-0006f26c/disk_ops-vda
9188 node42.example.com/virt-instance-0006f26c/if_dropped-ca:fe:ca:fe:ca:fe
9189 node42.example.com/virt-instance-0006f26c/if_errors-ca:fe:ca:fe:ca:fe
9190 node42.example.com/virt-instance-0006f26c/if_octets-ca:fe:ca:fe:ca:fe
9191 node42.example.com/virt-instance-0006f26c/if_packets-ca:fe:ca:fe:ca:fe
9192 node42.example.com/virt-instance-0006f26c/memory-actual_balloon
9193 node42.example.com/virt-instance-0006f26c/memory-available
9194 node42.example.com/virt-instance-0006f26c/memory-last_update
9195 node42.example.com/virt-instance-0006f26c/memory-major_fault
9196 node42.example.com/virt-instance-0006f26c/memory-minor_fault
9197 node42.example.com/virt-instance-0006f26c/memory-rss
9198 node42.example.com/virt-instance-0006f26c/memory-swap_in
9199 node42.example.com/virt-instance-0006f26c/memory-swap_out
9200 node42.example.com/virt-instance-0006f26c/memory-total
9201 node42.example.com/virt-instance-0006f26c/memory-unused
9202 node42.example.com/virt-instance-0006f26c/memory-usable
9203 node42.example.com/virt-instance-0006f26c/virt_cpu_total
9204 node42.example.com/virt-instance-0006f26c/virt_vcpu-0
9206 You can get information on the metric's units from the online libvirt documentation.
9207 For instance, I<virt_cpu_total> is in nanoseconds.
9211 =item B<Connection> I<uri>
9213 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9215 Connection "xen:///"
9217 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9219 =item B<RefreshInterval> I<seconds>
9221 Refresh the list of domains and devices every I<seconds>. The default is 60
9222 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9223 the list of domains and devices to be refreshed on every iteration.
9225 Refreshing the devices in particular is quite a costly operation, so if your
9226 virtualization setup is static you might consider increasing this. If this
9227 option is set to 0, refreshing is disabled completely.
9229 =item B<Domain> I<name>
9231 =item B<BlockDevice> I<name:dev>
9233 =item B<InterfaceDevice> I<name:dev>
9235 =item B<IgnoreSelected> B<true>|B<false>
9237 Select which domains and devices are collected.
9239 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9240 disk/network devices are collected.
9242 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9243 domains and disk/network devices are ignored, while the rest are collected.
9245 The domain name and device names may use a regular expression, if the name is
9246 surrounded by I</.../> and collectd was compiled with support for regexps.
9248 The default is to collect statistics for all domains and all their devices.
9252 BlockDevice "/:hdb/"
9253 IgnoreSelected "true"
9255 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9258 =item B<BlockDeviceFormat> B<target>|B<source>
9260 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9261 seen by the guest will be used for reporting metrics.
9262 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9265 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9266 using the path of the source, e.g. an image file.
9267 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9272 If the domain XML have the following device defined:
9274 <disk type='block' device='disk'>
9275 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9276 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9277 <target dev='sda' bus='scsi'/>
9279 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9282 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9284 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9285 to C<var_lib_libvirt_images_image1.qcow2>.
9287 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9289 The B<BlockDeviceFormatBasename> controls whether the full path or the
9290 L<basename(1)> of the source is being used as the I<type instance> when
9291 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9295 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9296 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9297 be set to C<var_lib_libvirt_images_image1.qcow2>.
9298 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9299 set to C<image1.qcow2>.
9301 =item B<HostnameFormat> B<name|uuid|hostname|...>
9303 When the virt plugin logs data, it sets the hostname of the collected data
9304 according to this setting. The default is to use the guest name as provided by
9305 the hypervisor, which is equal to setting B<name>.
9307 B<uuid> means use the guest's UUID. This is useful if you want to track the
9308 same guest across migrations.
9310 B<hostname> means to use the global B<Hostname> setting, which is probably not
9311 useful on its own because all guests will appear to have the same name. This is
9312 useful in conjunction with B<PluginInstanceFormat> though.
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>
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 =item B<PluginInstanceFormat> B<name|uuid|none>
9334 When the virt plugin logs data, it sets the plugin_instance of the collected
9335 data according to this setting. The default is to not set the plugin_instance.
9337 B<name> means use the guest's name as provided by the hypervisor.
9338 B<uuid> means use the guest's UUID.
9340 You can also specify combinations of the B<name> and B<uuid> fields.
9341 For example B<name uuid> means to concatenate the guest name and UUID
9342 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9344 =item B<Instances> B<integer>
9346 How many read instances you want to use for this plugin. The default is one,
9347 and the sensible setting is a multiple of the B<ReadThreads> value.
9348 If you are not sure, just use the default setting.
9350 =item B<ExtraStats> B<string>
9352 Report additional extra statistics. The default is no extra statistics, preserving
9353 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9354 allows the plugin to reported more detailed statistics about the behaviour of
9355 Virtual Machines. The argument is a space-separated list of selectors.
9357 Currently supported selectors are:
9361 =item B<cpu_util>: report CPU utilization per domain in percentage.
9363 =item B<disk>: report extra statistics like number of flush operations and total
9364 service time for read, write and flush operations. Requires libvirt API version
9367 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9370 =item B<domain_state>: report domain state and reason in human-readable format as
9371 a notification. If libvirt API version I<0.9.2> or later is available, domain
9372 reason will be included in notification.
9374 =item B<fs_info>: report file system information as a notification. Requires
9375 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9376 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9377 version supports retrieving file system information.
9379 =item B<job_stats_background>: report statistics about progress of a background
9380 job on a domain. Only one type of job statistics can be collected at the same time.
9381 Requires libvirt API version I<1.2.9> or later.
9383 =item B<job_stats_completed>: report statistics about a recently completed job on
9384 a domain. Only one type of job statistics can be collected at the same time.
9385 Requires libvirt API version I<1.2.9> or later.
9387 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9388 Requires libvirt API version I<0.9.11> or later.
9390 =item B<perf>: report performance monitoring events. To collect performance
9391 metrics they must be enabled for domain and supported by the platform. Requires
9392 libvirt API version I<1.3.3> or later.
9393 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9395 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9399 =item B<PersistentNotification> B<true>|B<false>
9400 Override default configuration to only send notifications when there is a change
9401 in the lifecycle state of a domain. When set to true notifications will be sent
9402 for every read cycle. Default is false. Does not affect the stats being
9407 =head2 Plugin C<vmem>
9409 The C<vmem> plugin collects information about the usage of virtual memory.
9410 Since the statistics provided by the Linux kernel are very detailed, they are
9411 collected very detailed. However, to get all the details, you have to switch
9412 them on manually. Most people just want an overview over, such as the number of
9413 pages read from swap space.
9417 =item B<Verbose> B<true>|B<false>
9419 Enables verbose collection of information. This will start collecting page
9420 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9421 Part of these statistics are collected on a "per zone" basis.
9425 =head2 Plugin C<vserver>
9427 This plugin doesn't have any options. B<VServer> support is only available for
9428 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9429 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9430 need to apply the patches and compile your own kernel, which will then provide
9431 the F</proc/virtual> filesystem that is required by this plugin.
9433 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9435 B<Note>: The traffic collected by this plugin accounts for the amount of
9436 traffic passing a socket which might be a lot less than the actual on-wire
9437 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9438 collect on-wire traffic you could, for example, use the logging facilities of
9439 iptables to feed data for the guest IPs into the iptables plugin.
9441 =head2 Plugin C<write_graphite>
9443 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9444 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9445 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9446 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9447 of at most 1428 bytes to minimize the number of network packets.
9451 <Plugin write_graphite>
9462 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9463 blocks. Inside the B<Node> blocks, the following options are recognized:
9467 =item B<Host> I<Address>
9469 Hostname or address to connect to. Defaults to C<localhost>.
9471 =item B<Port> I<Service>
9473 Service name or port number to connect to. Defaults to C<2003>.
9475 =item B<Protocol> I<String>
9477 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9479 =item B<ReconnectInterval> I<Seconds>
9481 When set to non-zero, forces the connection to the Graphite backend to be
9482 closed and re-opend periodically. This behavior is desirable in environments
9483 where the connection to the Graphite backend is done through load balancers,
9484 for example. When set to zero, the default, the connetion is kept open for as
9487 =item B<LogSendErrors> B<false>|B<true>
9489 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9490 If set to B<false>, it will not log the errors. This is especially useful when
9491 using Protocol UDP since many times we want to use the "fire-and-forget"
9492 approach and logging errors fills syslog with unneeded messages.
9494 =item B<Prefix> I<String>
9496 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9497 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9499 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9502 =item B<Postfix> I<String>
9504 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9505 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9506 (before the first ; that separates the name from the tags).
9508 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9511 =item B<EscapeCharacter> I<Char>
9513 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9514 in the identifier. The B<EscapeCharacter> option determines which character
9515 dots, whitespace and control characters are replaced with. Defaults to
9518 =item B<StoreRates> B<false>|B<true>
9520 If set to B<true> (the default), convert counter values to rates. If set to
9521 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9524 =item B<SeparateInstances> B<false>|B<true>
9526 If set to B<true>, the plugin instance and type instance will be in their own
9527 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9528 default), the plugin and plugin instance (and likewise the type and type
9529 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9531 Option value is not used when B<UseTags> is I<true>.
9533 =item B<AlwaysAppendDS> B<false>|B<true>
9535 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9536 identifier. If set to B<false> (the default), this is only done when there is
9539 =item B<PreserveSeparator> B<false>|B<true>
9541 If set to B<false> (the default) the C<.> (dot) character is replaced with
9542 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9543 is preserved, i.e. passed through.
9545 Option value is not used when B<UseTags> is I<true>.
9547 =item B<DropDuplicateFields> B<false>|B<true>
9549 If set to B<true>, detect and remove duplicate components in Graphite metric
9550 names. For example, the metric name C<host.load.load.shortterm> will
9551 be shortened to C<host.load.shortterm>.
9553 =item B<UseTags> B<false>|B<true>
9555 If set to B<true>, Graphite metric names will be generated as tagged series.
9556 This allows for much more flexibility than the traditional hierarchical layout.
9559 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9561 You can use B<Postfix> option to add more tags by specifying it like
9562 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9565 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9568 Default value: B<false>.
9572 =head2 Plugin C<write_log>
9574 The C<write_log> plugin writes metrics as INFO log messages.
9576 This plugin supports two output formats: I<Graphite> and I<JSON>.
9586 =item B<Format> I<Format>
9588 The output format to use. Can be one of C<Graphite> or C<JSON>.
9592 =head2 Plugin C<write_tsdb>
9594 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9595 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9596 state daemon that ingests metrics and stores them in HBase. The plugin uses
9597 I<TCP> over the "line based" protocol with a default port 4242. The data will
9598 be sent in blocks of at most 1428 bytes to minimize the number of network
9607 Host "tsd-1.my.domain"
9609 HostTags "status=production"
9613 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9614 blocks and global directives.
9616 Global directives are:
9620 =item B<ResolveInterval> I<seconds>
9622 =item B<ResolveJitter> I<seconds>
9624 When I<collectd> connects to a TSDB node, it will request the hostname from
9625 DNS. This can become a problem if the TSDB node is unavailable or badly
9626 configured because collectd will request DNS in order to reconnect for every
9627 metric, which can flood your DNS. So you can cache the last value for
9628 I<ResolveInterval> seconds.
9629 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9631 You can also define a jitter, a random interval to wait in addition to
9632 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9633 hostname at the same time when the connection fails.
9634 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9636 B<Note:> If the DNS resolution has already been successful when the socket
9637 closes, the plugin will try to reconnect immediately with the cached
9638 information. DNS is queried only when the socket is closed for a longer than
9639 I<ResolveInterval> + I<ResolveJitter> seconds.
9643 Inside the B<Node> blocks, the following options are recognized:
9647 =item B<Host> I<Address>
9649 Hostname or address to connect to. Defaults to C<localhost>.
9651 =item B<Port> I<Service>
9653 Service name or port number to connect to. Defaults to C<4242>.
9656 =item B<HostTags> I<String>
9658 When set, I<HostTags> is added to the end of the metric. It is intended to be
9659 used for name=value pairs that the TSD will tag the metric with. Dots and
9660 whitespace are I<not> escaped in this string.
9662 =item B<StoreRates> B<false>|B<true>
9664 If set to B<true>, convert counter values to rates. If set to B<false>
9665 (the default) counter values are stored as is, as an increasing
9668 =item B<AlwaysAppendDS> B<false>|B<true>
9670 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9671 identifier. If set to B<false> (the default), this is only done when there is
9676 =head2 Plugin C<write_mongodb>
9678 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9683 <Plugin "write_mongodb">
9692 The plugin can send values to multiple instances of I<MongoDB> by specifying
9693 one B<Node> block for each instance. Within the B<Node> blocks, the following
9694 options are available:
9698 =item B<Host> I<Address>
9700 Hostname or address to connect to. Defaults to C<localhost>.
9702 =item B<Port> I<Service>
9704 Service name or port number to connect to. Defaults to C<27017>.
9706 =item B<Timeout> I<Milliseconds>
9708 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9709 Setting this option to zero means no timeout, which is the default.
9711 =item B<StoreRates> B<false>|B<true>
9713 If set to B<true> (the default), convert counter values to rates. If set to
9714 B<false> counter values are stored as is, i.e. as an increasing integer
9717 =item B<Database> I<Database>
9719 =item B<User> I<User>
9721 =item B<Password> I<Password>
9723 Sets the information used when authenticating to a I<MongoDB> database. The
9724 fields are optional (in which case no authentication is attempted), but if you
9725 want to use authentication all three fields must be set.
9729 =head2 Plugin C<write_prometheus>
9731 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9732 using I<Prometheus>.
9738 =item B<Host> I<Host>
9740 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
9741 "any" address, i.e. accept packets sent to any of the hosts addresses.
9743 This option is supported only for libmicrohttpd newer than 0.9.0.
9745 =item B<Port> I<Port>
9747 Port the embedded webserver should listen on. Defaults to B<9103>.
9749 =item B<StalenessDelta> I<Seconds>
9751 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9752 hasn't seen any update for it. This value must match the setting in Prometheus.
9753 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9757 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9758 which time a metric without updates is considered "stale". This setting
9759 effectively puts an upper limit on the interval in which metrics are reported.
9761 When the I<write_prometheus plugin> encounters a metric with an interval
9762 exceeding this limit, it will inform you, the user, and provide the metric to
9763 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9764 metric "fresh" each time it is scraped, with the time of the scrape being
9765 considered the time of the update. The result is that there appear more
9766 datapoints in I<Prometheus> than were actually created, but at least the metric
9767 doesn't disappear periodically.
9771 =head2 Plugin C<write_http>
9773 This output plugin submits values to an HTTP server using POST requests and
9774 encoding metrics with JSON or using the C<PUTVAL> command described in
9775 L<collectd-unixsock(5)>.
9779 <Plugin "write_http">
9781 URL "http://example.com/post-collectd"
9788 The plugin can send values to multiple HTTP servers by specifying one
9789 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9790 block, the following options are available:
9796 URL to which the values are submitted to. Mandatory.
9798 =item B<User> I<Username>
9800 Optional user name needed for authentication.
9802 =item B<Password> I<Password>
9804 Optional password needed for authentication.
9806 =item B<VerifyPeer> B<true>|B<false>
9808 Enable or disable peer SSL certificate verification. See
9809 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9811 =item B<VerifyHost> B<true|false>
9813 Enable or disable peer host name verification. If enabled, the plugin checks if
9814 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9815 matches the host name provided by the B<URL> option. If this identity check
9816 fails, the connection is aborted. Obviously, only works when connecting to a
9817 SSL enabled server. Enabled by default.
9819 =item B<CACert> I<File>
9821 File that holds one or more SSL certificates. If you want to use HTTPS you will
9822 possibly need this option. What CA certificates come bundled with C<libcurl>
9823 and are checked by default depends on the distribution you use.
9825 =item B<CAPath> I<Directory>
9827 Directory holding one or more CA certificate files. You can use this if for
9828 some reason all the needed CA certificates aren't in the same file and can't be
9829 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9832 =item B<ClientKey> I<File>
9834 File that holds the private key in PEM format to be used for certificate-based
9837 =item B<ClientCert> I<File>
9839 File that holds the SSL certificate to be used for certificate-based
9842 =item B<ClientKeyPass> I<Password>
9844 Password required to load the private key in B<ClientKey>.
9846 =item B<Header> I<Header>
9848 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9850 Header "X-Custom-Header: custom_value"
9852 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9854 Define which SSL protocol version must be used. By default C<libcurl> will
9855 attempt to figure out the remote SSL protocol version. See
9856 L<curl_easy_setopt(3)> for more details.
9858 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9860 Format of the output to generate. If set to B<Command>, will create output that
9861 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9862 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9863 , will create output in the KairosDB format.
9865 Defaults to B<Command>.
9867 =item B<Attribute> I<String> I<String>
9869 Only available for the KAIROSDB output format.
9871 Consider the two given strings to be the key and value of an additional tag for
9872 each metric being sent out.
9874 You can add multiple B<Attribute>.
9878 Only available for the KAIROSDB output format.
9880 Sets the Cassandra ttl for the data points.
9882 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9884 =item B<Prefix> I<String>
9886 Only available for the KAIROSDB output format.
9888 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9890 =item B<Metrics> B<true>|B<false>
9892 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9894 =item B<Notifications> B<false>|B<true>
9896 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9898 =item B<StoreRates> B<true|false>
9900 If set to B<true>, convert counter values to rates. If set to B<false> (the
9901 default) counter values are stored as is, i.e. as an increasing integer number.
9903 =item B<BufferSize> I<Bytes>
9905 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9906 requests will be generated, but more metrics will be batched / metrics are
9907 cached for longer before being sent, introducing additional delay until they
9908 are available on the server side. I<Bytes> must be at least 1024 and cannot
9909 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9910 Defaults to C<4096>.
9912 =item B<LowSpeedLimit> I<Bytes per Second>
9914 Sets the minimal transfer rate in I<Bytes per Second> below which the
9915 connection with the HTTP server will be considered too slow and aborted. All
9916 the data submitted over this connection will probably be lost. Defaults to 0,
9917 which means no minimum transfer rate is enforced.
9919 =item B<Timeout> I<Timeout>
9921 Sets the maximum time in milliseconds given for HTTP POST operations to
9922 complete. When this limit is reached, the POST operation will be aborted, and
9923 all the data in the current send buffer will probably be lost. Defaults to 0,
9924 which means the connection never times out.
9926 =item B<LogHttpError> B<false>|B<true>
9928 Enables printing of HTTP error code to log. Turned off by default.
9930 The C<write_http> plugin regularly submits the collected values to the HTTP
9931 server. How frequently this happens depends on how much data you are collecting
9932 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9933 slightly below this interval, which you can estimate by monitoring the network
9934 traffic between collectd and the HTTP server.
9938 =head2 Plugin C<write_kafka>
9940 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9944 <Plugin "write_kafka">
9945 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9951 The following options are understood by the I<write_kafka plugin>:
9955 =item E<lt>B<Topic> I<Name>E<gt>
9957 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9958 is given a unique I<Name> and specifies one kafka producer.
9959 Inside the B<Topic> block, the following per-topic options are
9964 =item B<Property> I<String> I<String>
9966 Configure the named property for the current topic. Properties are
9967 forwarded to the kafka producer library B<librdkafka>.
9969 =item B<Key> I<String>
9971 Use the specified string as a partitioning key for the topic. Kafka breaks
9972 topic into partitions and guarantees that for a given topology, the same
9973 consumer will be used for a specific key. The special (case insensitive)
9974 string B<Random> can be used to specify that an arbitrary partition should
9977 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9979 Selects the format in which messages are sent to the broker. If set to
9980 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9981 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9983 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9984 an easy and straight forward exchange format.
9986 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9987 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9989 =item B<StoreRates> B<true>|B<false>
9991 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9992 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9993 default), no conversion is performed. Otherwise the conversion is performed
9994 using the internal value cache.
9996 Please note that currently this option is only used if the B<Format> option has
9997 been set to B<JSON>.
9999 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
10001 A prefix can be added in the metric name when outputting in the I<Graphite>
10004 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
10005 Metric name will be
10006 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>>
10008 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
10010 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
10012 A postfix can be added in the metric name when outputting in the I<Graphite>
10015 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
10016 Metric name will be
10017 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>>
10019 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
10020 name (before the first ; that separates the name from the tags).
10022 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
10024 Specify a character to replace dots (.) in the host part of the metric name.
10025 In I<Graphite> metric name, dots are used as separators between different
10026 metric parts (host, plugin, type).
10027 Default is C<_> (I<Underscore>).
10029 =item B<GraphiteSeparateInstances> B<false>|B<true>
10031 If set to B<true>, the plugin instance and type instance will be in their own
10032 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
10033 default), the plugin and plugin instance (and likewise the type and type
10034 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
10036 Option value is not used when B<GraphiteUseTags> is I<true>.
10038 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
10040 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10041 identifier. If set to B<false> (the default), this is only done when there is
10044 =item B<GraphitePreserveSeparator> B<false>|B<true>
10046 If set to B<false> (the default) the C<.> (dot) character is replaced with
10047 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
10048 is preserved, i.e. passed through.
10050 Option value is not used when B<GraphiteUseTags> is I<true>.
10052 =item B<GraphiteUseTags> B<false>|B<true>
10054 If set to B<true> Graphite metric names will be generated as tagged series.
10056 Default value: B<false>.
10058 =item B<StoreRates> B<true>|B<false>
10060 If set to B<true> (the default), convert counter values to rates. If set to
10061 B<false> counter values are stored as is, i.e. as an increasing integer number.
10063 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10064 converted values will have "rate" appended to the data source type, e.g.
10065 C<ds_type:derive:rate>.
10069 =item B<Property> I<String> I<String>
10071 Configure the kafka producer through properties, you almost always will
10072 want to set B<metadata.broker.list> to your Kafka broker list.
10076 =head2 Plugin C<write_redis>
10078 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
10082 <Plugin "write_redis">
10095 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
10096 the timestamp as the score. Retrieving a date range can then be done using the
10097 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
10098 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
10099 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
10100 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
10101 with the B<Database> parameter (default is C<0>). See
10102 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
10105 The information shown in the synopsis above is the I<default configuration>
10106 which is used by the plugin if no configuration is present.
10108 The plugin can send values to multiple instances of I<Redis> by specifying
10109 one B<Node> block for each instance. Within the B<Node> blocks, the following
10110 options are available:
10114 =item B<Node> I<Nodename>
10116 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10117 instance running on a specified host and port. The node name is a
10118 canonical identifier which is used as I<plugin instance>. It is limited to
10119 51E<nbsp>characters in length.
10121 =item B<Host> I<Hostname>
10123 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10126 =item B<Port> I<Port>
10128 The B<Port> option is the TCP port on which the Redis instance accepts
10129 connections. Either a service name of a port number may be given. Please note
10130 that numerical port numbers must be given as a string, too.
10132 =item B<Timeout> I<Milliseconds>
10134 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10136 =item B<Prefix> I<Prefix>
10138 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10139 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10140 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10141 is recommended but not required to include a trailing slash in I<Prefix>.
10143 =item B<Database> I<Index>
10145 This index selects the redis database to use for writing operations. Defaults
10148 =item B<MaxSetSize> I<Items>
10150 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10151 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10153 =item B<MaxSetDuration> I<Seconds>
10155 The B<MaxSetDuration> option limits the duration of items that the
10156 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10157 is the default behavior.
10159 =item B<StoreRates> B<true>|B<false>
10161 If set to B<true> (the default), convert counter values to rates. If set to
10162 B<false> counter values are stored as is, i.e. as an increasing integer number.
10166 =head2 Plugin C<write_riemann>
10168 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10169 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10170 I<Riemann> using UDP packets.
10174 <Plugin "write_riemann">
10180 AlwaysAppendDS false
10184 Attribute "foo" "bar"
10187 The following options are understood by the I<write_riemann plugin>:
10191 =item E<lt>B<Node> I<Name>E<gt>
10193 The plugin's configuration consists of one or more B<Node> blocks. Each block
10194 is given a unique I<Name> and specifies one connection to an instance of
10195 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10200 =item B<Host> I<Address>
10202 Hostname or address to connect to. Defaults to C<localhost>.
10204 =item B<Port> I<Service>
10206 Service name or port number to connect to. Defaults to C<5555>.
10208 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10210 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10213 =item B<TLSCertFile> I<Path>
10215 When using the B<TLS> protocol, path to a PEM certificate to present
10218 =item B<TLSCAFile> I<Path>
10220 When using the B<TLS> protocol, path to a PEM CA certificate to
10221 use to validate the remote hosts's identity.
10223 =item B<TLSKeyFile> I<Path>
10225 When using the B<TLS> protocol, path to a PEM private key associated
10226 with the certificate defined by B<TLSCertFile>.
10228 =item B<Batch> B<true>|B<false>
10230 If set to B<true> and B<Protocol> is set to B<TCP>,
10231 events will be batched in memory and flushed at
10232 regular intervals or when B<BatchMaxSize> is exceeded.
10234 Notifications are not batched and sent as soon as possible.
10236 When enabled, it can occur that events get processed by the Riemann server
10237 close to or after their expiration time. Tune the B<TTLFactor> and
10238 B<BatchMaxSize> settings according to the amount of values collected, if this
10243 =item B<BatchMaxSize> I<size>
10245 Maximum payload size for a riemann packet. Defaults to 8192
10247 =item B<BatchFlushTimeout> I<seconds>
10249 Maximum amount of seconds to wait in between to batch flushes.
10250 No timeout by default.
10252 =item B<StoreRates> B<true>|B<false>
10254 If set to B<true> (the default), convert counter values to rates. If set to
10255 B<false> counter values are stored as is, i.e. as an increasing integer number.
10257 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10258 converted values will have "rate" appended to the data source type, e.g.
10259 C<ds_type:derive:rate>.
10261 =item B<AlwaysAppendDS> B<false>|B<true>
10263 If set to B<true>, append the name of the I<Data Source> (DS) to the
10264 "service", i.e. the field that, together with the "host" field, uniquely
10265 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10266 only done when there is more than one DS.
10268 =item B<TTLFactor> I<Factor>
10270 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10271 event is considered active. I<collectd> populates this field based on the
10272 metrics interval setting. This setting controls the factor with which the
10273 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10274 know exactly what you're doing, you should only increase this setting from its
10277 =item B<Notifications> B<false>|B<true>
10279 If set to B<true>, create riemann events for notifications. This is B<true>
10280 by default. When processing thresholds from write_riemann, it might prove
10281 useful to avoid getting notification events.
10283 =item B<CheckThresholds> B<false>|B<true>
10285 If set to B<true>, attach state to events based on thresholds defined
10286 in the B<Threshold> plugin. Defaults to B<false>.
10288 =item B<EventServicePrefix> I<String>
10290 Add the given string as a prefix to the event service name.
10291 If B<EventServicePrefix> not set or set to an empty string (""),
10292 no prefix will be used.
10296 =item B<Tag> I<String>
10298 Add the given string as an additional tag to the metric being sent to
10301 =item B<Attribute> I<String> I<String>
10303 Consider the two given strings to be the key and value of an additional
10304 attribute for each metric being sent out to I<Riemann>.
10308 =head2 Plugin C<write_sensu>
10310 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10311 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10312 a local I<Sensu> client using a TCP socket.
10314 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10315 parameter so it is not possible to use one collectd instance as a gateway for
10316 others. Each collectd host must pair with one I<Sensu> client.
10320 <Plugin "write_sensu">
10325 AlwaysAppendDS false
10326 MetricHandler "influx"
10327 MetricHandler "default"
10328 NotificationHandler "flapjack"
10329 NotificationHandler "howling_monkey"
10333 Attribute "foo" "bar"
10336 The following options are understood by the I<write_sensu plugin>:
10340 =item E<lt>B<Node> I<Name>E<gt>
10342 The plugin's configuration consists of one or more B<Node> blocks. Each block
10343 is given a unique I<Name> and specifies one connection to an instance of
10344 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10349 =item B<Host> I<Address>
10351 Hostname or address to connect to. Defaults to C<localhost>.
10353 =item B<Port> I<Service>
10355 Service name or port number to connect to. Defaults to C<3030>.
10357 =item B<StoreRates> B<true>|B<false>
10359 If set to B<true> (the default), convert counter values to rates. If set to
10360 B<false> counter values are stored as is, i.e. as an increasing integer number.
10362 This will be reflected in the C<collectd_data_source_type> tag: If
10363 B<StoreRates> is enabled, converted values will have "rate" appended to the
10364 data source type, e.g. C<collectd_data_source_type:derive:rate>.
10366 =item B<AlwaysAppendDS> B<false>|B<true>
10368 If set the B<true>, append the name of the I<Data Source> (DS) to the
10369 "service", i.e. the field that, together with the "host" field, uniquely
10370 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10371 only done when there is more than one DS.
10373 =item B<Notifications> B<false>|B<true>
10375 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10376 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10378 =item B<Metrics> B<false>|B<true>
10380 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10381 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10384 =item B<Separator> I<String>
10386 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10388 =item B<MetricHandler> I<String>
10390 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10391 several of them, one per line. Defaults to no handler.
10393 =item B<NotificationHandler> I<String>
10395 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10396 add several of them, one per line. Defaults to no handler.
10398 =item B<EventServicePrefix> I<String>
10400 Add the given string as a prefix to the event service name.
10401 If B<EventServicePrefix> not set or set to an empty string (""),
10402 no prefix will be used.
10406 =item B<Tag> I<String>
10408 Add the given string as an additional tag to the metric being sent to
10411 =item B<Attribute> I<String> I<String>
10413 Consider the two given strings to be the key and value of an additional
10414 attribute for each metric being sent out to I<Sensu>.
10418 =head2 Plugin C<write_stackdriver>
10420 The C<write_stackdriver> plugin writes metrics to the
10421 I<Google Stackdriver Monitoring> service.
10423 This plugin supports two authentication methods: When configured, credentials
10424 are read from the JSON credentials file specified with B<CredentialFile>.
10425 Alternatively, when running on
10426 I<Google Compute Engine> (GCE), an I<OAuth> token is retrieved from the
10427 I<metadata server> and used to authenticate to GCM.
10431 <Plugin write_stackdriver>
10432 CredentialFile "/path/to/service_account.json"
10433 <Resource "global">
10434 Label "project_id" "monitored_project"
10440 =item B<CredentialFile> I<file>
10442 Path to a JSON credentials file holding the credentials for a GCP service
10445 If B<CredentialFile> is not specified, the plugin uses I<Application Default
10446 Credentials>. That means which credentials are used depends on the environment:
10452 The environment variable C<GOOGLE_APPLICATION_CREDENTIALS> is checked. If this
10453 variable is specified it should point to a JSON file that defines the
10458 The path C<${HOME}/.config/gcloud/application_default_credentials.json> is
10459 checked. This where credentials used by the I<gcloud> command line utility are
10460 stored. You can use C<gcloud auth application-default login> to create these
10463 Please note that these credentials are often of your personal account, not a
10464 service account, and are therefore unfit to be used in a production
10469 When running on GCE, the built-in service account associated with the virtual
10470 machine instance is used.
10471 See also the B<Email> option below.
10475 =item B<Project> I<Project>
10477 The I<Project ID> or the I<Project Number> of the I<Stackdriver Account>. The
10478 I<Project ID> is a string identifying the GCP project, which you can chose
10479 freely when creating a new project. The I<Project Number> is a 12-digit decimal
10480 number. You can look up both on the I<Developer Console>.
10482 This setting is optional. If not set, the project ID is read from the
10483 credentials file or determined from the GCE's metadata service.
10485 =item B<Email> I<Email> (GCE only)
10487 Choses the GCE I<Service Account> used for authentication.
10489 Each GCE instance has a C<default> I<Service Account> but may also be
10490 associated with additional I<Service Accounts>. This is often used to restrict
10491 the permissions of services running on the GCE instance to the required
10492 minimum. The I<write_stackdriver plugin> requires the
10493 C<https://www.googleapis.com/auth/monitoring> scope. When multiple I<Service
10494 Accounts> are available, this option selects which one is used by
10495 I<write_stackdriver plugin>.
10497 =item B<Resource> I<ResourceType>
10499 Configures the I<Monitored Resource> to use when storing metrics.
10500 More information on I<Monitored Resources> and I<Monitored Resource Types> are
10501 available at L<https://cloud.google.com/monitoring/api/resources>.
10503 This block takes one string argument, the I<ResourceType>. Inside the block are
10504 one or more B<Label> options which configure the resource labels.
10506 This block is optional. The default value depends on the runtime environment:
10507 on GCE, the C<gce_instance> resource type is used, otherwise the C<global>
10508 resource type ist used:
10514 B<On GCE>, defaults to the equivalent of this config:
10516 <Resource "gce_instance">
10517 Label "project_id" "<project_id>"
10518 Label "instance_id" "<instance_id>"
10519 Label "zone" "<zone>"
10522 The values for I<project_id>, I<instance_id> and I<zone> are read from the GCE
10527 B<Elsewhere>, i.e. not on GCE, defaults to the equivalent of this config:
10529 <Resource "global">
10530 Label "project_id" "<Project>"
10533 Where I<Project> refers to the value of the B<Project> option or the project ID
10534 inferred from the B<CredentialFile>.
10538 =item B<Url> I<Url>
10540 URL of the I<Stackdriver Monitoring> API. Defaults to
10541 C<https://monitoring.googleapis.com/v3>.
10545 =head2 Plugin C<xencpu>
10547 This plugin collects metrics of hardware CPU load for machine running Xen
10548 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10549 Result is reported using the C<percent> type, for each CPU (core).
10551 This plugin doesn't have any options (yet).
10553 =head2 Plugin C<zookeeper>
10555 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10556 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
10561 <Plugin "zookeeper">
10568 =item B<Host> I<Address>
10570 Hostname or address to connect to. Defaults to C<localhost>.
10572 =item B<Port> I<Service>
10574 Service name or port number to connect to. Defaults to C<2181>.
10578 =head1 THRESHOLD CONFIGURATION
10580 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
10581 we mean that the values are not only stored or sent somewhere, but that they
10582 are judged and, if a problem is recognized, acted upon. The only action
10583 collectd takes itself is to generate and dispatch a "notification". Plugins can
10584 register to receive notifications and perform appropriate further actions.
10586 Since systems and what you expect them to do differ a lot, you can configure
10587 B<thresholds> for your values freely. This gives you a lot of flexibility but
10588 also a lot of responsibility.
10590 Every time a value is out of range a notification is dispatched. This means
10591 that the idle percentage of your CPU needs to be less then the configured
10592 threshold only once for a notification to be generated. There's no such thing
10593 as a moving average or similar - at least not now.
10595 Also, all values that match a threshold are considered to be relevant or
10596 "interesting". As a consequence collectd will issue a notification if they are
10597 not received for B<Timeout> iterations. The B<Timeout> configuration option is
10598 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
10599 "2" (the default) and some hosts sends it's CPU statistics to the server every
10600 60 seconds, a notification will be dispatched after about 120 seconds. It may
10601 take a little longer because the timeout is checked only once each B<Interval>
10604 When a value comes within range again or is received after it was missing, an
10605 "OKAY-notification" is dispatched.
10607 Here is a configuration example to get you started. Read below for more
10620 <Plugin "interface">
10623 FailureMax 10000000
10637 WarningMin 100000000
10643 There are basically two types of configuration statements: The C<Host>,
10644 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10645 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10646 C<Instance> option. You can combine the block by nesting the blocks, though
10647 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10648 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10649 C<Type> may not contain other blocks. If multiple blocks apply to the same
10650 value the most specific block is used.
10652 The other statements specify the threshold to configure. They B<must> be
10653 included in a C<Type> block. Currently the following statements are recognized:
10657 =item B<FailureMax> I<Value>
10659 =item B<WarningMax> I<Value>
10661 Sets the upper bound of acceptable values. If unset defaults to positive
10662 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10663 will be created. If the value is greater than B<WarningMax> but less than (or
10664 equal to) B<FailureMax> a B<WARNING> notification will be created.
10666 =item B<FailureMin> I<Value>
10668 =item B<WarningMin> I<Value>
10670 Sets the lower bound of acceptable values. If unset defaults to negative
10671 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10672 be created. If the value is less than B<WarningMin> but greater than (or equal
10673 to) B<FailureMin> a B<WARNING> notification will be created.
10675 =item B<DataSource> I<DSName>
10677 Some data sets have more than one "data source". Interesting examples are the
10678 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10679 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10680 system load data set, C<load>, even has three data sources: C<shortterm>,
10681 C<midterm>, and C<longterm>.
10683 Normally, all data sources are checked against a configured threshold. If this
10684 is undesirable, or if you want to specify different limits for each data
10685 source, you can use the B<DataSource> option to have a threshold apply only to
10688 =item B<Invert> B<true>|B<false>
10690 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10691 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10692 B<WarningMax>) are not okay. Defaults to B<false>.
10694 =item B<Persist> B<true>|B<false>
10696 Sets how often notifications are generated. If set to B<true> one notification
10697 will be generated for each value that is out of the acceptable range. If set to
10698 B<false> (the default) then a notification is only generated if a value is out
10699 of range but the previous value was okay.
10701 This applies to missing values, too: If set to B<true> a notification about a
10702 missing value is generated once every B<Interval> seconds. If set to B<false>
10703 only one such notification is generated until the value appears again.
10705 =item B<Percentage> B<true>|B<false>
10707 If set to B<true>, the minimum and maximum values given are interpreted as
10708 percentage value, relative to the other data sources. This is helpful for
10709 example for the "df" type, where you may want to issue a warning when less than
10710 5E<nbsp>% of the total space is available. Defaults to B<false>.
10712 =item B<Hits> I<Number>
10714 Delay creating the notification until the threshold has been passed I<Number>
10715 times. When a notification has been generated, or when a subsequent value is
10716 inside the threshold, the counter is reset. If, for example, a value is
10717 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10718 will be dispatched at most once every 30E<nbsp>seconds.
10720 This is useful when short bursts are not a problem. If, for example, 100% CPU
10721 usage for up to a minute is normal (and data is collected every
10722 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10724 =item B<Hysteresis> I<Number>
10726 When set to non-zero, a hysteresis value is applied when checking minimum and
10727 maximum bounds. This is useful for values that increase slowly and fluctuate a
10728 bit while doing so. When these values come close to the threshold, they may
10729 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10731 If, for example, the threshold is configures as
10736 then a I<Warning> notification is created when the value exceeds I<101> and the
10737 corresponding I<Okay> notification is only created once the value falls below
10738 I<99>, thus avoiding the "flapping".
10742 =head1 FILTER CONFIGURATION
10744 Starting with collectd 4.6 there is a powerful filtering infrastructure
10745 implemented in the daemon. The concept has mostly been copied from
10746 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10747 terminology, so that users that are familiar with iptables feel right at home.
10751 The following are the terms used in the remainder of the filter configuration
10752 documentation. For an ASCII-art schema of the mechanism, see
10753 L<"General structure"> below.
10759 A I<match> is a criteria to select specific values. Examples are, of course, the
10760 name of the value or it's current value.
10762 Matches are implemented in plugins which you have to load prior to using the
10763 match. The name of such plugins starts with the "match_" prefix.
10767 A I<target> is some action that is to be performed with data. Such actions
10768 could, for example, be to change part of the value's identifier or to ignore
10769 the value completely.
10771 Some of these targets are built into the daemon, see L<"Built-in targets">
10772 below. Other targets are implemented in plugins which you have to load prior to
10773 using the target. The name of such plugins starts with the "target_" prefix.
10777 The combination of any number of matches and at least one target is called a
10778 I<rule>. The target actions will be performed for all values for which B<all>
10779 matches apply. If the rule does not have any matches associated with it, the
10780 target action will be performed for all values.
10784 A I<chain> is a list of rules and possibly default targets. The rules are tried
10785 in order and if one matches, the associated target will be called. If a value
10786 is handled by a rule, it depends on the target whether or not any subsequent
10787 rules are considered or if traversal of the chain is aborted, see
10788 L<"Flow control"> below. After all rules have been checked, the default targets
10793 =head2 General structure
10795 The following shows the resulting structure:
10802 +---------+ +---------+ +---------+ +---------+
10803 ! Rule !->! Match !->! Match !->! Target !
10804 +---------+ +---------+ +---------+ +---------+
10807 +---------+ +---------+ +---------+
10808 ! Rule !->! Target !->! Target !
10809 +---------+ +---------+ +---------+
10816 +---------+ +---------+ +---------+
10817 ! Rule !->! Match !->! Target !
10818 +---------+ +---------+ +---------+
10826 =head2 Flow control
10828 There are four ways to control which way a value takes through the filter
10835 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10836 process the value with another chain. When the called chain finishes, usually
10837 the next target or rule after the jump is executed.
10841 The stop condition, signaled for example by the built-in target B<stop>, causes
10842 all processing of the value to be stopped immediately.
10846 Causes processing in the current chain to be aborted, but processing of the
10847 value generally will continue. This means that if the chain was called via
10848 B<Jump>, the next target or rule after the jump will be executed. If the chain
10849 was not called by another chain, control will be returned to the daemon and it
10850 may pass the value to another chain.
10854 Most targets will signal the B<continue> condition, meaning that processing
10855 should continue normally. There is no special built-in target for this
10862 The configuration reflects this structure directly:
10864 PostCacheChain "PostCache"
10865 <Chain "PostCache">
10866 <Rule "ignore_mysql_show">
10869 Type "^mysql_command$"
10870 TypeInstance "^show_"
10880 The above configuration example will ignore all values where the plugin field
10881 is "mysql", the type is "mysql_command" and the type instance begins with
10882 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10883 default target of the chain. Since this chain is run after the value has been
10884 added to the cache, the MySQL C<show_*> command statistics will be available
10885 via the C<unixsock> plugin.
10887 =head2 List of configuration options
10891 =item B<PreCacheChain> I<ChainName>
10893 =item B<PostCacheChain> I<ChainName>
10895 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10896 argument is the name of a I<chain> that should be executed before and/or after
10897 the values have been added to the cache.
10899 To understand the implications, it's important you know what is going on inside
10900 I<collectd>. The following diagram shows how values are passed from the
10901 read-plugins to the write-plugins:
10907 + - - - - V - - - - +
10908 : +---------------+ :
10911 : +-------+-------+ :
10914 : +-------+-------+ : +---------------+
10915 : ! Cache !--->! Value Cache !
10916 : ! insert ! : +---+---+-------+
10917 : +-------+-------+ : ! !
10918 : ! ,------------' !
10920 : +-------+---+---+ : +-------+-------+
10921 : ! Post-Cache +--->! Write-Plugins !
10922 : ! Chain ! : +---------------+
10923 : +---------------+ :
10925 : dispatch values :
10926 + - - - - - - - - - +
10928 After the values are passed from the "read" plugins to the dispatch functions,
10929 the pre-cache chain is run first. The values are added to the internal cache
10930 afterwards. The post-cache chain is run after the values have been added to the
10931 cache. So why is it such a huge deal if chains are run before or after the
10932 values have been added to this cache?
10934 Targets that change the identifier of a value list should be executed before
10935 the values are added to the cache, so that the name in the cache matches the
10936 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10937 this cache to receive a list of all available values. If you change the
10938 identifier after the value list has been added to the cache, this may easily
10939 lead to confusion, but it's not forbidden of course.
10941 The cache is also used to convert counter values to rates. These rates are, for
10942 example, used by the C<value> match (see below). If you use the rate stored in
10943 the cache B<before> the new value is added, you will use the old, B<previous>
10944 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10945 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10948 Last but not last, the B<stop> target makes a difference: If the pre-cache
10949 chain returns the stop condition, the value will not be added to the cache and
10950 the post-cache chain will not be run.
10952 =item B<Chain> I<Name>
10954 Adds a new chain with a certain name. This name can be used to refer to a
10955 specific chain, for example to jump to it.
10957 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10959 =item B<Rule> [I<Name>]
10961 Adds a new rule to the current chain. The name of the rule is optional and
10962 currently has no meaning for the daemon.
10964 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10965 must be at least one B<Target> block.
10967 =item B<Match> I<Name>
10969 Adds a match to a B<Rule> block. The name specifies what kind of match should
10970 be performed. Available matches depend on the plugins that have been loaded.
10972 The arguments inside the B<Match> block are passed to the plugin implementing
10973 the match, so which arguments are valid here depends on the plugin being used.
10974 If you do not need any to pass any arguments to a match, you can use the
10979 Which is equivalent to:
10984 =item B<Target> I<Name>
10986 Add a target to a rule or a default target to a chain. The name specifies what
10987 kind of target is to be added. Which targets are available depends on the
10988 plugins being loaded.
10990 The arguments inside the B<Target> block are passed to the plugin implementing
10991 the target, so which arguments are valid here depends on the plugin being used.
10992 If you do not need any to pass any arguments to a target, you can use the
10997 This is the same as writing:
11004 =head2 Built-in targets
11006 The following targets are built into the core daemon and therefore need no
11007 plugins to be loaded:
11013 Signals the "return" condition, see the L<"Flow control"> section above. This
11014 causes the current chain to stop processing the value and returns control to
11015 the calling chain. The calling chain will continue processing targets and rules
11016 just after the B<jump> target (see below). This is very similar to the
11017 B<RETURN> target of iptables, see L<iptables(8)>.
11019 This target does not have any options.
11027 Signals the "stop" condition, see the L<"Flow control"> section above. This
11028 causes processing of the value to be aborted immediately. This is similar to
11029 the B<DROP> target of iptables, see L<iptables(8)>.
11031 This target does not have any options.
11039 Sends the value to "write" plugins.
11045 =item B<Plugin> I<Name>
11047 Name of the write plugin to which the data should be sent. This option may be
11048 given multiple times to send the data to more than one write plugin. If the
11049 plugin supports multiple instances, the plugin's instance(s) must also be
11054 If no plugin is explicitly specified, the values will be sent to all available
11057 Single-instance plugin example:
11063 Multi-instance plugin example:
11065 <Plugin "write_graphite">
11075 Plugin "write_graphite/foo"
11080 Starts processing the rules of another chain, see L<"Flow control"> above. If
11081 the end of that chain is reached, or a stop condition is encountered,
11082 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
11083 next target or the next rule. This is similar to the B<-j> command line option
11084 of iptables, see L<iptables(8)>.
11090 =item B<Chain> I<Name>
11092 Jumps to the chain I<Name>. This argument is required and may appear only once.
11104 =head2 Available matches
11110 Matches a value using regular expressions.
11116 =item B<Host> I<Regex>
11118 =item B<Plugin> I<Regex>
11120 =item B<PluginInstance> I<Regex>
11122 =item B<Type> I<Regex>
11124 =item B<TypeInstance> I<Regex>
11126 =item B<MetaData> I<String> I<Regex>
11128 Match values where the given regular expressions match the various fields of
11129 the identifier of a value. If multiple regular expressions are given, B<all>
11130 regexen must match for a value to match.
11132 =item B<Invert> B<false>|B<true>
11134 When set to B<true>, the result of the match is inverted, i.e. all value lists
11135 where all regular expressions apply are not matched, all other value lists are
11136 matched. Defaults to B<false>.
11143 Host "customer[0-9]+"
11149 Matches values that have a time which differs from the time on the server.
11151 This match is mainly intended for servers that receive values over the
11152 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
11153 is very sensitive to the timestamp used when updating the RRD files. In
11154 particular, the time must be ever increasing. If a misbehaving client sends one
11155 packet with a timestamp far in the future, all further packets with a correct
11156 time will be ignored because of that one packet. What's worse, such corrupted
11157 RRD files are hard to fix.
11159 This match lets one match all values B<outside> a specified time range
11160 (relative to the server's time), so you can use the B<stop> target (see below)
11161 to ignore the value, for example.
11167 =item B<Future> I<Seconds>
11169 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
11170 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11173 =item B<Past> I<Seconds>
11175 Matches all values that are I<behind> of the server's time by I<Seconds> or
11176 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11188 This example matches all values that are five minutes or more ahead of the
11189 server or one hour (or more) lagging behind.
11193 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
11194 values. If a data-set consists of more than one data-source, all data-sources
11195 must match the specified ranges for a positive match.
11201 =item B<Min> I<Value>
11203 Sets the smallest value which still results in a match. If unset, behaves like
11206 =item B<Max> I<Value>
11208 Sets the largest value which still results in a match. If unset, behaves like
11211 =item B<Invert> B<true>|B<false>
11213 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
11214 no-match is returned and vice versa. Please note that the B<Invert> setting
11215 only effects how B<Min> and B<Max> are applied to a specific value. Especially
11216 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
11218 =item B<DataSource> I<DSName> [I<DSName> ...]
11220 Select one or more of the data sources. If no data source is configured, all
11221 data sources will be checked. If the type handled by the match does not have a
11222 data source of the specified name(s), this will always result in no match
11223 (independent of the B<Invert> setting).
11225 =item B<Satisfy> B<Any>|B<All>
11227 Specifies how checking with several data sources is performed. If set to
11228 B<Any>, the match succeeds if one of the data sources is in the configured
11229 range. If set to B<All> the match only succeeds if all data sources are within
11230 the configured range. Default is B<All>.
11232 Usually B<All> is used for positive matches, B<Any> is used for negative
11233 matches. This means that with B<All> you usually check that all values are in a
11234 "good" range, while with B<Any> you check if any value is within a "bad" range
11235 (or outside the "good" range).
11239 Either B<Min> or B<Max>, but not both, may be unset.
11243 # Match all values smaller than or equal to 100. Matches only if all data
11244 # sources are below 100.
11250 # Match if the value of any data source is outside the range of 0 - 100.
11258 =item B<empty_counter>
11260 Matches all values with one or more data sources of type B<COUNTER> and where
11261 all counter values are zero. These counters usually I<never> increased since
11262 they started existing (and are therefore uninteresting), or got reset recently
11263 or overflowed and you had really, I<really> bad luck.
11265 Please keep in mind that ignoring such counters can result in confusing
11266 behavior: Counters which hardly ever increase will be zero for long periods of
11267 time. If the counter is reset for some reason (machine or service restarted,
11268 usually), the graph will be empty (NAN) for a long time. People may not
11273 Calculates a hash value of the host name and matches values according to that
11274 hash value. This makes it possible to divide all hosts into groups and match
11275 only values that are in a specific group. The intended use is in load
11276 balancing, where you want to handle only part of all data and leave the rest
11279 The hashing function used tries to distribute the hosts evenly. First, it
11280 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11283 for (i = 0; host[i] != 0; i++)
11284 hash_value = (hash_value * 251) + host[i];
11286 The constant 251 is a prime number which is supposed to make this hash value
11287 more random. The code then checks the group for this host according to the
11288 I<Total> and I<Match> arguments:
11290 if ((hash_value % Total) == Match)
11295 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11296 groups), then the least significant bit of the hash value will be the XOR of
11297 all least significant bits in the host name. One consequence is that when you
11298 have two hosts, "server0.example.com" and "server1.example.com", where the host
11299 name differs in one digit only and the digits differ by one, those hosts will
11300 never end up in the same group.
11306 =item B<Match> I<Match> I<Total>
11308 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11309 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11310 be smaller than I<Total>. I<Total> must be at least one, although only values
11311 greater than one really do make any sense.
11313 You can repeat this option to match multiple groups, for example:
11318 The above config will divide the data into seven groups and match groups three
11319 and five. One use would be to keep every value on two hosts so that if one
11320 fails the missing data can later be reconstructed from the second host.
11326 # Operate on the pre-cache chain, so that ignored values are not even in the
11331 # Divide all received hosts in seven groups and accept all hosts in
11335 # If matched: Return and continue.
11338 # If not matched: Return and stop.
11344 =head2 Available targets
11348 =item B<notification>
11350 Creates and dispatches a notification.
11356 =item B<Message> I<String>
11358 This required option sets the message of the notification. The following
11359 placeholders will be replaced by an appropriate value:
11367 =item B<%{plugin_instance}>
11371 =item B<%{type_instance}>
11373 These placeholders are replaced by the identifier field of the same name.
11375 =item B<%{ds:>I<name>B<}>
11377 These placeholders are replaced by a (hopefully) human readable representation
11378 of the current rate of this data source. If you changed the instance name
11379 (using the B<set> or B<replace> targets, see below), it may not be possible to
11380 convert counter values to rates.
11384 Please note that these placeholders are B<case sensitive>!
11386 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11388 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11395 <Target "notification">
11396 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11402 Replaces parts of the identifier using regular expressions.
11408 =item B<Host> I<Regex> I<Replacement>
11410 =item B<Plugin> I<Regex> I<Replacement>
11412 =item B<PluginInstance> I<Regex> I<Replacement>
11414 =item B<TypeInstance> I<Regex> I<Replacement>
11416 =item B<MetaData> I<String> I<Regex> I<Replacement>
11418 =item B<DeleteMetaData> I<String> I<Regex>
11420 Match the appropriate field with the given regular expression I<Regex>. If the
11421 regular expression matches, that part that matches is replaced with
11422 I<Replacement>. If multiple places of the input buffer match a given regular
11423 expression, only the first occurrence will be replaced.
11425 You can specify each option multiple times to use multiple regular expressions
11433 # Replace "example.net" with "example.com"
11434 Host "\\<example.net\\>" "example.com"
11436 # Strip "www." from hostnames
11437 Host "\\<www\\." ""
11442 Sets part of the identifier of a value to a given string.
11448 =item B<Host> I<String>
11450 =item B<Plugin> I<String>
11452 =item B<PluginInstance> I<String>
11454 =item B<TypeInstance> I<String>
11456 =item B<MetaData> I<String> I<String>
11458 Set the appropriate field to the given string. The strings for plugin instance,
11459 type instance, and meta data may be empty, the strings for host and plugin may
11460 not be empty. It's currently not possible to set the type of a value this way.
11462 The following placeholders will be replaced by an appropriate value:
11470 =item B<%{plugin_instance}>
11474 =item B<%{type_instance}>
11476 These placeholders are replaced by the identifier field of the same name.
11478 =item B<%{meta:>I<name>B<}>
11480 These placeholders are replaced by the meta data value with the given name.
11484 Please note that these placeholders are B<case sensitive>!
11486 =item B<DeleteMetaData> I<String>
11488 Delete the named meta data field.
11495 PluginInstance "coretemp"
11496 TypeInstance "core3"
11501 =head2 Backwards compatibility
11503 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11504 B<Chain> block, it will behave as it used to. This is equivalent to the
11505 following configuration:
11507 <Chain "PostCache">
11511 If you specify a B<PostCacheChain>, the B<write> target will not be added
11512 anywhere and you will have to make sure that it is called where appropriate. We
11513 suggest to add the above snippet as default target to your "PostCache" chain.
11517 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11532 B<Ignorelists> are a generic framework to either ignore some metrics or report
11533 specific metircs only. Plugins usually provide one or more options to specify
11534 the items (mounts points, devices, ...) and the boolean option
11539 =item B<Select> I<String>
11541 Selects the item I<String>. This option often has a plugin specific name, e.g.
11542 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11543 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11544 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11546 By default, this option is doing a case-sensitive full-string match. The
11547 following config will match C<foo>, but not C<Foo>:
11551 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11552 I<regular expression>. For example, so match all item starting with C<foo>, use
11553 could use the following syntax:
11557 The regular expression is I<not> anchored, i.e. the following config will match
11558 C<foobar>, C<barfoo> and C<AfooZ>:
11562 The B<Select> option may be repeated to select multiple items.
11564 =item B<IgnoreSelected> B<true>|B<false>
11566 If set to B<true>, matching metrics are I<ignored> and all other metrics are
11567 collected. If set to B<false>, matching metrics are I<collected> and all other
11568 metrics are ignored.
11575 L<collectd-exec(5)>,
11576 L<collectd-perl(5)>,
11577 L<collectd-unixsock(5)>,
11590 Florian Forster E<lt>octo@collectd.orgE<gt>