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 message broker. Values
534 are sent to or received from the broker, which handles routing, queueing and
535 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<apache>
743 To configure the C<apache>-plugin you first need to configure the Apache
744 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
745 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
746 the following snipped to base your Apache config upon:
749 <IfModule mod_status.c>
750 <Location /mod_status>
751 SetHandler server-status
755 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
756 also supported. It introduces a new field, called C<BusyServers>, to count the
757 number of currently connected clients. This field is also supported.
759 The configuration of the I<Apache> plugin consists of one or more
760 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
761 as the instance name. For example:
765 URL "http://www1.example.com/mod_status?auto"
768 URL "http://www2.example.com/mod_status?auto"
772 The instance name will be used as the I<plugin instance>. To emulate the old
773 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
774 plugin to work correctly, each instance name must be unique. This is not
775 enforced by the plugin and it is your responsibility to ensure it.
777 The following options are accepted within each I<Instance> block:
781 =item B<URL> I<http://host/mod_status?auto>
783 Sets the URL of the C<mod_status> output. This needs to be the output generated
784 by C<ExtendedStatus on> and it needs to be the machine readable output
785 generated by appending the C<?auto> argument. This option is I<mandatory>.
787 =item B<User> I<Username>
789 Optional user name needed for authentication.
791 =item B<Password> I<Password>
793 Optional password needed for authentication.
795 =item B<VerifyPeer> B<true|false>
797 Enable or disable peer SSL certificate verification. See
798 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
800 =item B<VerifyHost> B<true|false>
802 Enable or disable peer host name verification. If enabled, the plugin checks
803 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
804 certificate matches the host name provided by the B<URL> option. If this
805 identity check fails, the connection is aborted. Obviously, only works when
806 connecting to a SSL enabled server. Enabled by default.
808 =item B<CACert> I<File>
810 File that holds one or more SSL certificates. If you want to use HTTPS you will
811 possibly need this option. What CA certificates come bundled with C<libcurl>
812 and are checked by default depends on the distribution you use.
814 =item B<SSLCiphers> I<list of ciphers>
816 Specifies which ciphers to use in the connection. The list of ciphers
817 must specify valid ciphers. See
818 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
820 =item B<Timeout> I<Milliseconds>
822 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
823 milliseconds. By default, the configured B<Interval> is used to set the
828 =head2 Plugin C<apcups>
832 =item B<Host> I<Hostname>
834 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
835 that IPv6 support has been disabled unless someone can confirm or decline that
836 B<apcupsd> can handle it.
838 =item B<Port> I<Port>
840 TCP-Port to connect to. Defaults to B<3551>.
842 =item B<ReportSeconds> B<true>|B<false>
844 If set to B<true>, the time reported in the C<timeleft> metric will be
845 converted to seconds. This is the recommended setting. If set to B<false>, the
846 default for backwards compatibility, the time will be reported in minutes.
848 =item B<PersistentConnection> B<true>|B<false>
850 The plugin is designed to keep the connection to I<apcupsd> open between reads.
851 If plugin poll interval is greater than 15 seconds (hardcoded socket close
852 timeout in I<apcupsd> NIS), then this option is B<false> by default.
854 You can instruct the plugin to close the connection after each read by setting
855 this option to B<false> or force keeping the connection by setting it to B<true>.
857 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
858 the plugin will try to detect this problem and switch to an open-read-close mode.
862 =head2 Plugin C<aquaero>
864 This plugin collects the value of the available sensors in an
865 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
866 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
867 connection for monitoring and configuration. The board can handle multiple
868 temperature sensors, fans, water pumps and water level sensors and adjust the
869 output settings such as fan voltage or power used by the water pump based on
870 the available inputs using a configurable controller included in the board.
871 This plugin collects all the available inputs as well as some of the output
872 values chosen by this controller. The plugin is based on the I<libaquaero5>
873 library provided by I<aquatools-ng>.
877 =item B<Device> I<DevicePath>
879 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
880 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
881 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
885 =head2 Plugin C<ascent>
887 This plugin collects information about an Ascent server, a free server for the
888 "World of Warcraft" game. This plugin gathers the information by fetching the
889 XML status page using C<libcurl> and parses it using C<libxml2>.
891 The configuration options are the same as for the C<apache> plugin above:
895 =item B<URL> I<http://localhost/ascent/status/>
897 Sets the URL of the XML status output.
899 =item B<User> I<Username>
901 Optional user name needed for authentication.
903 =item B<Password> I<Password>
905 Optional password needed for authentication.
907 =item B<VerifyPeer> B<true|false>
909 Enable or disable peer SSL certificate verification. See
910 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
912 =item B<VerifyHost> B<true|false>
914 Enable or disable peer host name verification. If enabled, the plugin checks
915 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
916 certificate matches the host name provided by the B<URL> option. If this
917 identity check fails, the connection is aborted. Obviously, only works when
918 connecting to a SSL enabled server. Enabled by default.
920 =item B<CACert> I<File>
922 File that holds one or more SSL certificates. If you want to use HTTPS you will
923 possibly need this option. What CA certificates come bundled with C<libcurl>
924 and are checked by default depends on the distribution you use.
926 =item B<Timeout> I<Milliseconds>
928 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
929 milliseconds. By default, the configured B<Interval> is used to set the
934 =head2 Plugin C<barometer>
936 This plugin reads absolute air pressure using digital barometer sensor on a I2C
937 bus. Supported sensors are:
941 =item I<MPL115A2> from Freescale,
942 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
945 =item I<MPL3115> from Freescale
946 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
949 =item I<BMP085> from Bosch Sensortec
953 The sensor type - one of the above - is detected automatically by the plugin
954 and indicated in the plugin_instance (you will see subdirectory
955 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
956 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
957 (only one sensor can be used by the plugin).
959 The plugin provides absolute barometric pressure, air pressure reduced to sea
960 level (several possible approximations) and as an auxiliary value also internal
961 sensor temperature. It uses (expects/provides) typical metric units - pressure
962 in [hPa], temperature in [C], altitude in [m].
964 It was developed and tested under Linux only. The only platform dependency is
965 the standard Linux i2c-dev interface (the particular bus driver has to
966 support the SM Bus command subset).
968 The reduction or normalization to mean sea level pressure requires (depending
969 on selected method/approximation) also altitude and reference to temperature
970 sensor(s). When multiple temperature sensors are configured the minimum of
971 their values is always used (expecting that the warmer ones are affected by
972 e.g. direct sun light at that moment).
980 TemperatureOffset 0.0
983 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
988 =item B<Device> I<device>
990 The only mandatory configuration parameter.
992 Device name of the I2C bus to which the sensor is connected. Note that
993 typically you need to have loaded the i2c-dev module.
994 Using i2c-tools you can check/list i2c buses available on your system by:
998 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1002 This way you should be able to verify that the pressure sensor (either type) is
1003 connected and detected on address 0x60.
1005 =item B<Oversampling> I<value>
1007 Optional parameter controlling the oversampling/accuracy. Default value
1008 is 1 providing fastest and least accurate reading.
1010 For I<MPL115> this is the size of the averaging window. To filter out sensor
1011 noise a simple averaging using floating window of this configurable size is
1012 used. The plugin will use average of the last C<value> measurements (value of 1
1013 means no averaging). Minimal size is 1, maximal 1024.
1015 For I<MPL3115> this is the oversampling value. The actual oversampling is
1016 performed by the sensor and the higher value the higher accuracy and longer
1017 conversion time (although nothing to worry about in the collectd context).
1018 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1019 adjusted by the plugin to the closest supported one.
1021 For I<BMP085> this is the oversampling value. The actual oversampling is
1022 performed by the sensor and the higher value the higher accuracy and longer
1023 conversion time (although nothing to worry about in the collectd context).
1024 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1025 the closest supported one.
1027 =item B<PressureOffset> I<offset>
1029 Optional parameter for MPL3115 only.
1031 You can further calibrate the sensor by supplying pressure and/or temperature
1032 offsets. This is added to the measured/caclulated value (i.e. if the measured
1033 value is too high then use negative offset).
1034 In hPa, default is 0.0.
1036 =item B<TemperatureOffset> I<offset>
1038 Optional parameter for MPL3115 only.
1040 You can further calibrate the sensor by supplying pressure and/or temperature
1041 offsets. This is added to the measured/caclulated value (i.e. if the measured
1042 value is too high then use negative offset).
1043 In C, default is 0.0.
1045 =item B<Normalization> I<method>
1047 Optional parameter, default value is 0.
1049 Normalization method - what approximation/model is used to compute the mean sea
1050 level pressure from the air absolute pressure.
1052 Supported values of the C<method> (integer between from 0 to 2) are:
1056 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1057 do not need to configure C<Altitude> or C<TemperatureSensor>.
1059 =item B<1> - international formula for conversion ,
1061 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1062 For this method you have to configure C<Altitude> but do not need
1063 C<TemperatureSensor> (uses fixed global temperature average instead).
1065 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1066 Meteorological Service).
1067 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1068 For this method you have to configure both C<Altitude> and
1069 C<TemperatureSensor>.
1074 =item B<Altitude> I<altitude>
1076 The altitude (in meters) of the location where you meassure the pressure.
1078 =item B<TemperatureSensor> I<reference>
1080 Temperature sensor(s) which should be used as a reference when normalizing the
1081 pressure using C<Normalization> method 2.
1082 When specified more sensors a minimum is found and used each time. The
1083 temperature reading directly from this pressure sensor/plugin is typically not
1084 suitable as the pressure sensor will be probably inside while we want outside
1085 temperature. The collectd reference name is something like
1086 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1087 (<type_instance> is usually omitted when there is just single value type). Or
1088 you can figure it out from the path of the output data files.
1092 =head2 Plugin C<battery>
1094 The I<battery plugin> reports the remaining capacity, power and voltage of
1099 =item B<ValuesPercentage> B<false>|B<true>
1101 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1102 capacity remaining". Otherwise the capacity is stored as reported by the
1103 battery, most likely in "Wh". This option does not work with all input methods,
1104 in particular when only C</proc/pmu> is available on an old Linux system.
1105 Defaults to B<false>.
1107 =item B<ReportDegraded> B<false>|B<true>
1109 Typical laptop batteries degrade over time, meaning the capacity decreases with
1110 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1111 "last full capacity" and used to determine that a battery is "fully charged".
1113 When this option is set to B<false>, the default, the I<battery plugin> will
1114 only report the remaining capacity. If the B<ValuesPercentage> option is
1115 enabled, the relative remaining capacity is calculated as the ratio of the
1116 "remaining capacity" and the "last full capacity". This is what most tools,
1117 such as the status bar of desktop environments, also do.
1119 When set to B<true>, the battery plugin will report three values: B<charged>
1120 (remaining capacity), B<discharged> (difference between "last full capacity"
1121 and "remaining capacity") and B<degraded> (difference between "design capacity"
1122 and "last full capacity").
1124 =item B<QueryStateFS> B<false>|B<true>
1126 When set to B<true>, the battery plugin will only read statistics
1127 related to battery performance as exposed by StateFS at
1128 /run/state. StateFS is used in Mer-based Sailfish OS, for
1133 =head2 Plugin C<bind>
1135 Starting with BIND 9.5.0, the most widely used DNS server software provides
1136 extensive statistics about queries, responses and lots of other information.
1137 The bind plugin retrieves this information that's encoded in XML and provided
1138 via HTTP and submits the values to collectd.
1140 To use this plugin, you first need to tell BIND to make this information
1141 available. This is done with the C<statistics-channels> configuration option:
1143 statistics-channels {
1144 inet localhost port 8053;
1147 The configuration follows the grouping that can be seen when looking at the
1148 data with an XSLT compatible viewer, such as a modern web browser. It's
1149 probably a good idea to make yourself familiar with the provided values, so you
1150 can understand what the collected statistics actually mean.
1155 URL "http://localhost:8053/"
1170 Zone "127.in-addr.arpa/IN"
1174 The bind plugin accepts the following configuration options:
1180 URL from which to retrieve the XML data. If not specified,
1181 C<http://localhost:8053/> will be used.
1183 =item B<ParseTime> B<true>|B<false>
1185 When set to B<true>, the time provided by BIND will be parsed and used to
1186 dispatch the values. When set to B<false>, the local time source is queried.
1188 This setting is set to B<true> by default for backwards compatibility; setting
1189 this to B<false> is I<recommended> to avoid problems with timezones and
1192 =item B<OpCodes> B<true>|B<false>
1194 When enabled, statistics about the I<"OpCodes">, for example the number of
1195 C<QUERY> packets, are collected.
1199 =item B<QTypes> B<true>|B<false>
1201 When enabled, the number of I<incoming> queries by query types (for example
1202 C<A>, C<MX>, C<AAAA>) is collected.
1206 =item B<ServerStats> B<true>|B<false>
1208 Collect global server statistics, such as requests received over IPv4 and IPv6,
1209 successful queries, and failed updates.
1213 =item B<ZoneMaintStats> B<true>|B<false>
1215 Collect zone maintenance statistics, mostly information about notifications
1216 (zone updates) and zone transfers.
1220 =item B<ResolverStats> B<true>|B<false>
1222 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1223 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1224 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1225 default. Use the B<ResolverStats> option within a B<View "_default"> block
1226 instead for the same functionality.
1230 =item B<MemoryStats>
1232 Collect global memory statistics.
1236 =item B<Timeout> I<Milliseconds>
1238 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1239 milliseconds. By default, the configured B<Interval> is used to set the
1242 =item B<View> I<Name>
1244 Collect statistics about a specific I<"view">. BIND can behave different,
1245 mostly depending on the source IP-address of the request. These different
1246 configurations are called "views". If you don't use this feature, you most
1247 likely are only interested in the C<_default> view.
1249 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1250 information you want to collect about a view. If no B<View> block is
1251 configured, no detailed view statistics will be collected.
1255 =item B<QTypes> B<true>|B<false>
1257 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1258 C<MX>) is collected.
1262 =item B<ResolverStats> B<true>|B<false>
1264 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1265 (e.E<nbsp>g. queries over IPv4, lame servers).
1269 =item B<CacheRRSets> B<true>|B<false>
1271 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1272 type is collected. Negative entries (queries which resulted in an error, for
1273 example names that do not exist) are reported with a leading exclamation mark,
1278 =item B<Zone> I<Name>
1280 When given, collect detailed information about the given zone in the view. The
1281 information collected if very similar to the global B<ServerStats> information
1284 You can repeat this option to collect detailed information about multiple
1287 By default no detailed zone information is collected.
1293 =head2 Plugin C<ceph>
1295 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1296 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1298 A separate B<Daemon> block must be configured for each ceph daemon to be
1299 monitored. The following example will read daemon statistics from four
1300 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1303 LongRunAvgLatency false
1304 ConvertSpecialMetricTypes true
1306 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1309 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1312 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1315 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1319 The ceph plugin accepts the following configuration options:
1323 =item B<LongRunAvgLatency> B<true>|B<false>
1325 If enabled, latency values(sum,count pairs) are calculated as the long run
1326 average - average since the ceph daemon was started = (sum / count).
1327 When disabled, latency values are calculated as the average since the last
1328 collection = (sum_now - sum_last) / (count_now - count_last).
1332 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1334 If enabled, special metrics (metrics that differ in type from similar counters)
1335 are converted to the type of those similar counters. This currently only
1336 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1337 ceph schema reports this metric type as a sum,count pair while similar counters
1338 are treated as derive types. When converted, the sum is used as the counter
1339 value and is treated as a derive type.
1340 When disabled, all metrics are treated as the types received from the ceph schema.
1346 Each B<Daemon> block must have a string argument for the plugin instance name.
1347 A B<SocketPath> is also required for each B<Daemon> block:
1351 =item B<Daemon> I<DaemonName>
1353 Name to be used as the instance name for this daemon.
1355 =item B<SocketPath> I<SocketPath>
1357 Specifies the path to the UNIX admin socket of the ceph daemon.
1361 =head2 Plugin C<cgroups>
1363 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1364 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1365 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1369 =item B<CGroup> I<Directory>
1371 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1372 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1375 See F</"IGNORELISTS"> for details.
1377 =item B<IgnoreSelected> B<true>|B<false>
1379 Invert the selection: If set to true, all cgroups I<except> the ones that
1380 match any one of the criteria are collected. By default only selected
1381 cgroups are collected if a selection is made. If no selection is configured
1382 at all, B<all> cgroups are selected.
1386 =head2 Plugin C<chrony>
1388 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1389 skew and per-peer stratum.
1391 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1394 Available configuration options for the C<chrony> plugin:
1398 =item B<Host> I<Hostname>
1400 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1402 =item B<Port> I<Port>
1404 UDP-Port to connect to. Defaults to B<323>.
1406 =item B<Timeout> I<Timeout>
1408 Connection timeout in seconds. Defaults to B<2>.
1412 =head2 Plugin Connectivity
1414 connectivity - Documentation of collectd's C<connectivity plugin>
1417 LoadPlugin connectivity
1419 <Plugin connectivity>
1423 The C<connectivity plugin> queries interface status using netlink (man 7 netlink) which provides information about network interfaces via the NETLINK_ROUTE family (man 7 rtnetlink). The plugin translates the value it receives to collectd's internal format and, depending on the write plugins you have loaded, it may be written to disk or submitted to another instance.
1424 The plugin listens to interfaces configured in LoadPlugin (see configuration below). If no interfaces are listed, then the default is for all interfaces to be monitored.
1426 This example shows C<connectivity plugin> monitoring all interfaces.
1427 LoadPlugin connectivity
1428 <Plugin connectivity>
1431 This example shows C<connectivity plugin> monitoring 2 interfaces, "eth0" and "eth1".
1432 LoadPlugin connectivity
1433 <Plugin connectivity>
1440 =item B<Interface> I<interface_name>
1442 interface(s) to monitor connect to.
1446 If I<Status> is greater than or equal to zero the message indicates interface is up,
1447 if I<Status> is less than zero the message indicates interface is down.
1451 =head2 Plugin C<conntrack>
1453 This plugin collects IP conntrack statistics.
1459 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1460 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1464 =head2 Plugin C<cpu>
1466 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1467 as Jiffies, using the C<cpu> type. Two aggregations are available:
1473 Sum, per-state, over all CPUs installed in the system; and
1477 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1481 The two aggregations can be combined, leading to I<collectd> only emitting a
1482 single "active" metric for the entire system. As soon as one of these
1483 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1484 rather than Jiffies. In addition, you can request individual, per-state,
1485 per-CPU metrics to be reported as percentage.
1487 The following configuration options are available:
1491 =item B<ReportByState> B<true>|B<false>
1493 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1495 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1498 =item B<ReportByCpu> B<true>|B<false>
1500 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1501 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1502 global sum of CPU states is emitted.
1504 =item B<ValuesPercentage> B<false>|B<true>
1506 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1507 are set to B<true>. In this case, by default, metrics will be reported as
1508 Jiffies. By setting this option to B<true>, you can request percentage values
1509 in the un-aggregated (per-CPU, per-state) mode as well.
1511 =item B<ReportNumCpu> B<false>|B<true>
1513 When set to B<true>, reports the number of available CPUs.
1514 Defaults to B<false>.
1516 =item B<ReportGuestState> B<false>|B<true>
1518 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1519 Defaults to B<false>.
1521 =item B<SubtractGuestState> B<false>|B<true>
1523 This option is only considered when B<ReportGuestState> is set to B<true>.
1524 "guest" and "guest_nice" are included in respectively "user" and "nice".
1525 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1526 will be subtracted from "nice".
1527 Defaults to B<true>.
1531 =head2 Plugin C<cpufreq>
1533 This plugin doesn't have any options. It reads
1534 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1535 installed) to get the current CPU frequency. If this file does not exist make
1536 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1537 installed and an "cpu governor" (that's a kernel module) is loaded.
1539 =head2 Plugin C<cpusleep>
1541 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1542 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1543 BOOTTIME clock increments while device is suspended and MONOTONIC
1544 clock does not, the derivative of the difference between these clocks
1545 gives the relative amount of time the device has spent in suspend
1546 state. The recorded value is in milliseconds of sleep per seconds of
1549 =head2 Plugin C<csv>
1553 =item B<DataDir> I<Directory>
1555 Set the directory to store CSV-files under. Per default CSV-files are generated
1556 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1557 The special strings B<stdout> and B<stderr> can be used to write to the standard
1558 output and standard error channels, respectively. This, of course, only makes
1559 much sense when collectd is running in foreground- or non-daemon-mode.
1561 =item B<StoreRates> B<true|false>
1563 If set to B<true>, convert counter values to rates. If set to B<false> (the
1564 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1569 =head2 cURL Statistics
1571 All cURL-based plugins support collection of generic, request-based
1572 statistics. These are disabled by default and can be enabled selectively for
1573 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1574 the documentation of those plugins for specific information. This section
1575 describes the available metrics that can be configured for each plugin. All
1576 options are disabled by default.
1578 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1582 =item B<TotalTime> B<true|false>
1584 Total time of the transfer, including name resolving, TCP connect, etc.
1586 =item B<NamelookupTime> B<true|false>
1588 Time it took from the start until name resolving was completed.
1590 =item B<ConnectTime> B<true|false>
1592 Time it took from the start until the connect to the remote host (or proxy)
1595 =item B<AppconnectTime> B<true|false>
1597 Time it took from the start until the SSL/SSH connect/handshake to the remote
1600 =item B<PretransferTime> B<true|false>
1602 Time it took from the start until just before the transfer begins.
1604 =item B<StarttransferTime> B<true|false>
1606 Time it took from the start until the first byte was received.
1608 =item B<RedirectTime> B<true|false>
1610 Time it took for all redirection steps include name lookup, connect,
1611 pre-transfer and transfer before final transaction was started.
1613 =item B<RedirectCount> B<true|false>
1615 The total number of redirections that were actually followed.
1617 =item B<SizeUpload> B<true|false>
1619 The total amount of bytes that were uploaded.
1621 =item B<SizeDownload> B<true|false>
1623 The total amount of bytes that were downloaded.
1625 =item B<SpeedDownload> B<true|false>
1627 The average download speed that curl measured for the complete download.
1629 =item B<SpeedUpload> B<true|false>
1631 The average upload speed that curl measured for the complete upload.
1633 =item B<HeaderSize> B<true|false>
1635 The total size of all the headers received.
1637 =item B<RequestSize> B<true|false>
1639 The total size of the issued requests.
1641 =item B<ContentLengthDownload> B<true|false>
1643 The content-length of the download.
1645 =item B<ContentLengthUpload> B<true|false>
1647 The specified size of the upload.
1649 =item B<NumConnects> B<true|false>
1651 The number of new connections that were created to achieve the transfer.
1655 =head2 Plugin C<curl>
1657 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1658 and the match infrastructure (the same code used by the tail plugin) to use
1659 regular expressions with the received data.
1661 The following example will read the current value of AMD stock from Google's
1662 finance page and dispatch the value to collectd.
1665 <Page "stock_quotes">
1667 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1673 CACert "/path/to/ca.crt"
1674 Header "X-Custom-Header: foobar"
1677 MeasureResponseTime false
1678 MeasureResponseCode false
1681 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1682 DSType "GaugeAverage"
1683 # Note: `stock_value' is not a standard type.
1690 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1691 a web page and one or more "matches" to be performed on the returned data. The
1692 string argument to the B<Page> block is used as plugin instance.
1694 The following options are valid within B<Page> blocks:
1698 =item B<Plugin> I<Plugin>
1700 Use I<Plugin> as the plugin name when submitting values.
1701 Defaults to C<curl>.
1705 URL of the web site to retrieve. Since a regular expression will be used to
1706 extract information from this data, non-binary data is a big plus here ;)
1708 =item B<User> I<Name>
1710 Username to use if authorization is required to read the page.
1712 =item B<Password> I<Password>
1714 Password to use if authorization is required to read the page.
1716 =item B<Digest> B<true>|B<false>
1718 Enable HTTP digest authentication.
1720 =item B<VerifyPeer> B<true>|B<false>
1722 Enable or disable peer SSL certificate verification. See
1723 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1725 =item B<VerifyHost> B<true>|B<false>
1727 Enable or disable peer host name verification. If enabled, the plugin checks if
1728 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1729 matches the host name provided by the B<URL> option. If this identity check
1730 fails, the connection is aborted. Obviously, only works when connecting to a
1731 SSL enabled server. Enabled by default.
1733 =item B<CACert> I<file>
1735 File that holds one or more SSL certificates. If you want to use HTTPS you will
1736 possibly need this option. What CA certificates come bundled with C<libcurl>
1737 and are checked by default depends on the distribution you use.
1739 =item B<Header> I<Header>
1741 A HTTP header to add to the request. Multiple headers are added if this option
1742 is specified more than once.
1744 =item B<Post> I<Body>
1746 Specifies that the HTTP operation should be a POST instead of a GET. The
1747 complete data to be posted is given as the argument. This option will usually
1748 need to be accompanied by a B<Header> option to set an appropriate
1749 C<Content-Type> for the post body (e.g. to
1750 C<application/x-www-form-urlencoded>).
1752 =item B<MeasureResponseTime> B<true>|B<false>
1754 Measure response time for the request. If this setting is enabled, B<Match>
1755 blocks (see below) are optional. Disabled by default.
1757 Beware that requests will get aborted if they take too long to complete. Adjust
1758 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1761 This option is similar to enabling the B<TotalTime> statistic but it's
1762 measured by collectd instead of cURL.
1764 =item B<MeasureResponseCode> B<true>|B<false>
1766 Measure response code for the request. If this setting is enabled, B<Match>
1767 blocks (see below) are optional. Disabled by default.
1769 =item B<E<lt>StatisticsE<gt>>
1771 One B<Statistics> block can be used to specify cURL statistics to be collected
1772 for each request to the remote web site. See the section "cURL Statistics"
1773 above for details. If this setting is enabled, B<Match> blocks (see below) are
1776 =item B<E<lt>MatchE<gt>>
1778 One or more B<Match> blocks that define how to match information in the data
1779 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1780 used by the C<tail> plugin, so please see the documentation of the C<tail>
1781 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1782 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1785 =item B<Timeout> I<Milliseconds>
1787 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1788 milliseconds. By default, the configured B<Interval> is used to set the
1789 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1790 indefinitely. This legacy behaviour can be achieved by setting the value of
1793 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1794 network connection will stall one read thread. Adjust the B<ReadThreads> global
1795 setting accordingly to prevent this from blocking other plugins.
1799 =head2 Plugin C<curl_json>
1801 The B<curl_json plugin> collects values from JSON data to be parsed by
1802 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1803 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1804 unix socket. The former can be used, for example, to collect values
1805 from CouchDB documents (which are stored JSON notation), and the
1806 latter to collect values from a uWSGI stats socket.
1808 The following example will collect several values from the built-in
1809 C<_stats> runtime statistics module of I<CouchDB>
1810 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1813 <URL "http://localhost:5984/_stats">
1815 <Key "httpd/requests/count">
1816 Type "http_requests"
1819 <Key "httpd_request_methods/*/count">
1820 Type "http_request_methods"
1823 <Key "httpd_status_codes/*/count">
1824 Type "http_response_codes"
1829 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1832 <Sock "/var/run/uwsgi.stats.sock">
1834 <Key "workers/*/requests">
1835 Type "http_requests"
1838 <Key "workers/*/apps/*/requests">
1839 Type "http_requests"
1844 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1845 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1846 blocks defining a unix socket to read JSON from directly. Each of
1847 these blocks may have one or more B<Key> blocks.
1849 The B<Key> string argument must be in a path format. Each component is
1850 used to match the key from a JSON map or the index of an JSON
1851 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1852 values for all map keys or array indices will be collectd.
1854 The following options are valid within B<URL> blocks:
1858 =item B<Host> I<Name>
1860 Use I<Name> as the host name when submitting values. Defaults to the global
1863 =item B<Plugin> I<Plugin>
1865 Use I<Plugin> as the plugin name when submitting values.
1866 Defaults to C<curl_json>.
1868 =item B<Instance> I<Instance>
1870 Sets the plugin instance to I<Instance>.
1872 =item B<Interval> I<Interval>
1874 Sets the interval (in seconds) in which the values will be collected from this
1875 URL. By default the global B<Interval> setting will be used.
1877 =item B<User> I<Name>
1879 =item B<Password> I<Password>
1881 =item B<Digest> B<true>|B<false>
1883 =item B<VerifyPeer> B<true>|B<false>
1885 =item B<VerifyHost> B<true>|B<false>
1887 =item B<CACert> I<file>
1889 =item B<Header> I<Header>
1891 =item B<Post> I<Body>
1893 =item B<Timeout> I<Milliseconds>
1895 These options behave exactly equivalent to the appropriate options of the
1896 I<cURL> plugin. Please see there for a detailed description.
1898 =item B<E<lt>StatisticsE<gt>>
1900 One B<Statistics> block can be used to specify cURL statistics to be collected
1901 for each request to the remote URL. See the section "cURL Statistics" above
1906 The following options are valid within B<Key> blocks:
1910 =item B<Type> I<Type>
1912 Sets the type used to dispatch the values to the daemon. Detailed information
1913 about types and their configuration can be found in L<types.db(5)>. This
1914 option is mandatory.
1916 =item B<Instance> I<Instance>
1918 Type-instance to use. Defaults to the current map key or current string array element value.
1922 =head2 Plugin C<curl_xml>
1924 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1925 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1928 <URL "http://localhost/stats.xml">
1931 Instance "some_instance"
1936 CACert "/path/to/ca.crt"
1937 Header "X-Custom-Header: foobar"
1940 <XPath "table[@id=\"magic_level\"]/tr">
1942 #InstancePrefix "prefix-"
1943 InstanceFrom "td[1]"
1944 #PluginInstanceFrom "td[1]"
1945 ValuesFrom "td[2]/span[@class=\"level\"]"
1950 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1951 URL to be fetched using libcurl. Within each B<URL> block there are
1952 options which specify the connection parameters, for example authentication
1953 information, and one or more B<XPath> blocks.
1955 Each B<XPath> block specifies how to get one type of information. The
1956 string argument must be a valid XPath expression which returns a list
1957 of "base elements". One value is dispatched for each "base element". The
1958 I<type instance> and values are looked up using further I<XPath> expressions
1959 that should be relative to the base element.
1961 Within the B<URL> block the following options are accepted:
1965 =item B<Host> I<Name>
1967 Use I<Name> as the host name when submitting values. Defaults to the global
1970 =item B<Plugin> I<Plugin>
1972 Use I<Plugin> as the plugin name when submitting values.
1973 Defaults to 'curl_xml'.
1975 =item B<Instance> I<Instance>
1977 Use I<Instance> as the plugin instance when submitting values.
1978 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
1979 Defaults to an empty string (no plugin instance).
1981 =item B<Namespace> I<Prefix> I<URL>
1983 If an XPath expression references namespaces, they must be specified
1984 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1985 I<URL> is the "namespace name", an URI reference uniquely identifying the
1986 namespace. The option can be repeated to register multiple namespaces.
1990 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1991 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1993 =item B<User> I<User>
1995 =item B<Password> I<Password>
1997 =item B<Digest> B<true>|B<false>
1999 =item B<VerifyPeer> B<true>|B<false>
2001 =item B<VerifyHost> B<true>|B<false>
2003 =item B<CACert> I<CA Cert File>
2005 =item B<Header> I<Header>
2007 =item B<Post> I<Body>
2009 =item B<Timeout> I<Milliseconds>
2011 These options behave exactly equivalent to the appropriate options of the
2012 I<cURL plugin>. Please see there for a detailed description.
2014 =item B<E<lt>StatisticsE<gt>>
2016 One B<Statistics> block can be used to specify cURL statistics to be collected
2017 for each request to the remote URL. See the section "cURL Statistics" above
2020 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2022 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2023 B<XPath> block specifies how to get one type of information. The string
2024 argument must be a valid XPath expression which returns a list of "base
2025 elements". One value is dispatched for each "base element".
2027 Within the B<XPath> block the following options are accepted:
2031 =item B<Type> I<Type>
2033 Specifies the I<Type> used for submitting patches. This determines the number
2034 of values that are required / expected and whether the strings are parsed as
2035 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2036 This option is required.
2038 =item B<InstancePrefix> I<InstancePrefix>
2040 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2041 concatenated together without any separator.
2042 This option is optional.
2044 =item B<InstanceFrom> I<InstanceFrom>
2046 Specifies a XPath expression to use for determining the I<type instance>. The
2047 XPath expression must return exactly one element. The element's value is then
2048 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2050 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2052 Specifies a XPath expression to use for determining the I<plugin instance>. The
2053 XPath expression must return exactly one element. The element's value is then
2054 used as I<plugin instance>.
2058 If the "base XPath expression" (the argument to the B<XPath> block) returns
2059 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2060 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2064 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2066 Specifies one or more XPath expression to use for reading the values. The
2067 number of XPath expressions must match the number of data sources in the
2068 I<type> specified with B<Type> (see above). Each XPath expression must return
2069 exactly one element. The element's value is then parsed as a number and used as
2070 value for the appropriate value in the value list dispatched to the daemon.
2071 This option is required.
2077 =head2 Plugin C<dbi>
2079 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2080 connect to various databases, execute I<SQL> statements and read back the
2081 results. I<dbi> is an acronym for "database interface" in case you were
2082 wondering about the name. You can configure how each column is to be
2083 interpreted and the plugin will generate one or more data sets from each row
2084 returned according to these rules.
2086 Because the plugin is very generic, the configuration is a little more complex
2087 than those of other plugins. It usually looks something like this:
2090 <Query "out_of_stock">
2091 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2092 # Use with MySQL 5.0.0 or later
2096 InstancePrefix "out_of_stock"
2097 InstancesFrom "category"
2101 <Database "product_information">
2105 DriverOption "host" "localhost"
2106 DriverOption "username" "collectd"
2107 DriverOption "password" "aZo6daiw"
2108 DriverOption "dbname" "prod_info"
2109 SelectDB "prod_info"
2110 Query "out_of_stock"
2114 The configuration above defines one query with one result and one database. The
2115 query is then linked to the database with the B<Query> option I<within> the
2116 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2117 and you can also use the B<Include> statement to split up the configuration
2118 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2119 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2122 The following is a complete list of options:
2124 =head3 B<Query> blocks
2126 Query blocks define I<SQL> statements and how the returned data should be
2127 interpreted. They are identified by the name that is given in the opening line
2128 of the block. Thus the name needs to be unique. Other than that, the name is
2129 not used in collectd.
2131 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2132 define which column holds which value or instance information. You can use
2133 multiple B<Result> blocks to create multiple values from one returned row. This
2134 is especially useful, when queries take a long time and sending almost the same
2135 query again and again is not desirable.
2139 <Query "environment">
2140 Statement "select station, temperature, humidity from environment"
2143 # InstancePrefix "foo"
2144 InstancesFrom "station"
2145 ValuesFrom "temperature"
2149 InstancesFrom "station"
2150 ValuesFrom "humidity"
2154 The following options are accepted:
2158 =item B<Statement> I<SQL>
2160 Sets the statement that should be executed on the server. This is B<not>
2161 interpreted by collectd, but simply passed to the database server. Therefore,
2162 the SQL dialect that's used depends on the server collectd is connected to.
2164 The query has to return at least two columns, one for the instance and one
2165 value. You cannot omit the instance, even if the statement is guaranteed to
2166 always return exactly one line. In that case, you can usually specify something
2169 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2171 (That works with MySQL but may not be valid SQL according to the spec. If you
2172 use a more strict database server, you may have to select from a dummy table or
2175 Please note that some databases, for example B<Oracle>, will fail if you
2176 include a semicolon at the end of the statement.
2178 =item B<MinVersion> I<Version>
2180 =item B<MaxVersion> I<Value>
2182 Only use this query for the specified database version. You can use these
2183 options to provide multiple queries with the same name but with a slightly
2184 different syntax. The plugin will use only those queries, where the specified
2185 minimum and maximum versions fit the version of the database in use.
2187 The database version is determined by C<dbi_conn_get_engine_version>, see the
2188 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2189 for details. Basically, each part of the version is assumed to be in the range
2190 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2191 "40102", version "5.0.42" becomes "50042".
2193 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2194 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2195 happen. Don't to it! A valid example would be something along these lines:
2206 In the above example, there are three ranges that don't overlap. The last one
2207 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2208 before "4.0.0" are not specified.
2210 =item B<Type> I<Type>
2212 The B<type> that's used for each line returned. See L<types.db(5)> for more
2213 details on how types are defined. In short: A type is a predefined layout of
2214 data and the number of values and type of values has to match the type
2217 If you specify "temperature" here, you need exactly one gauge column. If you
2218 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2221 There must be exactly one B<Type> option inside each B<Result> block.
2223 =item B<InstancePrefix> I<prefix>
2225 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2226 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2227 all strings returned in the appropriate columns are concatenated together,
2228 separated by dashes I<("-")>.
2230 =item B<InstancesFrom> I<column0> [I<column1> ...]
2232 Specifies the columns whose values will be used to create the "type-instance"
2233 for each row. If you specify more than one column, the value of all columns
2234 will be joined together with dashes I<("-")> as separation characters.
2236 The plugin itself does not check whether or not all built instances are
2237 different. It's your responsibility to assure that each is unique. This is
2238 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2239 sure that only one row is returned in this case.
2241 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2244 =item B<ValuesFrom> I<column0> [I<column1> ...]
2246 Names the columns whose content is used as the actual data for the data sets
2247 that are dispatched to the daemon. How many such columns you need is determined
2248 by the B<Type> setting above. If you specify too many or not enough columns,
2249 the plugin will complain about that and no data will be submitted to the
2252 The actual data type in the columns is not that important. The plugin will
2253 automatically cast the values to the right type if it know how to do that. So
2254 it should be able to handle integer an floating point types, as well as strings
2255 (if they include a number at the beginning).
2257 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2259 =item B<MetadataFrom> [I<column0> I<column1> ...]
2261 Names the columns whose content is used as metadata for the data sets
2262 that are dispatched to the daemon.
2264 The actual data type in the columns is not that important. The plugin will
2265 automatically cast the values to the right type if it know how to do that. So
2266 it should be able to handle integer an floating point types, as well as strings
2267 (if they include a number at the beginning).
2271 =head3 B<Database> blocks
2273 Database blocks define a connection to a database and which queries should be
2274 sent to that database. Since the used "dbi" library can handle a wide variety
2275 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2276 documentationE<nbsp>- we stick as close to the terminology used there.
2278 Each database needs a "name" as string argument in the starting tag of the
2279 block. This name will be used as "PluginInstance" in the values submitted to
2280 the daemon. Other than that, that name is not used.
2284 =item B<Plugin> I<Plugin>
2286 Use I<Plugin> as the plugin name when submitting query results from
2287 this B<Database>. Defaults to C<dbi>.
2289 =item B<Interval> I<Interval>
2291 Sets the interval (in seconds) in which the values will be collected from this
2292 database. By default the global B<Interval> setting will be used.
2294 =item B<Driver> I<Driver>
2296 Specifies the driver to use to connect to the database. In many cases those
2297 drivers are named after the database they can connect to, but this is not a
2298 technical necessity. These drivers are sometimes referred to as "DBD",
2299 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2300 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2301 project at L<http://libdbi-drivers.sourceforge.net/>.
2303 You need to give the driver name as expected by the "dbi" library here. You
2304 should be able to find that in the documentation for each driver. If you
2305 mistype the driver name, the plugin will dump a list of all known driver names
2308 =item B<DriverOption> I<Key> I<Value>
2310 Sets driver-specific options. What option a driver supports can be found in the
2311 documentation for each driver, somewhere at
2312 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2313 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2315 DBDs can register two types of options: String options and numeric options. The
2316 plugin will use the C<dbi_conn_set_option> function when the configuration
2317 provides a string and the C<dbi_conn_require_option_numeric> function when the
2318 configuration provides a number. So these two lines will actually result in
2319 different calls being used:
2321 DriverOption "Port" 1234 # numeric
2322 DriverOption "Port" "1234" # string
2324 Unfortunately, drivers are not too keen to report errors when an unknown option
2325 is passed to them, so invalid settings here may go unnoticed. This is not the
2326 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2327 the driver. If a driver complains about an option, the plugin will dump a
2328 complete list of all options understood by that driver to the log. There is no
2329 way to programmatically find out if an option expects a string or a numeric
2330 argument, so you will have to refer to the appropriate DBD's documentation to
2331 find this out. Sorry.
2333 =item B<SelectDB> I<Database>
2335 In some cases, the database name you connect with is not the database name you
2336 want to use for querying data. If this option is set, the plugin will "select"
2337 (switch to) that database after the connection is established.
2339 =item B<Query> I<QueryName>
2341 Associates the query named I<QueryName> with this database connection. The
2342 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2343 blocks you want to refer to must be placed above the database block you want to
2346 =item B<Host> I<Hostname>
2348 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2349 values. Defaults to the global hostname setting.
2357 =item B<Device> I<Device>
2359 Select partitions based on the devicename.
2361 See F</"IGNORELISTS"> for details.
2363 =item B<MountPoint> I<Directory>
2365 Select partitions based on the mountpoint.
2367 See F</"IGNORELISTS"> for details.
2369 =item B<FSType> I<FSType>
2371 Select partitions based on the filesystem type.
2373 See F</"IGNORELISTS"> for details.
2375 =item B<IgnoreSelected> B<true>|B<false>
2377 Invert the selection: If set to true, all partitions B<except> the ones that
2378 match any one of the criteria are collected. By default only selected
2379 partitions are collected if a selection is made. If no selection is configured
2380 at all, B<all> partitions are selected.
2382 =item B<ReportByDevice> B<true>|B<false>
2384 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2385 (the default), it will report a disk as "root", but with it I<true>, it will be
2386 "sda1" (or whichever).
2388 =item B<ReportInodes> B<true>|B<false>
2390 Enables or disables reporting of free, reserved and used inodes. Defaults to
2391 inode collection being disabled.
2393 Enable this option if inodes are a scarce resource for you, usually because
2394 many small files are stored on the disk. This is a usual scenario for mail
2395 transfer agents and web caches.
2397 =item B<ValuesAbsolute> B<true>|B<false>
2399 Enables or disables reporting of free and used disk space in 1K-blocks.
2400 Defaults to B<true>.
2402 =item B<ValuesPercentage> B<false>|B<true>
2404 Enables or disables reporting of free and used disk space in percentage.
2405 Defaults to B<false>.
2407 This is useful for deploying I<collectd> on the cloud, where machines with
2408 different disk size may exist. Then it is more practical to configure
2409 thresholds based on relative disk size.
2413 =head2 Plugin C<disk>
2415 The C<disk> plugin collects information about the usage of physical disks and
2416 logical disks (partitions). Values collected are the number of octets written
2417 to and read from a disk or partition, the number of read/write operations
2418 issued to the disk and a rather complex "time" it took for these commands to be
2421 Using the following two options you can ignore some disks or configure the
2422 collection only of specific disks.
2426 =item B<Disk> I<Name>
2428 Select the disk I<Name>. Whether it is collected or ignored depends on the
2429 B<IgnoreSelected> setting, see below. As with other plugins that use the
2430 daemon's ignorelist functionality, a string that starts and ends with a slash
2431 is interpreted as a regular expression. Examples:
2436 See F</"IGNORELISTS"> for details.
2438 =item B<IgnoreSelected> B<true>|B<false>
2440 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2441 statements, are ignored or if all other disks are ignored. The behavior
2442 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2443 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2444 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2445 is set to B<true>, all disks are collected B<except> the ones matched.
2447 =item B<UseBSDName> B<true>|B<false>
2449 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2450 default major/minor numbers. Requires collectd to be built with Apple's
2453 =item B<UdevNameAttr> I<Attribute>
2455 Attempt to override disk instance name with the value of a specified udev
2456 attribute when built with B<libudev>. If the attribute is not defined for the
2457 given device, the default name is used. Example:
2459 UdevNameAttr "DM_NAME"
2463 =head2 Plugin C<dns>
2467 =item B<Interface> I<Interface>
2469 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2470 option sets the interface that should be used. If this option is not set, or
2471 set to "any", the plugin will try to get packets from B<all> interfaces. This
2472 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2474 =item B<IgnoreSource> I<IP-address>
2476 Ignore packets that originate from this address.
2478 =item B<SelectNumericQueryTypes> B<true>|B<false>
2480 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2484 =head2 Plugin C<dpdkevents>
2486 The I<dpdkevents plugin> collects events from DPDK such as link status of
2487 network ports and Keep Alive status of DPDK logical cores.
2488 In order to get Keep Alive events following requirements must be met:
2490 - support for Keep Alive implemented in DPDK application. More details can
2491 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2495 <Plugin "dpdkevents">
2501 <Event "link_status">
2502 SendEventsOnUpdate true
2503 EnabledPortMask 0xffff
2504 PortName "interface1"
2505 PortName "interface2"
2506 SendNotification false
2508 <Event "keep_alive">
2509 SendEventsOnUpdate true
2511 KeepAliveShmName "/dpdk_keepalive_shm_name"
2512 SendNotification false
2519 =head3 The EAL block
2523 =item B<Coremask> I<Mask>
2525 =item B<Memorychannels> I<Channels>
2527 Number of memory channels per processor socket.
2529 =item B<FilePrefix> I<File>
2531 The prefix text used for hugepage filenames. The filename will be set to
2532 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2536 =head3 The Event block
2538 The B<Event> block defines configuration for specific event. It accepts a
2539 single argument which specifies the name of the event.
2541 =head4 Link Status event
2545 =item B<SendEventOnUpdate> I<true|false>
2547 If set to true link status value will be dispatched only when it is
2548 different from previously read value. This is an optional argument - default
2551 =item B<EnabledPortMask> I<Mask>
2553 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2554 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2555 that all ports will be enabled. This is an optional argument - by default
2556 all ports are enabled.
2558 =item B<PortName> I<Name>
2560 A string containing an optional name for the enabled DPDK ports. Each PortName
2561 option should contain only one port name; specify as many PortName options as
2562 desired. Default naming convention will be used if PortName is blank. If there
2563 are less PortName options than there are enabled ports, the default naming
2564 convention will be used for the additional ports.
2566 =item B<SendNotification> I<true|false>
2568 If set to true, link status notifications are sent, instead of link status
2569 being collected as a statistic. This is an optional argument - default
2574 =head4 Keep Alive event
2578 =item B<SendEventOnUpdate> I<true|false>
2580 If set to true keep alive value will be dispatched only when it is
2581 different from previously read value. This is an optional argument - default
2584 =item B<LCoreMask> I<Mask>
2586 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2588 =item B<KeepAliveShmName> I<Name>
2590 Shared memory name identifier that is used by secondary process to monitor
2591 the keep alive cores state.
2593 =item B<SendNotification> I<true|false>
2595 If set to true, keep alive notifications are sent, instead of keep alive
2596 information being collected as a statistic. This is an optional
2597 argument - default value is false.
2601 =head2 Plugin C<dpdkstat>
2603 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2604 extended NIC stats API in DPDK.
2615 RteDriverLibPath "/usr/lib/dpdk-pmd"
2617 SharedMemObj "dpdk_collectd_stats_0"
2618 EnabledPortMask 0xffff
2619 PortName "interface1"
2620 PortName "interface2"
2625 =head3 The EAL block
2629 =item B<Coremask> I<Mask>
2631 A string containing an hexadecimal bit mask of the cores to run on. Note that
2632 core numbering can change between platforms and should be determined beforehand.
2634 =item B<Memorychannels> I<Channels>
2636 A string containing a number of memory channels per processor socket.
2638 =item B<FilePrefix> I<File>
2640 The prefix text used for hugepage filenames. The filename will be set to
2641 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2643 =item B<SocketMemory> I<MB>
2645 A string containing amount of Memory to allocate from hugepages on specific
2646 sockets in MB. This is an optional value.
2648 =item B<LogLevel> I<LogLevel_number>
2650 A string containing log level number. This parameter is optional.
2651 If parameter is not present then default value "7" - (INFO) is used.
2652 Value "8" - (DEBUG) can be set to enable debug traces.
2654 =item B<RteDriverLibPath> I<Path>
2656 A string containing path to shared pmd driver lib or path to directory,
2657 where shared pmd driver libs are available. This parameter is optional.
2658 This parameter enable loading of shared pmd driver libs from defined path.
2659 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2660 or "/usr/lib/dpdk-pmd"
2666 =item B<SharedMemObj> I<Mask>
2668 A string containing the name of the shared memory object that should be used to
2669 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2670 Defaults to dpdk_collectd_stats if no other value is configured.
2672 =item B<EnabledPortMask> I<Mask>
2674 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2675 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2676 that all ports will be enabled. This is an optional argument - default
2677 is all ports enabled.
2679 =item B<PortName> I<Name>
2681 A string containing an optional name for the enabled DPDK ports. Each PortName
2682 option should contain only one port name; specify as many PortName options as
2683 desired. Default naming convention will be used if PortName is blank. If there
2684 are less PortName options than there are enabled ports, the default naming
2685 convention will be used for the additional ports.
2689 =head2 Plugin C<email>
2693 =item B<SocketFile> I<Path>
2695 Sets the socket-file which is to be created.
2697 =item B<SocketGroup> I<Group>
2699 If running as root change the group of the UNIX-socket after it has been
2700 created. Defaults to B<collectd>.
2702 =item B<SocketPerms> I<Permissions>
2704 Change the file permissions of the UNIX-socket after it has been created. The
2705 permissions must be given as a numeric, octal value as you would pass to
2706 L<chmod(1)>. Defaults to B<0770>.
2708 =item B<MaxConns> I<Number>
2710 Sets the maximum number of connections that can be handled in parallel. Since
2711 this many threads will be started immediately setting this to a very high
2712 value will waste valuable resources. Defaults to B<5> and will be forced to be
2713 at most B<16384> to prevent typos and dumb mistakes.
2717 =head2 Plugin C<ethstat>
2719 The I<ethstat plugin> collects information about network interface cards (NICs)
2720 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2726 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2727 Map "multicast" "if_multicast"
2734 =item B<Interface> I<Name>
2736 Collect statistical information about interface I<Name>.
2738 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2740 By default, the plugin will submit values as type C<derive> and I<type
2741 instance> set to I<Name>, the name of the metric as reported by the driver. If
2742 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2743 I<TypeInstance> will be used.
2745 =item B<MappedOnly> B<true>|B<false>
2747 When set to B<true>, only metrics that can be mapped to a I<type> will be
2748 collected, all other metrics will be ignored. Defaults to B<false>.
2752 =head2 Plugin C<exec>
2754 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2755 contains valuable information on when the executable is executed and the
2756 output that is expected from it.
2760 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2762 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2764 Execute the executable I<Executable> as user I<User>. If the user name is
2765 followed by a colon and a group name, the effective group is set to that group.
2766 The real group and saved-set group will be set to the default group of that
2767 user. If no group is given the effective group ID will be the same as the real
2770 Please note that in order to change the user and/or group the daemon needs
2771 superuser privileges. If the daemon is run as an unprivileged user you must
2772 specify the same user/group here. If the daemon is run with superuser
2773 privileges, you must supply a non-root user here.
2775 The executable may be followed by optional arguments that are passed to the
2776 program. Please note that due to the configuration parsing numbers and boolean
2777 values may be changed. If you want to be absolutely sure that something is
2778 passed as-is please enclose it in quotes.
2780 The B<Exec> and B<NotificationExec> statements change the semantics of the
2781 programs executed, i.E<nbsp>e. the data passed to them and the response
2782 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2786 =head2 Plugin C<fhcount>
2788 The C<fhcount> plugin provides statistics about used, unused and total number of
2789 file handles on Linux.
2791 The I<fhcount plugin> provides the following configuration options:
2795 =item B<ValuesAbsolute> B<true>|B<false>
2797 Enables or disables reporting of file handles usage in absolute numbers,
2798 e.g. file handles used. Defaults to B<true>.
2800 =item B<ValuesPercentage> B<false>|B<true>
2802 Enables or disables reporting of file handles usage in percentages, e.g.
2803 percent of file handles used. Defaults to B<false>.
2807 =head2 Plugin C<filecount>
2809 The C<filecount> plugin counts the number of files in a certain directory (and
2810 its subdirectories) and their combined size. The configuration is very straight
2813 <Plugin "filecount">
2814 <Directory "/var/qmail/queue/mess">
2815 Instance "qmail-message"
2817 <Directory "/var/qmail/queue/todo">
2818 Instance "qmail-todo"
2820 <Directory "/var/lib/php5">
2821 Instance "php5-sessions"
2826 The example above counts the number of files in QMail's queue directories and
2827 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2828 QMail has not yet looked at, the "message" queue holds the messages that were
2829 classified into "local" and "remote".
2831 As you can see, the configuration consists of one or more C<Directory> blocks,
2832 each of which specifies a directory in which to count the files. Within those
2833 blocks, the following options are recognized:
2837 =item B<Plugin> I<Plugin>
2839 Use I<Plugin> as the plugin name when submitting values.
2840 Defaults to B<filecount>.
2842 =item B<Instance> I<Instance>
2844 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2845 the directory name with all slashes replaced by underscores and all leading
2846 underscores removed. Empty value is allowed.
2848 =item B<Name> I<Pattern>
2850 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2851 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2852 against the pattern, not the entire path. In case this makes it easier for you:
2853 This option has been named after the B<-name> parameter to L<find(1)>.
2855 =item B<MTime> I<Age>
2857 Count only files of a specific age: If I<Age> is greater than zero, only files
2858 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2859 a negative number, this is inversed. For example, if B<-60> is specified, only
2860 files that have been modified in the last minute will be counted.
2862 The number can also be followed by a "multiplier" to easily specify a larger
2863 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2864 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2865 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2866 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2867 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2870 =item B<Size> I<Size>
2872 Count only files of a specific size. When I<Size> is a positive number, only
2873 files that are at least this big are counted. If I<Size> is a negative number,
2874 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2875 I<Size> are counted.
2877 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2878 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2879 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2880 note that there are 1000 bytes in a kilobyte, not 1024.
2882 =item B<Recursive> I<true>|I<false>
2884 Controls whether or not to recurse into subdirectories. Enabled by default.
2886 =item B<IncludeHidden> I<true>|I<false>
2888 Controls whether or not to include "hidden" files and directories in the count.
2889 "Hidden" files and directories are those, whose name begins with a dot.
2890 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2892 =item B<RegularOnly> I<true>|I<false>
2894 Controls whether or not to include only regular files in the count.
2895 Defaults to I<true>, i.e. by default non regular files are ignored.
2897 =item B<FilesSizeType> I<Type>
2899 Sets the type used to dispatch files combined size. Empty value ("") disables
2900 reporting. Defaults to B<bytes>.
2902 =item B<FilesCountType> I<Type>
2904 Sets the type used to dispatch number of files. Empty value ("") disables
2905 reporting. Defaults to B<files>.
2907 =item B<TypeInstance> I<Instance>
2909 Sets the I<type instance> used to dispatch values. Defaults to an empty string
2910 (no plugin instance).
2914 =head2 Plugin C<GenericJMX>
2916 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2917 L<collectd-java(5)>.
2919 =head2 Plugin C<gmond>
2921 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2922 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2923 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2928 MCReceiveFrom "239.2.11.71" "8649"
2929 <Metric "swap_total">
2931 TypeInstance "total"
2934 <Metric "swap_free">
2941 The following metrics are built-in:
2947 load_one, load_five, load_fifteen
2951 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2955 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2967 Available configuration options:
2971 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2973 Sets sets the multicast group and UDP port to which to subscribe.
2975 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2977 =item E<lt>B<Metric> I<Name>E<gt>
2979 These blocks add a new metric conversion to the internal table. I<Name>, the
2980 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2984 =item B<Type> I<Type>
2986 Type to map this metric to. Required.
2988 =item B<TypeInstance> I<Instance>
2990 Type-instance to use. Optional.
2992 =item B<DataSource> I<Name>
2994 Data source to map this metric to. If the configured type has exactly one data
2995 source, this is optional. Otherwise the option is required.
3001 =head2 Plugin C<gps>
3003 The C<gps plugin> connects to gpsd on the host machine.
3004 The host, port, timeout and pause are configurable.
3006 This is useful if you run an NTP server using a GPS for source and you want to
3009 Mind your GPS must send $--GSA for having the data reported!
3011 The following elements are collected:
3017 Number of satellites used for fix (type instance "used") and in view (type
3018 instance "visible"). 0 means no GPS satellites are visible.
3020 =item B<dilution_of_precision>
3022 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3023 It should be between 0 and 3.
3024 Look at the documentation of your GPS to know more.
3032 # Connect to localhost on gpsd regular port:
3037 # PauseConnect of 5 sec. between connection attempts.
3041 Available configuration options:
3045 =item B<Host> I<Host>
3047 The host on which gpsd daemon runs. Defaults to B<localhost>.
3049 =item B<Port> I<Port>
3051 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3053 =item B<Timeout> I<Seconds>
3055 Timeout in seconds (default 0.015 sec).
3057 The GPS data stream is fetch by the plugin form the daemon.
3058 It waits for data to be available, if none arrives it times out
3059 and loop for another reading.
3060 Mind to put a low value gpsd expects value in the micro-seconds area
3061 (recommended is 500 us) since the waiting function is blocking.
3062 Value must be between 500 us and 5 sec., if outside that range the
3063 default value is applied.
3065 This only applies from gpsd release-2.95.
3067 =item B<PauseConnect> I<Seconds>
3069 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3073 =head2 Plugin C<grpc>
3075 The I<grpc> plugin provides an RPC interface to submit values to or query
3076 values from collectd based on the open source gRPC framework. It exposes an
3077 end-point for dispatching values to the daemon.
3079 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3083 =item B<Server> I<Host> I<Port>
3085 The B<Server> statement sets the address of a server to which to send metrics
3086 via the C<DispatchValues> function.
3088 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3090 Optionally, B<Server> may be specified as a configuration block which supports
3091 the following options:
3095 =item B<EnableSSL> B<false>|B<true>
3097 Whether to require SSL for outgoing connections. Default: false.
3099 =item B<SSLCACertificateFile> I<Filename>
3101 =item B<SSLCertificateFile> I<Filename>
3103 =item B<SSLCertificateKeyFile> I<Filename>
3105 Filenames specifying SSL certificate and key material to be used with SSL
3110 =item B<Listen> I<Host> I<Port>
3112 The B<Listen> statement sets the network address to bind to. When multiple
3113 statements are specified, the daemon will bind to all of them. If none are
3114 specified, it defaults to B<0.0.0.0:50051>.
3116 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3118 Optionally, B<Listen> may be specified as a configuration block which
3119 supports the following options:
3123 =item B<EnableSSL> I<true>|I<false>
3125 Whether to enable SSL for incoming connections. Default: false.
3127 =item B<SSLCACertificateFile> I<Filename>
3129 =item B<SSLCertificateFile> I<Filename>
3131 =item B<SSLCertificateKeyFile> I<Filename>
3133 Filenames specifying SSL certificate and key material to be used with SSL
3136 =item B<VerifyPeer> B<true>|B<false>
3138 When enabled, a valid client certificate is required to connect to the server.
3139 When disabled, a client certifiacte is not requested and any unsolicited client
3140 certificate is accepted.
3147 =head2 Plugin C<hddtemp>
3149 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3150 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3151 default values, see below. C<hddtemp> has to be running to work correctly. If
3152 C<hddtemp> is not running timeouts may appear which may interfere with other
3155 The B<hddtemp> homepage can be found at
3156 L<http://www.guzu.net/linux/hddtemp.php>.
3160 =item B<Host> I<Hostname>
3162 Hostname to connect to. Defaults to B<127.0.0.1>.
3164 =item B<Port> I<Port>
3166 TCP-Port to connect to. Defaults to B<7634>.
3170 =head2 Plugin C<hugepages>
3172 To collect B<hugepages> information, collectd reads directories
3173 "/sys/devices/system/node/*/hugepages" and
3174 "/sys/kernel/mm/hugepages".
3175 Reading of these directories can be disabled by the following
3176 options (default is enabled).
3180 =item B<ReportPerNodeHP> B<true>|B<false>
3182 If enabled, information will be collected from the hugepage
3183 counters in "/sys/devices/system/node/*/hugepages".
3184 This is used to check the per-node hugepage statistics on
3187 =item B<ReportRootHP> B<true>|B<false>
3189 If enabled, information will be collected from the hugepage
3190 counters in "/sys/kernel/mm/hugepages".
3191 This can be used on both NUMA and non-NUMA systems to check
3192 the overall hugepage statistics.
3194 =item B<ValuesPages> B<true>|B<false>
3196 Whether to report hugepages metrics in number of pages.
3197 Defaults to B<true>.
3199 =item B<ValuesBytes> B<false>|B<true>
3201 Whether to report hugepages metrics in bytes.
3202 Defaults to B<false>.
3204 =item B<ValuesPercentage> B<false>|B<true>
3206 Whether to report hugepages metrics as percentage.
3207 Defaults to B<false>.
3211 =head2 Plugin C<intel_pmu>
3213 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3214 Linux perf interface. All events are reported on a per core basis.
3219 ReportHardwareCacheEvents true
3220 ReportKernelPMUEvents true
3221 ReportSoftwareEvents true
3222 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3223 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3230 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3232 Enable or disable measuring of hardware CPU cache events:
3234 - L1-dcache-load-misses
3236 - L1-dcache-store-misses
3237 - L1-dcache-prefetches
3238 - L1-dcache-prefetch-misses
3240 - L1-icache-load-misses
3241 - L1-icache-prefetches
3242 - L1-icache-prefetch-misses
3248 - LLC-prefetch-misses
3254 - dTLB-prefetch-misses
3258 - branch-load-misses
3260 =item B<ReportKernelPMUEvents> B<false>|B<true>
3262 Enable or disable measuring of the following events:
3271 =item B<ReportSoftwareEvents> B<false>|B<true>
3273 Enable or disable measuring of software events provided by kernel:
3284 =item B<EventList> I<filename>
3286 JSON performance counter event list file name. To be able to monitor all Intel
3287 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3288 event_download.py script to download event list for current CPU.
3290 =item B<HardwareEvents> I<events>
3292 This field is a list of event names or groups of comma separated event names.
3293 This option requires B<EventList> option to be configured.
3297 =head2 Plugin C<intel_rdt>
3299 The I<intel_rdt> plugin collects information provided by monitoring features of
3300 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3301 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3302 information about utilization of shared resources. CMT monitors last level cache
3303 occupancy (LLC). MBM supports two types of events reporting local and remote
3304 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3305 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3306 reports the bandwidth of accessing the remote socket. Also this technology
3307 allows to monitor instructions per clock (IPC).
3308 Monitor events are hardware dependant. Monitoring capabilities are detected on
3309 plugin initialization and only supported events are monitored.
3311 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3312 require an additional capability to be enabled if collectd is run as a service.
3313 Please refer to I<contrib/systemd.collectd.service> file for more details.
3317 <Plugin "intel_rdt">
3318 Cores "0-2" "3,4,6" "8-10,15"
3325 =item B<Interval> I<seconds>
3327 The interval within which to retrieve statistics on monitored events in seconds.
3328 For milliseconds divide the time by 1000 for example if the desired interval
3329 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3330 recommended to set interval higher than 1 sec.
3332 =item B<Cores> I<cores groups>
3334 All events are reported on a per core basis. Monitoring of the events can be
3335 configured for group of cores (aggregated statistics). This field defines groups
3336 of cores on which to monitor supported events. The field is represented as list
3337 of strings with core group values. Each string represents a list of cores in a
3338 group. Allowed formats are:
3343 If an empty string is provided as value for this field default cores
3344 configuration is applied - a separate group is created for each core.
3348 B<Note:> By default global interval is used to retrieve statistics on monitored
3349 events. To configure a plugin specific interval use B<Interval> option of the
3350 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3351 example if the desired interval is 50ms, set interval to 0.05.
3352 Due to limited capacity of counters it is not recommended to set interval higher
3355 =head2 Plugin C<interface>
3359 =item B<Interface> I<Interface>
3361 Select this interface. By default these interfaces will then be collected. For
3362 a more detailed description see B<IgnoreSelected> below.
3364 See F</"IGNORELISTS"> for details.
3366 =item B<IgnoreSelected> I<true>|I<false>
3368 If no configuration is given, the B<interface>-plugin will collect data from
3369 all interfaces. This may not be practical, especially for loopback- and
3370 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3371 interfaces you're interested in. Sometimes, however, it's easier/preferred
3372 to collect all interfaces I<except> a few ones. This option enables you to
3373 do that: By setting B<IgnoreSelected> to I<true> the effect of
3374 B<Interface> is inverted: All selected interfaces are ignored and all
3375 other interfaces are collected.
3377 It is possible to use regular expressions to match interface names, if the
3378 name is surrounded by I</.../> and collectd was compiled with support for
3379 regexps. This is useful if there's a need to collect (or ignore) data
3380 for a group of interfaces that are similarly named, without the need to
3381 explicitly list all of them (especially useful if the list is dynamic).
3386 Interface "/^tun[0-9]+/"
3387 IgnoreSelected "true"
3389 This will ignore the loopback interface, all interfaces with names starting
3390 with I<veth> and all interfaces with names starting with I<tun> followed by
3393 =item B<ReportInactive> I<true>|I<false>
3395 When set to I<false>, only interfaces with non-zero traffic will be
3396 reported. Note that the check is done by looking into whether a
3397 package was sent at any time from boot and the corresponding counter
3398 is non-zero. So, if the interface has been sending data in the past
3399 since boot, but not during the reported time-interval, it will still
3402 The default value is I<true> and results in collection of the data
3403 from all interfaces that are selected by B<Interface> and
3404 B<IgnoreSelected> options.
3406 =item B<UniqueName> I<true>|I<false>
3408 Interface name is not unique on Solaris (KSTAT), interface name is unique
3409 only within a module/instance. Following tuple is considered unique:
3410 (ks_module, ks_instance, ks_name)
3411 If this option is set to true, interface name contains above three fields
3412 separated by an underscore. For more info on KSTAT, visit
3413 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3415 This option is only available on Solaris.
3419 =head2 Plugin C<ipmi>
3421 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3422 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3424 The plugin configuration consists of one or more B<Instance> blocks which
3425 specify one I<ipmi> connection each. Each block requires one unique string
3426 argument as the instance name. If instances are not configured, an instance with
3427 the default option values will be created.
3429 For backwards compatibility, any option other than B<Instance> block will trigger
3430 legacy config handling and it will be treated as an option within B<Instance>
3431 block. This support will go away in the next major version of Collectd.
3433 Within the B<Instance> blocks, the following options are allowed:
3437 =item B<Address> I<Address>
3439 Hostname or IP to connect to. If not specified, plugin will try to connect to
3440 local management controller (BMC).
3442 =item B<Username> I<Username>
3444 =item B<Password> I<Password>
3446 The username and the password to use for the connection to remote BMC.
3448 =item B<AuthType> I<MD5>|I<rmcp+>
3450 Forces the authentication type to use for the connection to remote BMC.
3451 By default most secure type is seleted.
3453 =item B<Host> I<Hostname>
3455 Sets the B<host> field of dispatched values. Defaults to the global hostname
3458 =item B<Sensor> I<Sensor>
3460 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3462 See F</"IGNORELISTS"> for details.
3464 =item B<IgnoreSelected> I<true>|I<false>
3466 If no configuration if given, the B<ipmi> plugin will collect data from all
3467 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3468 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3469 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3470 all other sensors are collected.
3472 =item B<NotifySensorAdd> I<true>|I<false>
3474 If a sensor appears after initialization time of a minute a notification
3477 =item B<NotifySensorRemove> I<true>|I<false>
3479 If a sensor disappears a notification is sent.
3481 =item B<NotifySensorNotPresent> I<true>|I<false>
3483 If you have for example dual power supply and one of them is (un)plugged then
3484 a notification is sent.
3486 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3488 If a IPMI connection state changes after initialization time of a minute
3489 a notification is sent. Defaults to B<false>.
3491 =item B<SELEnabled> I<true>|I<false>
3493 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3494 and discrete events. When event is received the notification is sent.
3495 Defaults to B<false>.
3497 =item B<SELClearEvent> I<true>|I<false>
3499 If SEL clear event is enabled, plugin will delete event from SEL list after
3500 it is received and successfully handled. In this case other tools that are
3501 subscribed for SEL events will receive an empty event.
3502 Defaults to B<false>.
3506 =head2 Plugin C<iptables>
3510 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3512 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3514 Select the iptables/ip6tables filter rules to count packets and bytes from.
3516 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3517 of all rules which have a comment-match. The comment is then used as
3520 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3521 the I<n>th rule will be collected. Again, the comment (or the number) will be
3522 used as the type-instance.
3524 If I<Name> is supplied, it will be used as the type-instance instead of the
3525 comment or the number.
3529 =head2 Plugin C<irq>
3535 Select this irq. By default these irqs will then be collected. For a more
3536 detailed description see B<IgnoreSelected> below.
3538 See F</"IGNORELISTS"> for details.
3540 =item B<IgnoreSelected> I<true>|I<false>
3542 If no configuration if given, the B<irq>-plugin will collect data from all
3543 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3544 can use the B<Irq>-option to pick the interrupt you're interested in.
3545 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3546 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3547 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3548 and all other interrupts are collected.
3552 =head2 Plugin C<java>
3554 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3555 This section only discusses the syntax and semantic of the configuration
3556 options. For more in-depth information on the I<Java> plugin, please read
3557 L<collectd-java(5)>.
3562 JVMArg "-verbose:jni"
3563 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3564 LoadPlugin "org.collectd.java.Foobar"
3565 <Plugin "org.collectd.java.Foobar">
3566 # To be parsed by the plugin
3570 Available configuration options:
3574 =item B<JVMArg> I<Argument>
3576 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3577 exactly the way the arguments to the I<java> binary on the command line work.
3578 Execute C<javaE<nbsp>--help> for details.
3580 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3581 any other options! When another option is found, the JVM will be started and
3582 later options will have to be ignored!
3584 =item B<LoadPlugin> I<JavaClass>
3586 Instantiates a new I<JavaClass> object. The constructor of this object very
3587 likely then registers one or more callback methods with the server.
3589 See L<collectd-java(5)> for details.
3591 When the first such option is found, the virtual machine (JVM) is created. This
3592 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3593 B<LoadPlugin> options!
3595 =item B<Plugin> I<Name>
3597 The entire block is passed to the Java plugin as an
3598 I<org.collectd.api.OConfigItem> object.
3600 For this to work, the plugin has to register a configuration callback first,
3601 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3602 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3603 depends on the (Java) plugin registering the callback and is completely
3604 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3608 =head2 Plugin C<load>
3610 The I<Load plugin> collects the system load. These numbers give a rough overview
3611 over the utilization of a machine. The system load is defined as the number of
3612 runnable tasks in the run-queue and is provided by many operating systems as a
3613 one, five or fifteen minute average.
3615 The following configuration options are available:
3619 =item B<ReportRelative> B<false>|B<true>
3621 When enabled, system load divided by number of available CPU cores is reported
3622 for intervals 1 min, 5 min and 15 min. Defaults to false.
3627 =head2 Plugin C<logfile>
3631 =item B<LogLevel> B<debug|info|notice|warning|err>
3633 Sets the log-level. If, for example, set to B<notice>, then all events with
3634 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3636 Please note that B<debug> is only available if collectd has been compiled with
3639 =item B<File> I<File>
3641 Sets the file to write log messages to. The special strings B<stdout> and
3642 B<stderr> can be used to write to the standard output and standard error
3643 channels, respectively. This, of course, only makes much sense when I<collectd>
3644 is running in foreground- or non-daemon-mode.
3646 =item B<Timestamp> B<true>|B<false>
3648 Prefix all lines printed by the current time. Defaults to B<true>.
3650 =item B<PrintSeverity> B<true>|B<false>
3652 When enabled, all lines are prefixed by the severity of the log message, for
3653 example "warning". Defaults to B<false>.
3657 B<Note>: There is no need to notify the daemon after moving or removing the
3658 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3659 for each line it writes.
3661 =head2 Plugin C<log_logstash>
3663 The I<log logstash plugin> behaves like the logfile plugin but formats
3664 messages as JSON events for logstash to parse and input.
3668 =item B<LogLevel> B<debug|info|notice|warning|err>
3670 Sets the log-level. If, for example, set to B<notice>, then all events with
3671 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3673 Please note that B<debug> is only available if collectd has been compiled with
3676 =item B<File> I<File>
3678 Sets the file to write log messages to. The special strings B<stdout> and
3679 B<stderr> can be used to write to the standard output and standard error
3680 channels, respectively. This, of course, only makes much sense when I<collectd>
3681 is running in foreground- or non-daemon-mode.
3685 B<Note>: There is no need to notify the daemon after moving or removing the
3686 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3687 for each line it writes.
3689 =head2 Plugin C<lpar>
3691 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3692 virtualization technique for IBM POWER processors. It takes into account CPU
3693 time stolen from or donated to a partition, in addition to the usual user,
3694 system, I/O statistics.
3696 The following configuration options are available:
3700 =item B<CpuPoolStats> B<false>|B<true>
3702 When enabled, statistics about the processor pool are read, too. The partition
3703 needs to have pool authority in order to be able to acquire this information.
3706 =item B<ReportBySerial> B<false>|B<true>
3708 If enabled, the serial of the physical machine the partition is currently
3709 running on is reported as I<hostname> and the logical hostname of the machine
3710 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3711 used (just like other plugins) and the I<plugin instance> will be empty.
3716 =head2 Plugin C<lua>
3718 This plugin embeds a Lua interpreter into collectd and provides an interface
3719 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3722 =head2 Plugin C<mbmon>
3724 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3726 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3727 B<Host> and B<Port> options can be used to change these values, see below.
3728 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3729 timeouts may appear which may interfere with other statistics..
3731 C<mbmon> must be run with the -r option ("print TAG and Value format");
3732 Debian's F</etc/init.d/mbmon> script already does this, other people
3733 will need to ensure that this is the case.
3737 =item B<Host> I<Hostname>
3739 Hostname to connect to. Defaults to B<127.0.0.1>.
3741 =item B<Port> I<Port>
3743 TCP-Port to connect to. Defaults to B<411>.
3747 =head2 Plugin C<mcelog>
3749 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3751 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3752 mcelog server is running. When the server is running, the plugin will tail the
3753 specified logfile to retrieve machine check exception information and send a
3754 notification with the details from the logfile. The plugin will use the mcelog
3755 client protocol to retrieve memory related machine check exceptions. Note that
3756 for memory exceptions, notifications are only sent when there is a change in
3757 the number of corrected/uncorrected memory errors.
3759 =head3 The Memory block
3761 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3766 =item B<McelogClientSocket> I<Path>
3767 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3768 Defaults to B<"/var/run/mcelog-client">.
3770 =item B<PersistentNotification> B<true>|B<false>
3771 Override default configuration to only send notifications when sent when there
3772 is a change in the number of corrected/uncorrected memory errors. When set to
3773 true notifications will be sent for every read cycle. Default is false. Does
3774 not affect the stats being dispatched.
3780 =item B<McelogLogfile> I<Path>
3782 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3783 cannot be used in conjunction with the memory block options, they are mutually
3790 The C<md plugin> collects information from Linux Software-RAID devices (md).
3792 All reported values are of the type C<md_disks>. Reported type instances are
3793 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3794 I<missing> (physically absent) disks.
3798 =item B<Device> I<Device>
3800 Select md devices based on device name. The I<device name> is the basename of
3801 the device, i.e. the name of the block device without the leading C</dev/>.
3802 See B<IgnoreSelected> for more details.
3804 See F</"IGNORELISTS"> for details.
3806 =item B<IgnoreSelected> B<true>|B<false>
3808 Invert device selection: If set to B<true>, all md devices B<except> those
3809 listed using B<Device> are collected. If B<false> (the default), only those
3810 listed are collected. If no configuration is given, the B<md> plugin will
3811 collect data from all md devices.
3815 =head2 Plugin C<memcachec>
3817 The C<memcachec plugin> connects to a memcached server, queries one or more
3818 given I<pages> and parses the returned data according to user specification.
3819 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3822 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3823 library. Please note that there is another library with a very similar name,
3824 libmemcache (notice the missing `d'), which is not applicable.
3826 Synopsis of the configuration:
3828 <Plugin "memcachec">
3829 <Page "plugin_instance">
3832 Plugin "plugin_name"
3834 Regex "(\\d+) bytes sent"
3837 Instance "type_instance"
3842 The configuration options are:
3846 =item E<lt>B<Page> I<Name>E<gt>
3848 Each B<Page> block defines one I<page> to be queried from the memcached server.
3849 The block requires one string argument which is used as I<plugin instance>.
3851 =item B<Server> I<Address>
3853 Sets the server address to connect to when querying the page. Must be inside a
3858 When connected to the memcached server, asks for the page I<Key>.
3860 =item B<Plugin> I<Plugin>
3862 Use I<Plugin> as the plugin name when submitting values.
3863 Defaults to C<memcachec>.
3865 =item E<lt>B<Match>E<gt>
3867 Match blocks define which strings to look for and how matches substrings are
3868 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3872 =head2 Plugin C<memcached>
3874 The B<memcached plugin> connects to a memcached server and queries statistics
3875 about cache utilization, memory and bandwidth used.
3876 L<http://memcached.org/>
3878 <Plugin "memcached">
3880 #Host "memcache.example.com"
3886 The plugin configuration consists of one or more B<Instance> blocks which
3887 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3888 following options are allowed:
3892 =item B<Host> I<Hostname>
3894 Sets the B<host> field of dispatched values. Defaults to the global hostname
3896 For backwards compatibility, values are also dispatched with the global
3897 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3900 =item B<Address> I<Address>
3902 Hostname or IP to connect to. For backwards compatibility, defaults to the
3903 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3905 =item B<Port> I<Port>
3907 TCP port to connect to. Defaults to B<11211>.
3909 =item B<Socket> I<Path>
3911 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3912 setting is given, the B<Address> and B<Port> settings are ignored.
3916 =head2 Plugin C<mic>
3918 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3919 Intel's Many Integrated Core (MIC) systems.
3928 ShowTemperatures true
3931 IgnoreSelectedTemperature true
3936 IgnoreSelectedPower true
3939 The following options are valid inside the B<PluginE<nbsp>mic> block:
3943 =item B<ShowCPU> B<true>|B<false>
3945 If enabled (the default) a sum of the CPU usage across all cores is reported.
3947 =item B<ShowCPUCores> B<true>|B<false>
3949 If enabled (the default) per-core CPU usage is reported.
3951 =item B<ShowMemory> B<true>|B<false>
3953 If enabled (the default) the physical memory usage of the MIC system is
3956 =item B<ShowTemperatures> B<true>|B<false>
3958 If enabled (the default) various temperatures of the MIC system are reported.
3960 =item B<Temperature> I<Name>
3962 This option controls which temperatures are being reported. Whether matching
3963 temperatures are being ignored or I<only> matching temperatures are reported
3964 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3965 temperatures are reported.
3967 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3969 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3970 (the default) only temperatures matching a B<Temperature> option are reported
3971 or, if no B<Temperature> option is specified, all temperatures are reported. If
3972 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3975 Known temperature names are:
4009 =item B<ShowPower> B<true>|B<false>
4011 If enabled (the default) various temperatures of the MIC system are reported.
4013 =item B<Power> I<Name>
4015 This option controls which power readings are being reported. Whether matching
4016 power readings are being ignored or I<only> matching power readings are reported
4017 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4018 power readings are reported.
4020 =item B<IgnoreSelectedPower> B<false>|B<true>
4022 Controls the behavior of the B<Power> setting above. If set to B<false>
4023 (the default) only power readings matching a B<Power> option are reported
4024 or, if no B<Power> option is specified, all power readings are reported. If
4025 set to B<true>, matching power readings are I<ignored> and all other power readings
4028 Known power names are:
4034 Total power utilization averaged over Time Window 0 (uWatts).
4038 Total power utilization averaged over Time Window 0 (uWatts).
4042 Instantaneous power (uWatts).
4046 Max instantaneous power (uWatts).
4050 PCI-E connector power (uWatts).
4054 2x3 connector power (uWatts).
4058 2x4 connector power (uWatts).
4066 Uncore rail (uVolts).
4070 Memory subsystem rail (uVolts).
4076 =head2 Plugin C<memory>
4078 The I<memory plugin> provides the following configuration options:
4082 =item B<ValuesAbsolute> B<true>|B<false>
4084 Enables or disables reporting of physical memory usage in absolute numbers,
4085 i.e. bytes. Defaults to B<true>.
4087 =item B<ValuesPercentage> B<false>|B<true>
4089 Enables or disables reporting of physical memory usage in percentages, e.g.
4090 percent of physical memory used. Defaults to B<false>.
4092 This is useful for deploying I<collectd> in a heterogeneous environment in
4093 which the sizes of physical memory vary.
4097 =head2 Plugin C<modbus>
4099 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4100 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4101 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
4102 values (two registers interpreted as IEEE floats in big endian notation).
4106 <Data "voltage-input-1">
4109 RegisterCmd ReadHolding
4114 <Data "voltage-input-2">
4117 RegisterCmd ReadHolding
4122 <Data "supply-temperature-1">
4125 RegisterCmd ReadHolding
4130 <Host "modbus.example.com">
4131 Address "192.168.0.42"
4136 Instance "power-supply"
4137 Collect "voltage-input-1"
4138 Collect "voltage-input-2"
4143 Device "/dev/ttyUSB0"
4148 Instance "temperature"
4149 Collect "supply-temperature-1"
4155 =item E<lt>B<Data> I<Name>E<gt> blocks
4157 Data blocks define a mapping between register numbers and the "types" used by
4160 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4164 =item B<RegisterBase> I<Number>
4166 Configures the base register to read from the device. If the option
4167 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4168 register will be read (the register number is increased by one).
4170 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
4172 Specifies what kind of data is returned by the device. If the type is B<Int32>,
4173 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
4174 combined into one value. Defaults to B<Uint16>.
4176 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4178 Specifies register type to be collected from device. Works only with libmodbus
4179 2.9.2 or higher. Defaults to B<ReadHolding>.
4181 =item B<Type> I<Type>
4183 Specifies the "type" (data set) to use when dispatching the value to
4184 I<collectd>. Currently, only data sets with exactly one data source are
4187 =item B<Instance> I<Instance>
4189 Sets the type instance to use when dispatching the value to I<collectd>. If
4190 unset, an empty string (no type instance) is used.
4194 =item E<lt>B<Host> I<Name>E<gt> blocks
4196 Host blocks are used to specify to which hosts to connect and what data to read
4197 from their "slaves". The string argument I<Name> is used as hostname when
4198 dispatching the values to I<collectd>.
4200 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4204 =item B<Address> I<Hostname>
4206 For Modbus/TCP, specifies the node name (the actual network address) used to
4207 connect to the host. This may be an IP address or a hostname. Please note that
4208 the used I<libmodbus> library only supports IPv4 at the moment.
4210 =item B<Port> I<Service>
4212 for Modbus/TCP, specifies the port used to connect to the host. The port can
4213 either be given as a number or as a service name. Please note that the
4214 I<Service> argument must be a string, even if ports are given in their numerical
4215 form. Defaults to "502".
4217 =item B<Device> I<Devicenode>
4219 For Modbus/RTU, specifies the path to the serial device being used.
4221 =item B<Baudrate> I<Baudrate>
4223 For Modbus/RTU, specifies the baud rate of the serial device.
4224 Note, connections currently support only 8/N/1.
4226 =item B<Interval> I<Interval>
4228 Sets the interval (in seconds) in which the values will be collected from this
4229 host. By default the global B<Interval> setting will be used.
4231 =item E<lt>B<Slave> I<ID>E<gt>
4233 Over each connection, multiple Modbus devices may be reached. The slave ID
4234 is used to specify which device should be addressed. For each device you want
4235 to query, one B<Slave> block must be given.
4237 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4241 =item B<Instance> I<Instance>
4243 Specify the plugin instance to use when dispatching the values to I<collectd>.
4244 By default "slave_I<ID>" is used.
4246 =item B<Collect> I<DataName>
4248 Specifies which data to retrieve from the device. I<DataName> must be the same
4249 string as the I<Name> argument passed to a B<Data> block. You can specify this
4250 option multiple times to collect more than one value from a slave. At least one
4251 B<Collect> option is mandatory.
4259 =head2 Plugin C<mqtt>
4261 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4262 values from MQTT (B<Subscribe> blocks).
4268 Host "mqtt.example.com"
4272 Host "mqtt.example.com"
4277 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4278 configuring the sending and receiving direction respectively. The plugin will
4279 register a write callback named C<mqtt/I<name>> where I<name> is the string
4280 argument given to the B<Publish> block. Both types of blocks share many but not
4281 all of the following options. If an option is valid in only one of the blocks,
4282 it will be mentioned explicitly.
4288 =item B<Host> I<Hostname>
4290 Hostname of the MQTT broker to connect to.
4292 =item B<Port> I<Service>
4294 Port number or service name of the MQTT broker to connect to.
4296 =item B<User> I<UserName>
4298 Username used when authenticating to the MQTT broker.
4300 =item B<Password> I<Password>
4302 Password used when authenticating to the MQTT broker.
4304 =item B<ClientId> I<ClientId>
4306 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4308 =item B<QoS> [B<0>-B<2>]
4310 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4328 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4329 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4330 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4331 on a message is larger than the maximum accepted QoS of a subscriber, the
4332 message's QoS will be downgraded.
4334 =item B<Prefix> I<Prefix> (Publish only)
4336 This plugin will use one topic per I<value list> which will looks like a path.
4337 I<Prefix> is used as the first path element and defaults to B<collectd>.
4339 An example topic name would be:
4341 collectd/cpu-0/cpu-user
4343 =item B<Retain> B<false>|B<true> (Publish only)
4345 Controls whether the MQTT broker will retain (keep a copy of) the last message
4346 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4348 =item B<StoreRates> B<true>|B<false> (Publish only)
4350 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4351 before sending. Defaults to B<true>.
4353 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4355 Controls whether the MQTT "cleans" the session up after the subscriber
4356 disconnects or if it maintains the subscriber's subscriptions and all messages
4357 that arrive while the subscriber is disconnected. Defaults to B<true>.
4359 =item B<Topic> I<TopicName> (Subscribe only)
4361 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4362 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4363 the B<collectd> branch.
4365 =item B<CACert> I<file>
4367 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4368 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4369 port of the MQTT broker.
4370 This option enables the use of TLS.
4372 =item B<CertificateFile> I<file>
4374 Path to the PEM-encoded certificate file to use as client certificate when
4375 connecting to the MQTT broker.
4376 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4378 =item B<CertificateKeyFile> I<file>
4380 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4381 Only valid if B<CACert> and B<CertificateFile> are also set.
4383 =item B<TLSProtocol> I<protocol>
4385 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4386 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4387 version is used which depends on the version of OpenSSL the Mosquitto library
4389 Only valid if B<CACert> is set.
4391 =item B<CipherSuite> I<ciphersuite>
4393 A string describing the ciphers available for use. See L<ciphers(1)> and the
4394 C<openssl ciphers> utility for more information. If unset, the default ciphers
4396 Only valid if B<CACert> is set.
4400 =head2 Plugin C<mysql>
4402 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4403 one or more databases when started and keeps the connection up as long as
4404 possible. When the connection is interrupted for whatever reason it will try
4405 to re-connect. The plugin will complain loudly in case anything goes wrong.
4407 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4408 and collects information about MySQL network traffic, executed statements,
4409 requests, the query cache and threads by evaluating the
4410 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4411 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4412 Status Variables> for an explanation of these values.
4414 Optionally, master and slave statistics may be collected in a MySQL
4415 replication setup. In that case, information about the synchronization state
4416 of the nodes are collected by evaluating the C<Position> return value of the
4417 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4418 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4419 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4420 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4421 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4433 SSLKey "/path/to/key.pem"
4434 SSLCert "/path/to/cert.pem"
4435 SSLCA "/path/to/ca.pem"
4436 SSLCAPath "/path/to/cas/"
4437 SSLCipher "DHE-RSA-AES256-SHA"
4443 Socket "/var/run/mysql/mysqld.sock"
4445 SlaveNotifications true
4451 Socket "/var/run/mysql/mysqld.sock"
4456 A B<Database> block defines one connection to a MySQL database. It accepts a
4457 single argument which specifies the name of the database. None of the other
4458 options are required. MySQL will use default values as documented in the
4459 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4460 B<MySQL reference manual>.
4464 =item B<Alias> I<Alias>
4466 Alias to use as sender instead of hostname when reporting. This may be useful
4467 when having cryptic hostnames.
4469 =item B<Host> I<Hostname>
4471 Hostname of the database server. Defaults to B<localhost>.
4473 =item B<User> I<Username>
4475 Username to use when connecting to the database. The user does not have to be
4476 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4477 unless you want to collectd replication statistics (see B<MasterStats> and
4478 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4479 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4481 =item B<Password> I<Password>
4483 Password needed to log into the database.
4485 =item B<Database> I<Database>
4487 Select this database. Defaults to I<no database> which is a perfectly reasonable
4488 option for what this plugin does.
4490 =item B<Port> I<Port>
4492 TCP-port to connect to. The port must be specified in its numeric form, but it
4493 must be passed as a string nonetheless. For example:
4497 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4498 See the documentation for the C<mysql_real_connect> function for details.
4500 =item B<Socket> I<Socket>
4502 Specifies the path to the UNIX domain socket of the MySQL server. This option
4503 only has any effect, if B<Host> is set to B<localhost> (the default).
4504 Otherwise, use the B<Port> option above. See the documentation for the
4505 C<mysql_real_connect> function for details.
4507 =item B<InnodbStats> I<true|false>
4509 If enabled, metrics about the InnoDB storage engine are collected.
4510 Disabled by default.
4512 =item B<MasterStats> I<true|false>
4514 =item B<SlaveStats> I<true|false>
4516 Enable the collection of master / slave statistics in a replication setup. In
4517 order to be able to get access to these statistics, the user needs special
4518 privileges. See the B<User> documentation above. Defaults to B<false>.
4520 =item B<SlaveNotifications> I<true|false>
4522 If enabled, the plugin sends a notification if the replication slave I/O and /
4523 or SQL threads are not running. Defaults to B<false>.
4525 =item B<WsrepStats> I<true|false>
4527 Enable the collection of wsrep plugin statistics, used in Master-Master
4528 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4529 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4531 =item B<ConnectTimeout> I<Seconds>
4533 Sets the connect timeout for the MySQL client.
4535 =item B<SSLKey> I<Path>
4537 If provided, the X509 key in PEM format.
4539 =item B<SSLCert> I<Path>
4541 If provided, the X509 cert in PEM format.
4543 =item B<SSLCA> I<Path>
4545 If provided, the CA file in PEM format (check OpenSSL docs).
4547 =item B<SSLCAPath> I<Path>
4549 If provided, the CA directory (check OpenSSL docs).
4551 =item B<SSLCipher> I<String>
4553 If provided, the SSL cipher to use.
4557 =head2 Plugin C<netapp>
4559 The netapp plugin can collect various performance and capacity information
4560 from a NetApp filer using the NetApp API.
4562 Please note that NetApp has a wide line of products and a lot of different
4563 software versions for each of these products. This plugin was developed for a
4564 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4565 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4566 model and software version but it is very hard to test this.
4567 If you have used this plugin with other models and/or software version, feel
4568 free to send us a mail to tell us about the results, even if it's just a short
4571 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4572 basic authentication.
4574 B<Do not use a regular user for this!> Create a special collectd user with just
4575 the minimum of capabilities needed. The user only needs the "login-http-admin"
4576 capability as well as a few more depending on which data will be collected.
4577 Required capabilities are documented below.
4582 <Host "netapp1.example.com">
4606 IgnoreSelectedIO false
4608 IgnoreSelectedOps false
4609 GetLatency "volume0"
4610 IgnoreSelectedLatency false
4617 IgnoreSelectedCapacity false
4620 IgnoreSelectedSnapshot false
4648 The netapp plugin accepts the following configuration options:
4652 =item B<Host> I<Name>
4654 A host block defines one NetApp filer. It will appear in collectd with the name
4655 you specify here which does not have to be its real name nor its hostname (see
4656 the B<Address> option below).
4658 =item B<VFiler> I<Name>
4660 A B<VFiler> block may only be used inside a host block. It accepts all the
4661 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4662 will execute all NetApp API commands in the context of the specified
4663 VFiler(R). It will appear in collectd with the name you specify here which
4664 does not have to be its real name. The VFiler name may be specified using the
4665 B<VFilerName> option. If this is not specified, it will default to the name
4668 The VFiler block inherits all connection related settings from the surrounding
4669 B<Host> block (which appear before the B<VFiler> block) but they may be
4670 overwritten inside the B<VFiler> block.
4672 This feature is useful, for example, when using a VFiler as SnapVault target
4673 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4674 available in the host filer (vfiler0) but only in the respective VFiler
4677 =item B<Protocol> B<httpd>|B<http>
4679 The protocol collectd will use to query this host.
4687 Valid options: http, https
4689 =item B<Address> I<Address>
4691 The hostname or IP address of the host.
4697 Default: The "host" block's name.
4699 =item B<Port> I<Port>
4701 The TCP port to connect to on the host.
4707 Default: 80 for protocol "http", 443 for protocol "https"
4709 =item B<User> I<User>
4711 =item B<Password> I<Password>
4713 The username and password to use to login to the NetApp.
4719 =item B<VFilerName> I<Name>
4721 The name of the VFiler in which context to execute API commands. If not
4722 specified, the name provided to the B<VFiler> block will be used instead.
4728 Default: name of the B<VFiler> block
4730 B<Note:> This option may only be used inside B<VFiler> blocks.
4732 =item B<Interval> I<Interval>
4738 The following options decide what kind of data will be collected. You can
4739 either use them as a block and fine tune various parameters inside this block,
4740 use them as a single statement to just accept all default values, or omit it to
4741 not collect any data.
4743 The following options are valid inside all blocks:
4747 =item B<Interval> I<Seconds>
4749 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4750 host specific setting.
4754 =head3 The System block
4756 This will collect various performance data about the whole system.
4758 B<Note:> To get this data the collectd user needs the
4759 "api-perf-object-get-instances" capability.
4763 =item B<Interval> I<Seconds>
4765 Collect disk statistics every I<Seconds> seconds.
4767 =item B<GetCPULoad> B<true>|B<false>
4769 If you set this option to true the current CPU usage will be read. This will be
4770 the average usage between all CPUs in your NetApp without any information about
4773 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4774 returns in the "CPU" field.
4782 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4784 =item B<GetInterfaces> B<true>|B<false>
4786 If you set this option to true the current traffic of the network interfaces
4787 will be read. This will be the total traffic over all interfaces of your NetApp
4788 without any information about individual interfaces.
4790 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4791 in the "Net kB/s" field.
4801 Result: One value list of type "if_octects".
4803 =item B<GetDiskIO> B<true>|B<false>
4805 If you set this option to true the current IO throughput will be read. This
4806 will be the total IO of your NetApp without any information about individual
4807 disks, volumes or aggregates.
4809 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4810 in the "DiskE<nbsp>kB/s" field.
4818 Result: One value list of type "disk_octets".
4820 =item B<GetDiskOps> B<true>|B<false>
4822 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4823 iSCSI, etc. operations will be read. This will be the total number of
4824 operations on your NetApp without any information about individual volumes or
4827 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4828 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4836 Result: A variable number of value lists of type "disk_ops_complex". Each type
4837 of operation will result in one value list with the name of the operation as
4842 =head3 The WAFL block
4844 This will collect various performance data about the WAFL file system. At the
4845 moment this just means cache performance.
4847 B<Note:> To get this data the collectd user needs the
4848 "api-perf-object-get-instances" capability.
4850 B<Note:> The interface to get these values is classified as "Diagnostics" by
4851 NetApp. This means that it is not guaranteed to be stable even between minor
4856 =item B<Interval> I<Seconds>
4858 Collect disk statistics every I<Seconds> seconds.
4860 =item B<GetNameCache> B<true>|B<false>
4868 Result: One value list of type "cache_ratio" and type instance
4871 =item B<GetDirCache> B<true>|B<false>
4879 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4881 =item B<GetInodeCache> B<true>|B<false>
4889 Result: One value list of type "cache_ratio" and type instance
4892 =item B<GetBufferCache> B<true>|B<false>
4894 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4895 in the "Cache hit" field.
4903 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4907 =head3 The Disks block
4909 This will collect performance data about the individual disks in the NetApp.
4911 B<Note:> To get this data the collectd user needs the
4912 "api-perf-object-get-instances" capability.
4916 =item B<Interval> I<Seconds>
4918 Collect disk statistics every I<Seconds> seconds.
4920 =item B<GetBusy> B<true>|B<false>
4922 If you set this option to true the busy time of all disks will be calculated
4923 and the value of the busiest disk in the system will be written.
4925 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4926 in the "Disk util" field. Probably.
4934 Result: One value list of type "percent" and type instance "disk_busy".
4938 =head3 The VolumePerf block
4940 This will collect various performance data about the individual volumes.
4942 You can select which data to collect about which volume using the following
4943 options. They follow the standard ignorelist semantic.
4945 B<Note:> To get this data the collectd user needs the
4946 I<api-perf-object-get-instances> capability.
4950 =item B<Interval> I<Seconds>
4952 Collect volume performance data every I<Seconds> seconds.
4954 =item B<GetIO> I<Volume>
4956 =item B<GetOps> I<Volume>
4958 =item B<GetLatency> I<Volume>
4960 Select the given volume for IO, operations or latency statistics collection.
4961 The argument is the name of the volume without the C</vol/> prefix.
4963 Since the standard ignorelist functionality is used here, you can use a string
4964 starting and ending with a slash to specify regular expression matching: To
4965 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4968 GetIO "/^vol[027]$/"
4970 If no regular expression is specified, an exact match is required. Both,
4971 regular and exact matching are case sensitive.
4973 If no volume was specified at all for either of the three options, that data
4974 will be collected for all available volumes.
4976 See F</"IGNORELISTS"> for details.
4978 =item B<IgnoreSelectedIO> B<true>|B<false>
4980 =item B<IgnoreSelectedOps> B<true>|B<false>
4982 =item B<IgnoreSelectedLatency> B<true>|B<false>
4984 When set to B<true>, the volumes selected for IO, operations or latency
4985 statistics collection will be ignored and the data will be collected for all
4988 When set to B<false>, data will only be collected for the specified volumes and
4989 all other volumes will be ignored.
4991 If no volumes have been specified with the above B<Get*> options, all volumes
4992 will be collected regardless of the B<IgnoreSelected*> option.
4994 Defaults to B<false>
4998 =head3 The VolumeUsage block
5000 This will collect capacity data about the individual volumes.
5002 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5007 =item B<Interval> I<Seconds>
5009 Collect volume usage statistics every I<Seconds> seconds.
5011 =item B<GetCapacity> I<VolumeName>
5013 The current capacity of the volume will be collected. This will result in two
5014 to four value lists, depending on the configuration of the volume. All data
5015 sources are of type "df_complex" with the name of the volume as
5018 There will be type_instances "used" and "free" for the number of used and
5019 available bytes on the volume. If the volume has some space reserved for
5020 snapshots, a type_instance "snap_reserved" will be available. If the volume
5021 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5022 number of bytes saved by the SIS feature.
5024 B<Note:> The current NetApp API has a bug that results in this value being
5025 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5026 number which works most of the time. If you see strange values here, bug
5027 NetApp support to fix this.
5029 Repeat this option to specify multiple volumes.
5031 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5033 Specify whether to collect only the volumes selected by the B<GetCapacity>
5034 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5035 B<false>. However, if no B<GetCapacity> option is specified at all, all
5036 capacities will be selected anyway.
5038 =item B<GetSnapshot> I<VolumeName>
5040 Select volumes from which to collect snapshot information.
5042 Usually, the space used for snapshots is included in the space reported as
5043 "used". If snapshot information is collected as well, the space used for
5044 snapshots is subtracted from the used space.
5046 To make things even more interesting, it is possible to reserve space to be
5047 used for snapshots. If the space required for snapshots is less than that
5048 reserved space, there is "reserved free" and "reserved used" space in addition
5049 to "free" and "used". If the space required for snapshots exceeds the reserved
5050 space, that part allocated in the normal space is subtracted from the "used"
5053 Repeat this option to specify multiple volumes.
5055 =item B<IgnoreSelectedSnapshot>
5057 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5058 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5059 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5060 capacities will be selected anyway.
5064 =head3 The Quota block
5066 This will collect (tree) quota statistics (used disk space and number of used
5067 files). This mechanism is useful to get usage information for single qtrees.
5068 In case the quotas are not used for any other purpose, an entry similar to the
5069 following in C</etc/quotas> would be sufficient:
5071 /vol/volA/some_qtree tree - - - - -
5073 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5077 =item B<Interval> I<Seconds>
5079 Collect SnapVault(R) statistics every I<Seconds> seconds.
5083 =head3 The SnapVault block
5085 This will collect statistics about the time and traffic of SnapVault(R)
5090 =item B<Interval> I<Seconds>
5092 Collect SnapVault(R) statistics every I<Seconds> seconds.
5096 =head2 Plugin C<netlink>
5098 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5099 statistics of various interface and routing aspects.
5103 =item B<Interface> I<Interface>
5105 =item B<VerboseInterface> I<Interface>
5107 Instruct the plugin to collect interface statistics. This is basically the same
5108 as the statistics provided by the C<interface> plugin (see above) but
5109 potentially much more detailed.
5111 When configuring with B<Interface> only the basic statistics will be collected,
5112 namely octets, packets, and errors. These statistics are collected by
5113 the C<interface> plugin, too, so using both at the same time is no benefit.
5115 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5116 so that no data needs to be collected twice if you use the C<interface> plugin.
5117 This includes dropped packets, received multicast packets, collisions and a
5118 whole zoo of differentiated RX and TX errors. You can try the following command
5119 to get an idea of what awaits you:
5123 If I<Interface> is B<All>, all interfaces will be selected.
5125 =item B<QDisc> I<Interface> [I<QDisc>]
5127 =item B<Class> I<Interface> [I<Class>]
5129 =item B<Filter> I<Interface> [I<Filter>]
5131 Collect the octets and packets that pass a certain qdisc, class or filter.
5133 QDiscs and classes are identified by their type and handle (or classid).
5134 Filters don't necessarily have a handle, therefore the parent's handle is used.
5135 The notation used in collectd differs from that used in tc(1) in that it
5136 doesn't skip the major or minor number if it's zero and doesn't print special
5137 ids by their name. So, for example, a qdisc may be identified by
5138 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5139 thus not displayed by tc(1).
5141 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5142 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5143 associated with that interface will be collected.
5145 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5146 used. This may lead to problems when more than one filter is attached to a
5147 qdisc or class. This isn't nice, but we don't know how this could be done any
5148 better. If you have a idea, please don't hesitate to tell us.
5150 As with the B<Interface> option you can specify B<All> as the interface,
5151 meaning all interfaces.
5153 Here are some examples to help you understand the above text more easily:
5156 VerboseInterface "All"
5157 QDisc "eth0" "pfifo_fast-1:0"
5159 Class "ppp0" "htb-1:10"
5160 Filter "ppp0" "u32-1:0"
5163 See F</"IGNORELISTS"> for details.
5165 =item B<IgnoreSelected>
5167 The behavior is the same as with all other similar plugins: If nothing is
5168 selected at all, everything is collected. If some things are selected using the
5169 options described above, only these statistics are collected. If you set
5170 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5171 specified statistics will not be collected.
5175 =head2 Plugin C<network>
5177 The Network plugin sends data to a remote instance of collectd, receives data
5178 from a remote instance, or both at the same time. Data which has been received
5179 from the network is usually not transmitted again, but this can be activated, see
5180 the B<Forward> option below.
5182 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5183 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5185 Both, B<Server> and B<Listen> can be used as single option or as block. When
5186 used as block, given options are valid for this socket only. The following
5187 example will export the metrics twice: Once to an "internal" server (without
5188 encryption and signing) and one to an external server (with cryptographic
5192 # Export to an internal server
5193 # (demonstrates usage without additional options)
5194 Server "collectd.internal.tld"
5196 # Export to an external server
5197 # (demonstrates usage with signature options)
5198 <Server "collectd.external.tld">
5199 SecurityLevel "sign"
5200 Username "myhostname"
5207 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5209 The B<Server> statement/block sets the server to send datagrams to. The
5210 statement may occur multiple times to send each datagram to multiple
5213 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5214 optional second argument specifies a port number or a service name. If not
5215 given, the default, B<25826>, is used.
5217 The following options are recognized within B<Server> blocks:
5221 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5223 Set the security you require for network communication. When the security level
5224 has been set to B<Encrypt>, data sent over the network will be encrypted using
5225 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5226 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5227 authentication code. When set to B<None>, data is sent without any security.
5229 This feature is only available if the I<network> plugin was linked with
5232 =item B<Username> I<Username>
5234 Sets the username to transmit. This is used by the server to lookup the
5235 password. See B<AuthFile> below. All security levels except B<None> require
5238 This feature is only available if the I<network> plugin was linked with
5241 =item B<Password> I<Password>
5243 Sets a password (shared secret) for this socket. All security levels except
5244 B<None> require this setting.
5246 This feature is only available if the I<network> plugin was linked with
5249 =item B<Interface> I<Interface name>
5251 Set the outgoing interface for IP packets. This applies at least
5252 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5253 undefined or a non-existent interface name is specified, the default
5254 behavior is to let the kernel choose the appropriate interface. Be warned
5255 that the manual selection of an interface for unicast traffic is only
5256 necessary in rare cases.
5258 =item B<ResolveInterval> I<Seconds>
5260 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5261 useful to force a regular DNS lookup to support a high availability setup. If
5262 not specified, re-resolves are never attempted.
5266 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5268 The B<Listen> statement sets the interfaces to bind to. When multiple
5269 statements are found the daemon will bind to multiple interfaces.
5271 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5272 the argument is a multicast address the daemon will join that multicast group.
5273 The optional second argument specifies a port number or a service name. If not
5274 given, the default, B<25826>, is used.
5276 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5280 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5282 Set the security you require for network communication. When the security level
5283 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5284 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5285 signed and encrypted data is accepted. When set to B<None>, all data will be
5286 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5287 decrypted if possible.
5289 This feature is only available if the I<network> plugin was linked with
5292 =item B<AuthFile> I<Filename>
5294 Sets a file in which usernames are mapped to passwords. These passwords are
5295 used to verify signatures and to decrypt encrypted network packets. If
5296 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5297 verified and encrypted packets are decrypted. Otherwise, signed data is
5298 accepted without checking the signature and encrypted data cannot be decrypted.
5299 For the other security levels this option is mandatory.
5301 The file format is very simple: Each line consists of a username followed by a
5302 colon and any number of spaces followed by the password. To demonstrate, an
5303 example file could look like this:
5308 Each time a packet is received, the modification time of the file is checked
5309 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5310 the file is being read, it is locked using L<fcntl(2)>.
5312 =item B<Interface> I<Interface name>
5314 Set the incoming interface for IP packets explicitly. This applies at least
5315 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5316 undefined or a non-existent interface name is specified, the default
5317 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5318 traffic gets only accepted, if it arrives on the given interface.
5322 =item B<TimeToLive> I<1-255>
5324 Set the time-to-live of sent packets. This applies to all, unicast and
5325 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5326 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5329 =item B<MaxPacketSize> I<1024-65535>
5331 Set the maximum size for datagrams received over the network. Packets larger
5332 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5333 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5336 On the server side, this limit should be set to the largest value used on
5337 I<any> client. Likewise, the value on the client must not be larger than the
5338 value on the server, or data will be lost.
5340 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5341 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5342 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5345 =item B<Forward> I<true|false>
5347 If set to I<true>, write packets that were received via the network plugin to
5348 the sending sockets. This should only be activated when the B<Listen>- and
5349 B<Server>-statements differ. Otherwise packets may be send multiple times to
5350 the same multicast group. While this results in more network traffic than
5351 necessary it's not a huge problem since the plugin has a duplicate detection,
5352 so the values will not loop.
5354 =item B<ReportStats> B<true>|B<false>
5356 The network plugin cannot only receive and send statistics, it can also create
5357 statistics about itself. Collectd data included the number of received and
5358 sent octets and packets, the length of the receive queue and the number of
5359 values handled. When set to B<true>, the I<Network plugin> will make these
5360 statistics available. Defaults to B<false>.
5364 =head2 Plugin C<nfs>
5366 The I<nfs plugin> collects information about the usage of the Network File
5367 System (NFS). It counts the number of procedure calls for each procedure,
5368 grouped by version and whether the system runs as server or client.
5370 It is possibly to omit metrics for a specific NFS version by setting one or
5371 more of the following options to B<false> (all of them default to B<true>).
5375 =item B<ReportV2> B<true>|B<false>
5377 =item B<ReportV3> B<true>|B<false>
5379 =item B<ReportV4> B<true>|B<false>
5383 =head2 Plugin C<nginx>
5385 This plugin collects the number of connections and requests handled by the
5386 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5387 queries the page provided by the C<ngx_http_stub_status_module> module, which
5388 isn't compiled by default. Please refer to
5389 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5390 how to compile and configure nginx and this module.
5392 The following options are accepted by the C<nginx plugin>:
5396 =item B<URL> I<http://host/nginx_status>
5398 Sets the URL of the C<ngx_http_stub_status_module> output.
5400 =item B<User> I<Username>
5402 Optional user name needed for authentication.
5404 =item B<Password> I<Password>
5406 Optional password needed for authentication.
5408 =item B<VerifyPeer> B<true|false>
5410 Enable or disable peer SSL certificate verification. See
5411 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5413 =item B<VerifyHost> B<true|false>
5415 Enable or disable peer host name verification. If enabled, the plugin checks
5416 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5417 certificate matches the host name provided by the B<URL> option. If this
5418 identity check fails, the connection is aborted. Obviously, only works when
5419 connecting to a SSL enabled server. Enabled by default.
5421 =item B<CACert> I<File>
5423 File that holds one or more SSL certificates. If you want to use HTTPS you will
5424 possibly need this option. What CA certificates come bundled with C<libcurl>
5425 and are checked by default depends on the distribution you use.
5427 =item B<Timeout> I<Milliseconds>
5429 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5430 milliseconds. By default, the configured B<Interval> is used to set the
5435 =head2 Plugin C<notify_desktop>
5437 This plugin sends a desktop notification to a notification daemon, as defined
5438 in the Desktop Notification Specification. To actually display the
5439 notifications, B<notification-daemon> is required and B<collectd> has to be
5440 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5441 environment variables have to be set correctly) and the D-Bus message bus.
5443 The Desktop Notification Specification can be found at
5444 L<http://www.galago-project.org/specs/notification/>.
5448 =item B<OkayTimeout> I<timeout>
5450 =item B<WarningTimeout> I<timeout>
5452 =item B<FailureTimeout> I<timeout>
5454 Set the I<timeout>, in milliseconds, after which to expire the notification
5455 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5456 been specified, the displayed notification will not be closed at all - the
5457 user has to do so herself. These options default to 5000. If a negative number
5458 has been specified, the default is used as well.
5462 =head2 Plugin C<notify_email>
5464 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5465 configured email address.
5467 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5469 Available configuration options:
5473 =item B<From> I<Address>
5475 Email address from which the emails should appear to come from.
5477 Default: C<root@localhost>
5479 =item B<Recipient> I<Address>
5481 Configures the email address(es) to which the notifications should be mailed.
5482 May be repeated to send notifications to multiple addresses.
5484 At least one B<Recipient> must be present for the plugin to work correctly.
5486 =item B<SMTPServer> I<Hostname>
5488 Hostname of the SMTP server to connect to.
5490 Default: C<localhost>
5492 =item B<SMTPPort> I<Port>
5494 TCP port to connect to.
5498 =item B<SMTPUser> I<Username>
5500 Username for ASMTP authentication. Optional.
5502 =item B<SMTPPassword> I<Password>
5504 Password for ASMTP authentication. Optional.
5506 =item B<Subject> I<Subject>
5508 Subject-template to use when sending emails. There must be exactly two
5509 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5510 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5513 Default: C<Collectd notify: %s@%s>
5517 =head2 Plugin C<notify_nagios>
5519 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5520 a I<passive service check result>.
5522 Available configuration options:
5526 =item B<CommandFile> I<Path>
5528 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5532 =head2 Plugin C<ntpd>
5534 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5537 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5538 the wire - using B<mode 7> specific requests. This mode is deprecated with
5539 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5540 correctly with them, the ntp daemon must be explicitly configured to
5541 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5542 manual page for details.
5544 Available configuration options for the C<ntpd> plugin:
5548 =item B<Host> I<Hostname>
5550 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5552 =item B<Port> I<Port>
5554 UDP-Port to connect to. Defaults to B<123>.
5556 =item B<ReverseLookups> B<true>|B<false>
5558 Sets whether or not to perform reverse lookups on peers. Since the name or
5559 IP-address may be used in a filename it is recommended to disable reverse
5560 lookups. The default is to do reverse lookups to preserve backwards
5561 compatibility, though.
5563 =item B<IncludeUnitID> B<true>|B<false>
5565 When a peer is a refclock, include the unit ID in the I<type instance>.
5566 Defaults to B<false> for backward compatibility.
5568 If two refclock peers use the same driver and this is B<false>, the plugin will
5569 try to write simultaneous measurements from both to the same type instance.
5570 This will result in error messages in the log and only one set of measurements
5575 =head2 Plugin C<nut>
5579 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5581 Add a UPS to collect data from. The format is identical to the one accepted by
5584 =item B<ForceSSL> B<true>|B<false>
5586 Stops connections from falling back to unsecured if an SSL connection
5587 cannot be established. Defaults to false if undeclared.
5589 =item B<VerifyPeer> I<true>|I<false>
5591 If set to true, requires a CAPath be provided. Will use the CAPath to find
5592 certificates to use as Trusted Certificates to validate a upsd server certificate.
5593 If validation of the upsd server certificate fails, the connection will not be
5594 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5595 will override and set ForceSSL to true.
5597 =item B<CAPath> I/path/to/certs/folder
5599 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5600 The folder pointed at must contain certificate(s) named according to their hash.
5601 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5602 occur because two different certs have the same hash value, Y can be incremented
5603 in order to avoid conflict. To create a symbolic link to a certificate the following
5604 command can be used from within the directory where the cert resides:
5606 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5608 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5609 generate links like the one described above for ALL certs in a given folder.
5611 C<c_rehash /path/to/certs/folder>
5613 =item B<ConnectTimeout> I<Milliseconds>
5615 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5616 By default, the configured B<Interval> is used to set the timeout.
5620 =head2 Plugin C<olsrd>
5622 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5623 the Optimized Link State Routing daemon and reads information about the current
5624 state of the meshed network.
5626 The following configuration options are understood:
5630 =item B<Host> I<Host>
5632 Connect to I<Host>. Defaults to B<"localhost">.
5634 =item B<Port> I<Port>
5636 Specifies the port to connect to. This must be a string, even if you give the
5637 port as a number rather than a service name. Defaults to B<"2006">.
5639 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5641 Specifies what information to collect about links, i.E<nbsp>e. direct
5642 connections of the daemon queried. If set to B<No>, no information is
5643 collected. If set to B<Summary>, the number of links and the average of all
5644 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5645 If set to B<Detail> LQ and NLQ are collected per link.
5647 Defaults to B<Detail>.
5649 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5651 Specifies what information to collect about routes of the daemon queried. If
5652 set to B<No>, no information is collected. If set to B<Summary>, the number of
5653 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5654 metric and ETX are collected per route.
5656 Defaults to B<Summary>.
5658 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5660 Specifies what information to collect about the global topology. If set to
5661 B<No>, no information is collected. If set to B<Summary>, the number of links
5662 in the entire topology and the average I<link quality> (LQ) is calculated.
5663 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5665 Defaults to B<Summary>.
5669 =head2 Plugin C<onewire>
5671 B<EXPERIMENTAL!> See notes below.
5673 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5674 L<http://owfs.org/> to read sensors connected via the onewire bus.
5676 It can be used in two possible modes - standard or advanced.
5678 In the standard mode only temperature sensors (sensors with the family code
5679 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5680 other sensors you would like to have included, please send a sort request to
5681 the mailing list. You can select sensors to be read or to be ignored depending
5682 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5683 walked and all sensors are read.
5685 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5686 experimental, below.
5688 In the advanced mode you can configure any sensor to be read (only numerical
5689 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5690 In this mode you have to list all the sensors. Neither default bus walk nor
5691 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5692 the path automatically and should produce compatible structure with the "standard"
5693 mode (basically the path is expected as for example
5694 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5695 "F10FCA000800" and the rest after the slash is considered the type - here
5697 There are two advantages to this mode - you can access virtually any sensor
5698 (not just temperature), select whether to use cached or directly read values
5699 and it is slighlty faster. The downside is more complex configuration.
5701 The two modes are distinguished automatically by the format of the address.
5702 It is not possible to mix the two modes. Once a full path is detected in any
5703 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5704 (and as standard addresses will fail parsing they will be ignored).
5708 =item B<Device> I<Device>
5710 Sets the device to read the values from. This can either be a "real" hardware
5711 device, such as a serial port or an USB port, or the address of the
5712 L<owserver(1)> socket, usually B<localhost:4304>.
5714 Though the documentation claims to automatically recognize the given address
5715 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5716 with that version, the following configuration worked for us:
5719 Device "-s localhost:4304"
5722 This directive is B<required> and does not have a default value.
5724 =item B<Sensor> I<Sensor>
5726 In the standard mode selects sensors to collect or to ignore
5727 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5728 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5729 and B<not> include the leading C<10.> family byte and point.
5730 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5731 sensors (see above) are read.
5733 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5734 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5735 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5737 As there can be multiple devices on the bus you can list multiple sensor (use
5738 multiple B<Sensor> elements).
5740 See F</"IGNORELISTS"> for details.
5742 =item B<IgnoreSelected> I<true>|I<false>
5744 If no configuration is given, the B<onewire> plugin will collect data from all
5745 sensors found. This may not be practical, especially if sensors are added and
5746 removed regularly. Sometimes, however, it's easier/preferred to collect only
5747 specific sensors or all sensors I<except> a few specified ones. This option
5748 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5749 B<Sensor> is inverted: All selected interfaces are ignored and all other
5750 interfaces are collected.
5752 Used only in the standard mode - see above.
5754 =item B<Interval> I<Seconds>
5756 Sets the interval in which all sensors should be read. If not specified, the
5757 global B<Interval> setting is used.
5761 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5762 work with big setups. It works with one sensor being attached to one
5763 controller, but as soon as you throw in a couple more senors and maybe a hub
5764 or two, reading all values will take more than ten seconds (the default
5765 interval). We will probably add some separate thread for reading the sensors
5766 and some cache or something like that, but it's not done yet. We will try to
5767 maintain backwards compatibility in the future, but we can't promise. So in
5768 short: If it works for you: Great! But keep in mind that the config I<might>
5769 change, though this is unlikely. Oh, and if you want to help improving this
5770 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5772 =head2 Plugin C<openldap>
5774 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5775 server correctly. The backend database C<monitor> needs to be loaded and
5776 working. See slapd-monitor(5) for the details.
5778 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5779 blocks. Each block requires one string argument as the instance name. For
5784 URL "ldap://localhost/"
5787 URL "ldaps://localhost/"
5791 The instance name will be used as the I<plugin instance>. To emulate the old
5792 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5793 plugin to work correctly, each instance name must be unique. This is not
5794 enforced by the plugin and it is your responsibility to ensure it is.
5796 The following options are accepted within each B<Instance> block:
5800 =item B<URL> I<ldap://host/binddn>
5802 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5805 =item B<BindDN> I<BindDN>
5807 Name in the form of an LDAP distinguished name intended to be used for
5808 authentication. Defaults to empty string to establish an anonymous authorization.
5810 =item B<Password> I<Password>
5812 Password for simple bind authentication. If this option is not set,
5813 unauthenticated bind operation is used.
5815 =item B<StartTLS> B<true|false>
5817 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5818 Disabled by default.
5820 =item B<VerifyHost> B<true|false>
5822 Enables or disables peer host name verification. If enabled, the plugin checks
5823 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5824 certificate matches the host name provided by the B<URL> option. If this
5825 identity check fails, the connection is aborted. Enabled by default.
5827 =item B<CACert> I<File>
5829 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5830 may possibly need this option. What CA certificates are checked by default
5831 depends on the distribution you use and can be changed with the usual ldap
5832 client configuration mechanisms. See ldap.conf(5) for the details.
5834 =item B<Timeout> I<Seconds>
5836 Sets the timeout value for ldap operations, in seconds. By default, the
5837 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5840 =item B<Version> I<Version>
5842 An integer which sets the LDAP protocol version number to use when connecting
5843 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5847 =head2 Plugin C<openvpn>
5849 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5850 traffic statistics about connected clients.
5852 To set up OpenVPN to write to the status file periodically, use the
5853 B<--status> option of OpenVPN.
5855 So, in a nutshell you need:
5857 openvpn $OTHER_OPTIONS \
5858 --status "/var/run/openvpn-status" 10
5864 =item B<StatusFile> I<File>
5866 Specifies the location of the status file.
5868 =item B<ImprovedNamingSchema> B<true>|B<false>
5870 When enabled, the filename of the status file will be used as plugin instance
5871 and the client's "common name" will be used as type instance. This is required
5872 when reading multiple status files. Enabling this option is recommended, but to
5873 maintain backwards compatibility this option is disabled by default.
5875 =item B<CollectCompression> B<true>|B<false>
5877 Sets whether or not statistics about the compression used by OpenVPN should be
5878 collected. This information is only available in I<single> mode. Enabled by
5881 =item B<CollectIndividualUsers> B<true>|B<false>
5883 Sets whether or not traffic information is collected for each connected client
5884 individually. If set to false, currently no traffic data is collected at all
5885 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5887 =item B<CollectUserCount> B<true>|B<false>
5889 When enabled, the number of currently connected clients or users is collected.
5890 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5891 can be configured independently from that option. Defaults to B<false>.
5895 =head2 Plugin C<oracle>
5897 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5898 Oracle® Database and lets you execute SQL statements there. It is very similar
5899 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5900 plugin's documentation above for details.
5903 <Query "out_of_stock">
5904 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5907 # InstancePrefix "foo"
5908 InstancesFrom "category"
5912 <Database "product_information">
5917 Query "out_of_stock"
5921 =head3 B<Query> blocks
5923 The Query blocks are handled identically to the Query blocks of the "dbi"
5924 plugin. Please see its documentation above for details on how to specify
5927 =head3 B<Database> blocks
5929 Database blocks define a connection to a database and which queries should be
5930 sent to that database. Each database needs a "name" as string argument in the
5931 starting tag of the block. This name will be used as "PluginInstance" in the
5932 values submitted to the daemon. Other than that, that name is not used.
5936 =item B<Plugin> I<Plugin>
5938 Use I<Plugin> as the plugin name when submitting query results from
5939 this B<Database>. Defaults to C<oracle>.
5941 =item B<ConnectID> I<ID>
5943 Defines the "database alias" or "service name" to connect to. Usually, these
5944 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5946 =item B<Host> I<Host>
5948 Hostname to use when dispatching values for this database. Defaults to using
5949 the global hostname of the I<collectd> instance.
5951 =item B<Username> I<Username>
5953 Username used for authentication.
5955 =item B<Password> I<Password>
5957 Password used for authentication.
5959 =item B<Query> I<QueryName>
5961 Associates the query named I<QueryName> with this database connection. The
5962 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5963 blocks you want to refer to must be placed above the database block you want to
5968 =head2 Plugin C<ovs_events>
5970 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5971 connected interfaces, dispatches the values to collectd and sends the
5972 notification whenever the link state change occurs. This plugin uses OVS
5973 database to get a link state change notification.
5977 <Plugin "ovs_events">
5980 Socket "/var/run/openvswitch/db.sock"
5981 Interfaces "br0" "veth0"
5982 SendNotification true
5983 DispatchValues false
5986 The plugin provides the following configuration options:
5990 =item B<Address> I<node>
5992 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5993 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5994 option. See L<ovsdb-server(1)> for more details. The option may be either
5995 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5996 format. Defaults to C<localhost>.
5998 =item B<Port> I<service>
6000 TCP-port to connect to. Either a service name or a port number may be given.
6001 Defaults to B<6640>.
6003 =item B<Socket> I<path>
6005 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6006 plugin. To enable the interface, the OVS DB daemon should be running with
6007 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6008 option is set, B<Address> and B<Port> options are ignored.
6010 =item B<Interfaces> [I<ifname> ...]
6012 List of interface names to be monitored by this plugin. If this option is not
6013 specified or is empty then all OVS connected interfaces on all bridges are
6016 Default: empty (all interfaces on all bridges are monitored)
6018 =item B<SendNotification> I<true|false>
6020 If set to true, OVS link notifications (interface status and OVS DB connection
6021 terminate) are sent to collectd. Default value is true.
6023 =item B<DispatchValues> I<true|false>
6025 Dispatch the OVS DB interface link status value with configured plugin interval.
6026 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6027 options are false, no OVS information will be provided by the plugin.
6031 B<Note:> By default, the global interval setting is used within which to
6032 retrieve the OVS link status. To configure a plugin-specific interval, please
6033 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6034 simple divide the time by 1000 for example if the desired interval is 50ms, set
6037 =head2 Plugin C<ovs_stats>
6039 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6040 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6041 statistics from OVSDB
6045 <Plugin "ovs_stats">
6048 Socket "/var/run/openvswitch/db.sock"
6049 Bridges "br0" "br_ext"
6052 The plugin provides the following configuration options:
6056 =item B<Address> I<node>
6058 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6059 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6060 option. See L<ovsdb-server(1)> for more details. The option may be either
6061 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6062 format. Defaults to C<localhost>.
6064 =item B<Port> I<service>
6066 TCP-port to connect to. Either a service name or a port number may be given.
6067 Defaults to B<6640>.
6069 =item B<Socket> I<path>
6071 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6072 plugin. To enable the interface, the OVS DB daemon should be running with
6073 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6074 option is set, B<Address> and B<Port> options are ignored.
6076 =item B<Bridges> [I<brname> ...]
6078 List of OVS bridge names to be monitored by this plugin. If this option is
6079 omitted or is empty then all OVS bridges will be monitored.
6081 Default: empty (monitor all bridges)
6085 =head2 Plugin C<perl>
6087 This plugin embeds a Perl-interpreter into collectd and provides an interface
6088 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6090 =head2 Plugin C<pinba>
6092 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6093 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6094 PHP-based webpage has been delivered, the extension will send a UDP packet
6095 containing timing information, peak memory usage and so on. The plugin will
6096 wait for such packets, parse them and account the provided information, which
6097 is then dispatched to the daemon once per interval.
6104 # Overall statistics for the website.
6106 Server "www.example.com"
6108 # Statistics for www-a only
6110 Host "www-a.example.com"
6111 Server "www.example.com"
6113 # Statistics for www-b only
6115 Host "www-b.example.com"
6116 Server "www.example.com"
6120 The plugin provides the following configuration options:
6124 =item B<Address> I<Node>
6126 Configures the address used to open a listening socket. By default, plugin will
6127 bind to the I<any> address C<::0>.
6129 =item B<Port> I<Service>
6131 Configures the port (service) to bind to. By default the default Pinba port
6132 "30002" will be used. The option accepts service names in addition to port
6133 numbers and thus requires a I<string> argument.
6135 =item E<lt>B<View> I<Name>E<gt> block
6137 The packets sent by the Pinba extension include the hostname of the server, the
6138 server name (the name of the virtual host) and the script that was executed.
6139 Using B<View> blocks it is possible to separate the data into multiple groups
6140 to get more meaningful statistics. Each packet is added to all matching groups,
6141 so that a packet may be accounted for more than once.
6145 =item B<Host> I<Host>
6147 Matches the hostname of the system the webserver / script is running on. This
6148 will contain the result of the L<gethostname(2)> system call. If not
6149 configured, all hostnames will be accepted.
6151 =item B<Server> I<Server>
6153 Matches the name of the I<virtual host>, i.e. the contents of the
6154 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6155 server names will be accepted.
6157 =item B<Script> I<Script>
6159 Matches the name of the I<script name>, i.e. the contents of the
6160 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6161 script names will be accepted.
6167 =head2 Plugin C<ping>
6169 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6170 configured hosts periodically and measures the network latency. Whenever the
6171 C<read> function of the plugin is called, it submits the average latency, the
6172 standard deviation and the drop rate for each host.
6174 Available configuration options:
6178 =item B<Host> I<IP-address>
6180 Host to ping periodically. This option may be repeated several times to ping
6183 =item B<Interval> I<Seconds>
6185 Sets the interval in which to send ICMP echo packets to the configured hosts.
6186 This is B<not> the interval in which metrics are read from the plugin but the
6187 interval in which the hosts are "pinged". Therefore, the setting here should be
6188 smaller than or equal to the global B<Interval> setting. Fractional times, such
6189 as "1.24" are allowed.
6193 =item B<Timeout> I<Seconds>
6195 Time to wait for a response from the host to which an ICMP packet had been
6196 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6197 to be down or the packet to be dropped. This setting must be smaller than the
6198 B<Interval> setting above for the plugin to work correctly. Fractional
6199 arguments are accepted.
6203 =item B<TTL> I<0-255>
6205 Sets the Time-To-Live of generated ICMP packets.
6207 =item B<Size> I<size>
6209 Sets the size of the data payload in ICMP packet to specified I<size> (it
6210 will be filled with regular ASCII pattern). If not set, default 56 byte
6211 long string is used so that the packet size of an ICMPv4 packet is exactly
6212 64 bytes, similar to the behaviour of normal ping(1) command.
6214 =item B<SourceAddress> I<host>
6216 Sets the source address to use. I<host> may either be a numerical network
6217 address or a network hostname.
6219 =item B<Device> I<name>
6221 Sets the outgoing network device to be used. I<name> has to specify an
6222 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6225 =item B<MaxMissed> I<Packets>
6227 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6228 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6230 Default: B<-1> (disabled)
6234 =head2 Plugin C<postgresql>
6236 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6237 keeps a persistent connection to all configured databases and tries to
6238 reconnect if the connection has been interrupted. A database is configured by
6239 specifying a B<Database> block as described below. The default statistics are
6240 collected from PostgreSQL's B<statistics collector> which thus has to be
6241 enabled for this plugin to work correctly. This should usually be the case by
6242 default. See the section "The Statistics Collector" of the B<PostgreSQL
6243 Documentation> for details.
6245 By specifying custom database queries using a B<Query> block as described
6246 below, you may collect any data that is available from some PostgreSQL
6247 database. This way, you are able to access statistics of external daemons
6248 which are available in a PostgreSQL database or use future or special
6249 statistics provided by PostgreSQL without the need to upgrade your collectd
6252 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6253 PostgreSQL databases as well. This has been implemented in a generic way. You
6254 need to specify an SQL statement which will then be executed by collectd in
6255 order to write the data (see below for details). The benefit of that approach
6256 is that there is no fixed database layout. Rather, the layout may be optimized
6257 for the current setup.
6259 The B<PostgreSQL Documentation> manual can be found at
6260 L<http://www.postgresql.org/docs/manuals/>.
6264 Statement "SELECT magic FROM wizard WHERE host = $1;"
6268 InstancePrefix "magic"
6273 <Query rt36_tickets>
6274 Statement "SELECT COUNT(type) AS count, type \
6276 WHEN resolved = 'epoch' THEN 'open' \
6277 ELSE 'resolved' END AS type \
6278 FROM tickets) type \
6282 InstancePrefix "rt36_tickets"
6283 InstancesFrom "type"
6289 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6300 KRBSrvName "kerberos_service_name"
6306 Service "service_name"
6307 Query backends # predefined
6318 The B<Query> block defines one database query which may later be used by a
6319 database definition. It accepts a single mandatory argument which specifies
6320 the name of the query. The names of all queries have to be unique (see the
6321 B<MinVersion> and B<MaxVersion> options below for an exception to this
6324 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6325 B<Result> blocks may be used to extract multiple values from a single query.
6327 The following configuration options are available to define the query:
6331 =item B<Statement> I<sql query statement>
6333 Specify the I<sql query statement> which the plugin should execute. The string
6334 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6335 first, second, etc. parameter. The value of the parameters is specified by the
6336 B<Param> configuration option - see below for details. To include a literal
6337 B<$> character followed by a number, surround it with single quotes (B<'>).
6339 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6340 allowed. Note, however, that only a single command may be used. Semicolons are
6341 allowed as long as a single non-empty command has been specified only.
6343 The returned lines will be handled separately one after another.
6345 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6347 Specify the parameters which should be passed to the SQL query. The parameters
6348 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6349 they appear in the configuration file. The value of the parameter is
6350 determined depending on the value of the B<Param> option as follows:
6356 The configured hostname of the database connection. If a UNIX domain socket is
6357 used, the parameter expands to "localhost".
6361 The name of the database of the current connection.
6365 The name of the database plugin instance. See the B<Instance> option of the
6366 database specification below for details.
6370 The username used to connect to the database.
6374 The interval with which this database is queried (as specified by the database
6375 specific or global B<Interval> options).
6379 Please note that parameters are only supported by PostgreSQL's protocol
6380 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6382 =item B<PluginInstanceFrom> I<column>
6384 Specify how to create the "PluginInstance" for reporting this query results.
6385 Only one column is supported. You may concatenate fields and string values in
6386 the query statement to get the required results.
6388 =item B<MinVersion> I<version>
6390 =item B<MaxVersion> I<version>
6392 Specify the minimum or maximum version of PostgreSQL that this query should be
6393 used with. Some statistics might only be available with certain versions of
6394 PostgreSQL. This allows you to specify multiple queries with the same name but
6395 which apply to different versions, thus allowing you to use the same
6396 configuration in a heterogeneous environment.
6398 The I<version> has to be specified as the concatenation of the major, minor
6399 and patch-level versions, each represented as two-decimal-digit numbers. For
6400 example, version 8.2.3 will become 80203.
6404 The B<Result> block defines how to handle the values returned from the query.
6405 It defines which column holds which value and how to dispatch that value to
6410 =item B<Type> I<type>
6412 The I<type> name to be used when dispatching the values. The type describes
6413 how to handle the data and where to store it. See L<types.db(5)> for more
6414 details on types and their configuration. The number and type of values (as
6415 selected by the B<ValuesFrom> option) has to match the type of the given name.
6417 This option is mandatory.
6419 =item B<InstancePrefix> I<prefix>
6421 =item B<InstancesFrom> I<column0> [I<column1> ...]
6423 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6424 B<InstancePrefix> defines a static prefix that will be prepended to all type
6425 instances. B<InstancesFrom> defines the column names whose values will be used
6426 to create the type instance. Multiple values will be joined together using the
6427 hyphen (C<->) as separation character.
6429 The plugin itself does not check whether or not all built instances are
6430 different. It is your responsibility to assure that each is unique.
6432 Both options are optional. If none is specified, the type instance will be
6435 =item B<ValuesFrom> I<column0> [I<column1> ...]
6437 Names the columns whose content is used as the actual data for the data sets
6438 that are dispatched to the daemon. How many such columns you need is
6439 determined by the B<Type> setting as explained above. If you specify too many
6440 or not enough columns, the plugin will complain about that and no data will be
6441 submitted to the daemon.
6443 The actual data type, as seen by PostgreSQL, is not that important as long as
6444 it represents numbers. The plugin will automatically cast the values to the
6445 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6446 L<strtod(3)> functions, so anything supported by those functions is supported
6447 by the plugin as well.
6449 This option is required inside a B<Result> block and may be specified multiple
6450 times. If multiple B<ValuesFrom> options are specified, the columns are read
6455 The following predefined queries are available (the definitions can be found
6456 in the F<postgresql_default.conf> file which, by default, is available at
6457 C<I<prefix>/share/collectd/>):
6463 This query collects the number of backends, i.E<nbsp>e. the number of
6466 =item B<transactions>
6468 This query collects the numbers of committed and rolled-back transactions of
6473 This query collects the numbers of various table modifications (i.E<nbsp>e.
6474 insertions, updates, deletions) of the user tables.
6476 =item B<query_plans>
6478 This query collects the numbers of various table scans and returned tuples of
6481 =item B<table_states>
6483 This query collects the numbers of live and dead rows in the user tables.
6487 This query collects disk block access counts for user tables.
6491 This query collects the on-disk size of the database in bytes.
6495 In addition, the following detailed queries are available by default. Please
6496 note that each of those queries collects information B<by table>, thus,
6497 potentially producing B<a lot> of data. For details see the description of the
6498 non-by_table queries above.
6502 =item B<queries_by_table>
6504 =item B<query_plans_by_table>
6506 =item B<table_states_by_table>
6508 =item B<disk_io_by_table>
6512 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6513 mandatory argument specifying the name of the writer. This will then be used
6514 in the B<Database> specification in order to activate the writer instance. The
6515 names of all writers have to be unique. The following options may be
6520 =item B<Statement> I<sql statement>
6522 This mandatory option specifies the SQL statement that will be executed for
6523 each submitted value. A single SQL statement is allowed only. Anything after
6524 the first semicolon will be ignored.
6526 Nine parameters will be passed to the statement and should be specified as
6527 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6528 values are made available through those parameters:
6534 The timestamp of the queried value as an RFC 3339-formatted local time.
6538 The hostname of the queried value.
6542 The plugin name of the queried value.
6546 The plugin instance of the queried value. This value may be B<NULL> if there
6547 is no plugin instance.
6551 The type of the queried value (cf. L<types.db(5)>).
6555 The type instance of the queried value. This value may be B<NULL> if there is
6560 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6561 sources of the submitted value-list).
6565 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6566 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6567 B<StoreRates> is enabled (which is the default, see below), all types will be
6572 An array of the submitted values. The dimensions of the value name and value
6577 In general, it is advisable to create and call a custom function in the
6578 PostgreSQL database for this purpose. Any procedural language supported by
6579 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6582 =item B<StoreRates> B<false>|B<true>
6584 If set to B<true> (the default), convert counter values to rates. If set to
6585 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6590 The B<Database> block defines one PostgreSQL database for which to collect
6591 statistics. It accepts a single mandatory argument which specifies the
6592 database name. None of the other options are required. PostgreSQL will use
6593 default values as documented in the section "CONNECTING TO A DATABASE" in the
6594 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6595 the user collectd is run as and special environment variables. See the manpage
6600 =item B<Interval> I<seconds>
6602 Specify the interval with which the database should be queried. The default is
6603 to use the global B<Interval> setting.
6605 =item B<CommitInterval> I<seconds>
6607 This option may be used for database connections which have "writers" assigned
6608 (see above). If specified, it causes a writer to put several updates into a
6609 single transaction. This transaction will last for the specified amount of
6610 time. By default, each update will be executed in a separate transaction. Each
6611 transaction generates a fair amount of overhead which can, thus, be reduced by
6612 activating this option. The draw-back is, that data covering the specified
6613 amount of time will be lost, for example, if a single statement within the
6614 transaction fails or if the database server crashes.
6616 =item B<Plugin> I<Plugin>
6618 Use I<Plugin> as the plugin name when submitting query results from
6619 this B<Database>. Defaults to C<postgresql>.
6621 =item B<Instance> I<name>
6623 Specify the plugin instance name that should be used instead of the database
6624 name (which is the default, if this option has not been specified). This
6625 allows one to query multiple databases of the same name on the same host (e.g.
6626 when running multiple database server versions in parallel).
6627 The plugin instance name can also be set from the query result using
6628 the B<PluginInstanceFrom> option in B<Query> block.
6630 =item B<Host> I<hostname>
6632 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6633 value begins with a slash, it is interpreted as the directory name in which to
6634 look for the UNIX domain socket.
6636 This option is also used to determine the hostname that is associated with a
6637 collected data set. If it has been omitted or either begins with with a slash
6638 or equals B<localhost> it will be replaced with the global hostname definition
6639 of collectd. Any other value will be passed literally to collectd when
6640 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6642 =item B<Port> I<port>
6644 Specify the TCP port or the local UNIX domain socket file extension of the
6647 =item B<User> I<username>
6649 Specify the username to be used when connecting to the server.
6651 =item B<Password> I<password>
6653 Specify the password to be used when connecting to the server.
6655 =item B<ExpireDelay> I<delay>
6657 Skip expired values in query output.
6659 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6661 Specify whether to use an SSL connection when contacting the server. The
6662 following modes are supported:
6668 Do not use SSL at all.
6672 First, try to connect without using SSL. If that fails, try using SSL.
6674 =item I<prefer> (default)
6676 First, try to connect using SSL. If that fails, try without using SSL.
6684 =item B<Instance> I<name>
6686 Specify the plugin instance name that should be used instead of the database
6687 name (which is the default, if this option has not been specified). This
6688 allows one to query multiple databases of the same name on the same host (e.g.
6689 when running multiple database server versions in parallel).
6691 =item B<KRBSrvName> I<kerberos_service_name>
6693 Specify the Kerberos service name to use when authenticating with Kerberos 5
6694 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6695 B<PostgreSQL Documentation> for details.
6697 =item B<Service> I<service_name>
6699 Specify the PostgreSQL service name to use for additional parameters. That
6700 service has to be defined in F<pg_service.conf> and holds additional
6701 connection parameters. See the section "The Connection Service File" in the
6702 B<PostgreSQL Documentation> for details.
6704 =item B<Query> I<query>
6706 Specifies a I<query> which should be executed in the context of the database
6707 connection. This may be any of the predefined or user-defined queries. If no
6708 such option is given, it defaults to "backends", "transactions", "queries",
6709 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6710 has been specified). Else, the specified queries are used only.
6712 =item B<Writer> I<writer>
6714 Assigns the specified I<writer> backend to the database connection. This
6715 causes all collected data to be send to the database using the settings
6716 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6717 below for details on how to selectively send data to certain plugins).
6719 Each writer will register a flush callback which may be used when having long
6720 transactions enabled (see the B<CommitInterval> option above). When issuing
6721 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6722 transaction will be committed right away. Two different kinds of flush
6723 callbacks are available with the C<postgresql> plugin:
6729 Flush all writer backends.
6731 =item B<postgresql->I<database>
6733 Flush all writers of the specified I<database> only.
6739 =head2 Plugin C<powerdns>
6741 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6742 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6743 values, many of which are probably meaningless to most users, but may be useful
6744 for some. So you may chose which values to collect, but if you don't, some
6745 reasonable defaults will be collected.
6748 <Server "server_name">
6750 Collect "udp-answers" "udp-queries"
6751 Socket "/var/run/pdns.controlsocket"
6753 <Recursor "recursor_name">
6755 Collect "cache-hits" "cache-misses"
6756 Socket "/var/run/pdns_recursor.controlsocket"
6758 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6763 =item B<Server> and B<Recursor> block
6765 The B<Server> block defines one authoritative server to query, the B<Recursor>
6766 does the same for an recursing server. The possible options in both blocks are
6767 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6772 =item B<Collect> I<Field>
6774 Using the B<Collect> statement you can select which values to collect. Here,
6775 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6776 C<dlg-only-drops>, C<answers10-100>.
6778 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6779 When querying the server a C<SHOW *> command is issued in any case, because
6780 that's the only way of getting multiple values out of the server at once.
6781 collectd then picks out the values you have selected. When querying the
6782 recursor, a command is generated to query exactly these values. So if you
6783 specify invalid fields when querying the recursor, a syntax error may be
6784 returned by the daemon and collectd may not collect any values at all.
6786 If no B<Collect> statement is given, the following B<Server> values will be
6793 =item packetcache-hit
6795 =item packetcache-miss
6797 =item packetcache-size
6799 =item query-cache-hit
6801 =item query-cache-miss
6803 =item recursing-answers
6805 =item recursing-questions
6817 The following B<Recursor> values will be collected by default:
6821 =item noerror-answers
6823 =item nxdomain-answers
6825 =item servfail-answers
6843 Please note that up to that point collectd doesn't know what values are
6844 available on the server and values that are added do not need a change of the
6845 mechanism so far. However, the values must be mapped to collectd's naming
6846 scheme, which is done using a lookup table that lists all known values. If
6847 values are added in the future and collectd does not know about them, you will
6848 get an error much like this:
6850 powerdns plugin: submit: Not found in lookup table: foobar = 42
6852 In this case please file a bug report with the collectd team.
6854 =item B<Socket> I<Path>
6856 Configures the path to the UNIX domain socket to be used when connecting to the
6857 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6858 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6859 will be used for the recursor.
6863 =item B<LocalSocket> I<Path>
6865 Querying the recursor is done using UDP. When using UDP over UNIX domain
6866 sockets, the client socket needs a name in the file system, too. You can set
6867 this local name to I<Path> using the B<LocalSocket> option. The default is
6868 C<I<prefix>/var/run/collectd-powerdns>.
6872 =head2 Plugin C<processes>
6874 Collects information about processes of local system.
6876 By default, with no process matches configured, only general statistics is
6877 collected: the number of processes in each state and fork rate.
6879 Process matches can be configured by B<Process> and B<ProcessMatch> options.
6880 These may also be a block in which further options may be specified.
6882 The statistics collected for matched processes are:
6883 - size of the resident segment size (RSS)
6884 - user- and system-time used
6885 - number of processes
6887 - number of open files (under Linux)
6888 - number of memory mapped files (under Linux)
6889 - io data (where available)
6890 - context switches (under Linux)
6891 - minor and major pagefaults
6892 - Delay Accounting information (Linux only, requires libmnl)
6897 CollectFileDescriptor true
6898 CollectContextSwitch true
6899 CollectDelayAccounting false
6901 ProcessMatch "name" "regex"
6902 <Process "collectd">
6903 CollectFileDescriptor false
6904 CollectContextSwitch false
6905 CollectDelayAccounting true
6907 <ProcessMatch "name" "regex">
6908 CollectFileDescriptor false
6909 CollectContextSwitch true
6915 =item B<Process> I<Name>
6917 Select more detailed statistics of processes matching this name.
6919 Some platforms have a limit on the length of process names.
6920 I<Name> must stay below this limit.
6922 =item B<ProcessMatch> I<name> I<regex>
6924 Select more detailed statistics of processes matching the specified I<regex>
6925 (see L<regex(7)> for details). The statistics of all matching processes are
6926 summed up and dispatched to the daemon using the specified I<name> as an
6927 identifier. This allows one to "group" several processes together.
6928 I<name> must not contain slashes.
6930 =item B<CollectContextSwitch> I<Boolean>
6932 Collect the number of context switches for matched processes.
6933 Disabled by default.
6935 =item B<CollectDelayAccounting> I<Boolean>
6937 If enabled, collect Linux Delay Accounding information for matching processes.
6938 Delay Accounting provides the time processes wait for the CPU to become
6939 available, for I/O operations to finish, for pages to be swapped in and for
6940 freed pages to be reclaimed. The metrics are reported as "seconds per second"
6941 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
6942 Disabled by default.
6944 This option is only available on Linux, requires the C<libmnl> library and
6945 requires the C<CAP_NET_ADMIN> capability at runtime.
6947 =item B<CollectFileDescriptor> I<Boolean>
6949 Collect number of file descriptors of matched processes.
6950 Disabled by default.
6952 =item B<CollectMemoryMaps> I<Boolean>
6954 Collect the number of memory mapped files of the process.
6955 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
6960 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
6961 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
6962 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
6963 reporting the corresponding processes only. Outside of B<Process> and
6964 B<ProcessMatch> blocks these options set the default value for subsequent
6967 =head2 Plugin C<protocols>
6969 Collects a lot of information about various network protocols, such as I<IP>,
6970 I<TCP>, I<UDP>, etc.
6972 Available configuration options:
6976 =item B<Value> I<Selector>
6978 Selects whether or not to select a specific value. The string being matched is
6979 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6980 plugin instance and I<ValueName> will be used as type instance. An example of
6981 the string being used would be C<Tcp:RetransSegs>.
6983 You can use regular expressions to match a large number of values with just one
6984 configuration option. To select all "extended" I<TCP> values, you could use the
6985 following statement:
6989 Whether only matched values are selected or all matched values are ignored
6990 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6991 If no value is configured at all, all values will be selected.
6993 See F</"IGNORELISTS"> for details.
6995 =item B<IgnoreSelected> B<true>|B<false>
6997 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6998 matching values will be ignored.
7002 =head2 Plugin C<python>
7004 This plugin embeds a Python-interpreter into collectd and provides an interface
7005 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7007 =head2 Plugin C<routeros>
7009 The C<routeros> plugin connects to a device running I<RouterOS>, the
7010 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7011 I<librouteros> to connect and reads information about the interfaces and
7012 wireless connections of the device. The configuration supports querying
7017 Host "router0.example.com"
7020 CollectInterface true
7025 Host "router1.example.com"
7028 CollectInterface true
7029 CollectRegistrationTable true
7035 As you can see above, the configuration of the I<routeros> plugin consists of
7036 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7037 options are understood:
7041 =item B<Host> I<Host>
7043 Hostname or IP-address of the router to connect to.
7045 =item B<Port> I<Port>
7047 Port name or port number used when connecting. If left unspecified, the default
7048 will be chosen by I<librouteros>, currently "8728". This option expects a
7049 string argument, even when a numeric port number is given.
7051 =item B<User> I<User>
7053 Use the user name I<User> to authenticate. Defaults to "admin".
7055 =item B<Password> I<Password>
7057 Set the password used to authenticate.
7059 =item B<CollectInterface> B<true>|B<false>
7061 When set to B<true>, interface statistics will be collected for all interfaces
7062 present on the device. Defaults to B<false>.
7064 =item B<CollectRegistrationTable> B<true>|B<false>
7066 When set to B<true>, information about wireless LAN connections will be
7067 collected. Defaults to B<false>.
7069 =item B<CollectCPULoad> B<true>|B<false>
7071 When set to B<true>, information about the CPU usage will be collected. The
7072 number is a dimensionless value where zero indicates no CPU usage at all.
7073 Defaults to B<false>.
7075 =item B<CollectMemory> B<true>|B<false>
7077 When enabled, the amount of used and free memory will be collected. How used
7078 memory is calculated is unknown, for example whether or not caches are counted
7080 Defaults to B<false>.
7082 =item B<CollectDF> B<true>|B<false>
7084 When enabled, the amount of used and free disk space will be collected.
7085 Defaults to B<false>.
7087 =item B<CollectDisk> B<true>|B<false>
7089 When enabled, the number of sectors written and bad blocks will be collected.
7090 Defaults to B<false>.
7094 =head2 Plugin C<redis>
7096 The I<Redis plugin> connects to one or more Redis servers and gathers
7097 information about each server's state. For each server there is a I<Node> block
7098 which configures the connection parameters for this node.
7105 <Query "LLEN myqueue">
7112 The information shown in the synopsis above is the I<default configuration>
7113 which is used by the plugin if no configuration is present.
7117 =item B<Node> I<Nodename>
7119 The B<Node> block identifies a new Redis node, that is a new Redis instance
7120 running in an specified host and port. The name for node is a canonical
7121 identifier which is used as I<plugin instance>. It is limited to
7122 64E<nbsp>characters in length.
7124 =item B<Host> I<Hostname>
7126 The B<Host> option is the hostname or IP-address where the Redis instance is
7129 =item B<Port> I<Port>
7131 The B<Port> option is the TCP port on which the Redis instance accepts
7132 connections. Either a service name of a port number may be given. Please note
7133 that numerical port numbers must be given as a string, too.
7135 =item B<Password> I<Password>
7137 Use I<Password> to authenticate when connecting to I<Redis>.
7139 =item B<Timeout> I<Milliseconds>
7141 The B<Timeout> option set the socket timeout for node response. Since the Redis
7142 read function is blocking, you should keep this value as low as possible. Keep
7143 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
7144 than B<Interval> defined globally.
7146 =item B<Query> I<Querystring>
7148 The B<Query> block identifies a query to execute against the redis server.
7149 There may be an arbitrary number of queries to execute.
7151 =item B<Type> I<Collectd type>
7153 Within a query definition, a valid collectd type to use as when submitting
7154 the result of the query. When not supplied, will default to B<gauge>.
7156 =item B<Instance> I<Type instance>
7158 Within a query definition, an optional type instance to use when submitting
7159 the result of the query. When not supplied will default to the escaped
7160 command, up to 64 chars.
7164 =head2 Plugin C<rrdcached>
7166 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7167 to store values to RRD files in an efficient manner. The combination of the
7168 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7169 way the C<rrdtool> plugin works (see below). The added abstraction layer
7170 provides a number of benefits, though: Because the cache is not within
7171 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7172 restarted. This results in much shorter (if any) gaps in graphs, especially
7173 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7174 daemon so that it can flush values to disk automatically when needed. This
7175 allows one to integrate automated flushing of values into graphing solutions
7178 There are disadvantages, though: The daemon may reside on a different host, so
7179 it may not be possible for C<collectd> to create the appropriate RRD files
7180 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7181 different base directory, so relative paths may do weird stuff if you're not
7184 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7185 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7186 setting should be set to an absolute path, so that a changed base directory
7187 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7191 =item B<DaemonAddress> I<Address>
7193 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7194 library. See L<rrdcached(1)> for details. Example:
7196 <Plugin "rrdcached">
7197 DaemonAddress "unix:/var/run/rrdcached.sock"
7200 =item B<DataDir> I<Directory>
7202 Set the base directory in which the RRD files reside. If this is a relative
7203 path, it is relative to the working base directory of the C<rrdcached> daemon!
7204 Use of an absolute path is recommended.
7206 =item B<CreateFiles> B<true>|B<false>
7208 Enables or disables the creation of RRD files. If the daemon is not running
7209 locally, or B<DataDir> is set to a relative path, this will not work as
7210 expected. Default is B<true>.
7212 =item B<CreateFilesAsync> B<false>|B<true>
7214 When enabled, new RRD files are enabled asynchronously, using a separate thread
7215 that runs in the background. This prevents writes to block, which is a problem
7216 especially when many hundreds of files need to be created at once. However,
7217 since the purpose of creating the files asynchronously is I<not> to block until
7218 the file is available, values before the file is available will be discarded.
7219 When disabled (the default) files are created synchronously, blocking for a
7220 short while, while the file is being written.
7222 =item B<StepSize> I<Seconds>
7224 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7225 this setting is unset and the stepsize is set to the interval in which the data
7226 is collected. Do not use this option unless you absolutely have to for some
7227 reason. Setting this option may cause problems with the C<snmp plugin>, the
7228 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7230 =item B<HeartBeat> I<Seconds>
7232 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7233 in which case the heartbeat is set to twice the B<StepSize> which should equal
7234 the interval in which data is collected. Do not set this option unless you have
7235 a very good reason to do so.
7237 =item B<RRARows> I<NumRows>
7239 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7240 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7241 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7242 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7243 week, one month, and one year.
7245 So for each timespan, it calculates how many PDPs need to be consolidated into
7246 one CDP by calculating:
7247 number of PDPs = timespan / (stepsize * rrarows)
7249 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7252 =item B<RRATimespan> I<Seconds>
7254 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7255 more then one RRA. If this option is never used, the built-in default of (3600,
7256 86400, 604800, 2678400, 31622400) is used.
7258 For more information on how RRA-sizes are calculated see B<RRARows> above.
7260 =item B<XFF> I<Factor>
7262 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7263 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7266 =item B<CollectStatistics> B<false>|B<true>
7268 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7269 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7271 Statistics are read via I<rrdcached>s socket using the STATS command.
7272 See L<rrdcached(1)> for details.
7276 =head2 Plugin C<rrdtool>
7278 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7279 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7280 using these settings. If you don't want to dive into the depths of RRDtool, you
7281 can safely ignore these settings.
7285 =item B<DataDir> I<Directory>
7287 Set the directory to store RRD files under. By default RRD files are generated
7288 beneath the daemon's working directory, i.e. the B<BaseDir>.
7290 =item B<CreateFilesAsync> B<false>|B<true>
7292 When enabled, new RRD files are enabled asynchronously, using a separate thread
7293 that runs in the background. This prevents writes to block, which is a problem
7294 especially when many hundreds of files need to be created at once. However,
7295 since the purpose of creating the files asynchronously is I<not> to block until
7296 the file is available, values before the file is available will be discarded.
7297 When disabled (the default) files are created synchronously, blocking for a
7298 short while, while the file is being written.
7300 =item B<StepSize> I<Seconds>
7302 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7303 this setting is unset and the stepsize is set to the interval in which the data
7304 is collected. Do not use this option unless you absolutely have to for some
7305 reason. Setting this option may cause problems with the C<snmp plugin>, the
7306 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7308 =item B<HeartBeat> I<Seconds>
7310 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7311 in which case the heartbeat is set to twice the B<StepSize> which should equal
7312 the interval in which data is collected. Do not set this option unless you have
7313 a very good reason to do so.
7315 =item B<RRARows> I<NumRows>
7317 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7318 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7319 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7320 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7321 week, one month, and one year.
7323 So for each timespan, it calculates how many PDPs need to be consolidated into
7324 one CDP by calculating:
7325 number of PDPs = timespan / (stepsize * rrarows)
7327 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7330 =item B<RRATimespan> I<Seconds>
7332 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7333 more then one RRA. If this option is never used, the built-in default of (3600,
7334 86400, 604800, 2678400, 31622400) is used.
7336 For more information on how RRA-sizes are calculated see B<RRARows> above.
7338 =item B<XFF> I<Factor>
7340 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7341 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7344 =item B<CacheFlush> I<Seconds>
7346 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7347 it writes all values for a certain RRD-file if the oldest value is older than
7348 (or equal to) the number of seconds specified by B<CacheTimeout>.
7349 That check happens on new values arriwal. If some RRD-file is not updated
7350 anymore for some reason (the computer was shut down, the network is broken,
7351 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7352 every I<Seconds> seconds the entire cache is searched for entries older than
7353 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7354 disk. Since scanning the entire cache is kind of expensive and does nothing
7355 under normal circumstances, this value should not be too small. 900 seconds
7356 might be a good value, though setting this to 7200 seconds doesn't normally
7357 do much harm either.
7359 Defaults to 10x B<CacheTimeout>.
7360 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7361 above default is used.
7363 =item B<CacheTimeout> I<Seconds>
7365 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7366 save values in a cache, as described above. Writing multiple values at once
7367 reduces IO-operations and thus lessens the load produced by updating the files.
7368 The trade off is that the graphs kind of "drag behind" and that more memory is
7371 =item B<WritesPerSecond> I<Updates>
7373 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7374 will run serious performance problems. The B<CacheFlush> setting and the
7375 internal update queue assert that collectd continues to work just fine even
7376 under heavy load, but the system may become very unresponsive and slow. This is
7377 a problem especially if you create graphs from the RRD files on the same
7378 machine, for example using the C<graph.cgi> script included in the
7379 C<contrib/collection3/> directory.
7381 This setting is designed for very large setups. Setting this option to a value
7382 between 25 and 80 updates per second, depending on your hardware, will leave
7383 the server responsive enough to draw graphs even while all the cached values
7384 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7385 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7386 written as fast as possible, so that web frontends have up to date data when
7389 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7390 updates per second, writing all values to disk will take approximately
7391 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7392 "collection3" you'll end up with a responsive and fast system, up to date
7393 graphs and basically a "backup" of your values every hour.
7395 =item B<RandomTimeout> I<Seconds>
7397 When set, the actual timeout for each value is chosen randomly between
7398 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7399 intention is to avoid high load situations that appear when many values timeout
7400 at the same time. This is especially a problem shortly after the daemon starts,
7401 because all values were added to the internal cache at roughly the same time.
7405 =head2 Plugin C<sensors>
7407 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7408 that all the needed modules have to be loaded and lm_sensors has to be
7409 configured (most likely by editing F</etc/sensors.conf>. Read
7410 L<sensors.conf(5)> for details.
7412 The B<lm_sensors> homepage can be found at
7413 L<http://secure.netroedge.com/~lm78/>.
7417 =item B<SensorConfigFile> I<File>
7419 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7420 the library's default will be used.
7422 =item B<Sensor> I<chip-bus-address/type-feature>
7424 Selects the name of the sensor which you want to collect or ignore, depending
7425 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7426 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7427 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7429 See F</"IGNORELISTS"> for details.
7431 =item B<IgnoreSelected> I<true>|I<false>
7433 If no configuration if given, the B<sensors>-plugin will collect data from all
7434 sensors. This may not be practical, especially for uninteresting sensors.
7435 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7436 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7437 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7438 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7439 and all other sensors are collected.
7441 =item B<UseLabels> I<true>|I<false>
7443 Configures how sensor readings are reported. When set to I<true>, sensor
7444 readings are reported using their descriptive label (e.g. "VCore"). When set to
7445 I<false> (the default) the sensor name is used ("in0").
7449 =head2 Plugin C<sigrok>
7451 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7452 supported by the L<sigrok|http://sigrok.org/> project.
7458 <Device "AC Voltage">
7463 <Device "Sound Level">
7464 Driver "cem-dt-885x"
7471 =item B<LogLevel> B<0-5>
7473 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7474 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7475 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7476 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7477 their level, are always submitted to I<collectd> at its INFO log level.
7479 =item E<lt>B<Device> I<Name>E<gt>
7481 A sigrok-supported device, uniquely identified by this section's options. The
7482 I<Name> is passed to I<collectd> as the I<plugin instance>.
7484 =item B<Driver> I<DriverName>
7486 The sigrok driver to use for this device.
7488 =item B<Conn> I<ConnectionSpec>
7490 If the device cannot be auto-discovered, or more than one might be discovered
7491 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7492 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7493 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7494 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7495 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7497 =item B<SerialComm> I<SerialSpec>
7499 For serial devices with non-standard port settings, this option can be used
7500 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7501 This should not be necessary; drivers know how to communicate with devices they
7504 =item B<MinimumInterval> I<Seconds>
7506 Specifies the minimum time between measurement dispatches to I<collectd>, in
7507 seconds. Since some I<sigrok> supported devices can acquire measurements many
7508 times per second, it may be necessary to throttle these. For example, the
7509 I<RRD plugin> cannot process writes more than once per second.
7511 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7512 device are always dispatched to I<collectd>. When throttled, unused
7513 measurements are discarded.
7517 =head2 Plugin C<smart>
7519 The C<smart> plugin collects SMART information from physical
7520 disks. Values collectd include temperature, power cycle count, poweron
7521 time and bad sectors. Also, all SMART attributes are collected along
7522 with the normalized current value, the worst value, the threshold and
7523 a human readable value.
7525 Using the following two options you can ignore some disks or configure the
7526 collection only of specific disks.
7530 =item B<Disk> I<Name>
7532 Select the disk I<Name>. Whether it is collected or ignored depends on the
7533 B<IgnoreSelected> setting, see below. As with other plugins that use the
7534 daemon's ignorelist functionality, a string that starts and ends with a slash
7535 is interpreted as a regular expression. Examples:
7540 See F</"IGNORELISTS"> for details.
7542 =item B<IgnoreSelected> B<true>|B<false>
7544 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7545 statements, are ignored or if all other disks are ignored. The behavior
7546 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7547 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7548 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7549 is set to B<true>, all disks are collected B<except> the ones matched.
7551 =item B<IgnoreSleepMode> B<true>|B<false>
7553 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7554 This option disables the sleep mode check and allows the plugin to collect data
7555 from these disks anyway. This is useful in cases where libatasmart mistakenly
7556 reports disks as asleep because it has not been updated to incorporate support
7557 for newer idle states in the ATA spec.
7559 =item B<UseSerial> B<true>|B<false>
7561 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7562 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7563 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7564 storing data. This ensures that the data for a given disk will be kept together
7565 even if the kernel name changes.
7569 =head2 Plugin C<snmp>
7571 Since the configuration of the C<snmp plugin> is a little more complicated than
7572 other plugins, its documentation has been moved to an own manpage,
7573 L<collectd-snmp(5)>. Please see there for details.
7575 =head2 Plugin C<snmp_agent>
7577 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7578 from SNMP master agent and returns the data collected by read plugins.
7579 The I<snmp_agent> plugin handles requests only for OIDs specified in
7580 configuration file. To handle SNMP queries the plugin gets data from collectd
7581 and translates requested values from collectd's internal format to SNMP format.
7582 This plugin is a generic plugin and cannot work without configuration.
7583 For more details on AgentX subagent see
7584 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7589 <Data "memAvailReal">
7591 #PluginInstance "some"
7594 OIDs "1.3.6.1.4.1.2021.4.6.0"
7597 IndexOID "IF-MIB::ifIndex"
7598 SizeOID "IF-MIB::ifNumber"
7602 OIDs "IF-MIB::ifDescr"
7608 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7613 There are two types of blocks that can be contained in the
7614 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7616 =head3 The B<Data> block
7618 The B<Data> block defines a list OIDs that are to be handled. This block can
7619 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7620 block it reperesents table OIDs.
7621 The following options can be set:
7625 =item B<Instance> I<true|false>
7627 When B<Instance> is set to B<true>, the value for requested OID is copied from
7628 plugin instance field of corresponding collectd value. If B<Data> block defines
7629 scalar data type B<Instance> has no effect and can be omitted.
7631 =item B<Plugin> I<String>
7633 Read plugin name whose collected data will be mapped to specified OIDs.
7635 =item B<PluginInstance> I<String>
7637 Read plugin instance whose collected data will be mapped to specified OIDs.
7638 The field is optional and by default there is no plugin instance check.
7639 Allowed only if B<Data> block defines scalar data type.
7641 =item B<Type> I<String>
7643 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7644 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7646 =item B<TypeInstance> I<String>
7648 Collectd's type-instance that is to be used for specified OID.
7650 =item B<OIDs> I<OID> [I<OID> ...]
7652 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7653 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7654 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7655 configured should correspond to number of values in specified B<Type>.
7656 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7657 "rx" and "tx" values of "if_octets" type.
7659 =item B<Scale> I<Value>
7661 The values taken from collectd are multiplied by I<Value>. The field is optional
7662 and the default is B<1.0>.
7664 =item B<Shift> I<Value>
7666 I<Value> is added to values from collectd after they have been multiplied by
7667 B<Scale> value. The field is optional and the default value is B<0.0>.
7671 =head3 The B<Table> block
7673 The B<Table> block defines a collection of B<Data> blocks that belong to one
7674 snmp table. In addition to multiple B<Data> blocks the following options can be
7679 =item B<IndexOID> I<OID>
7681 OID that is handled by the plugin and is mapped to numerical index value that is
7682 generated by the plugin for each table record.
7684 =item B<SizeOID> I<OID>
7686 OID that is handled by the plugin. Returned value is the number of records in
7687 the table. The field is optional.
7691 =head2 Plugin C<statsd>
7693 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7694 protocol and dispatches rates or other aggregates of these numbers
7697 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7698 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7699 C<objects> respectively.
7701 The following configuration options are valid:
7705 =item B<Host> I<Host>
7707 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7708 "any" address, i.e. accept packets sent to any of the hosts addresses.
7710 =item B<Port> I<Port>
7712 UDP port to listen to. This can be either a service name or a port number.
7713 Defaults to C<8125>.
7715 =item B<DeleteCounters> B<false>|B<true>
7717 =item B<DeleteTimers> B<false>|B<true>
7719 =item B<DeleteGauges> B<false>|B<true>
7721 =item B<DeleteSets> B<false>|B<true>
7723 These options control what happens if metrics are not updated in an interval.
7724 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7725 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7726 are unchanged. If set to B<True>, the such metrics are not dispatched and
7727 removed from the internal cache.
7729 =item B<CounterSum> B<false>|B<true>
7731 When enabled, creates a C<count> metric which reports the change since the last
7732 read. This option primarily exists for compatibility with the I<statsd>
7733 implementation by Etsy.
7735 =item B<TimerPercentile> I<Percent>
7737 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7738 that I<Percent> of all reported timers are smaller than or equal to the
7739 computed latency. This is useful for cutting off the long tail latency, as it's
7740 often done in I<Service Level Agreements> (SLAs).
7742 Different percentiles can be calculated by setting this option several times.
7743 If none are specified, no percentiles are calculated / dispatched.
7745 =item B<TimerLower> B<false>|B<true>
7747 =item B<TimerUpper> B<false>|B<true>
7749 =item B<TimerSum> B<false>|B<true>
7751 =item B<TimerCount> B<false>|B<true>
7753 Calculate and dispatch various values out of I<Timer> metrics received during
7754 an interval. If set to B<False>, the default, these values aren't calculated /
7757 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
7761 =head2 Plugin C<swap>
7763 The I<Swap plugin> collects information about used and available swap space. On
7764 I<Linux> and I<Solaris>, the following options are available:
7768 =item B<ReportByDevice> B<false>|B<true>
7770 Configures how to report physical swap devices. If set to B<false> (the
7771 default), the summary over all swap devices is reported only, i.e. the globally
7772 used and available space over all devices. If B<true> is configured, the used
7773 and available space of each device will be reported separately.
7775 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7776 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7778 =item B<ReportBytes> B<false>|B<true>
7780 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7781 I<swap I/O> is reported in pages. This option is available under Linux only.
7783 =item B<ValuesAbsolute> B<true>|B<false>
7785 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7786 available and used. Defaults to B<true>.
7788 =item B<ValuesPercentage> B<false>|B<true>
7790 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7791 available and free. Defaults to B<false>.
7793 This is useful for deploying I<collectd> in a heterogeneous environment, where
7794 swap sizes differ and you want to specify generic thresholds or similar.
7796 =item B<ReportIO> B<true>|B<false>
7798 Enables or disables reporting swap IO. Defaults to B<true>.
7800 This is useful for the cases when swap IO is not neccessary, is not available,
7805 =head2 Plugin C<syslog>
7809 =item B<LogLevel> B<debug|info|notice|warning|err>
7811 Sets the log-level. If, for example, set to B<notice>, then all events with
7812 severity B<notice>, B<warning>, or B<err> will be submitted to the
7815 Please note that B<debug> is only available if collectd has been compiled with
7818 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7820 Controls which notifications should be sent to syslog. The default behaviour is
7821 not to send any. Less severe notifications always imply logging more severe
7822 notifications: Setting this to B<OKAY> means all notifications will be sent to
7823 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7824 notifications but will dismiss B<OKAY> notifications. Setting this option to
7825 B<FAILURE> will only send failures to syslog.
7829 =head2 Plugin C<table>
7831 The C<table plugin> provides generic means to parse tabular data and dispatch
7832 user specified values. Values are selected based on column numbers. For
7833 example, this plugin may be used to get values from the Linux L<proc(5)>
7834 filesystem or CSV (comma separated values) files.
7837 <Table "/proc/slabinfo">
7843 InstancePrefix "active_objs"
7849 InstancePrefix "objperslab"
7856 The configuration consists of one or more B<Table> blocks, each of which
7857 configures one file to parse. Within each B<Table> block, there are one or
7858 more B<Result> blocks, which configure which data to select and how to
7861 The following options are available inside a B<Table> block:
7865 =item B<Plugin> I<Plugin>
7867 If specified, I<Plugin> is used as the plugin name when submitting values.
7868 Defaults to B<table>.
7870 =item B<Instance> I<instance>
7872 If specified, I<instance> is used as the plugin instance. If omitted, the
7873 filename of the table is used instead, with all special characters replaced
7874 with an underscore (C<_>).
7876 =item B<Separator> I<string>
7878 Any character of I<string> is interpreted as a delimiter between the different
7879 columns of the table. A sequence of two or more contiguous delimiters in the
7880 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7881 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7882 of a table - see its documentation for more details. This option is mandatory.
7884 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7885 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7886 required because of collectd's config parsing.
7890 The following options are available inside a B<Result> block:
7894 =item B<Type> I<type>
7896 Sets the type used to dispatch the values to the daemon. Detailed information
7897 about types and their configuration can be found in L<types.db(5)>. This
7898 option is mandatory.
7900 =item B<InstancePrefix> I<prefix>
7902 If specified, prepend I<prefix> to the type instance. If omitted, only the
7903 B<InstancesFrom> option is considered for the type instance.
7905 =item B<InstancesFrom> I<column0> [I<column1> ...]
7907 If specified, the content of the given columns (identified by the column
7908 number starting at zero) will be used to create the type instance for each
7909 row. Multiple values (and the instance prefix) will be joined together with
7910 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7911 option is considered for the type instance.
7913 The plugin itself does not check whether or not all built instances are
7914 different. It’s your responsibility to assure that each is unique. This is
7915 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7916 sure that the table only contains one row.
7918 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7921 =item B<ValuesFrom> I<column0> [I<column1> ...]
7923 Specifies the columns (identified by the column numbers starting at zero)
7924 whose content is used as the actual data for the data sets that are dispatched
7925 to the daemon. How many such columns you need is determined by the B<Type>
7926 setting above. If you specify too many or not enough columns, the plugin will
7927 complain about that and no data will be submitted to the daemon. The plugin
7928 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7929 respectively, so anything supported by those functions is supported by the
7930 plugin as well. This option is mandatory.
7934 =head2 Plugin C<tail>
7936 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7937 each line and dispatches found values. What is matched can be configured by the
7938 user using (extended) regular expressions, as described in L<regex(7)>.
7941 <File "/var/log/exim4/mainlog">
7946 Regex "S=([1-9][0-9]*)"
7952 Regex "\\<R=local_user\\>"
7953 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7956 Instance "local_user"
7959 Regex "l=([0-9]*\\.[0-9]*)"
7960 <DSType "Distribution">
7963 #BucketType "bucket"
7971 The config consists of one or more B<File> blocks, each of which configures one
7972 logfile to parse. Within each B<File> block, there are one or more B<Match>
7973 blocks, which configure a regular expression to search for.
7975 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
7976 the plugin name and instance respectively. So in the above example the plugin name
7977 C<mail-exim> would be used.
7979 These options are applied for all B<Match> blocks that B<follow> it, until the
7980 next B<Plugin> or B<Instance> option. This way you can extract several plugin
7981 instances from one logfile, handy when parsing syslog and the like.
7983 The B<Interval> option allows you to define the length of time between reads. If
7984 this is not set, the default Interval will be used.
7986 Each B<Match> block has the following options to describe how the match should
7991 =item B<Regex> I<regex>
7993 Sets the regular expression to use for matching against a line. The first
7994 subexpression has to match something that can be turned into a number by
7995 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7996 below. Because B<extended> regular expressions are used, you do not need to use
7997 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7998 collectd's config parsing you need to escape backslashes, though. So if you
7999 want to match literal parentheses you need to do the following:
8001 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8003 =item B<ExcludeRegex> I<regex>
8005 Sets an optional regular expression to use for excluding lines from the match.
8006 An example which excludes all connections from localhost from the match:
8008 ExcludeRegex "127\\.0\\.0\\.1"
8010 =item B<DSType> I<Type>
8012 Sets how the values are cumulated. I<Type> is one of:
8016 =item B<GaugeAverage>
8018 Calculate the average.
8022 Use the smallest number only.
8026 Use the greatest number only.
8030 Use the last number found.
8032 =item B<GaugePersist>
8034 Use the last number found. The number is not reset at the end of an interval.
8035 It is continously reported until another number is matched. This is intended
8036 for cases in which only state changes are reported, for example a thermometer
8037 that only reports the temperature when it changes.
8043 =item B<AbsoluteSet>
8045 The matched number is a counter. Simply I<sets> the internal counter to this
8046 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8054 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8055 matched number may be negative, which will effectively subtract from the
8064 Increase the internal counter by one. These B<DSType> are the only ones that do
8065 not use the matched subexpression, but simply count the number of matched
8066 lines. Thus, you may use a regular expression without submatch in this case.
8068 =item B<Distribution>
8070 Type to do calculations based on the distribution of values, primarily
8071 calculating percentiles. This is primarily geared towards latency, but can be
8072 used for other metrics as well. The range of values tracked with this setting
8073 must be in the range (0–2^34) and can be fractional. Please note that neither
8074 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8077 This option must be used together with the B<Percentile> and/or B<Bucket>
8082 <DSType "Distribution">
8090 =item B<Percentile> I<Percent>
8092 Calculate and dispatch the configured percentile, i.e. compute the value, so
8093 that I<Percent> of all matched values are smaller than or equal to the computed
8096 Metrics are reported with the I<type> B<Type> (the value of the above option)
8097 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8099 This option may be repeated to calculate more than one percentile.
8101 =item B<Bucket> I<lower_bound> I<upper_bound>
8103 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8104 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8105 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8106 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8107 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8110 To export the entire (0–inf) range without overlap, use the upper bound of the
8111 previous range as the lower bound of the following range. In other words, use
8112 the following schema:
8122 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8123 by default) and the I<type instance>
8124 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8126 This option may be repeated to calculate more than one rate.
8128 =item B<BucketType> I<Type>
8130 Sets the type used to dispatch B<Bucket> metrics.
8131 Optional, by default C<bucket> will be used.
8137 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8138 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8139 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8140 B<Derive*> types interpret the submatch as a signed integer using
8141 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8142 and it may be omitted in this case.
8144 =item B<Type> I<Type>
8146 Sets the type used to dispatch this value. Detailed information about types and
8147 their configuration can be found in L<types.db(5)>.
8149 =item B<Instance> I<TypeInstance>
8151 This optional setting sets the type instance to use.
8155 =head2 Plugin C<tail_csv>
8157 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8158 written by I<Snort>.
8163 <Metric "snort-dropped">
8168 <File "/var/log/snort/snort.stats">
8172 Collect "snort-dropped"
8176 The configuration consists of one or more B<Metric> blocks that define an index
8177 into the line of the CSV file and how this value is mapped to I<collectd's>
8178 internal representation. These are followed by one or more B<Instance> blocks
8179 which configure which file to read, in which interval and which metrics to
8184 =item E<lt>B<Metric> I<Name>E<gt>
8186 The B<Metric> block configures a new metric to be extracted from the statistics
8187 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8188 only used inside the B<Instance> blocks to refer to this block, so you can use
8189 one B<Metric> block for multiple CSV files.
8193 =item B<Type> I<Type>
8195 Configures which I<Type> to use when dispatching this metric. Types are defined
8196 in the L<types.db(5)> file, see the appropriate manual page for more
8197 information on specifying types. Only types with a single I<data source> are
8198 supported by the I<tail_csv plugin>. The information whether the value is an
8199 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8200 I<Type's> definition.
8202 =item B<Instance> I<TypeInstance>
8204 If set, I<TypeInstance> is used to populate the type instance field of the
8205 created value lists. Otherwise, no type instance is used.
8207 =item B<ValueFrom> I<Index>
8209 Configure to read the value from the field with the zero-based index I<Index>.
8210 If the value is parsed as signed integer, unsigned integer or double depends on
8211 the B<Type> setting, see above.
8215 =item E<lt>B<File> I<Path>E<gt>
8217 Each B<File> block represents one CSV file to read. There must be at least one
8218 I<File> block but there can be multiple if you have multiple CSV files.
8222 =item B<Plugin> I<Plugin>
8224 Use I<Plugin> as the plugin name when submitting values.
8225 Defaults to C<tail_csv>.
8227 =item B<Instance> I<PluginInstance>
8229 Sets the I<plugin instance> used when dispatching the values.
8231 =item B<Collect> I<Metric>
8233 Specifies which I<Metric> to collect. This option must be specified at least
8234 once, and you can use this option multiple times to specify more than one
8235 metric to be extracted from this statistic file.
8237 =item B<Interval> I<Seconds>
8239 Configures the interval in which to read values from this instance / file.
8240 Defaults to the plugin's default interval.
8242 =item B<TimeFrom> I<Index>
8244 Rather than using the local time when dispatching a value, read the timestamp
8245 from the field with the zero-based index I<Index>. The value is interpreted as
8246 seconds since epoch. The value is parsed as a double and may be factional.
8252 =head2 Plugin C<teamspeak2>
8254 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8255 polls interesting global and virtual server data. The plugin can query only one
8256 physical server but unlimited virtual servers. You can use the following
8257 options to configure it:
8261 =item B<Host> I<hostname/ip>
8263 The hostname or ip which identifies the physical server.
8266 =item B<Port> I<port>
8268 The query port of the physical server. This needs to be a string.
8271 =item B<Server> I<port>
8273 This option has to be added once for every virtual server the plugin should
8274 query. If you want to query the virtual server on port 8767 this is what the
8275 option would look like:
8279 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8280 use quotes around it! If no such statement is given only global information
8285 =head2 Plugin C<ted>
8287 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8288 measure power consumption. These devices are usually connected to a serial
8289 (RS232) or USB port. The plugin opens a configured device and tries to read the
8290 current energy readings. For more information on TED, visit
8291 L<http://www.theenergydetective.com/>.
8293 Available configuration options:
8297 =item B<Device> I<Path>
8299 Path to the device on which TED is connected. collectd will need read and write
8300 permissions on that file.
8302 Default: B</dev/ttyUSB0>
8304 =item B<Retries> I<Num>
8306 Apparently reading from TED is not that reliable. You can therefore configure a
8307 number of retries here. You only configure the I<retries> here, to if you
8308 specify zero, one reading will be performed (but no retries if that fails); if
8309 you specify three, a maximum of four readings are performed. Negative values
8316 =head2 Plugin C<tcpconns>
8318 The C<tcpconns plugin> counts the number of currently established TCP
8319 connections based on the local port and/or the remote port. Since there may be
8320 a lot of connections the default if to count all connections with a local port,
8321 for which a listening socket is opened. You can use the following options to
8322 fine-tune the ports you are interested in:
8326 =item B<ListeningPorts> I<true>|I<false>
8328 If this option is set to I<true>, statistics for all local ports for which a
8329 listening socket exists are collected. The default depends on B<LocalPort> and
8330 B<RemotePort> (see below): If no port at all is specifically selected, the
8331 default is to collect listening ports. If specific ports (no matter if local or
8332 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8333 the selected ports will be collected unless this option is set to I<true>
8336 =item B<LocalPort> I<Port>
8338 Count the connections to a specific local port. This can be used to see how
8339 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8340 You have to specify the port in numeric form, so for the mailserver example
8341 you'd need to set B<25>.
8343 =item B<RemotePort> I<Port>
8345 Count the connections to a specific remote port. This is useful to see how
8346 much a remote service is used. This is most useful if you want to know how many
8347 connections a local service has opened to remote services, e.E<nbsp>g. how many
8348 connections a mail server or news server has to other mail or news servers, or
8349 how many connections a web proxy holds to web servers. You have to give the
8350 port in numeric form.
8352 =item B<AllPortsSummary> I<true>|I<false>
8354 If this option is set to I<true> a summary of statistics from all connections
8355 are collected. This option defaults to I<false>.
8359 =head2 Plugin C<thermal>
8363 =item B<ForceUseProcfs> I<true>|I<false>
8365 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8366 C<sysfs> interface. If that is not available, the plugin falls back to the
8367 C<procfs> interface. By setting this option to I<true>, you can force the
8368 plugin to use the latter. This option defaults to I<false>.
8370 =item B<Device> I<Device>
8372 Selects the name of the thermal device that you want to collect or ignore,
8373 depending on the value of the B<IgnoreSelected> option. This option may be
8374 used multiple times to specify a list of devices.
8376 See F</"IGNORELISTS"> for details.
8378 =item B<IgnoreSelected> I<true>|I<false>
8380 Invert the selection: If set to true, all devices B<except> the ones that
8381 match the device names specified by the B<Device> option are collected. By
8382 default only selected devices are collected if a selection is made. If no
8383 selection is configured at all, B<all> devices are selected.
8387 =head2 Plugin C<threshold>
8389 The I<Threshold plugin> checks values collected or received by I<collectd>
8390 against a configurable I<threshold> and issues I<notifications> if values are
8393 Documentation for this plugin is available in the L<collectd-threshold(5)>
8396 =head2 Plugin C<tokyotyrant>
8398 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8399 couple metrics: number of records, and database size on disk.
8403 =item B<Host> I<Hostname/IP>
8405 The hostname or IP which identifies the server.
8406 Default: B<127.0.0.1>
8408 =item B<Port> I<Service/Port>
8410 The query port of the server. This needs to be a string, even if the port is
8411 given in its numeric form.
8416 =head2 Plugin C<turbostat>
8418 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8419 Intel processors by using I<Model Specific Registers>.
8423 =item B<CoreCstates> I<Bitmask(Integer)>
8425 Bit mask of the list of core C-states supported by the processor.
8426 This option should only be used if the automated detection fails.
8427 Default value extracted from the CPU model and family.
8429 Currently supported C-states (by this plugin): 3, 6, 7
8433 All states (3, 6 and 7):
8434 (1<<3) + (1<<6) + (1<<7) = 392
8436 =item B<PackageCstates> I<Bitmask(Integer)>
8438 Bit mask of the list of packages C-states supported by the processor. This
8439 option should only be used if the automated detection fails. Default value
8440 extracted from the CPU model and family.
8442 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8446 States 2, 3, 6 and 7:
8447 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8449 =item B<SystemManagementInterrupt> I<true>|I<false>
8451 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8452 This option should only be used if the automated detection fails or if you want
8453 to disable this feature.
8455 =item B<DigitalTemperatureSensor> I<true>|I<false>
8457 Boolean enabling the collection of the temperature of each core. This option
8458 should only be used if the automated detection fails or if you want to disable
8461 =item B<TCCActivationTemp> I<Temperature>
8463 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8464 temperature is used when collecting the temperature of cores or packages. This
8465 option should only be used if the automated detection fails. Default value
8466 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8468 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8470 Bit mask of the list of elements to be thermally monitored. This option should
8471 only be used if the automated detection fails or if you want to disable some
8472 collections. The different bits of this bit mask accepted by this plugin are:
8476 =item 0 ('1'): Package
8480 =item 2 ('4'): Cores
8482 =item 3 ('8'): Embedded graphic device
8486 =item B<LogicalCoreNames> I<true>|I<false>
8488 Boolean enabling the use of logical core numbering for per core statistics.
8489 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8490 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8491 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8492 more than one, where I<n> is the n-th core of package I<m>.
8496 =head2 Plugin C<unixsock>
8500 =item B<SocketFile> I<Path>
8502 Sets the socket-file which is to be created.
8504 =item B<SocketGroup> I<Group>
8506 If running as root change the group of the UNIX-socket after it has been
8507 created. Defaults to B<collectd>.
8509 =item B<SocketPerms> I<Permissions>
8511 Change the file permissions of the UNIX-socket after it has been created. The
8512 permissions must be given as a numeric, octal value as you would pass to
8513 L<chmod(1)>. Defaults to B<0770>.
8515 =item B<DeleteSocket> B<false>|B<true>
8517 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8518 with the given name already exists. If I<collectd> crashes a socket file may be
8519 left over, preventing the daemon from opening a new socket when restarted.
8520 Since this is potentially dangerous, this defaults to B<false>.
8524 =head2 Plugin C<uuid>
8526 This plugin, if loaded, causes the Hostname to be taken from the machine's
8527 UUID. The UUID is a universally unique designation for the machine, usually
8528 taken from the machine's BIOS. This is most useful if the machine is running in
8529 a virtual environment such as Xen, in which case the UUID is preserved across
8530 shutdowns and migration.
8532 The following methods are used to find the machine's UUID, in order:
8538 Check I</etc/uuid> (or I<UUIDFile>).
8542 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8547 Check for UUID from C<dmidecode> / SMBIOS.
8551 Check for UUID from Xen hypervisor.
8555 If no UUID can be found then the hostname is not modified.
8559 =item B<UUIDFile> I<Path>
8561 Take the UUID from the given file (default I</etc/uuid>).
8565 =head2 Plugin C<varnish>
8567 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8568 It collects a subset of the values displayed by L<varnishstat(1)>, and
8569 organizes them in categories which can be enabled or disabled. Currently only
8570 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8571 meaning of each metric can be found in L<varnish-counters(7)>.
8576 <Instance "example">
8580 CollectConnections true
8581 CollectDirectorDNS false
8585 CollectObjects false
8587 CollectSession false
8597 CollectWorkers false
8599 CollectMempool false
8600 CollectManagement false
8607 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8608 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8609 will collectd statistics from the default "varnishd" instance (this should work
8610 fine in most cases).
8612 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8616 =item B<CollectBackend> B<true>|B<false>
8618 Back-end connection statistics, such as successful, reused,
8619 and closed connections. True by default.
8621 =item B<CollectBan> B<true>|B<false>
8623 Statistics about ban operations, such as number of bans added, retired, and
8624 number of objects tested against ban operations. Only available with Varnish
8625 3.x and above. False by default.
8627 =item B<CollectCache> B<true>|B<false>
8629 Cache hits and misses. True by default.
8631 =item B<CollectConnections> B<true>|B<false>
8633 Number of client connections received, accepted and dropped. True by default.
8635 =item B<CollectDirectorDNS> B<true>|B<false>
8637 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8640 =item B<CollectESI> B<true>|B<false>
8642 Edge Side Includes (ESI) parse statistics. False by default.
8644 =item B<CollectFetch> B<true>|B<false>
8646 Statistics about fetches (HTTP requests sent to the backend). False by default.
8648 =item B<CollectHCB> B<true>|B<false>
8650 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8651 divided into locked and unlocked look-ups. False by default.
8653 =item B<CollectObjects> B<true>|B<false>
8655 Statistics on cached objects: number of objects expired, nuked (prematurely
8656 expired), saved, moved, etc. False by default.
8658 =item B<CollectPurge> B<true>|B<false>
8660 Statistics about purge operations, such as number of purges added, retired, and
8661 number of objects tested against purge operations. Only available with Varnish
8662 2.x. False by default.
8664 =item B<CollectSession> B<true>|B<false>
8666 Client session statistics. Number of past and current sessions, session herd and
8667 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8668 metrics found in the Connections and Threads sections with previous versions of
8669 Varnish have been moved here.
8671 =item B<CollectSHM> B<true>|B<false>
8673 Statistics about the shared memory log, a memory region to store
8674 log messages which is flushed to disk when full. True by default.
8676 =item B<CollectSMA> B<true>|B<false>
8678 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8679 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
8680 only the one used by the Varnish instance. Only available with Varnish 2.x.
8683 =item B<CollectSMS> B<true>|B<false>
8685 synth (synthetic content) storage statistics. This storage
8686 component is used internally only. False by default.
8688 =item B<CollectSM> B<true>|B<false>
8690 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
8691 in varnish 4.x. use CollectSMF.
8694 =item B<CollectStruct> B<true>|B<false>
8696 Current varnish internal state statistics. Number of current sessions, objects
8697 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8700 =item B<CollectTotals> B<true>|B<false>
8702 Collects overview counters, such as the number of sessions created,
8703 the number of requests and bytes transferred. False by default.
8705 =item B<CollectUptime> B<true>|B<false>
8707 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8709 =item B<CollectVCL> B<true>|B<false>
8711 Number of total (available + discarded) VCL (config files). False by default.
8713 =item B<CollectVSM> B<true>|B<false>
8715 Collect statistics about Varnish's shared memory usage (used by the logging and
8716 statistics subsystems). Only available with Varnish 4.x. False by default.
8718 =item B<CollectWorkers> B<true>|B<false>
8720 Collect statistics about worker threads. False by default.
8722 =item B<CollectVBE> B<true>|B<false>
8724 Backend counters. Only available with Varnish 4.x. False by default.
8726 =item B<CollectSMF> B<true>|B<false>
8728 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
8729 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
8730 instance. Used to be called SM in Varnish 2.x. False by default.
8732 =item B<CollectManagement> B<true>|B<false>
8734 Management process counters. Only available with Varnish 4.x. False by default.
8736 =item B<CollectLock> B<true>|B<false>
8738 Lock counters. Only available with Varnish 4.x. False by default.
8740 =item B<CollectMempool> B<true>|B<false>
8742 Memory pool counters. Only available with Varnish 4.x. False by default.
8744 =item B<CollectMSE> B<true>|B<false>
8746 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
8747 Varnish, replacing the traditional malloc and file storages. Only available
8748 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
8749 one used by the Varnish instance. False by default.
8753 =head2 Plugin C<virt>
8755 This plugin allows CPU, disk, network load and other metrics to be collected for
8756 virtualized guests on the machine. The statistics are collected through libvirt
8757 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8758 installing any additional software on guests, especially I<collectd>, which runs
8759 only on the host system.
8761 Only I<Connection> is required.
8765 =item B<Connection> I<uri>
8767 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8769 Connection "xen:///"
8771 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8773 =item B<RefreshInterval> I<seconds>
8775 Refresh the list of domains and devices every I<seconds>. The default is 60
8776 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8777 the list of domains and devices to be refreshed on every iteration.
8779 Refreshing the devices in particular is quite a costly operation, so if your
8780 virtualization setup is static you might consider increasing this. If this
8781 option is set to 0, refreshing is disabled completely.
8783 =item B<Domain> I<name>
8785 =item B<BlockDevice> I<name:dev>
8787 =item B<InterfaceDevice> I<name:dev>
8789 =item B<IgnoreSelected> B<true>|B<false>
8791 Select which domains and devices are collected.
8793 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8794 disk/network devices are collected.
8796 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8797 domains and disk/network devices are ignored, while the rest are collected.
8799 The domain name and device names may use a regular expression, if the name is
8800 surrounded by I</.../> and collectd was compiled with support for regexps.
8802 The default is to collect statistics for all domains and all their devices.
8806 BlockDevice "/:hdb/"
8807 IgnoreSelected "true"
8809 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8812 =item B<BlockDeviceFormat> B<target>|B<source>
8814 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8815 seen by the guest will be used for reporting metrics.
8816 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8819 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8820 using the path of the source, e.g. an image file.
8821 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8826 If the domain XML have the following device defined:
8828 <disk type='block' device='disk'>
8829 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8830 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8831 <target dev='sda' bus='scsi'/>
8833 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8836 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8838 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8839 to C<var_lib_libvirt_images_image1.qcow2>.
8841 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8843 The B<BlockDeviceFormatBasename> controls whether the full path or the
8844 L<basename(1)> of the source is being used as the I<type instance> when
8845 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8849 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8850 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8851 be set to C<var_lib_libvirt_images_image1.qcow2>.
8852 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8853 set to C<image1.qcow2>.
8855 =item B<HostnameFormat> B<name|uuid|hostname|...>
8857 When the virt plugin logs data, it sets the hostname of the collected data
8858 according to this setting. The default is to use the guest name as provided by
8859 the hypervisor, which is equal to setting B<name>.
8861 B<uuid> means use the guest's UUID. This is useful if you want to track the
8862 same guest across migrations.
8864 B<hostname> means to use the global B<Hostname> setting, which is probably not
8865 useful on its own because all guests will appear to have the same name.
8867 You can also specify combinations of these fields. For example B<name uuid>
8868 means to concatenate the guest name and UUID (with a literal colon character
8869 between, thus I<"foo:1234-1234-1234-1234">).
8871 At the moment of writing (collectd-5.5), hostname string is limited to 62
8872 characters. In case when combination of fields exceeds 62 characters,
8873 hostname will be truncated without a warning.
8875 =item B<InterfaceFormat> B<name>|B<address>
8877 When the virt plugin logs interface data, it sets the name of the collected
8878 data according to this setting. The default is to use the path as provided by
8879 the hypervisor (the "dev" property of the target node), which is equal to
8882 B<address> means use the interface's mac address. This is useful since the
8883 interface path might change between reboots of a guest or across migrations.
8885 =item B<PluginInstanceFormat> B<name|uuid|none>
8887 When the virt plugin logs data, it sets the plugin_instance of the collected
8888 data according to this setting. The default is to not set the plugin_instance.
8890 B<name> means use the guest's name as provided by the hypervisor.
8891 B<uuid> means use the guest's UUID.
8893 You can also specify combinations of the B<name> and B<uuid> fields.
8894 For example B<name uuid> means to concatenate the guest name and UUID
8895 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8897 =item B<Instances> B<integer>
8899 How many read instances you want to use for this plugin. The default is one,
8900 and the sensible setting is a multiple of the B<ReadThreads> value.
8901 If you are not sure, just use the default setting.
8903 =item B<ExtraStats> B<string>
8905 Report additional extra statistics. The default is no extra statistics, preserving
8906 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8907 allows the plugin to reported more detailed statistics about the behaviour of
8908 Virtual Machines. The argument is a space-separated list of selectors.
8910 Currently supported selectors are:
8914 =item B<cpu_util>: report CPU utilization per domain in percentage.
8916 =item B<disk>: report extra statistics like number of flush operations and total
8917 service time for read, write and flush operations. Requires libvirt API version
8920 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8923 =item B<domain_state>: report domain state and reason in human-readable format as
8924 a notification. If libvirt API version I<0.9.2> or later is available, domain
8925 reason will be included in notification.
8927 =item B<fs_info>: report file system information as a notification. Requires
8928 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8929 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8930 version supports retrieving file system information.
8932 =item B<job_stats_background>: report statistics about progress of a background
8933 job on a domain. Only one type of job statistics can be collected at the same time.
8934 Requires libvirt API version I<1.2.9> or later.
8936 =item B<job_stats_completed>: report statistics about a recently completed job on
8937 a domain. Only one type of job statistics can be collected at the same time.
8938 Requires libvirt API version I<1.2.9> or later.
8940 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8941 Requires libvirt API version I<0.9.11> or later.
8943 =item B<perf>: report performance monitoring events. To collect performance
8944 metrics they must be enabled for domain and supported by the platform. Requires
8945 libvirt API version I<1.3.3> or later.
8946 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8948 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8954 =head2 Plugin C<vmem>
8956 The C<vmem> plugin collects information about the usage of virtual memory.
8957 Since the statistics provided by the Linux kernel are very detailed, they are
8958 collected very detailed. However, to get all the details, you have to switch
8959 them on manually. Most people just want an overview over, such as the number of
8960 pages read from swap space.
8964 =item B<Verbose> B<true>|B<false>
8966 Enables verbose collection of information. This will start collecting page
8967 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8968 Part of these statistics are collected on a "per zone" basis.
8972 =head2 Plugin C<vserver>
8974 This plugin doesn't have any options. B<VServer> support is only available for
8975 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8976 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8977 need to apply the patches and compile your own kernel, which will then provide
8978 the F</proc/virtual> filesystem that is required by this plugin.
8980 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8982 B<Note>: The traffic collected by this plugin accounts for the amount of
8983 traffic passing a socket which might be a lot less than the actual on-wire
8984 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8985 collect on-wire traffic you could, for example, use the logging facilities of
8986 iptables to feed data for the guest IPs into the iptables plugin.
8988 =head2 Plugin C<write_graphite>
8990 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8991 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8992 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8993 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8994 of at most 1428 bytes to minimize the number of network packets.
8998 <Plugin write_graphite>
9008 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9009 blocks. Inside the B<Node> blocks, the following options are recognized:
9013 =item B<Host> I<Address>
9015 Hostname or address to connect to. Defaults to C<localhost>.
9017 =item B<Port> I<Service>
9019 Service name or port number to connect to. Defaults to C<2003>.
9021 =item B<Protocol> I<String>
9023 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9025 =item B<ReconnectInterval> I<Seconds>
9027 When set to non-zero, forces the connection to the Graphite backend to be
9028 closed and re-opend periodically. This behavior is desirable in environments
9029 where the connection to the Graphite backend is done through load balancers,
9030 for example. When set to zero, the default, the connetion is kept open for as
9033 =item B<LogSendErrors> B<false>|B<true>
9035 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9036 If set to B<false>, it will not log the errors. This is especially useful when
9037 using Protocol UDP since many times we want to use the "fire-and-forget"
9038 approach and logging errors fills syslog with unneeded messages.
9040 =item B<Prefix> I<String>
9042 When set, I<String> is added in front of the host name. Dots and whitespace are
9043 I<not> escaped in this string (see B<EscapeCharacter> below).
9045 =item B<Postfix> I<String>
9047 When set, I<String> is appended to the host name. Dots and whitespace are
9048 I<not> escaped in this string (see B<EscapeCharacter> below).
9050 =item B<EscapeCharacter> I<Char>
9052 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9053 in the identifier. The B<EscapeCharacter> option determines which character
9054 dots, whitespace and control characters are replaced with. Defaults to
9057 =item B<StoreRates> B<false>|B<true>
9059 If set to B<true> (the default), convert counter values to rates. If set to
9060 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9063 =item B<SeparateInstances> B<false>|B<true>
9065 If set to B<true>, the plugin instance and type instance will be in their own
9066 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9067 default), the plugin and plugin instance (and likewise the type and type
9068 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9070 =item B<AlwaysAppendDS> B<false>|B<true>
9072 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9073 identifier. If set to B<false> (the default), this is only done when there is
9076 =item B<PreserveSeparator> B<false>|B<true>
9078 If set to B<false> (the default) the C<.> (dot) character is replaced with
9079 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9080 is preserved, i.e. passed through.
9082 =item B<DropDuplicateFields> B<false>|B<true>
9084 If set to B<true>, detect and remove duplicate components in Graphite metric
9085 names. For example, the metric name C<host.load.load.shortterm> will
9086 be shortened to C<host.load.shortterm>.
9090 =head2 Plugin C<write_log>
9092 The C<write_log> plugin writes metrics as INFO log messages.
9094 This plugin supports two output formats: I<Graphite> and I<JSON>.
9104 =item B<Format> I<Format>
9106 The output format to use. Can be one of C<Graphite> or C<JSON>.
9110 =head2 Plugin C<write_tsdb>
9112 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9113 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9114 state daemon that ingests metrics and stores them in HBase. The plugin uses
9115 I<TCP> over the "line based" protocol with a default port 4242. The data will
9116 be sent in blocks of at most 1428 bytes to minimize the number of network
9125 Host "tsd-1.my.domain"
9127 HostTags "status=production"
9131 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9132 blocks and global directives.
9134 Global directives are:
9138 =item B<ResolveInterval> I<seconds>
9140 =item B<ResolveJitter> I<seconds>
9142 When I<collectd> connects to a TSDB node, it will request the hostname from
9143 DNS. This can become a problem if the TSDB node is unavailable or badly
9144 configured because collectd will request DNS in order to reconnect for every
9145 metric, which can flood your DNS. So you can cache the last value for
9146 I<ResolveInterval> seconds.
9147 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9149 You can also define a jitter, a random interval to wait in addition to
9150 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9151 hostname at the same time when the connection fails.
9152 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9154 B<Note:> If the DNS resolution has already been successful when the socket
9155 closes, the plugin will try to reconnect immediately with the cached
9156 information. DNS is queried only when the socket is closed for a longer than
9157 I<ResolveInterval> + I<ResolveJitter> seconds.
9161 Inside the B<Node> blocks, the following options are recognized:
9165 =item B<Host> I<Address>
9167 Hostname or address to connect to. Defaults to C<localhost>.
9169 =item B<Port> I<Service>
9171 Service name or port number to connect to. Defaults to C<4242>.
9174 =item B<HostTags> I<String>
9176 When set, I<HostTags> is added to the end of the metric. It is intended to be
9177 used for name=value pairs that the TSD will tag the metric with. Dots and
9178 whitespace are I<not> escaped in this string.
9180 =item B<StoreRates> B<false>|B<true>
9182 If set to B<true>, convert counter values to rates. If set to B<false>
9183 (the default) counter values are stored as is, as an increasing
9186 =item B<AlwaysAppendDS> B<false>|B<true>
9188 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9189 identifier. If set to B<false> (the default), this is only done when there is
9194 =head2 Plugin C<write_mongodb>
9196 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9201 <Plugin "write_mongodb">
9210 The plugin can send values to multiple instances of I<MongoDB> by specifying
9211 one B<Node> block for each instance. Within the B<Node> blocks, the following
9212 options are available:
9216 =item B<Host> I<Address>
9218 Hostname or address to connect to. Defaults to C<localhost>.
9220 =item B<Port> I<Service>
9222 Service name or port number to connect to. Defaults to C<27017>.
9224 =item B<Timeout> I<Milliseconds>
9226 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9227 Setting this option to zero means no timeout, which is the default.
9229 =item B<StoreRates> B<false>|B<true>
9231 If set to B<true> (the default), convert counter values to rates. If set to
9232 B<false> counter values are stored as is, i.e. as an increasing integer
9235 =item B<Database> I<Database>
9237 =item B<User> I<User>
9239 =item B<Password> I<Password>
9241 Sets the information used when authenticating to a I<MongoDB> database. The
9242 fields are optional (in which case no authentication is attempted), but if you
9243 want to use authentication all three fields must be set.
9247 =head2 Plugin C<write_prometheus>
9249 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9250 using I<Prometheus>.
9256 =item B<Port> I<Port>
9258 Port the embedded webserver should listen on. Defaults to B<9103>.
9260 =item B<StalenessDelta> I<Seconds>
9262 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9263 hasn't seen any update for it. This value must match the setting in Prometheus.
9264 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9268 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9269 which time a metric without updates is considered "stale". This setting
9270 effectively puts an upper limit on the interval in which metrics are reported.
9272 When the I<write_prometheus plugin> encounters a metric with an interval
9273 exceeding this limit, it will inform you, the user, and provide the metric to
9274 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9275 metric "fresh" each time it is scraped, with the time of the scrape being
9276 considered the time of the update. The result is that there appear more
9277 datapoints in I<Prometheus> than were actually created, but at least the metric
9278 doesn't disappear periodically.
9282 =head2 Plugin C<write_http>
9284 This output plugin submits values to an HTTP server using POST requests and
9285 encoding metrics with JSON or using the C<PUTVAL> command described in
9286 L<collectd-unixsock(5)>.
9290 <Plugin "write_http">
9292 URL "http://example.com/post-collectd"
9299 The plugin can send values to multiple HTTP servers by specifying one
9300 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9301 block, the following options are available:
9307 URL to which the values are submitted to. Mandatory.
9309 =item B<User> I<Username>
9311 Optional user name needed for authentication.
9313 =item B<Password> I<Password>
9315 Optional password needed for authentication.
9317 =item B<VerifyPeer> B<true>|B<false>
9319 Enable or disable peer SSL certificate verification. See
9320 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9322 =item B<VerifyHost> B<true|false>
9324 Enable or disable peer host name verification. If enabled, the plugin checks if
9325 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9326 matches the host name provided by the B<URL> option. If this identity check
9327 fails, the connection is aborted. Obviously, only works when connecting to a
9328 SSL enabled server. Enabled by default.
9330 =item B<CACert> I<File>
9332 File that holds one or more SSL certificates. If you want to use HTTPS you will
9333 possibly need this option. What CA certificates come bundled with C<libcurl>
9334 and are checked by default depends on the distribution you use.
9336 =item B<CAPath> I<Directory>
9338 Directory holding one or more CA certificate files. You can use this if for
9339 some reason all the needed CA certificates aren't in the same file and can't be
9340 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9343 =item B<ClientKey> I<File>
9345 File that holds the private key in PEM format to be used for certificate-based
9348 =item B<ClientCert> I<File>
9350 File that holds the SSL certificate to be used for certificate-based
9353 =item B<ClientKeyPass> I<Password>
9355 Password required to load the private key in B<ClientKey>.
9357 =item B<Header> I<Header>
9359 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9361 Header "X-Custom-Header: custom_value"
9363 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9365 Define which SSL protocol version must be used. By default C<libcurl> will
9366 attempt to figure out the remote SSL protocol version. See
9367 L<curl_easy_setopt(3)> for more details.
9369 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9371 Format of the output to generate. If set to B<Command>, will create output that
9372 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9373 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9374 , will create output in the KairosDB format.
9376 Defaults to B<Command>.
9378 =item B<Attribute> I<String> I<String>
9380 Only available for the KAIROSDB output format.
9382 Consider the two given strings to be the key and value of an additional tag for
9383 each metric being sent out.
9385 You can add multiple B<Attribute>.
9389 Only available for the KAIROSDB output format.
9391 Sets the Cassandra ttl for the data points.
9393 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9395 =item B<Prefix> I<String>
9397 Only available for the KAIROSDB output format.
9399 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9401 =item B<Metrics> B<true>|B<false>
9403 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9405 =item B<Notifications> B<false>|B<true>
9407 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9409 =item B<StoreRates> B<true|false>
9411 If set to B<true>, convert counter values to rates. If set to B<false> (the
9412 default) counter values are stored as is, i.e. as an increasing integer number.
9414 =item B<BufferSize> I<Bytes>
9416 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9417 requests will be generated, but more metrics will be batched / metrics are
9418 cached for longer before being sent, introducing additional delay until they
9419 are available on the server side. I<Bytes> must be at least 1024 and cannot
9420 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9421 Defaults to C<4096>.
9423 =item B<LowSpeedLimit> I<Bytes per Second>
9425 Sets the minimal transfer rate in I<Bytes per Second> below which the
9426 connection with the HTTP server will be considered too slow and aborted. All
9427 the data submitted over this connection will probably be lost. Defaults to 0,
9428 which means no minimum transfer rate is enforced.
9430 =item B<Timeout> I<Timeout>
9432 Sets the maximum time in milliseconds given for HTTP POST operations to
9433 complete. When this limit is reached, the POST operation will be aborted, and
9434 all the data in the current send buffer will probably be lost. Defaults to 0,
9435 which means the connection never times out.
9437 =item B<LogHttpError> B<false>|B<true>
9439 Enables printing of HTTP error code to log. Turned off by default.
9441 The C<write_http> plugin regularly submits the collected values to the HTTP
9442 server. How frequently this happens depends on how much data you are collecting
9443 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9444 slightly below this interval, which you can estimate by monitoring the network
9445 traffic between collectd and the HTTP server.
9449 =head2 Plugin C<write_kafka>
9451 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9455 <Plugin "write_kafka">
9456 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9462 The following options are understood by the I<write_kafka plugin>:
9466 =item E<lt>B<Topic> I<Name>E<gt>
9468 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9469 is given a unique I<Name> and specifies one kafka producer.
9470 Inside the B<Topic> block, the following per-topic options are
9475 =item B<Property> I<String> I<String>
9477 Configure the named property for the current topic. Properties are
9478 forwarded to the kafka producer library B<librdkafka>.
9480 =item B<Key> I<String>
9482 Use the specified string as a partitioning key for the topic. Kafka breaks
9483 topic into partitions and guarantees that for a given topology, the same
9484 consumer will be used for a specific key. The special (case insensitive)
9485 string B<Random> can be used to specify that an arbitrary partition should
9488 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9490 Selects the format in which messages are sent to the broker. If set to
9491 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9492 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9494 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9495 an easy and straight forward exchange format.
9497 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9498 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9500 =item B<StoreRates> B<true>|B<false>
9502 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9503 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9504 default), no conversion is performed. Otherwise the conversion is performed
9505 using the internal value cache.
9507 Please note that currently this option is only used if the B<Format> option has
9508 been set to B<JSON>.
9510 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9512 A prefix can be added in the metric name when outputting in the I<Graphite>
9513 format. It's added before the I<Host> name.
9515 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>>
9517 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9519 A postfix can be added in the metric name when outputting in the I<Graphite>
9520 format. It's added after the I<Host> name.
9522 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>>
9524 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9526 Specify a character to replace dots (.) in the host part of the metric name.
9527 In I<Graphite> metric name, dots are used as separators between different
9528 metric parts (host, plugin, type).
9529 Default is C<_> (I<Underscore>).
9531 =item B<GraphiteSeparateInstances> B<false>|B<true>
9533 If set to B<true>, the plugin instance and type instance will be in their own
9534 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9535 default), the plugin and plugin instance (and likewise the type and type
9536 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9538 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9540 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9541 identifier. If set to B<false> (the default), this is only done when there is
9544 =item B<GraphitePreserveSeparator> B<false>|B<true>
9546 If set to B<false> (the default) the C<.> (dot) character is replaced with
9547 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9548 is preserved, i.e. passed through.
9550 =item B<StoreRates> B<true>|B<false>
9552 If set to B<true> (the default), convert counter values to rates. If set to
9553 B<false> counter values are stored as is, i.e. as an increasing integer number.
9555 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9556 converted values will have "rate" appended to the data source type, e.g.
9557 C<ds_type:derive:rate>.
9561 =item B<Property> I<String> I<String>
9563 Configure the kafka producer through properties, you almost always will
9564 want to set B<metadata.broker.list> to your Kafka broker list.
9568 =head2 Plugin C<write_redis>
9570 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9574 <Plugin "write_redis">
9587 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9588 the timestamp as the score. Retrieving a date range can then be done using the
9589 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9590 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9591 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9592 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9593 with the B<Database> parameter (default is C<0>). See
9594 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9597 The information shown in the synopsis above is the I<default configuration>
9598 which is used by the plugin if no configuration is present.
9600 The plugin can send values to multiple instances of I<Redis> by specifying
9601 one B<Node> block for each instance. Within the B<Node> blocks, the following
9602 options are available:
9606 =item B<Node> I<Nodename>
9608 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9609 instance running on a specified host and port. The node name is a
9610 canonical identifier which is used as I<plugin instance>. It is limited to
9611 51E<nbsp>characters in length.
9613 =item B<Host> I<Hostname>
9615 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9618 =item B<Port> I<Port>
9620 The B<Port> option is the TCP port on which the Redis instance accepts
9621 connections. Either a service name of a port number may be given. Please note
9622 that numerical port numbers must be given as a string, too.
9624 =item B<Timeout> I<Milliseconds>
9626 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9628 =item B<Prefix> I<Prefix>
9630 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9631 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9632 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9633 is recommended but not required to include a trailing slash in I<Prefix>.
9635 =item B<Database> I<Index>
9637 This index selects the redis database to use for writing operations. Defaults
9640 =item B<MaxSetSize> I<Items>
9642 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9643 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9645 =item B<MaxSetDuration> I<Seconds>
9647 The B<MaxSetDuration> option limits the duration of items that the
9648 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9649 is the default behavior.
9651 =item B<StoreRates> B<true>|B<false>
9653 If set to B<true> (the default), convert counter values to rates. If set to
9654 B<false> counter values are stored as is, i.e. as an increasing integer number.
9658 =head2 Plugin C<write_riemann>
9660 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9661 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9662 I<Riemann> using UDP packets.
9666 <Plugin "write_riemann">
9672 AlwaysAppendDS false
9676 Attribute "foo" "bar"
9679 The following options are understood by the I<write_riemann plugin>:
9683 =item E<lt>B<Node> I<Name>E<gt>
9685 The plugin's configuration consists of one or more B<Node> blocks. Each block
9686 is given a unique I<Name> and specifies one connection to an instance of
9687 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9692 =item B<Host> I<Address>
9694 Hostname or address to connect to. Defaults to C<localhost>.
9696 =item B<Port> I<Service>
9698 Service name or port number to connect to. Defaults to C<5555>.
9700 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9702 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9705 =item B<TLSCertFile> I<Path>
9707 When using the B<TLS> protocol, path to a PEM certificate to present
9710 =item B<TLSCAFile> I<Path>
9712 When using the B<TLS> protocol, path to a PEM CA certificate to
9713 use to validate the remote hosts's identity.
9715 =item B<TLSKeyFile> I<Path>
9717 When using the B<TLS> protocol, path to a PEM private key associated
9718 with the certificate defined by B<TLSCertFile>.
9720 =item B<Batch> B<true>|B<false>
9722 If set to B<true> and B<Protocol> is set to B<TCP>,
9723 events will be batched in memory and flushed at
9724 regular intervals or when B<BatchMaxSize> is exceeded.
9726 Notifications are not batched and sent as soon as possible.
9728 When enabled, it can occur that events get processed by the Riemann server
9729 close to or after their expiration time. Tune the B<TTLFactor> and
9730 B<BatchMaxSize> settings according to the amount of values collected, if this
9735 =item B<BatchMaxSize> I<size>
9737 Maximum payload size for a riemann packet. Defaults to 8192
9739 =item B<BatchFlushTimeout> I<seconds>
9741 Maximum amount of seconds to wait in between to batch flushes.
9742 No timeout by default.
9744 =item B<StoreRates> B<true>|B<false>
9746 If set to B<true> (the default), convert counter values to rates. If set to
9747 B<false> counter values are stored as is, i.e. as an increasing integer number.
9749 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9750 converted values will have "rate" appended to the data source type, e.g.
9751 C<ds_type:derive:rate>.
9753 =item B<AlwaysAppendDS> B<false>|B<true>
9755 If set to B<true>, append the name of the I<Data Source> (DS) to the
9756 "service", i.e. the field that, together with the "host" field, uniquely
9757 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9758 only done when there is more than one DS.
9760 =item B<TTLFactor> I<Factor>
9762 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9763 event is considered active. I<collectd> populates this field based on the
9764 metrics interval setting. This setting controls the factor with which the
9765 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9766 know exactly what you're doing, you should only increase this setting from its
9769 =item B<Notifications> B<false>|B<true>
9771 If set to B<true>, create riemann events for notifications. This is B<true>
9772 by default. When processing thresholds from write_riemann, it might prove
9773 useful to avoid getting notification events.
9775 =item B<CheckThresholds> B<false>|B<true>
9777 If set to B<true>, attach state to events based on thresholds defined
9778 in the B<Threshold> plugin. Defaults to B<false>.
9780 =item B<EventServicePrefix> I<String>
9782 Add the given string as a prefix to the event service name.
9783 If B<EventServicePrefix> not set or set to an empty string (""),
9784 no prefix will be used.
9788 =item B<Tag> I<String>
9790 Add the given string as an additional tag to the metric being sent to
9793 =item B<Attribute> I<String> I<String>
9795 Consider the two given strings to be the key and value of an additional
9796 attribute for each metric being sent out to I<Riemann>.
9800 =head2 Plugin C<write_sensu>
9802 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9803 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9804 a local I<Sensu> client using a TCP socket.
9806 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9807 parameter so it is not possible to use one collectd instance as a gateway for
9808 others. Each collectd host must pair with one I<Sensu> client.
9812 <Plugin "write_sensu">
9817 AlwaysAppendDS false
9818 MetricHandler "influx"
9819 MetricHandler "default"
9820 NotificationHandler "flapjack"
9821 NotificationHandler "howling_monkey"
9825 Attribute "foo" "bar"
9828 The following options are understood by the I<write_sensu plugin>:
9832 =item E<lt>B<Node> I<Name>E<gt>
9834 The plugin's configuration consists of one or more B<Node> blocks. Each block
9835 is given a unique I<Name> and specifies one connection to an instance of
9836 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9841 =item B<Host> I<Address>
9843 Hostname or address to connect to. Defaults to C<localhost>.
9845 =item B<Port> I<Service>
9847 Service name or port number to connect to. Defaults to C<3030>.
9849 =item B<StoreRates> B<true>|B<false>
9851 If set to B<true> (the default), convert counter values to rates. If set to
9852 B<false> counter values are stored as is, i.e. as an increasing integer number.
9854 This will be reflected in the C<collectd_data_source_type> tag: If
9855 B<StoreRates> is enabled, converted values will have "rate" appended to the
9856 data source type, e.g. C<collectd_data_source_type:derive:rate>.
9858 =item B<AlwaysAppendDS> B<false>|B<true>
9860 If set the B<true>, append the name of the I<Data Source> (DS) to the
9861 "service", i.e. the field that, together with the "host" field, uniquely
9862 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9863 only done when there is more than one DS.
9865 =item B<Notifications> B<false>|B<true>
9867 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9868 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9870 =item B<Metrics> B<false>|B<true>
9872 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9873 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9876 =item B<Separator> I<String>
9878 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9880 =item B<MetricHandler> I<String>
9882 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9883 several of them, one per line. Defaults to no handler.
9885 =item B<NotificationHandler> I<String>
9887 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9888 add several of them, one per line. Defaults to no handler.
9890 =item B<EventServicePrefix> I<String>
9892 Add the given string as a prefix to the event service name.
9893 If B<EventServicePrefix> not set or set to an empty string (""),
9894 no prefix will be used.
9898 =item B<Tag> I<String>
9900 Add the given string as an additional tag to the metric being sent to
9903 =item B<Attribute> I<String> I<String>
9905 Consider the two given strings to be the key and value of an additional
9906 attribute for each metric being sent out to I<Sensu>.
9910 =head2 Plugin C<xencpu>
9912 This plugin collects metrics of hardware CPU load for machine running Xen
9913 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9914 Result is reported using the C<percent> type, for each CPU (core).
9916 This plugin doesn't have any options (yet).
9918 =head2 Plugin C<zookeeper>
9920 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9921 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
9926 <Plugin "zookeeper">
9933 =item B<Host> I<Address>
9935 Hostname or address to connect to. Defaults to C<localhost>.
9937 =item B<Port> I<Service>
9939 Service name or port number to connect to. Defaults to C<2181>.
9943 =head1 THRESHOLD CONFIGURATION
9945 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9946 we mean that the values are not only stored or sent somewhere, but that they
9947 are judged and, if a problem is recognized, acted upon. The only action
9948 collectd takes itself is to generate and dispatch a "notification". Plugins can
9949 register to receive notifications and perform appropriate further actions.
9951 Since systems and what you expect them to do differ a lot, you can configure
9952 B<thresholds> for your values freely. This gives you a lot of flexibility but
9953 also a lot of responsibility.
9955 Every time a value is out of range a notification is dispatched. This means
9956 that the idle percentage of your CPU needs to be less then the configured
9957 threshold only once for a notification to be generated. There's no such thing
9958 as a moving average or similar - at least not now.
9960 Also, all values that match a threshold are considered to be relevant or
9961 "interesting". As a consequence collectd will issue a notification if they are
9962 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9963 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9964 "2" (the default) and some hosts sends it's CPU statistics to the server every
9965 60 seconds, a notification will be dispatched after about 120 seconds. It may
9966 take a little longer because the timeout is checked only once each B<Interval>
9969 When a value comes within range again or is received after it was missing, an
9970 "OKAY-notification" is dispatched.
9972 Here is a configuration example to get you started. Read below for more
9985 <Plugin "interface">
10002 WarningMin 100000000
10008 There are basically two types of configuration statements: The C<Host>,
10009 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10010 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10011 C<Instance> option. You can combine the block by nesting the blocks, though
10012 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10013 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10014 C<Type> may not contain other blocks. If multiple blocks apply to the same
10015 value the most specific block is used.
10017 The other statements specify the threshold to configure. They B<must> be
10018 included in a C<Type> block. Currently the following statements are recognized:
10022 =item B<FailureMax> I<Value>
10024 =item B<WarningMax> I<Value>
10026 Sets the upper bound of acceptable values. If unset defaults to positive
10027 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10028 will be created. If the value is greater than B<WarningMax> but less than (or
10029 equal to) B<FailureMax> a B<WARNING> notification will be created.
10031 =item B<FailureMin> I<Value>
10033 =item B<WarningMin> I<Value>
10035 Sets the lower bound of acceptable values. If unset defaults to negative
10036 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10037 be created. If the value is less than B<WarningMin> but greater than (or equal
10038 to) B<FailureMin> a B<WARNING> notification will be created.
10040 =item B<DataSource> I<DSName>
10042 Some data sets have more than one "data source". Interesting examples are the
10043 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10044 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10045 system load data set, C<load>, even has three data sources: C<shortterm>,
10046 C<midterm>, and C<longterm>.
10048 Normally, all data sources are checked against a configured threshold. If this
10049 is undesirable, or if you want to specify different limits for each data
10050 source, you can use the B<DataSource> option to have a threshold apply only to
10053 =item B<Invert> B<true>|B<false>
10055 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10056 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10057 B<WarningMax>) are not okay. Defaults to B<false>.
10059 =item B<Persist> B<true>|B<false>
10061 Sets how often notifications are generated. If set to B<true> one notification
10062 will be generated for each value that is out of the acceptable range. If set to
10063 B<false> (the default) then a notification is only generated if a value is out
10064 of range but the previous value was okay.
10066 This applies to missing values, too: If set to B<true> a notification about a
10067 missing value is generated once every B<Interval> seconds. If set to B<false>
10068 only one such notification is generated until the value appears again.
10070 =item B<Percentage> B<true>|B<false>
10072 If set to B<true>, the minimum and maximum values given are interpreted as
10073 percentage value, relative to the other data sources. This is helpful for
10074 example for the "df" type, where you may want to issue a warning when less than
10075 5E<nbsp>% of the total space is available. Defaults to B<false>.
10077 =item B<Hits> I<Number>
10079 Delay creating the notification until the threshold has been passed I<Number>
10080 times. When a notification has been generated, or when a subsequent value is
10081 inside the threshold, the counter is reset. If, for example, a value is
10082 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10083 will be dispatched at most once every 30E<nbsp>seconds.
10085 This is useful when short bursts are not a problem. If, for example, 100% CPU
10086 usage for up to a minute is normal (and data is collected every
10087 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10089 =item B<Hysteresis> I<Number>
10091 When set to non-zero, a hysteresis value is applied when checking minimum and
10092 maximum bounds. This is useful for values that increase slowly and fluctuate a
10093 bit while doing so. When these values come close to the threshold, they may
10094 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10096 If, for example, the threshold is configures as
10101 then a I<Warning> notification is created when the value exceeds I<101> and the
10102 corresponding I<Okay> notification is only created once the value falls below
10103 I<99>, thus avoiding the "flapping".
10107 =head1 FILTER CONFIGURATION
10109 Starting with collectd 4.6 there is a powerful filtering infrastructure
10110 implemented in the daemon. The concept has mostly been copied from
10111 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10112 terminology, so that users that are familiar with iptables feel right at home.
10116 The following are the terms used in the remainder of the filter configuration
10117 documentation. For an ASCII-art schema of the mechanism, see
10118 L<"General structure"> below.
10124 A I<match> is a criteria to select specific values. Examples are, of course, the
10125 name of the value or it's current value.
10127 Matches are implemented in plugins which you have to load prior to using the
10128 match. The name of such plugins starts with the "match_" prefix.
10132 A I<target> is some action that is to be performed with data. Such actions
10133 could, for example, be to change part of the value's identifier or to ignore
10134 the value completely.
10136 Some of these targets are built into the daemon, see L<"Built-in targets">
10137 below. Other targets are implemented in plugins which you have to load prior to
10138 using the target. The name of such plugins starts with the "target_" prefix.
10142 The combination of any number of matches and at least one target is called a
10143 I<rule>. The target actions will be performed for all values for which B<all>
10144 matches apply. If the rule does not have any matches associated with it, the
10145 target action will be performed for all values.
10149 A I<chain> is a list of rules and possibly default targets. The rules are tried
10150 in order and if one matches, the associated target will be called. If a value
10151 is handled by a rule, it depends on the target whether or not any subsequent
10152 rules are considered or if traversal of the chain is aborted, see
10153 L<"Flow control"> below. After all rules have been checked, the default targets
10158 =head2 General structure
10160 The following shows the resulting structure:
10167 +---------+ +---------+ +---------+ +---------+
10168 ! Rule !->! Match !->! Match !->! Target !
10169 +---------+ +---------+ +---------+ +---------+
10172 +---------+ +---------+ +---------+
10173 ! Rule !->! Target !->! Target !
10174 +---------+ +---------+ +---------+
10181 +---------+ +---------+ +---------+
10182 ! Rule !->! Match !->! Target !
10183 +---------+ +---------+ +---------+
10191 =head2 Flow control
10193 There are four ways to control which way a value takes through the filter
10200 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10201 process the value with another chain. When the called chain finishes, usually
10202 the next target or rule after the jump is executed.
10206 The stop condition, signaled for example by the built-in target B<stop>, causes
10207 all processing of the value to be stopped immediately.
10211 Causes processing in the current chain to be aborted, but processing of the
10212 value generally will continue. This means that if the chain was called via
10213 B<Jump>, the next target or rule after the jump will be executed. If the chain
10214 was not called by another chain, control will be returned to the daemon and it
10215 may pass the value to another chain.
10219 Most targets will signal the B<continue> condition, meaning that processing
10220 should continue normally. There is no special built-in target for this
10227 The configuration reflects this structure directly:
10229 PostCacheChain "PostCache"
10230 <Chain "PostCache">
10231 <Rule "ignore_mysql_show">
10234 Type "^mysql_command$"
10235 TypeInstance "^show_"
10245 The above configuration example will ignore all values where the plugin field
10246 is "mysql", the type is "mysql_command" and the type instance begins with
10247 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10248 default target of the chain. Since this chain is run after the value has been
10249 added to the cache, the MySQL C<show_*> command statistics will be available
10250 via the C<unixsock> plugin.
10252 =head2 List of configuration options
10256 =item B<PreCacheChain> I<ChainName>
10258 =item B<PostCacheChain> I<ChainName>
10260 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10261 argument is the name of a I<chain> that should be executed before and/or after
10262 the values have been added to the cache.
10264 To understand the implications, it's important you know what is going on inside
10265 I<collectd>. The following diagram shows how values are passed from the
10266 read-plugins to the write-plugins:
10272 + - - - - V - - - - +
10273 : +---------------+ :
10276 : +-------+-------+ :
10279 : +-------+-------+ : +---------------+
10280 : ! Cache !--->! Value Cache !
10281 : ! insert ! : +---+---+-------+
10282 : +-------+-------+ : ! !
10283 : ! ,------------' !
10285 : +-------+---+---+ : +-------+-------+
10286 : ! Post-Cache +--->! Write-Plugins !
10287 : ! Chain ! : +---------------+
10288 : +---------------+ :
10290 : dispatch values :
10291 + - - - - - - - - - +
10293 After the values are passed from the "read" plugins to the dispatch functions,
10294 the pre-cache chain is run first. The values are added to the internal cache
10295 afterwards. The post-cache chain is run after the values have been added to the
10296 cache. So why is it such a huge deal if chains are run before or after the
10297 values have been added to this cache?
10299 Targets that change the identifier of a value list should be executed before
10300 the values are added to the cache, so that the name in the cache matches the
10301 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10302 this cache to receive a list of all available values. If you change the
10303 identifier after the value list has been added to the cache, this may easily
10304 lead to confusion, but it's not forbidden of course.
10306 The cache is also used to convert counter values to rates. These rates are, for
10307 example, used by the C<value> match (see below). If you use the rate stored in
10308 the cache B<before> the new value is added, you will use the old, B<previous>
10309 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10310 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10313 Last but not last, the B<stop> target makes a difference: If the pre-cache
10314 chain returns the stop condition, the value will not be added to the cache and
10315 the post-cache chain will not be run.
10317 =item B<Chain> I<Name>
10319 Adds a new chain with a certain name. This name can be used to refer to a
10320 specific chain, for example to jump to it.
10322 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10324 =item B<Rule> [I<Name>]
10326 Adds a new rule to the current chain. The name of the rule is optional and
10327 currently has no meaning for the daemon.
10329 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10330 must be at least one B<Target> block.
10332 =item B<Match> I<Name>
10334 Adds a match to a B<Rule> block. The name specifies what kind of match should
10335 be performed. Available matches depend on the plugins that have been loaded.
10337 The arguments inside the B<Match> block are passed to the plugin implementing
10338 the match, so which arguments are valid here depends on the plugin being used.
10339 If you do not need any to pass any arguments to a match, you can use the
10344 Which is equivalent to:
10349 =item B<Target> I<Name>
10351 Add a target to a rule or a default target to a chain. The name specifies what
10352 kind of target is to be added. Which targets are available depends on the
10353 plugins being loaded.
10355 The arguments inside the B<Target> block are passed to the plugin implementing
10356 the target, so which arguments are valid here depends on the plugin being used.
10357 If you do not need any to pass any arguments to a target, you can use the
10362 This is the same as writing:
10369 =head2 Built-in targets
10371 The following targets are built into the core daemon and therefore need no
10372 plugins to be loaded:
10378 Signals the "return" condition, see the L<"Flow control"> section above. This
10379 causes the current chain to stop processing the value and returns control to
10380 the calling chain. The calling chain will continue processing targets and rules
10381 just after the B<jump> target (see below). This is very similar to the
10382 B<RETURN> target of iptables, see L<iptables(8)>.
10384 This target does not have any options.
10392 Signals the "stop" condition, see the L<"Flow control"> section above. This
10393 causes processing of the value to be aborted immediately. This is similar to
10394 the B<DROP> target of iptables, see L<iptables(8)>.
10396 This target does not have any options.
10404 Sends the value to "write" plugins.
10410 =item B<Plugin> I<Name>
10412 Name of the write plugin to which the data should be sent. This option may be
10413 given multiple times to send the data to more than one write plugin. If the
10414 plugin supports multiple instances, the plugin's instance(s) must also be
10419 If no plugin is explicitly specified, the values will be sent to all available
10422 Single-instance plugin example:
10428 Multi-instance plugin example:
10430 <Plugin "write_graphite">
10440 Plugin "write_graphite/foo"
10445 Starts processing the rules of another chain, see L<"Flow control"> above. If
10446 the end of that chain is reached, or a stop condition is encountered,
10447 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10448 next target or the next rule. This is similar to the B<-j> command line option
10449 of iptables, see L<iptables(8)>.
10455 =item B<Chain> I<Name>
10457 Jumps to the chain I<Name>. This argument is required and may appear only once.
10469 =head2 Available matches
10475 Matches a value using regular expressions.
10481 =item B<Host> I<Regex>
10483 =item B<Plugin> I<Regex>
10485 =item B<PluginInstance> I<Regex>
10487 =item B<Type> I<Regex>
10489 =item B<TypeInstance> I<Regex>
10491 =item B<MetaData> I<String> I<Regex>
10493 Match values where the given regular expressions match the various fields of
10494 the identifier of a value. If multiple regular expressions are given, B<all>
10495 regexen must match for a value to match.
10497 =item B<Invert> B<false>|B<true>
10499 When set to B<true>, the result of the match is inverted, i.e. all value lists
10500 where all regular expressions apply are not matched, all other value lists are
10501 matched. Defaults to B<false>.
10508 Host "customer[0-9]+"
10514 Matches values that have a time which differs from the time on the server.
10516 This match is mainly intended for servers that receive values over the
10517 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10518 is very sensitive to the timestamp used when updating the RRD files. In
10519 particular, the time must be ever increasing. If a misbehaving client sends one
10520 packet with a timestamp far in the future, all further packets with a correct
10521 time will be ignored because of that one packet. What's worse, such corrupted
10522 RRD files are hard to fix.
10524 This match lets one match all values B<outside> a specified time range
10525 (relative to the server's time), so you can use the B<stop> target (see below)
10526 to ignore the value, for example.
10532 =item B<Future> I<Seconds>
10534 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10535 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10538 =item B<Past> I<Seconds>
10540 Matches all values that are I<behind> of the server's time by I<Seconds> or
10541 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10553 This example matches all values that are five minutes or more ahead of the
10554 server or one hour (or more) lagging behind.
10558 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10559 values. If a data-set consists of more than one data-source, all data-sources
10560 must match the specified ranges for a positive match.
10566 =item B<Min> I<Value>
10568 Sets the smallest value which still results in a match. If unset, behaves like
10571 =item B<Max> I<Value>
10573 Sets the largest value which still results in a match. If unset, behaves like
10576 =item B<Invert> B<true>|B<false>
10578 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10579 no-match is returned and vice versa. Please note that the B<Invert> setting
10580 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10581 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10583 =item B<DataSource> I<DSName> [I<DSName> ...]
10585 Select one or more of the data sources. If no data source is configured, all
10586 data sources will be checked. If the type handled by the match does not have a
10587 data source of the specified name(s), this will always result in no match
10588 (independent of the B<Invert> setting).
10590 =item B<Satisfy> B<Any>|B<All>
10592 Specifies how checking with several data sources is performed. If set to
10593 B<Any>, the match succeeds if one of the data sources is in the configured
10594 range. If set to B<All> the match only succeeds if all data sources are within
10595 the configured range. Default is B<All>.
10597 Usually B<All> is used for positive matches, B<Any> is used for negative
10598 matches. This means that with B<All> you usually check that all values are in a
10599 "good" range, while with B<Any> you check if any value is within a "bad" range
10600 (or outside the "good" range).
10604 Either B<Min> or B<Max>, but not both, may be unset.
10608 # Match all values smaller than or equal to 100. Matches only if all data
10609 # sources are below 100.
10615 # Match if the value of any data source is outside the range of 0 - 100.
10623 =item B<empty_counter>
10625 Matches all values with one or more data sources of type B<COUNTER> and where
10626 all counter values are zero. These counters usually I<never> increased since
10627 they started existing (and are therefore uninteresting), or got reset recently
10628 or overflowed and you had really, I<really> bad luck.
10630 Please keep in mind that ignoring such counters can result in confusing
10631 behavior: Counters which hardly ever increase will be zero for long periods of
10632 time. If the counter is reset for some reason (machine or service restarted,
10633 usually), the graph will be empty (NAN) for a long time. People may not
10638 Calculates a hash value of the host name and matches values according to that
10639 hash value. This makes it possible to divide all hosts into groups and match
10640 only values that are in a specific group. The intended use is in load
10641 balancing, where you want to handle only part of all data and leave the rest
10644 The hashing function used tries to distribute the hosts evenly. First, it
10645 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10648 for (i = 0; host[i] != 0; i++)
10649 hash_value = (hash_value * 251) + host[i];
10651 The constant 251 is a prime number which is supposed to make this hash value
10652 more random. The code then checks the group for this host according to the
10653 I<Total> and I<Match> arguments:
10655 if ((hash_value % Total) == Match)
10660 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10661 groups), then the least significant bit of the hash value will be the XOR of
10662 all least significant bits in the host name. One consequence is that when you
10663 have two hosts, "server0.example.com" and "server1.example.com", where the host
10664 name differs in one digit only and the digits differ by one, those hosts will
10665 never end up in the same group.
10671 =item B<Match> I<Match> I<Total>
10673 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10674 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10675 be smaller than I<Total>. I<Total> must be at least one, although only values
10676 greater than one really do make any sense.
10678 You can repeat this option to match multiple groups, for example:
10683 The above config will divide the data into seven groups and match groups three
10684 and five. One use would be to keep every value on two hosts so that if one
10685 fails the missing data can later be reconstructed from the second host.
10691 # Operate on the pre-cache chain, so that ignored values are not even in the
10696 # Divide all received hosts in seven groups and accept all hosts in
10700 # If matched: Return and continue.
10703 # If not matched: Return and stop.
10709 =head2 Available targets
10713 =item B<notification>
10715 Creates and dispatches a notification.
10721 =item B<Message> I<String>
10723 This required option sets the message of the notification. The following
10724 placeholders will be replaced by an appropriate value:
10732 =item B<%{plugin_instance}>
10736 =item B<%{type_instance}>
10738 These placeholders are replaced by the identifier field of the same name.
10740 =item B<%{ds:>I<name>B<}>
10742 These placeholders are replaced by a (hopefully) human readable representation
10743 of the current rate of this data source. If you changed the instance name
10744 (using the B<set> or B<replace> targets, see below), it may not be possible to
10745 convert counter values to rates.
10749 Please note that these placeholders are B<case sensitive>!
10751 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10753 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10760 <Target "notification">
10761 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10767 Replaces parts of the identifier using regular expressions.
10773 =item B<Host> I<Regex> I<Replacement>
10775 =item B<Plugin> I<Regex> I<Replacement>
10777 =item B<PluginInstance> I<Regex> I<Replacement>
10779 =item B<TypeInstance> I<Regex> I<Replacement>
10781 =item B<MetaData> I<String> I<Regex> I<Replacement>
10783 =item B<DeleteMetaData> I<String> I<Regex>
10785 Match the appropriate field with the given regular expression I<Regex>. If the
10786 regular expression matches, that part that matches is replaced with
10787 I<Replacement>. If multiple places of the input buffer match a given regular
10788 expression, only the first occurrence will be replaced.
10790 You can specify each option multiple times to use multiple regular expressions
10798 # Replace "example.net" with "example.com"
10799 Host "\\<example.net\\>" "example.com"
10801 # Strip "www." from hostnames
10802 Host "\\<www\\." ""
10807 Sets part of the identifier of a value to a given string.
10813 =item B<Host> I<String>
10815 =item B<Plugin> I<String>
10817 =item B<PluginInstance> I<String>
10819 =item B<TypeInstance> I<String>
10821 =item B<MetaData> I<String> I<String>
10823 Set the appropriate field to the given string. The strings for plugin instance,
10824 type instance, and meta data may be empty, the strings for host and plugin may
10825 not be empty. It's currently not possible to set the type of a value this way.
10827 The following placeholders will be replaced by an appropriate value:
10835 =item B<%{plugin_instance}>
10839 =item B<%{type_instance}>
10841 These placeholders are replaced by the identifier field of the same name.
10843 =item B<%{meta:>I<name>B<}>
10845 These placeholders are replaced by the meta data value with the given name.
10849 Please note that these placeholders are B<case sensitive>!
10851 =item B<DeleteMetaData> I<String>
10853 Delete the named meta data field.
10860 PluginInstance "coretemp"
10861 TypeInstance "core3"
10866 =head2 Backwards compatibility
10868 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10869 B<Chain> block, it will behave as it used to. This is equivalent to the
10870 following configuration:
10872 <Chain "PostCache">
10876 If you specify a B<PostCacheChain>, the B<write> target will not be added
10877 anywhere and you will have to make sure that it is called where appropriate. We
10878 suggest to add the above snippet as default target to your "PostCache" chain.
10882 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10897 B<Ignorelists> are a generic framework to either ignore some metrics or report
10898 specific metircs only. Plugins usually provide one or more options to specify
10899 the items (mounts points, devices, ...) and the boolean option
10904 =item B<Select> I<String>
10906 Selects the item I<String>. This option often has a plugin specific name, e.g.
10907 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10908 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10909 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10911 By default, this option is doing a case-sensitive full-string match. The
10912 following config will match C<foo>, but not C<Foo>:
10916 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10917 I<regular expression>. For example, so match all item starting with C<foo>, use
10918 could use the following syntax:
10922 The regular expression is I<not> anchored, i.e. the following config will match
10923 C<foobar>, C<barfoo> and C<AfooZ>:
10927 The B<Select> option may be repeated to select multiple items.
10929 =item B<IgnoreSelected> B<true>|B<false>
10931 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10932 collected. If set to B<false>, matching metrics are I<collected> and all other
10933 metrics are ignored.
10940 L<collectd-exec(5)>,
10941 L<collectd-perl(5)>,
10942 L<collectd-unixsock(5)>,
10955 Florian Forster E<lt>octo@collectd.orgE<gt>