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 C<conntrack>
1414 This plugin collects IP conntrack statistics.
1420 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1421 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1425 =head2 Plugin C<cpu>
1427 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1428 as Jiffies, using the C<cpu> type. Two aggregations are available:
1434 Sum, per-state, over all CPUs installed in the system; and
1438 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1442 The two aggregations can be combined, leading to I<collectd> only emitting a
1443 single "active" metric for the entire system. As soon as one of these
1444 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1445 rather than Jiffies. In addition, you can request individual, per-state,
1446 per-CPU metrics to be reported as percentage.
1448 The following configuration options are available:
1452 =item B<ReportByState> B<true>|B<false>
1454 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1456 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1459 =item B<ReportByCpu> B<true>|B<false>
1461 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1462 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1463 global sum of CPU states is emitted.
1465 =item B<ValuesPercentage> B<false>|B<true>
1467 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1468 are set to B<true>. In this case, by default, metrics will be reported as
1469 Jiffies. By setting this option to B<true>, you can request percentage values
1470 in the un-aggregated (per-CPU, per-state) mode as well.
1472 =item B<ReportNumCpu> B<false>|B<true>
1474 When set to B<true>, reports the number of available CPUs.
1475 Defaults to B<false>.
1479 =head2 Plugin C<cpufreq>
1481 This plugin doesn't have any options. It reads
1482 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1483 installed) to get the current CPU frequency. If this file does not exist make
1484 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1485 installed and an "cpu governor" (that's a kernel module) is loaded.
1487 =head2 Plugin C<cpusleep>
1489 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1490 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1491 BOOTTIME clock increments while device is suspended and MONOTONIC
1492 clock does not, the derivative of the difference between these clocks
1493 gives the relative amount of time the device has spent in suspend
1494 state. The recorded value is in milliseconds of sleep per seconds of
1497 =head2 Plugin C<csv>
1501 =item B<DataDir> I<Directory>
1503 Set the directory to store CSV-files under. Per default CSV-files are generated
1504 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1505 The special strings B<stdout> and B<stderr> can be used to write to the standard
1506 output and standard error channels, respectively. This, of course, only makes
1507 much sense when collectd is running in foreground- or non-daemon-mode.
1509 =item B<StoreRates> B<true|false>
1511 If set to B<true>, convert counter values to rates. If set to B<false> (the
1512 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1517 =head2 cURL Statistics
1519 All cURL-based plugins support collection of generic, request-based
1520 statistics. These are disabled by default and can be enabled selectively for
1521 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1522 the documentation of those plugins for specific information. This section
1523 describes the available metrics that can be configured for each plugin. All
1524 options are disabled by default.
1526 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1530 =item B<TotalTime> B<true|false>
1532 Total time of the transfer, including name resolving, TCP connect, etc.
1534 =item B<NamelookupTime> B<true|false>
1536 Time it took from the start until name resolving was completed.
1538 =item B<ConnectTime> B<true|false>
1540 Time it took from the start until the connect to the remote host (or proxy)
1543 =item B<AppconnectTime> B<true|false>
1545 Time it took from the start until the SSL/SSH connect/handshake to the remote
1548 =item B<PretransferTime> B<true|false>
1550 Time it took from the start until just before the transfer begins.
1552 =item B<StarttransferTime> B<true|false>
1554 Time it took from the start until the first byte was received.
1556 =item B<RedirectTime> B<true|false>
1558 Time it took for all redirection steps include name lookup, connect,
1559 pre-transfer and transfer before final transaction was started.
1561 =item B<RedirectCount> B<true|false>
1563 The total number of redirections that were actually followed.
1565 =item B<SizeUpload> B<true|false>
1567 The total amount of bytes that were uploaded.
1569 =item B<SizeDownload> B<true|false>
1571 The total amount of bytes that were downloaded.
1573 =item B<SpeedDownload> B<true|false>
1575 The average download speed that curl measured for the complete download.
1577 =item B<SpeedUpload> B<true|false>
1579 The average upload speed that curl measured for the complete upload.
1581 =item B<HeaderSize> B<true|false>
1583 The total size of all the headers received.
1585 =item B<RequestSize> B<true|false>
1587 The total size of the issued requests.
1589 =item B<ContentLengthDownload> B<true|false>
1591 The content-length of the download.
1593 =item B<ContentLengthUpload> B<true|false>
1595 The specified size of the upload.
1597 =item B<NumConnects> B<true|false>
1599 The number of new connections that were created to achieve the transfer.
1603 =head2 Plugin C<curl>
1605 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1606 and the match infrastructure (the same code used by the tail plugin) to use
1607 regular expressions with the received data.
1609 The following example will read the current value of AMD stock from Google's
1610 finance page and dispatch the value to collectd.
1613 <Page "stock_quotes">
1614 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1620 CACert "/path/to/ca.crt"
1621 Header "X-Custom-Header: foobar"
1624 MeasureResponseTime false
1625 MeasureResponseCode false
1628 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1629 DSType "GaugeAverage"
1630 # Note: `stock_value' is not a standard type.
1637 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1638 a web page and one or more "matches" to be performed on the returned data. The
1639 string argument to the B<Page> block is used as plugin instance.
1641 The following options are valid within B<Page> blocks:
1647 URL of the web site to retrieve. Since a regular expression will be used to
1648 extract information from this data, non-binary data is a big plus here ;)
1650 =item B<User> I<Name>
1652 Username to use if authorization is required to read the page.
1654 =item B<Password> I<Password>
1656 Password to use if authorization is required to read the page.
1658 =item B<Digest> B<true>|B<false>
1660 Enable HTTP digest authentication.
1662 =item B<VerifyPeer> B<true>|B<false>
1664 Enable or disable peer SSL certificate verification. See
1665 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1667 =item B<VerifyHost> B<true>|B<false>
1669 Enable or disable peer host name verification. If enabled, the plugin checks if
1670 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1671 matches the host name provided by the B<URL> option. If this identity check
1672 fails, the connection is aborted. Obviously, only works when connecting to a
1673 SSL enabled server. Enabled by default.
1675 =item B<CACert> I<file>
1677 File that holds one or more SSL certificates. If you want to use HTTPS you will
1678 possibly need this option. What CA certificates come bundled with C<libcurl>
1679 and are checked by default depends on the distribution you use.
1681 =item B<Header> I<Header>
1683 A HTTP header to add to the request. Multiple headers are added if this option
1684 is specified more than once.
1686 =item B<Post> I<Body>
1688 Specifies that the HTTP operation should be a POST instead of a GET. The
1689 complete data to be posted is given as the argument. This option will usually
1690 need to be accompanied by a B<Header> option to set an appropriate
1691 C<Content-Type> for the post body (e.g. to
1692 C<application/x-www-form-urlencoded>).
1694 =item B<MeasureResponseTime> B<true>|B<false>
1696 Measure response time for the request. If this setting is enabled, B<Match>
1697 blocks (see below) are optional. Disabled by default.
1699 Beware that requests will get aborted if they take too long to complete. Adjust
1700 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1703 This option is similar to enabling the B<TotalTime> statistic but it's
1704 measured by collectd instead of cURL.
1706 =item B<MeasureResponseCode> B<true>|B<false>
1708 Measure response code for the request. If this setting is enabled, B<Match>
1709 blocks (see below) are optional. Disabled by default.
1711 =item B<E<lt>StatisticsE<gt>>
1713 One B<Statistics> block can be used to specify cURL statistics to be collected
1714 for each request to the remote web site. See the section "cURL Statistics"
1715 above for details. If this setting is enabled, B<Match> blocks (see below) are
1718 =item B<E<lt>MatchE<gt>>
1720 One or more B<Match> blocks that define how to match information in the data
1721 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1722 used by the C<tail> plugin, so please see the documentation of the C<tail>
1723 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1724 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1727 =item B<Timeout> I<Milliseconds>
1729 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1730 milliseconds. By default, the configured B<Interval> is used to set the
1731 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1732 indefinitely. This legacy behaviour can be achieved by setting the value of
1735 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1736 network connection will stall one read thread. Adjust the B<ReadThreads> global
1737 setting accordingly to prevent this from blocking other plugins.
1741 =head2 Plugin C<curl_json>
1743 The B<curl_json plugin> collects values from JSON data to be parsed by
1744 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1745 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1746 unix socket. The former can be used, for example, to collect values
1747 from CouchDB documents (which are stored JSON notation), and the
1748 latter to collect values from a uWSGI stats socket.
1750 The following example will collect several values from the built-in
1751 C<_stats> runtime statistics module of I<CouchDB>
1752 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1755 <URL "http://localhost:5984/_stats">
1757 <Key "httpd/requests/count">
1758 Type "http_requests"
1761 <Key "httpd_request_methods/*/count">
1762 Type "http_request_methods"
1765 <Key "httpd_status_codes/*/count">
1766 Type "http_response_codes"
1771 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1774 <Sock "/var/run/uwsgi.stats.sock">
1776 <Key "workers/*/requests">
1777 Type "http_requests"
1780 <Key "workers/*/apps/*/requests">
1781 Type "http_requests"
1786 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1787 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1788 blocks defining a unix socket to read JSON from directly. Each of
1789 these blocks may have one or more B<Key> blocks.
1791 The B<Key> string argument must be in a path format. Each component is
1792 used to match the key from a JSON map or the index of an JSON
1793 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1794 values for all map keys or array indices will be collectd.
1796 The following options are valid within B<URL> blocks:
1800 =item B<Host> I<Name>
1802 Use I<Name> as the host name when submitting values. Defaults to the global
1805 =item B<Instance> I<Instance>
1807 Sets the plugin instance to I<Instance>.
1809 =item B<Interval> I<Interval>
1811 Sets the interval (in seconds) in which the values will be collected from this
1812 URL. By default the global B<Interval> setting will be used.
1814 =item B<User> I<Name>
1816 =item B<Password> I<Password>
1818 =item B<Digest> B<true>|B<false>
1820 =item B<VerifyPeer> B<true>|B<false>
1822 =item B<VerifyHost> B<true>|B<false>
1824 =item B<CACert> I<file>
1826 =item B<Header> I<Header>
1828 =item B<Post> I<Body>
1830 =item B<Timeout> I<Milliseconds>
1832 These options behave exactly equivalent to the appropriate options of the
1833 I<cURL> plugin. Please see there for a detailed description.
1835 =item B<E<lt>StatisticsE<gt>>
1837 One B<Statistics> block can be used to specify cURL statistics to be collected
1838 for each request to the remote URL. See the section "cURL Statistics" above
1843 The following options are valid within B<Key> blocks:
1847 =item B<Type> I<Type>
1849 Sets the type used to dispatch the values to the daemon. Detailed information
1850 about types and their configuration can be found in L<types.db(5)>. This
1851 option is mandatory.
1853 =item B<Instance> I<Instance>
1855 Type-instance to use. Defaults to the current map key or current string array element value.
1859 =head2 Plugin C<curl_xml>
1861 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1862 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1865 <URL "http://localhost/stats.xml">
1867 Instance "some_instance"
1872 CACert "/path/to/ca.crt"
1873 Header "X-Custom-Header: foobar"
1876 <XPath "table[@id=\"magic_level\"]/tr">
1878 #InstancePrefix "prefix-"
1879 InstanceFrom "td[1]"
1880 ValuesFrom "td[2]/span[@class=\"level\"]"
1885 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1886 URL to be fetched using libcurl. Within each B<URL> block there are
1887 options which specify the connection parameters, for example authentication
1888 information, and one or more B<XPath> blocks.
1890 Each B<XPath> block specifies how to get one type of information. The
1891 string argument must be a valid XPath expression which returns a list
1892 of "base elements". One value is dispatched for each "base element". The
1893 I<type instance> and values are looked up using further I<XPath> expressions
1894 that should be relative to the base element.
1896 Within the B<URL> block the following options are accepted:
1900 =item B<Host> I<Name>
1902 Use I<Name> as the host name when submitting values. Defaults to the global
1905 =item B<Instance> I<Instance>
1907 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1908 empty string (no plugin instance).
1910 =item B<Namespace> I<Prefix> I<URL>
1912 If an XPath expression references namespaces, they must be specified
1913 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1914 I<URL> is the "namespace name", an URI reference uniquely identifying the
1915 namespace. The option can be repeated to register multiple namespaces.
1919 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1920 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1922 =item B<User> I<User>
1924 =item B<Password> I<Password>
1926 =item B<Digest> B<true>|B<false>
1928 =item B<VerifyPeer> B<true>|B<false>
1930 =item B<VerifyHost> B<true>|B<false>
1932 =item B<CACert> I<CA Cert File>
1934 =item B<Header> I<Header>
1936 =item B<Post> I<Body>
1938 =item B<Timeout> I<Milliseconds>
1940 These options behave exactly equivalent to the appropriate options of the
1941 I<cURL plugin>. Please see there for a detailed description.
1943 =item B<E<lt>StatisticsE<gt>>
1945 One B<Statistics> block can be used to specify cURL statistics to be collected
1946 for each request to the remote URL. See the section "cURL Statistics" above
1949 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1951 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1952 B<XPath> block specifies how to get one type of information. The string
1953 argument must be a valid XPath expression which returns a list of "base
1954 elements". One value is dispatched for each "base element".
1956 Within the B<XPath> block the following options are accepted:
1960 =item B<Type> I<Type>
1962 Specifies the I<Type> used for submitting patches. This determines the number
1963 of values that are required / expected and whether the strings are parsed as
1964 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1965 This option is required.
1967 =item B<InstancePrefix> I<InstancePrefix>
1969 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1970 concatenated together without any separator.
1971 This option is optional.
1973 =item B<InstanceFrom> I<InstanceFrom>
1975 Specifies a XPath expression to use for determining the I<type instance>. The
1976 XPath expression must return exactly one element. The element's value is then
1977 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1979 This value is required. As a special exception, if the "base XPath expression"
1980 (the argument to the B<XPath> block) returns exactly one argument, then this
1981 option may be omitted.
1983 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1985 Specifies one or more XPath expression to use for reading the values. The
1986 number of XPath expressions must match the number of data sources in the
1987 I<type> specified with B<Type> (see above). Each XPath expression must return
1988 exactly one element. The element's value is then parsed as a number and used as
1989 value for the appropriate value in the value list dispatched to the daemon.
1995 =head2 Plugin C<dbi>
1997 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1998 connect to various databases, execute I<SQL> statements and read back the
1999 results. I<dbi> is an acronym for "database interface" in case you were
2000 wondering about the name. You can configure how each column is to be
2001 interpreted and the plugin will generate one or more data sets from each row
2002 returned according to these rules.
2004 Because the plugin is very generic, the configuration is a little more complex
2005 than those of other plugins. It usually looks something like this:
2008 <Query "out_of_stock">
2009 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2010 # Use with MySQL 5.0.0 or later
2014 InstancePrefix "out_of_stock"
2015 InstancesFrom "category"
2019 <Database "product_information">
2020 #PluginName "warehouse"
2023 DriverOption "host" "localhost"
2024 DriverOption "username" "collectd"
2025 DriverOption "password" "aZo6daiw"
2026 DriverOption "dbname" "prod_info"
2027 SelectDB "prod_info"
2028 Query "out_of_stock"
2032 The configuration above defines one query with one result and one database. The
2033 query is then linked to the database with the B<Query> option I<within> the
2034 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2035 and you can also use the B<Include> statement to split up the configuration
2036 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2037 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2040 The following is a complete list of options:
2042 =head3 B<Query> blocks
2044 Query blocks define I<SQL> statements and how the returned data should be
2045 interpreted. They are identified by the name that is given in the opening line
2046 of the block. Thus the name needs to be unique. Other than that, the name is
2047 not used in collectd.
2049 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2050 define which column holds which value or instance information. You can use
2051 multiple B<Result> blocks to create multiple values from one returned row. This
2052 is especially useful, when queries take a long time and sending almost the same
2053 query again and again is not desirable.
2057 <Query "environment">
2058 Statement "select station, temperature, humidity from environment"
2061 # InstancePrefix "foo"
2062 InstancesFrom "station"
2063 ValuesFrom "temperature"
2067 InstancesFrom "station"
2068 ValuesFrom "humidity"
2072 The following options are accepted:
2076 =item B<Statement> I<SQL>
2078 Sets the statement that should be executed on the server. This is B<not>
2079 interpreted by collectd, but simply passed to the database server. Therefore,
2080 the SQL dialect that's used depends on the server collectd is connected to.
2082 The query has to return at least two columns, one for the instance and one
2083 value. You cannot omit the instance, even if the statement is guaranteed to
2084 always return exactly one line. In that case, you can usually specify something
2087 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2089 (That works with MySQL but may not be valid SQL according to the spec. If you
2090 use a more strict database server, you may have to select from a dummy table or
2093 Please note that some databases, for example B<Oracle>, will fail if you
2094 include a semicolon at the end of the statement.
2096 =item B<MinVersion> I<Version>
2098 =item B<MaxVersion> I<Value>
2100 Only use this query for the specified database version. You can use these
2101 options to provide multiple queries with the same name but with a slightly
2102 different syntax. The plugin will use only those queries, where the specified
2103 minimum and maximum versions fit the version of the database in use.
2105 The database version is determined by C<dbi_conn_get_engine_version>, see the
2106 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2107 for details. Basically, each part of the version is assumed to be in the range
2108 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2109 "40102", version "5.0.42" becomes "50042".
2111 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2112 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2113 happen. Don't to it! A valid example would be something along these lines:
2124 In the above example, there are three ranges that don't overlap. The last one
2125 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2126 before "4.0.0" are not specified.
2128 =item B<Type> I<Type>
2130 The B<type> that's used for each line returned. See L<types.db(5)> for more
2131 details on how types are defined. In short: A type is a predefined layout of
2132 data and the number of values and type of values has to match the type
2135 If you specify "temperature" here, you need exactly one gauge column. If you
2136 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2139 There must be exactly one B<Type> option inside each B<Result> block.
2141 =item B<InstancePrefix> I<prefix>
2143 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2144 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2145 all strings returned in the appropriate columns are concatenated together,
2146 separated by dashes I<("-")>.
2148 =item B<InstancesFrom> I<column0> [I<column1> ...]
2150 Specifies the columns whose values will be used to create the "type-instance"
2151 for each row. If you specify more than one column, the value of all columns
2152 will be joined together with dashes I<("-")> as separation characters.
2154 The plugin itself does not check whether or not all built instances are
2155 different. It's your responsibility to assure that each is unique. This is
2156 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2157 sure that only one row is returned in this case.
2159 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2162 =item B<ValuesFrom> I<column0> [I<column1> ...]
2164 Names the columns whose content is used as the actual data for the data sets
2165 that are dispatched to the daemon. How many such columns you need is determined
2166 by the B<Type> setting above. If you specify too many or not enough columns,
2167 the plugin will complain about that and no data will be submitted to the
2170 The actual data type in the columns is not that important. The plugin will
2171 automatically cast the values to the right type if it know how to do that. So
2172 it should be able to handle integer an floating point types, as well as strings
2173 (if they include a number at the beginning).
2175 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2177 =item B<MetadataFrom> [I<column0> I<column1> ...]
2179 Names the columns whose content is used as metadata for the data sets
2180 that are dispatched to the daemon.
2182 The actual data type in the columns is not that important. The plugin will
2183 automatically cast the values to the right type if it know how to do that. So
2184 it should be able to handle integer an floating point types, as well as strings
2185 (if they include a number at the beginning).
2189 =head3 B<Database> blocks
2191 Database blocks define a connection to a database and which queries should be
2192 sent to that database. Since the used "dbi" library can handle a wide variety
2193 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2194 documentationE<nbsp>- we stick as close to the terminology used there.
2196 Each database needs a "name" as string argument in the starting tag of the
2197 block. This name will be used as "PluginInstance" in the values submitted to
2198 the daemon. Other than that, that name is not used.
2202 =item B<PluginName> I<PluginName>
2204 Use I<PluginName> as the plugin name when submitting query results from
2205 this B<Database>. Defaults to 'dbi'.
2207 =item B<Interval> I<Interval>
2209 Sets the interval (in seconds) in which the values will be collected from this
2210 database. By default the global B<Interval> setting will be used.
2212 =item B<Driver> I<Driver>
2214 Specifies the driver to use to connect to the database. In many cases those
2215 drivers are named after the database they can connect to, but this is not a
2216 technical necessity. These drivers are sometimes referred to as "DBD",
2217 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2218 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2219 project at L<http://libdbi-drivers.sourceforge.net/>.
2221 You need to give the driver name as expected by the "dbi" library here. You
2222 should be able to find that in the documentation for each driver. If you
2223 mistype the driver name, the plugin will dump a list of all known driver names
2226 =item B<DriverOption> I<Key> I<Value>
2228 Sets driver-specific options. What option a driver supports can be found in the
2229 documentation for each driver, somewhere at
2230 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2231 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2233 DBDs can register two types of options: String options and numeric options. The
2234 plugin will use the C<dbi_conn_set_option> function when the configuration
2235 provides a string and the C<dbi_conn_require_option_numeric> function when the
2236 configuration provides a number. So these two lines will actually result in
2237 different calls being used:
2239 DriverOption "Port" 1234 # numeric
2240 DriverOption "Port" "1234" # string
2242 Unfortunately, drivers are not too keen to report errors when an unknown option
2243 is passed to them, so invalid settings here may go unnoticed. This is not the
2244 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2245 the driver. If a driver complains about an option, the plugin will dump a
2246 complete list of all options understood by that driver to the log. There is no
2247 way to programmatically find out if an option expects a string or a numeric
2248 argument, so you will have to refer to the appropriate DBD's documentation to
2249 find this out. Sorry.
2251 =item B<SelectDB> I<Database>
2253 In some cases, the database name you connect with is not the database name you
2254 want to use for querying data. If this option is set, the plugin will "select"
2255 (switch to) that database after the connection is established.
2257 =item B<Query> I<QueryName>
2259 Associates the query named I<QueryName> with this database connection. The
2260 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2261 blocks you want to refer to must be placed above the database block you want to
2264 =item B<Host> I<Hostname>
2266 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2267 values. Defaults to the global hostname setting.
2275 =item B<Device> I<Device>
2277 Select partitions based on the devicename.
2279 See F</"IGNORELISTS"> for details.
2281 =item B<MountPoint> I<Directory>
2283 Select partitions based on the mountpoint.
2285 See F</"IGNORELISTS"> for details.
2287 =item B<FSType> I<FSType>
2289 Select partitions based on the filesystem type.
2291 See F</"IGNORELISTS"> for details.
2293 =item B<IgnoreSelected> B<true>|B<false>
2295 Invert the selection: If set to true, all partitions B<except> the ones that
2296 match any one of the criteria are collected. By default only selected
2297 partitions are collected if a selection is made. If no selection is configured
2298 at all, B<all> partitions are selected.
2300 =item B<ReportByDevice> B<true>|B<false>
2302 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2303 (the default), it will report a disk as "root", but with it I<true>, it will be
2304 "sda1" (or whichever).
2306 =item B<ReportInodes> B<true>|B<false>
2308 Enables or disables reporting of free, reserved and used inodes. Defaults to
2309 inode collection being disabled.
2311 Enable this option if inodes are a scarce resource for you, usually because
2312 many small files are stored on the disk. This is a usual scenario for mail
2313 transfer agents and web caches.
2315 =item B<ValuesAbsolute> B<true>|B<false>
2317 Enables or disables reporting of free and used disk space in 1K-blocks.
2318 Defaults to B<true>.
2320 =item B<ValuesPercentage> B<false>|B<true>
2322 Enables or disables reporting of free and used disk space in percentage.
2323 Defaults to B<false>.
2325 This is useful for deploying I<collectd> on the cloud, where machines with
2326 different disk size may exist. Then it is more practical to configure
2327 thresholds based on relative disk size.
2331 =head2 Plugin C<disk>
2333 The C<disk> plugin collects information about the usage of physical disks and
2334 logical disks (partitions). Values collected are the number of octets written
2335 to and read from a disk or partition, the number of read/write operations
2336 issued to the disk and a rather complex "time" it took for these commands to be
2339 Using the following two options you can ignore some disks or configure the
2340 collection only of specific disks.
2344 =item B<Disk> I<Name>
2346 Select the disk I<Name>. Whether it is collected or ignored depends on the
2347 B<IgnoreSelected> setting, see below. As with other plugins that use the
2348 daemon's ignorelist functionality, a string that starts and ends with a slash
2349 is interpreted as a regular expression. Examples:
2354 See F</"IGNORELISTS"> for details.
2356 =item B<IgnoreSelected> B<true>|B<false>
2358 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2359 statements, are ignored or if all other disks are ignored. The behavior
2360 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2361 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2362 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2363 is set to B<true>, all disks are collected B<except> the ones matched.
2365 =item B<UseBSDName> B<true>|B<false>
2367 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2368 default major/minor numbers. Requires collectd to be built with Apple's
2371 =item B<UdevNameAttr> I<Attribute>
2373 Attempt to override disk instance name with the value of a specified udev
2374 attribute when built with B<libudev>. If the attribute is not defined for the
2375 given device, the default name is used. Example:
2377 UdevNameAttr "DM_NAME"
2381 =head2 Plugin C<dns>
2385 =item B<Interface> I<Interface>
2387 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2388 option sets the interface that should be used. If this option is not set, or
2389 set to "any", the plugin will try to get packets from B<all> interfaces. This
2390 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2392 =item B<IgnoreSource> I<IP-address>
2394 Ignore packets that originate from this address.
2396 =item B<SelectNumericQueryTypes> B<true>|B<false>
2398 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2402 =head2 Plugin C<dpdkevents>
2404 The I<dpdkevents plugin> collects events from DPDK such as link status of
2405 network ports and Keep Alive status of DPDK logical cores.
2406 In order to get Keep Alive events following requirements must be met:
2408 - support for Keep Alive implemented in DPDK application. More details can
2409 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2413 <Plugin "dpdkevents">
2419 <Event "link_status">
2420 SendEventsOnUpdate true
2421 EnabledPortMask 0xffff
2422 PortName "interface1"
2423 PortName "interface2"
2424 SendNotification false
2426 <Event "keep_alive">
2427 SendEventsOnUpdate true
2429 KeepAliveShmName "/dpdk_keepalive_shm_name"
2430 SendNotification false
2437 =head3 The EAL block
2441 =item B<Coremask> I<Mask>
2443 =item B<Memorychannels> I<Channels>
2445 Number of memory channels per processor socket.
2447 =item B<FilePrefix> I<File>
2449 The prefix text used for hugepage filenames. The filename will be set to
2450 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2454 =head3 The Event block
2456 The B<Event> block defines configuration for specific event. It accepts a
2457 single argument which specifies the name of the event.
2459 =head4 Link Status event
2463 =item B<SendEventOnUpdate> I<true|false>
2465 If set to true link status value will be dispatched only when it is
2466 different from previously read value. This is an optional argument - default
2469 =item B<EnabledPortMask> I<Mask>
2471 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2472 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2473 that all ports will be enabled. This is an optional argument - by default
2474 all ports are enabled.
2476 =item B<PortName> I<Name>
2478 A string containing an optional name for the enabled DPDK ports. Each PortName
2479 option should contain only one port name; specify as many PortName options as
2480 desired. Default naming convention will be used if PortName is blank. If there
2481 are less PortName options than there are enabled ports, the default naming
2482 convention will be used for the additional ports.
2484 =item B<SendNotification> I<true|false>
2486 If set to true, link status notifications are sent, instead of link status
2487 being collected as a statistic. This is an optional argument - default
2492 =head4 Keep Alive event
2496 =item B<SendEventOnUpdate> I<true|false>
2498 If set to true keep alive value will be dispatched only when it is
2499 different from previously read value. This is an optional argument - default
2502 =item B<LCoreMask> I<Mask>
2504 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2506 =item B<KeepAliveShmName> I<Name>
2508 Shared memory name identifier that is used by secondary process to monitor
2509 the keep alive cores state.
2511 =item B<SendNotification> I<true|false>
2513 If set to true, keep alive notifications are sent, instead of keep alive
2514 information being collected as a statistic. This is an optional
2515 argument - default value is false.
2519 =head2 Plugin C<dpdkstat>
2521 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2522 extended NIC stats API in DPDK.
2533 SharedMemObj "dpdk_collectd_stats_0"
2534 EnabledPortMask 0xffff
2535 PortName "interface1"
2536 PortName "interface2"
2541 =head3 The EAL block
2545 =item B<Coremask> I<Mask>
2547 A string containing an hexadecimal bit mask of the cores to run on. Note that
2548 core numbering can change between platforms and should be determined beforehand.
2550 =item B<Memorychannels> I<Channels>
2552 A string containing a number of memory channels per processor socket.
2554 =item B<FilePrefix> I<File>
2556 The prefix text used for hugepage filenames. The filename will be set to
2557 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2559 =item B<SocketMemory> I<MB>
2561 A string containing amount of Memory to allocate from hugepages on specific
2562 sockets in MB. This is an optional value.
2568 =item B<SharedMemObj> I<Mask>
2570 A string containing the name of the shared memory object that should be used to
2571 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2572 Defaults to dpdk_collectd_stats if no other value is configured.
2574 =item B<EnabledPortMask> I<Mask>
2576 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2577 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2578 that all ports will be enabled. This is an optional argument - default
2579 is all ports enabled.
2581 =item B<PortName> I<Name>
2583 A string containing an optional name for the enabled DPDK ports. Each PortName
2584 option should contain only one port name; specify as many PortName options as
2585 desired. Default naming convention will be used if PortName is blank. If there
2586 are less PortName options than there are enabled ports, the default naming
2587 convention will be used for the additional ports.
2591 =head2 Plugin C<email>
2595 =item B<SocketFile> I<Path>
2597 Sets the socket-file which is to be created.
2599 =item B<SocketGroup> I<Group>
2601 If running as root change the group of the UNIX-socket after it has been
2602 created. Defaults to B<collectd>.
2604 =item B<SocketPerms> I<Permissions>
2606 Change the file permissions of the UNIX-socket after it has been created. The
2607 permissions must be given as a numeric, octal value as you would pass to
2608 L<chmod(1)>. Defaults to B<0770>.
2610 =item B<MaxConns> I<Number>
2612 Sets the maximum number of connections that can be handled in parallel. Since
2613 this many threads will be started immediately setting this to a very high
2614 value will waste valuable resources. Defaults to B<5> and will be forced to be
2615 at most B<16384> to prevent typos and dumb mistakes.
2619 =head2 Plugin C<ethstat>
2621 The I<ethstat plugin> collects information about network interface cards (NICs)
2622 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2628 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2629 Map "multicast" "if_multicast"
2636 =item B<Interface> I<Name>
2638 Collect statistical information about interface I<Name>.
2640 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2642 By default, the plugin will submit values as type C<derive> and I<type
2643 instance> set to I<Name>, the name of the metric as reported by the driver. If
2644 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2645 I<TypeInstance> will be used.
2647 =item B<MappedOnly> B<true>|B<false>
2649 When set to B<true>, only metrics that can be mapped to a I<type> will be
2650 collected, all other metrics will be ignored. Defaults to B<false>.
2654 =head2 Plugin C<exec>
2656 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2657 contains valuable information on when the executable is executed and the
2658 output that is expected from it.
2662 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2664 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2666 Execute the executable I<Executable> as user I<User>. If the user name is
2667 followed by a colon and a group name, the effective group is set to that group.
2668 The real group and saved-set group will be set to the default group of that
2669 user. If no group is given the effective group ID will be the same as the real
2672 Please note that in order to change the user and/or group the daemon needs
2673 superuser privileges. If the daemon is run as an unprivileged user you must
2674 specify the same user/group here. If the daemon is run with superuser
2675 privileges, you must supply a non-root user here.
2677 The executable may be followed by optional arguments that are passed to the
2678 program. Please note that due to the configuration parsing numbers and boolean
2679 values may be changed. If you want to be absolutely sure that something is
2680 passed as-is please enclose it in quotes.
2682 The B<Exec> and B<NotificationExec> statements change the semantics of the
2683 programs executed, i.E<nbsp>e. the data passed to them and the response
2684 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2688 =head2 Plugin C<fhcount>
2690 The C<fhcount> plugin provides statistics about used, unused and total number of
2691 file handles on Linux.
2693 The I<fhcount plugin> provides the following configuration options:
2697 =item B<ValuesAbsolute> B<true>|B<false>
2699 Enables or disables reporting of file handles usage in absolute numbers,
2700 e.g. file handles used. Defaults to B<true>.
2702 =item B<ValuesPercentage> B<false>|B<true>
2704 Enables or disables reporting of file handles usage in percentages, e.g.
2705 percent of file handles used. Defaults to B<false>.
2709 =head2 Plugin C<filecount>
2711 The C<filecount> plugin counts the number of files in a certain directory (and
2712 its subdirectories) and their combined size. The configuration is very straight
2715 <Plugin "filecount">
2716 <Directory "/var/qmail/queue/mess">
2717 Instance "qmail-message"
2719 <Directory "/var/qmail/queue/todo">
2720 Instance "qmail-todo"
2722 <Directory "/var/lib/php5">
2723 Instance "php5-sessions"
2728 The example above counts the number of files in QMail's queue directories and
2729 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2730 QMail has not yet looked at, the "message" queue holds the messages that were
2731 classified into "local" and "remote".
2733 As you can see, the configuration consists of one or more C<Directory> blocks,
2734 each of which specifies a directory in which to count the files. Within those
2735 blocks, the following options are recognized:
2739 =item B<Instance> I<Instance>
2741 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2742 it's your responsibility, the plugin doesn't check for that. If not given, the
2743 instance is set to the directory name with all slashes replaced by underscores
2744 and all leading underscores removed.
2746 =item B<Name> I<Pattern>
2748 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2749 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2750 against the pattern, not the entire path. In case this makes it easier for you:
2751 This option has been named after the B<-name> parameter to L<find(1)>.
2753 =item B<MTime> I<Age>
2755 Count only files of a specific age: If I<Age> is greater than zero, only files
2756 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2757 a negative number, this is inversed. For example, if B<-60> is specified, only
2758 files that have been modified in the last minute will be counted.
2760 The number can also be followed by a "multiplier" to easily specify a larger
2761 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2762 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2763 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2764 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2765 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2768 =item B<Size> I<Size>
2770 Count only files of a specific size. When I<Size> is a positive number, only
2771 files that are at least this big are counted. If I<Size> is a negative number,
2772 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2773 I<Size> are counted.
2775 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2776 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2777 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2778 note that there are 1000 bytes in a kilobyte, not 1024.
2780 =item B<Recursive> I<true>|I<false>
2782 Controls whether or not to recurse into subdirectories. Enabled by default.
2784 =item B<IncludeHidden> I<true>|I<false>
2786 Controls whether or not to include "hidden" files and directories in the count.
2787 "Hidden" files and directories are those, whose name begins with a dot.
2788 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2792 =head2 Plugin C<GenericJMX>
2794 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2795 L<collectd-java(5)>.
2797 =head2 Plugin C<gmond>
2799 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2800 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2801 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2806 MCReceiveFrom "239.2.11.71" "8649"
2807 <Metric "swap_total">
2809 TypeInstance "total"
2812 <Metric "swap_free">
2819 The following metrics are built-in:
2825 load_one, load_five, load_fifteen
2829 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2833 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2845 Available configuration options:
2849 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2851 Sets sets the multicast group and UDP port to which to subscribe.
2853 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2855 =item E<lt>B<Metric> I<Name>E<gt>
2857 These blocks add a new metric conversion to the internal table. I<Name>, the
2858 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2862 =item B<Type> I<Type>
2864 Type to map this metric to. Required.
2866 =item B<TypeInstance> I<Instance>
2868 Type-instance to use. Optional.
2870 =item B<DataSource> I<Name>
2872 Data source to map this metric to. If the configured type has exactly one data
2873 source, this is optional. Otherwise the option is required.
2879 =head2 Plugin C<gps>
2881 The C<gps plugin> connects to gpsd on the host machine.
2882 The host, port, timeout and pause are configurable.
2884 This is useful if you run an NTP server using a GPS for source and you want to
2887 Mind your GPS must send $--GSA for having the data reported!
2889 The following elements are collected:
2895 Number of satellites used for fix (type instance "used") and in view (type
2896 instance "visible"). 0 means no GPS satellites are visible.
2898 =item B<dilution_of_precision>
2900 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2901 It should be between 0 and 3.
2902 Look at the documentation of your GPS to know more.
2910 # Connect to localhost on gpsd regular port:
2915 # PauseConnect of 5 sec. between connection attempts.
2919 Available configuration options:
2923 =item B<Host> I<Host>
2925 The host on which gpsd daemon runs. Defaults to B<localhost>.
2927 =item B<Port> I<Port>
2929 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2931 =item B<Timeout> I<Seconds>
2933 Timeout in seconds (default 0.015 sec).
2935 The GPS data stream is fetch by the plugin form the daemon.
2936 It waits for data to be available, if none arrives it times out
2937 and loop for another reading.
2938 Mind to put a low value gpsd expects value in the micro-seconds area
2939 (recommended is 500 us) since the waiting function is blocking.
2940 Value must be between 500 us and 5 sec., if outside that range the
2941 default value is applied.
2943 This only applies from gpsd release-2.95.
2945 =item B<PauseConnect> I<Seconds>
2947 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
2951 =head2 Plugin C<grpc>
2953 The I<grpc> plugin provides an RPC interface to submit values to or query
2954 values from collectd based on the open source gRPC framework. It exposes an
2955 end-point for dispatching values to the daemon.
2957 The B<gRPC> homepage can be found at L<https://grpc.io/>.
2961 =item B<Server> I<Host> I<Port>
2963 The B<Server> statement sets the address of a server to which to send metrics
2964 via the C<DispatchValues> function.
2966 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2968 Optionally, B<Server> may be specified as a configuration block which supports
2969 the following options:
2973 =item B<EnableSSL> B<false>|B<true>
2975 Whether to require SSL for outgoing connections. Default: false.
2977 =item B<SSLCACertificateFile> I<Filename>
2979 =item B<SSLCertificateFile> I<Filename>
2981 =item B<SSLCertificateKeyFile> I<Filename>
2983 Filenames specifying SSL certificate and key material to be used with SSL
2988 =item B<Listen> I<Host> I<Port>
2990 The B<Listen> statement sets the network address to bind to. When multiple
2991 statements are specified, the daemon will bind to all of them. If none are
2992 specified, it defaults to B<0.0.0.0:50051>.
2994 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2996 Optionally, B<Listen> may be specified as a configuration block which
2997 supports the following options:
3001 =item B<EnableSSL> I<true>|I<false>
3003 Whether to enable SSL for incoming connections. Default: false.
3005 =item B<SSLCACertificateFile> I<Filename>
3007 =item B<SSLCertificateFile> I<Filename>
3009 =item B<SSLCertificateKeyFile> I<Filename>
3011 Filenames specifying SSL certificate and key material to be used with SSL
3018 =head2 Plugin C<hddtemp>
3020 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3021 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3022 default values, see below. C<hddtemp> has to be running to work correctly. If
3023 C<hddtemp> is not running timeouts may appear which may interfere with other
3026 The B<hddtemp> homepage can be found at
3027 L<http://www.guzu.net/linux/hddtemp.php>.
3031 =item B<Host> I<Hostname>
3033 Hostname to connect to. Defaults to B<127.0.0.1>.
3035 =item B<Port> I<Port>
3037 TCP-Port to connect to. Defaults to B<7634>.
3041 =head2 Plugin C<hugepages>
3043 To collect B<hugepages> information, collectd reads directories
3044 "/sys/devices/system/node/*/hugepages" and
3045 "/sys/kernel/mm/hugepages".
3046 Reading of these directories can be disabled by the following
3047 options (default is enabled).
3051 =item B<ReportPerNodeHP> B<true>|B<false>
3053 If enabled, information will be collected from the hugepage
3054 counters in "/sys/devices/system/node/*/hugepages".
3055 This is used to check the per-node hugepage statistics on
3058 =item B<ReportRootHP> B<true>|B<false>
3060 If enabled, information will be collected from the hugepage
3061 counters in "/sys/kernel/mm/hugepages".
3062 This can be used on both NUMA and non-NUMA systems to check
3063 the overall hugepage statistics.
3065 =item B<ValuesPages> B<true>|B<false>
3067 Whether to report hugepages metrics in number of pages.
3068 Defaults to B<true>.
3070 =item B<ValuesBytes> B<false>|B<true>
3072 Whether to report hugepages metrics in bytes.
3073 Defaults to B<false>.
3075 =item B<ValuesPercentage> B<false>|B<true>
3077 Whether to report hugepages metrics as percentage.
3078 Defaults to B<false>.
3082 =head2 Plugin C<intel_rdt>
3084 The I<intel_rdt> plugin collects information provided by monitoring features of
3085 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3086 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3087 information about utilization of shared resources. CMT monitors last level cache
3088 occupancy (LLC). MBM supports two types of events reporting local and remote
3089 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3090 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3091 reports the bandwidth of accessing the remote socket. Also this technology
3092 allows to monitor instructions per clock (IPC).
3093 Monitor events are hardware dependant. Monitoring capabilities are detected on
3094 plugin initialization and only supported events are monitored.
3096 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3097 require an additional capability to be enabled if collectd is run as a service.
3098 Please refer to I<contrib/systemd.collectd.service> file for more details.
3102 <Plugin "intel_rdt">
3103 Cores "0-2" "3,4,6" "8-10,15"
3110 =item B<Interval> I<seconds>
3112 The interval within which to retrieve statistics on monitored events in seconds.
3113 For milliseconds divide the time by 1000 for example if the desired interval
3114 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3115 recommended to set interval higher than 1 sec.
3117 =item B<Cores> I<cores groups>
3119 All events are reported on a per core basis. Monitoring of the events can be
3120 configured for group of cores (aggregated statistics). This field defines groups
3121 of cores on which to monitor supported events. The field is represented as list
3122 of strings with core group values. Each string represents a list of cores in a
3123 group. Allowed formats are:
3128 If an empty string is provided as value for this field default cores
3129 configuration is applied - a separate group is created for each core.
3133 B<Note:> By default global interval is used to retrieve statistics on monitored
3134 events. To configure a plugin specific interval use B<Interval> option of the
3135 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3136 example if the desired interval is 50ms, set interval to 0.05.
3137 Due to limited capacity of counters it is not recommended to set interval higher
3140 =head2 Plugin C<interface>
3144 =item B<Interface> I<Interface>
3146 Select this interface. By default these interfaces will then be collected. For
3147 a more detailed description see B<IgnoreSelected> below.
3149 See F</"IGNORELISTS"> for details.
3151 =item B<IgnoreSelected> I<true>|I<false>
3153 If no configuration is given, the B<interface>-plugin will collect data from
3154 all interfaces. This may not be practical, especially for loopback- and
3155 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3156 interfaces you're interested in. Sometimes, however, it's easier/preferred
3157 to collect all interfaces I<except> a few ones. This option enables you to
3158 do that: By setting B<IgnoreSelected> to I<true> the effect of
3159 B<Interface> is inverted: All selected interfaces are ignored and all
3160 other interfaces are collected.
3162 It is possible to use regular expressions to match interface names, if the
3163 name is surrounded by I</.../> and collectd was compiled with support for
3164 regexps. This is useful if there's a need to collect (or ignore) data
3165 for a group of interfaces that are similarly named, without the need to
3166 explicitly list all of them (especially useful if the list is dynamic).
3171 Interface "/^tun[0-9]+/"
3172 IgnoreSelected "true"
3174 This will ignore the loopback interface, all interfaces with names starting
3175 with I<veth> and all interfaces with names starting with I<tun> followed by
3178 =item B<ReportInactive> I<true>|I<false>
3180 When set to I<false>, only interfaces with non-zero traffic will be
3181 reported. Note that the check is done by looking into whether a
3182 package was sent at any time from boot and the corresponding counter
3183 is non-zero. So, if the interface has been sending data in the past
3184 since boot, but not during the reported time-interval, it will still
3187 The default value is I<true> and results in collection of the data
3188 from all interfaces that are selected by B<Interface> and
3189 B<IgnoreSelected> options.
3191 =item B<UniqueName> I<true>|I<false>
3193 Interface name is not unique on Solaris (KSTAT), interface name is unique
3194 only within a module/instance. Following tuple is considered unique:
3195 (ks_module, ks_instance, ks_name)
3196 If this option is set to true, interface name contains above three fields
3197 separated by an underscore. For more info on KSTAT, visit
3198 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3200 This option is only available on Solaris.
3204 =head2 Plugin C<ipmi>
3208 =item B<Sensor> I<Sensor>
3210 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3212 See F</"IGNORELISTS"> for details.
3214 =item B<IgnoreSelected> I<true>|I<false>
3216 If no configuration if given, the B<ipmi> plugin will collect data from all
3217 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3218 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3219 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3220 all other sensors are collected.
3222 =item B<NotifySensorAdd> I<true>|I<false>
3224 If a sensor appears after initialization time of a minute a notification
3227 =item B<NotifySensorRemove> I<true>|I<false>
3229 If a sensor disappears a notification is sent.
3231 =item B<NotifySensorNotPresent> I<true>|I<false>
3233 If you have for example dual power supply and one of them is (un)plugged then
3234 a notification is sent.
3238 =head2 Plugin C<iptables>
3242 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3244 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3246 Select the iptables/ip6tables filter rules to count packets and bytes from.
3248 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3249 of all rules which have a comment-match. The comment is then used as
3252 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3253 the I<n>th rule will be collected. Again, the comment (or the number) will be
3254 used as the type-instance.
3256 If I<Name> is supplied, it will be used as the type-instance instead of the
3257 comment or the number.
3261 =head2 Plugin C<irq>
3267 Select this irq. By default these irqs will then be collected. For a more
3268 detailed description see B<IgnoreSelected> below.
3270 See F</"IGNORELISTS"> for details.
3272 =item B<IgnoreSelected> I<true>|I<false>
3274 If no configuration if given, the B<irq>-plugin will collect data from all
3275 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3276 can use the B<Irq>-option to pick the interrupt you're interested in.
3277 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3278 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3279 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3280 and all other interrupts are collected.
3284 =head2 Plugin C<java>
3286 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3287 This section only discusses the syntax and semantic of the configuration
3288 options. For more in-depth information on the I<Java> plugin, please read
3289 L<collectd-java(5)>.
3294 JVMArg "-verbose:jni"
3295 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3296 LoadPlugin "org.collectd.java.Foobar"
3297 <Plugin "org.collectd.java.Foobar">
3298 # To be parsed by the plugin
3302 Available configuration options:
3306 =item B<JVMArg> I<Argument>
3308 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3309 exactly the way the arguments to the I<java> binary on the command line work.
3310 Execute C<javaE<nbsp>--help> for details.
3312 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3313 any other options! When another option is found, the JVM will be started and
3314 later options will have to be ignored!
3316 =item B<LoadPlugin> I<JavaClass>
3318 Instantiates a new I<JavaClass> object. The constructor of this object very
3319 likely then registers one or more callback methods with the server.
3321 See L<collectd-java(5)> for details.
3323 When the first such option is found, the virtual machine (JVM) is created. This
3324 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3325 B<LoadPlugin> options!
3327 =item B<Plugin> I<Name>
3329 The entire block is passed to the Java plugin as an
3330 I<org.collectd.api.OConfigItem> object.
3332 For this to work, the plugin has to register a configuration callback first,
3333 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3334 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3335 depends on the (Java) plugin registering the callback and is completely
3336 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3340 =head2 Plugin C<load>
3342 The I<Load plugin> collects the system load. These numbers give a rough overview
3343 over the utilization of a machine. The system load is defined as the number of
3344 runnable tasks in the run-queue and is provided by many operating systems as a
3345 one, five or fifteen minute average.
3347 The following configuration options are available:
3351 =item B<ReportRelative> B<false>|B<true>
3353 When enabled, system load divided by number of available CPU cores is reported
3354 for intervals 1 min, 5 min and 15 min. Defaults to false.
3359 =head2 Plugin C<logfile>
3363 =item B<LogLevel> B<debug|info|notice|warning|err>
3365 Sets the log-level. If, for example, set to B<notice>, then all events with
3366 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3368 Please note that B<debug> is only available if collectd has been compiled with
3371 =item B<File> I<File>
3373 Sets the file to write log messages to. The special strings B<stdout> and
3374 B<stderr> can be used to write to the standard output and standard error
3375 channels, respectively. This, of course, only makes much sense when I<collectd>
3376 is running in foreground- or non-daemon-mode.
3378 =item B<Timestamp> B<true>|B<false>
3380 Prefix all lines printed by the current time. Defaults to B<true>.
3382 =item B<PrintSeverity> B<true>|B<false>
3384 When enabled, all lines are prefixed by the severity of the log message, for
3385 example "warning". Defaults to B<false>.
3389 B<Note>: There is no need to notify the daemon after moving or removing the
3390 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3391 for each line it writes.
3393 =head2 Plugin C<log_logstash>
3395 The I<log logstash plugin> behaves like the logfile plugin but formats
3396 messages as JSON events for logstash to parse and input.
3400 =item B<LogLevel> B<debug|info|notice|warning|err>
3402 Sets the log-level. If, for example, set to B<notice>, then all events with
3403 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3405 Please note that B<debug> is only available if collectd has been compiled with
3408 =item B<File> I<File>
3410 Sets the file to write log messages to. The special strings B<stdout> and
3411 B<stderr> can be used to write to the standard output and standard error
3412 channels, respectively. This, of course, only makes much sense when I<collectd>
3413 is running in foreground- or non-daemon-mode.
3417 B<Note>: There is no need to notify the daemon after moving or removing the
3418 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3419 for each line it writes.
3421 =head2 Plugin C<lpar>
3423 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3424 virtualization technique for IBM POWER processors. It takes into account CPU
3425 time stolen from or donated to a partition, in addition to the usual user,
3426 system, I/O statistics.
3428 The following configuration options are available:
3432 =item B<CpuPoolStats> B<false>|B<true>
3434 When enabled, statistics about the processor pool are read, too. The partition
3435 needs to have pool authority in order to be able to acquire this information.
3438 =item B<ReportBySerial> B<false>|B<true>
3440 If enabled, the serial of the physical machine the partition is currently
3441 running on is reported as I<hostname> and the logical hostname of the machine
3442 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3443 used (just like other plugins) and the I<plugin instance> will be empty.
3448 =head2 Plugin C<lua>
3450 This plugin embeds a Lua interpreter into collectd and provides an interface
3451 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3454 =head2 Plugin C<mbmon>
3456 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3458 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3459 B<Host> and B<Port> options can be used to change these values, see below.
3460 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3461 timeouts may appear which may interfere with other statistics..
3463 C<mbmon> must be run with the -r option ("print TAG and Value format");
3464 Debian's F</etc/init.d/mbmon> script already does this, other people
3465 will need to ensure that this is the case.
3469 =item B<Host> I<Hostname>
3471 Hostname to connect to. Defaults to B<127.0.0.1>.
3473 =item B<Port> I<Port>
3475 TCP-Port to connect to. Defaults to B<411>.
3479 =head2 Plugin C<mcelog>
3481 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3483 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3484 mcelog server is running. When the server is running, the plugin will tail the
3485 specified logfile to retrieve machine check exception information and send a
3486 notification with the details from the logfile. The plugin will use the mcelog
3487 client protocol to retrieve memory related machine check exceptions.
3491 =item B<McelogClientSocket> I<Path>
3492 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3493 Defaults to B<"/var/run/mcelog-client">.
3495 =item B<McelogLogfile> I<Path>
3497 The mcelog file to parse. Defaults to B<"/var/log/mcelog">.
3503 The C<md plugin> collects information from Linux Software-RAID devices (md).
3505 All reported values are of the type C<md_disks>. Reported type instances are
3506 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3507 I<missing> (physically absent) disks.
3511 =item B<Device> I<Device>
3513 Select md devices based on device name. The I<device name> is the basename of
3514 the device, i.e. the name of the block device without the leading C</dev/>.
3515 See B<IgnoreSelected> for more details.
3517 See F</"IGNORELISTS"> for details.
3519 =item B<IgnoreSelected> B<true>|B<false>
3521 Invert device selection: If set to B<true>, all md devices B<except> those
3522 listed using B<Device> are collected. If B<false> (the default), only those
3523 listed are collected. If no configuration is given, the B<md> plugin will
3524 collect data from all md devices.
3528 =head2 Plugin C<memcachec>
3530 The C<memcachec plugin> connects to a memcached server, queries one or more
3531 given I<pages> and parses the returned data according to user specification.
3532 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3535 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3536 library. Please note that there is another library with a very similar name,
3537 libmemcache (notice the missing `d'), which is not applicable.
3539 Synopsis of the configuration:
3541 <Plugin "memcachec">
3542 <Page "plugin_instance">
3546 Regex "(\\d+) bytes sent"
3549 Instance "type_instance"
3554 The configuration options are:
3558 =item E<lt>B<Page> I<Name>E<gt>
3560 Each B<Page> block defines one I<page> to be queried from the memcached server.
3561 The block requires one string argument which is used as I<plugin instance>.
3563 =item B<Server> I<Address>
3565 Sets the server address to connect to when querying the page. Must be inside a
3570 When connected to the memcached server, asks for the page I<Key>.
3572 =item E<lt>B<Match>E<gt>
3574 Match blocks define which strings to look for and how matches substrings are
3575 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3579 =head2 Plugin C<memcached>
3581 The B<memcached plugin> connects to a memcached server and queries statistics
3582 about cache utilization, memory and bandwidth used.
3583 L<http://memcached.org/>
3585 <Plugin "memcached">
3587 #Host "memcache.example.com"
3593 The plugin configuration consists of one or more B<Instance> blocks which
3594 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3595 following options are allowed:
3599 =item B<Host> I<Hostname>
3601 Sets the B<host> field of dispatched values. Defaults to the global hostname
3603 For backwards compatibility, values are also dispatched with the global
3604 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3607 =item B<Address> I<Address>
3609 Hostname or IP to connect to. For backwards compatibility, defaults to the
3610 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3612 =item B<Port> I<Port>
3614 TCP port to connect to. Defaults to B<11211>.
3616 =item B<Socket> I<Path>
3618 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3619 setting is given, the B<Address> and B<Port> settings are ignored.
3623 =head2 Plugin C<mic>
3625 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3626 Intel's Many Integrated Core (MIC) systems.
3635 ShowTemperatures true
3638 IgnoreSelectedTemperature true
3643 IgnoreSelectedPower true
3646 The following options are valid inside the B<PluginE<nbsp>mic> block:
3650 =item B<ShowCPU> B<true>|B<false>
3652 If enabled (the default) a sum of the CPU usage across all cores is reported.
3654 =item B<ShowCPUCores> B<true>|B<false>
3656 If enabled (the default) per-core CPU usage is reported.
3658 =item B<ShowMemory> B<true>|B<false>
3660 If enabled (the default) the physical memory usage of the MIC system is
3663 =item B<ShowTemperatures> B<true>|B<false>
3665 If enabled (the default) various temperatures of the MIC system are reported.
3667 =item B<Temperature> I<Name>
3669 This option controls which temperatures are being reported. Whether matching
3670 temperatures are being ignored or I<only> matching temperatures are reported
3671 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3672 temperatures are reported.
3674 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3676 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3677 (the default) only temperatures matching a B<Temperature> option are reported
3678 or, if no B<Temperature> option is specified, all temperatures are reported. If
3679 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3682 Known temperature names are:
3716 =item B<ShowPower> B<true>|B<false>
3718 If enabled (the default) various temperatures of the MIC system are reported.
3720 =item B<Power> I<Name>
3722 This option controls which power readings are being reported. Whether matching
3723 power readings are being ignored or I<only> matching power readings are reported
3724 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3725 power readings are reported.
3727 =item B<IgnoreSelectedPower> B<false>|B<true>
3729 Controls the behavior of the B<Power> setting above. If set to B<false>
3730 (the default) only power readings matching a B<Power> option are reported
3731 or, if no B<Power> option is specified, all power readings are reported. If
3732 set to B<true>, matching power readings are I<ignored> and all other power readings
3735 Known power names are:
3741 Total power utilization averaged over Time Window 0 (uWatts).
3745 Total power utilization averaged over Time Window 0 (uWatts).
3749 Instantaneous power (uWatts).
3753 Max instantaneous power (uWatts).
3757 PCI-E connector power (uWatts).
3761 2x3 connector power (uWatts).
3765 2x4 connector power (uWatts).
3773 Uncore rail (uVolts).
3777 Memory subsystem rail (uVolts).
3783 =head2 Plugin C<memory>
3785 The I<memory plugin> provides the following configuration options:
3789 =item B<ValuesAbsolute> B<true>|B<false>
3791 Enables or disables reporting of physical memory usage in absolute numbers,
3792 i.e. bytes. Defaults to B<true>.
3794 =item B<ValuesPercentage> B<false>|B<true>
3796 Enables or disables reporting of physical memory usage in percentages, e.g.
3797 percent of physical memory used. Defaults to B<false>.
3799 This is useful for deploying I<collectd> in a heterogeneous environment in
3800 which the sizes of physical memory vary.
3804 =head2 Plugin C<modbus>
3806 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3807 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3808 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3809 values (two registers interpreted as IEEE floats in big endian notation).
3813 <Data "voltage-input-1">
3816 RegisterCmd ReadHolding
3821 <Data "voltage-input-2">
3824 RegisterCmd ReadHolding
3829 <Data "supply-temperature-1">
3832 RegisterCmd ReadHolding
3837 <Host "modbus.example.com">
3838 Address "192.168.0.42"
3843 Instance "power-supply"
3844 Collect "voltage-input-1"
3845 Collect "voltage-input-2"
3850 Device "/dev/ttyUSB0"
3855 Instance "temperature"
3856 Collect "supply-temperature-1"
3862 =item E<lt>B<Data> I<Name>E<gt> blocks
3864 Data blocks define a mapping between register numbers and the "types" used by
3867 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3871 =item B<RegisterBase> I<Number>
3873 Configures the base register to read from the device. If the option
3874 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3875 register will be read (the register number is increased by one).
3877 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3879 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3880 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3881 combined into one value. Defaults to B<Uint16>.
3883 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3885 Specifies register type to be collected from device. Works only with libmodbus
3886 2.9.2 or higher. Defaults to B<ReadHolding>.
3888 =item B<Type> I<Type>
3890 Specifies the "type" (data set) to use when dispatching the value to
3891 I<collectd>. Currently, only data sets with exactly one data source are
3894 =item B<Instance> I<Instance>
3896 Sets the type instance to use when dispatching the value to I<collectd>. If
3897 unset, an empty string (no type instance) is used.
3901 =item E<lt>B<Host> I<Name>E<gt> blocks
3903 Host blocks are used to specify to which hosts to connect and what data to read
3904 from their "slaves". The string argument I<Name> is used as hostname when
3905 dispatching the values to I<collectd>.
3907 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3911 =item B<Address> I<Hostname>
3913 For Modbus/TCP, specifies the node name (the actual network address) used to
3914 connect to the host. This may be an IP address or a hostname. Please note that
3915 the used I<libmodbus> library only supports IPv4 at the moment.
3917 =item B<Port> I<Service>
3919 for Modbus/TCP, specifies the port used to connect to the host. The port can
3920 either be given as a number or as a service name. Please note that the
3921 I<Service> argument must be a string, even if ports are given in their numerical
3922 form. Defaults to "502".
3924 =item B<Device> I<Devicenode>
3926 For Modbus/RTU, specifies the path to the serial device being used.
3928 =item B<Baudrate> I<Baudrate>
3930 For Modbus/RTU, specifies the baud rate of the serial device.
3931 Note, connections currently support only 8/N/1.
3933 =item B<Interval> I<Interval>
3935 Sets the interval (in seconds) in which the values will be collected from this
3936 host. By default the global B<Interval> setting will be used.
3938 =item E<lt>B<Slave> I<ID>E<gt>
3940 Over each connection, multiple Modbus devices may be reached. The slave ID
3941 is used to specify which device should be addressed. For each device you want
3942 to query, one B<Slave> block must be given.
3944 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3948 =item B<Instance> I<Instance>
3950 Specify the plugin instance to use when dispatching the values to I<collectd>.
3951 By default "slave_I<ID>" is used.
3953 =item B<Collect> I<DataName>
3955 Specifies which data to retrieve from the device. I<DataName> must be the same
3956 string as the I<Name> argument passed to a B<Data> block. You can specify this
3957 option multiple times to collect more than one value from a slave. At least one
3958 B<Collect> option is mandatory.
3966 =head2 Plugin C<mqtt>
3968 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
3969 values from MQTT (B<Subscribe> blocks).
3975 Host "mqtt.example.com"
3979 Host "mqtt.example.com"
3984 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
3985 configuring the sending and receiving direction respectively. The plugin will
3986 register a write callback named C<mqtt/I<name>> where I<name> is the string
3987 argument given to the B<Publish> block. Both types of blocks share many but not
3988 all of the following options. If an option is valid in only one of the blocks,
3989 it will be mentioned explicitly.
3995 =item B<Host> I<Hostname>
3997 Hostname of the MQTT broker to connect to.
3999 =item B<Port> I<Service>
4001 Port number or service name of the MQTT broker to connect to.
4003 =item B<User> I<UserName>
4005 Username used when authenticating to the MQTT broker.
4007 =item B<Password> I<Password>
4009 Password used when authenticating to the MQTT broker.
4011 =item B<ClientId> I<ClientId>
4013 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4015 =item B<QoS> [B<0>-B<2>]
4017 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4035 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4036 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4037 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4038 on a message is larger than the maximum accepted QoS of a subscriber, the
4039 message's QoS will be downgraded.
4041 =item B<Prefix> I<Prefix> (Publish only)
4043 This plugin will use one topic per I<value list> which will looks like a path.
4044 I<Prefix> is used as the first path element and defaults to B<collectd>.
4046 An example topic name would be:
4048 collectd/cpu-0/cpu-user
4050 =item B<Retain> B<false>|B<true> (Publish only)
4052 Controls whether the MQTT broker will retain (keep a copy of) the last message
4053 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4055 =item B<StoreRates> B<true>|B<false> (Publish only)
4057 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4058 before sending. Defaults to B<true>.
4060 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4062 Controls whether the MQTT "cleans" the session up after the subscriber
4063 disconnects or if it maintains the subscriber's subscriptions and all messages
4064 that arrive while the subscriber is disconnected. Defaults to B<true>.
4066 =item B<Topic> I<TopicName> (Subscribe only)
4068 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4069 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4070 the B<collectd> branch.
4072 =item B<CACert> I<file>
4074 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4075 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4076 port of the MQTT broker.
4077 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4079 =item B<CertificateFile> I<file>
4081 Path to the PEM-encoded certificate file to use as client certificate when
4082 connecting to the MQTT broker.
4083 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4085 =item B<CertificateKeyFile> I<file>
4087 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4088 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4090 =item B<TLSProtocol> I<protocol>
4092 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4093 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4094 version is used which depends on the version of OpenSSL the Mosquitto library
4097 =item B<CipherSuite> I<ciphersuite>
4099 A string describing the ciphers available for use. See L<ciphers(1)> and the
4100 C<openssl ciphers> utility for more information. If unset, the default ciphers
4106 =head2 Plugin C<mysql>
4108 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4109 one or more databases when started and keeps the connection up as long as
4110 possible. When the connection is interrupted for whatever reason it will try
4111 to re-connect. The plugin will complain loudly in case anything goes wrong.
4113 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4114 and collects information about MySQL network traffic, executed statements,
4115 requests, the query cache and threads by evaluating the
4116 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4117 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4118 Status Variables> for an explanation of these values.
4120 Optionally, master and slave statistics may be collected in a MySQL
4121 replication setup. In that case, information about the synchronization state
4122 of the nodes are collected by evaluating the C<Position> return value of the
4123 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4124 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4125 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4126 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4127 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4139 SSLKey "/path/to/key.pem"
4140 SSLCert "/path/to/cert.pem"
4141 SSLCA "/path/to/ca.pem"
4142 SSLCAPath "/path/to/cas/"
4143 SSLCipher "DHE-RSA-AES256-SHA"
4149 Socket "/var/run/mysql/mysqld.sock"
4151 SlaveNotifications true
4157 Socket "/var/run/mysql/mysqld.sock"
4162 A B<Database> block defines one connection to a MySQL database. It accepts a
4163 single argument which specifies the name of the database. None of the other
4164 options are required. MySQL will use default values as documented in the
4165 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4166 B<MySQL reference manual>.
4170 =item B<Alias> I<Alias>
4172 Alias to use as sender instead of hostname when reporting. This may be useful
4173 when having cryptic hostnames.
4175 =item B<Host> I<Hostname>
4177 Hostname of the database server. Defaults to B<localhost>.
4179 =item B<User> I<Username>
4181 Username to use when connecting to the database. The user does not have to be
4182 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4183 unless you want to collectd replication statistics (see B<MasterStats> and
4184 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4185 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4187 =item B<Password> I<Password>
4189 Password needed to log into the database.
4191 =item B<Database> I<Database>
4193 Select this database. Defaults to I<no database> which is a perfectly reasonable
4194 option for what this plugin does.
4196 =item B<Port> I<Port>
4198 TCP-port to connect to. The port must be specified in its numeric form, but it
4199 must be passed as a string nonetheless. For example:
4203 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4204 See the documentation for the C<mysql_real_connect> function for details.
4206 =item B<Socket> I<Socket>
4208 Specifies the path to the UNIX domain socket of the MySQL server. This option
4209 only has any effect, if B<Host> is set to B<localhost> (the default).
4210 Otherwise, use the B<Port> option above. See the documentation for the
4211 C<mysql_real_connect> function for details.
4213 =item B<InnodbStats> I<true|false>
4215 If enabled, metrics about the InnoDB storage engine are collected.
4216 Disabled by default.
4218 =item B<MasterStats> I<true|false>
4220 =item B<SlaveStats> I<true|false>
4222 Enable the collection of master / slave statistics in a replication setup. In
4223 order to be able to get access to these statistics, the user needs special
4224 privileges. See the B<User> documentation above. Defaults to B<false>.
4226 =item B<SlaveNotifications> I<true|false>
4228 If enabled, the plugin sends a notification if the replication slave I/O and /
4229 or SQL threads are not running. Defaults to B<false>.
4231 =item B<WsrepStats> I<true|false>
4233 Enable the collection of wsrep plugin statistics, used in Master-Master
4234 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4235 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4237 =item B<ConnectTimeout> I<Seconds>
4239 Sets the connect timeout for the MySQL client.
4241 =item B<SSLKey> I<Path>
4243 If provided, the X509 key in PEM format.
4245 =item B<SSLCert> I<Path>
4247 If provided, the X509 cert in PEM format.
4249 =item B<SSLCA> I<Path>
4251 If provided, the CA file in PEM format (check OpenSSL docs).
4253 =item B<SSLCAPath> I<Path>
4255 If provided, the CA directory (check OpenSSL docs).
4257 =item B<SSLCipher> I<String>
4259 If provided, the SSL cipher to use.
4263 =head2 Plugin C<netapp>
4265 The netapp plugin can collect various performance and capacity information
4266 from a NetApp filer using the NetApp API.
4268 Please note that NetApp has a wide line of products and a lot of different
4269 software versions for each of these products. This plugin was developed for a
4270 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4271 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4272 model and software version but it is very hard to test this.
4273 If you have used this plugin with other models and/or software version, feel
4274 free to send us a mail to tell us about the results, even if it's just a short
4277 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4278 basic authentication.
4280 B<Do not use a regular user for this!> Create a special collectd user with just
4281 the minimum of capabilities needed. The user only needs the "login-http-admin"
4282 capability as well as a few more depending on which data will be collected.
4283 Required capabilities are documented below.
4288 <Host "netapp1.example.com">
4312 IgnoreSelectedIO false
4314 IgnoreSelectedOps false
4315 GetLatency "volume0"
4316 IgnoreSelectedLatency false
4323 IgnoreSelectedCapacity false
4326 IgnoreSelectedSnapshot false
4354 The netapp plugin accepts the following configuration options:
4358 =item B<Host> I<Name>
4360 A host block defines one NetApp filer. It will appear in collectd with the name
4361 you specify here which does not have to be its real name nor its hostname (see
4362 the B<Address> option below).
4364 =item B<VFiler> I<Name>
4366 A B<VFiler> block may only be used inside a host block. It accepts all the
4367 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4368 will execute all NetApp API commands in the context of the specified
4369 VFiler(R). It will appear in collectd with the name you specify here which
4370 does not have to be its real name. The VFiler name may be specified using the
4371 B<VFilerName> option. If this is not specified, it will default to the name
4374 The VFiler block inherits all connection related settings from the surrounding
4375 B<Host> block (which appear before the B<VFiler> block) but they may be
4376 overwritten inside the B<VFiler> block.
4378 This feature is useful, for example, when using a VFiler as SnapVault target
4379 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4380 available in the host filer (vfiler0) but only in the respective VFiler
4383 =item B<Protocol> B<httpd>|B<http>
4385 The protocol collectd will use to query this host.
4393 Valid options: http, https
4395 =item B<Address> I<Address>
4397 The hostname or IP address of the host.
4403 Default: The "host" block's name.
4405 =item B<Port> I<Port>
4407 The TCP port to connect to on the host.
4413 Default: 80 for protocol "http", 443 for protocol "https"
4415 =item B<User> I<User>
4417 =item B<Password> I<Password>
4419 The username and password to use to login to the NetApp.
4425 =item B<VFilerName> I<Name>
4427 The name of the VFiler in which context to execute API commands. If not
4428 specified, the name provided to the B<VFiler> block will be used instead.
4434 Default: name of the B<VFiler> block
4436 B<Note:> This option may only be used inside B<VFiler> blocks.
4438 =item B<Interval> I<Interval>
4444 The following options decide what kind of data will be collected. You can
4445 either use them as a block and fine tune various parameters inside this block,
4446 use them as a single statement to just accept all default values, or omit it to
4447 not collect any data.
4449 The following options are valid inside all blocks:
4453 =item B<Interval> I<Seconds>
4455 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4456 host specific setting.
4460 =head3 The System block
4462 This will collect various performance data about the whole system.
4464 B<Note:> To get this data the collectd user needs the
4465 "api-perf-object-get-instances" capability.
4469 =item B<Interval> I<Seconds>
4471 Collect disk statistics every I<Seconds> seconds.
4473 =item B<GetCPULoad> B<true>|B<false>
4475 If you set this option to true the current CPU usage will be read. This will be
4476 the average usage between all CPUs in your NetApp without any information about
4479 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4480 returns in the "CPU" field.
4488 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4490 =item B<GetInterfaces> B<true>|B<false>
4492 If you set this option to true the current traffic of the network interfaces
4493 will be read. This will be the total traffic over all interfaces of your NetApp
4494 without any information about individual interfaces.
4496 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4497 in the "Net kB/s" field.
4507 Result: One value list of type "if_octects".
4509 =item B<GetDiskIO> B<true>|B<false>
4511 If you set this option to true the current IO throughput will be read. This
4512 will be the total IO of your NetApp without any information about individual
4513 disks, volumes or aggregates.
4515 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4516 in the "DiskE<nbsp>kB/s" field.
4524 Result: One value list of type "disk_octets".
4526 =item B<GetDiskOps> B<true>|B<false>
4528 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4529 iSCSI, etc. operations will be read. This will be the total number of
4530 operations on your NetApp without any information about individual volumes or
4533 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4534 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4542 Result: A variable number of value lists of type "disk_ops_complex". Each type
4543 of operation will result in one value list with the name of the operation as
4548 =head3 The WAFL block
4550 This will collect various performance data about the WAFL file system. At the
4551 moment this just means cache performance.
4553 B<Note:> To get this data the collectd user needs the
4554 "api-perf-object-get-instances" capability.
4556 B<Note:> The interface to get these values is classified as "Diagnostics" by
4557 NetApp. This means that it is not guaranteed to be stable even between minor
4562 =item B<Interval> I<Seconds>
4564 Collect disk statistics every I<Seconds> seconds.
4566 =item B<GetNameCache> B<true>|B<false>
4574 Result: One value list of type "cache_ratio" and type instance
4577 =item B<GetDirCache> B<true>|B<false>
4585 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4587 =item B<GetInodeCache> B<true>|B<false>
4595 Result: One value list of type "cache_ratio" and type instance
4598 =item B<GetBufferCache> B<true>|B<false>
4600 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4601 in the "Cache hit" field.
4609 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4613 =head3 The Disks block
4615 This will collect performance data about the individual disks in the NetApp.
4617 B<Note:> To get this data the collectd user needs the
4618 "api-perf-object-get-instances" capability.
4622 =item B<Interval> I<Seconds>
4624 Collect disk statistics every I<Seconds> seconds.
4626 =item B<GetBusy> B<true>|B<false>
4628 If you set this option to true the busy time of all disks will be calculated
4629 and the value of the busiest disk in the system will be written.
4631 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4632 in the "Disk util" field. Probably.
4640 Result: One value list of type "percent" and type instance "disk_busy".
4644 =head3 The VolumePerf block
4646 This will collect various performance data about the individual volumes.
4648 You can select which data to collect about which volume using the following
4649 options. They follow the standard ignorelist semantic.
4651 B<Note:> To get this data the collectd user needs the
4652 I<api-perf-object-get-instances> capability.
4656 =item B<Interval> I<Seconds>
4658 Collect volume performance data every I<Seconds> seconds.
4660 =item B<GetIO> I<Volume>
4662 =item B<GetOps> I<Volume>
4664 =item B<GetLatency> I<Volume>
4666 Select the given volume for IO, operations or latency statistics collection.
4667 The argument is the name of the volume without the C</vol/> prefix.
4669 Since the standard ignorelist functionality is used here, you can use a string
4670 starting and ending with a slash to specify regular expression matching: To
4671 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4674 GetIO "/^vol[027]$/"
4676 If no regular expression is specified, an exact match is required. Both,
4677 regular and exact matching are case sensitive.
4679 If no volume was specified at all for either of the three options, that data
4680 will be collected for all available volumes.
4682 See F</"IGNORELISTS"> for details.
4684 =item B<IgnoreSelectedIO> B<true>|B<false>
4686 =item B<IgnoreSelectedOps> B<true>|B<false>
4688 =item B<IgnoreSelectedLatency> B<true>|B<false>
4690 When set to B<true>, the volumes selected for IO, operations or latency
4691 statistics collection will be ignored and the data will be collected for all
4694 When set to B<false>, data will only be collected for the specified volumes and
4695 all other volumes will be ignored.
4697 If no volumes have been specified with the above B<Get*> options, all volumes
4698 will be collected regardless of the B<IgnoreSelected*> option.
4700 Defaults to B<false>
4704 =head3 The VolumeUsage block
4706 This will collect capacity data about the individual volumes.
4708 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4713 =item B<Interval> I<Seconds>
4715 Collect volume usage statistics every I<Seconds> seconds.
4717 =item B<GetCapacity> I<VolumeName>
4719 The current capacity of the volume will be collected. This will result in two
4720 to four value lists, depending on the configuration of the volume. All data
4721 sources are of type "df_complex" with the name of the volume as
4724 There will be type_instances "used" and "free" for the number of used and
4725 available bytes on the volume. If the volume has some space reserved for
4726 snapshots, a type_instance "snap_reserved" will be available. If the volume
4727 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4728 number of bytes saved by the SIS feature.
4730 B<Note:> The current NetApp API has a bug that results in this value being
4731 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4732 number which works most of the time. If you see strange values here, bug
4733 NetApp support to fix this.
4735 Repeat this option to specify multiple volumes.
4737 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4739 Specify whether to collect only the volumes selected by the B<GetCapacity>
4740 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4741 B<false>. However, if no B<GetCapacity> option is specified at all, all
4742 capacities will be selected anyway.
4744 =item B<GetSnapshot> I<VolumeName>
4746 Select volumes from which to collect snapshot information.
4748 Usually, the space used for snapshots is included in the space reported as
4749 "used". If snapshot information is collected as well, the space used for
4750 snapshots is subtracted from the used space.
4752 To make things even more interesting, it is possible to reserve space to be
4753 used for snapshots. If the space required for snapshots is less than that
4754 reserved space, there is "reserved free" and "reserved used" space in addition
4755 to "free" and "used". If the space required for snapshots exceeds the reserved
4756 space, that part allocated in the normal space is subtracted from the "used"
4759 Repeat this option to specify multiple volumes.
4761 =item B<IgnoreSelectedSnapshot>
4763 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4764 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4765 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4766 capacities will be selected anyway.
4770 =head3 The Quota block
4772 This will collect (tree) quota statistics (used disk space and number of used
4773 files). This mechanism is useful to get usage information for single qtrees.
4774 In case the quotas are not used for any other purpose, an entry similar to the
4775 following in C</etc/quotas> would be sufficient:
4777 /vol/volA/some_qtree tree - - - - -
4779 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4783 =item B<Interval> I<Seconds>
4785 Collect SnapVault(R) statistics every I<Seconds> seconds.
4789 =head3 The SnapVault block
4791 This will collect statistics about the time and traffic of SnapVault(R)
4796 =item B<Interval> I<Seconds>
4798 Collect SnapVault(R) statistics every I<Seconds> seconds.
4802 =head2 Plugin C<netlink>
4804 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4805 statistics of various interface and routing aspects.
4809 =item B<Interface> I<Interface>
4811 =item B<VerboseInterface> I<Interface>
4813 Instruct the plugin to collect interface statistics. This is basically the same
4814 as the statistics provided by the C<interface> plugin (see above) but
4815 potentially much more detailed.
4817 When configuring with B<Interface> only the basic statistics will be collected,
4818 namely octets, packets, and errors. These statistics are collected by
4819 the C<interface> plugin, too, so using both at the same time is no benefit.
4821 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4822 so that no data needs to be collected twice if you use the C<interface> plugin.
4823 This includes dropped packets, received multicast packets, collisions and a
4824 whole zoo of differentiated RX and TX errors. You can try the following command
4825 to get an idea of what awaits you:
4829 If I<Interface> is B<All>, all interfaces will be selected.
4831 =item B<QDisc> I<Interface> [I<QDisc>]
4833 =item B<Class> I<Interface> [I<Class>]
4835 =item B<Filter> I<Interface> [I<Filter>]
4837 Collect the octets and packets that pass a certain qdisc, class or filter.
4839 QDiscs and classes are identified by their type and handle (or classid).
4840 Filters don't necessarily have a handle, therefore the parent's handle is used.
4841 The notation used in collectd differs from that used in tc(1) in that it
4842 doesn't skip the major or minor number if it's zero and doesn't print special
4843 ids by their name. So, for example, a qdisc may be identified by
4844 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4845 thus not displayed by tc(1).
4847 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4848 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4849 associated with that interface will be collected.
4851 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4852 used. This may lead to problems when more than one filter is attached to a
4853 qdisc or class. This isn't nice, but we don't know how this could be done any
4854 better. If you have a idea, please don't hesitate to tell us.
4856 As with the B<Interface> option you can specify B<All> as the interface,
4857 meaning all interfaces.
4859 Here are some examples to help you understand the above text more easily:
4862 VerboseInterface "All"
4863 QDisc "eth0" "pfifo_fast-1:0"
4865 Class "ppp0" "htb-1:10"
4866 Filter "ppp0" "u32-1:0"
4869 See F</"IGNORELISTS"> for details.
4871 =item B<IgnoreSelected>
4873 The behavior is the same as with all other similar plugins: If nothing is
4874 selected at all, everything is collected. If some things are selected using the
4875 options described above, only these statistics are collected. If you set
4876 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4877 specified statistics will not be collected.
4881 =head2 Plugin C<network>
4883 The Network plugin sends data to a remote instance of collectd, receives data
4884 from a remote instance, or both at the same time. Data which has been received
4885 from the network is usually not transmitted again, but this can be activated, see
4886 the B<Forward> option below.
4888 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4889 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4891 Both, B<Server> and B<Listen> can be used as single option or as block. When
4892 used as block, given options are valid for this socket only. The following
4893 example will export the metrics twice: Once to an "internal" server (without
4894 encryption and signing) and one to an external server (with cryptographic
4898 # Export to an internal server
4899 # (demonstrates usage without additional options)
4900 Server "collectd.internal.tld"
4902 # Export to an external server
4903 # (demonstrates usage with signature options)
4904 <Server "collectd.external.tld">
4905 SecurityLevel "sign"
4906 Username "myhostname"
4913 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4915 The B<Server> statement/block sets the server to send datagrams to. The
4916 statement may occur multiple times to send each datagram to multiple
4919 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
4920 optional second argument specifies a port number or a service name. If not
4921 given, the default, B<25826>, is used.
4923 The following options are recognized within B<Server> blocks:
4927 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4929 Set the security you require for network communication. When the security level
4930 has been set to B<Encrypt>, data sent over the network will be encrypted using
4931 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4932 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4933 authentication code. When set to B<None>, data is sent without any security.
4935 This feature is only available if the I<network> plugin was linked with
4938 =item B<Username> I<Username>
4940 Sets the username to transmit. This is used by the server to lookup the
4941 password. See B<AuthFile> below. All security levels except B<None> require
4944 This feature is only available if the I<network> plugin was linked with
4947 =item B<Password> I<Password>
4949 Sets a password (shared secret) for this socket. All security levels except
4950 B<None> require this setting.
4952 This feature is only available if the I<network> plugin was linked with
4955 =item B<Interface> I<Interface name>
4957 Set the outgoing interface for IP packets. This applies at least
4958 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4959 undefined or a non-existent interface name is specified, the default
4960 behavior is to let the kernel choose the appropriate interface. Be warned
4961 that the manual selection of an interface for unicast traffic is only
4962 necessary in rare cases.
4964 =item B<ResolveInterval> I<Seconds>
4966 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4967 useful to force a regular DNS lookup to support a high availability setup. If
4968 not specified, re-resolves are never attempted.
4972 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4974 The B<Listen> statement sets the interfaces to bind to. When multiple
4975 statements are found the daemon will bind to multiple interfaces.
4977 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4978 the argument is a multicast address the daemon will join that multicast group.
4979 The optional second argument specifies a port number or a service name. If not
4980 given, the default, B<25826>, is used.
4982 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4986 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4988 Set the security you require for network communication. When the security level
4989 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4990 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4991 signed and encrypted data is accepted. When set to B<None>, all data will be
4992 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4993 decrypted if possible.
4995 This feature is only available if the I<network> plugin was linked with
4998 =item B<AuthFile> I<Filename>
5000 Sets a file in which usernames are mapped to passwords. These passwords are
5001 used to verify signatures and to decrypt encrypted network packets. If
5002 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5003 verified and encrypted packets are decrypted. Otherwise, signed data is
5004 accepted without checking the signature and encrypted data cannot be decrypted.
5005 For the other security levels this option is mandatory.
5007 The file format is very simple: Each line consists of a username followed by a
5008 colon and any number of spaces followed by the password. To demonstrate, an
5009 example file could look like this:
5014 Each time a packet is received, the modification time of the file is checked
5015 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5016 the file is being read, it is locked using L<fcntl(2)>.
5018 =item B<Interface> I<Interface name>
5020 Set the incoming interface for IP packets explicitly. This applies at least
5021 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5022 undefined or a non-existent interface name is specified, the default
5023 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5024 traffic gets only accepted, if it arrives on the given interface.
5028 =item B<TimeToLive> I<1-255>
5030 Set the time-to-live of sent packets. This applies to all, unicast and
5031 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5032 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5035 =item B<MaxPacketSize> I<1024-65535>
5037 Set the maximum size for datagrams received over the network. Packets larger
5038 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5039 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5042 On the server side, this limit should be set to the largest value used on
5043 I<any> client. Likewise, the value on the client must not be larger than the
5044 value on the server, or data will be lost.
5046 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5047 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5048 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5051 =item B<Forward> I<true|false>
5053 If set to I<true>, write packets that were received via the network plugin to
5054 the sending sockets. This should only be activated when the B<Listen>- and
5055 B<Server>-statements differ. Otherwise packets may be send multiple times to
5056 the same multicast group. While this results in more network traffic than
5057 necessary it's not a huge problem since the plugin has a duplicate detection,
5058 so the values will not loop.
5060 =item B<ReportStats> B<true>|B<false>
5062 The network plugin cannot only receive and send statistics, it can also create
5063 statistics about itself. Collectd data included the number of received and
5064 sent octets and packets, the length of the receive queue and the number of
5065 values handled. When set to B<true>, the I<Network plugin> will make these
5066 statistics available. Defaults to B<false>.
5070 =head2 Plugin C<nginx>
5072 This plugin collects the number of connections and requests handled by the
5073 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5074 queries the page provided by the C<ngx_http_stub_status_module> module, which
5075 isn't compiled by default. Please refer to
5076 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5077 how to compile and configure nginx and this module.
5079 The following options are accepted by the C<nginx plugin>:
5083 =item B<URL> I<http://host/nginx_status>
5085 Sets the URL of the C<ngx_http_stub_status_module> output.
5087 =item B<User> I<Username>
5089 Optional user name needed for authentication.
5091 =item B<Password> I<Password>
5093 Optional password needed for authentication.
5095 =item B<VerifyPeer> B<true|false>
5097 Enable or disable peer SSL certificate verification. See
5098 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5100 =item B<VerifyHost> B<true|false>
5102 Enable or disable peer host name verification. If enabled, the plugin checks
5103 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5104 certificate matches the host name provided by the B<URL> option. If this
5105 identity check fails, the connection is aborted. Obviously, only works when
5106 connecting to a SSL enabled server. Enabled by default.
5108 =item B<CACert> I<File>
5110 File that holds one or more SSL certificates. If you want to use HTTPS you will
5111 possibly need this option. What CA certificates come bundled with C<libcurl>
5112 and are checked by default depends on the distribution you use.
5114 =item B<Timeout> I<Milliseconds>
5116 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5117 milliseconds. By default, the configured B<Interval> is used to set the
5122 =head2 Plugin C<notify_desktop>
5124 This plugin sends a desktop notification to a notification daemon, as defined
5125 in the Desktop Notification Specification. To actually display the
5126 notifications, B<notification-daemon> is required and B<collectd> has to be
5127 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5128 environment variables have to be set correctly) and the D-Bus message bus.
5130 The Desktop Notification Specification can be found at
5131 L<http://www.galago-project.org/specs/notification/>.
5135 =item B<OkayTimeout> I<timeout>
5137 =item B<WarningTimeout> I<timeout>
5139 =item B<FailureTimeout> I<timeout>
5141 Set the I<timeout>, in milliseconds, after which to expire the notification
5142 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5143 been specified, the displayed notification will not be closed at all - the
5144 user has to do so herself. These options default to 5000. If a negative number
5145 has been specified, the default is used as well.
5149 =head2 Plugin C<notify_email>
5151 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5152 configured email address.
5154 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5156 Available configuration options:
5160 =item B<From> I<Address>
5162 Email address from which the emails should appear to come from.
5164 Default: C<root@localhost>
5166 =item B<Recipient> I<Address>
5168 Configures the email address(es) to which the notifications should be mailed.
5169 May be repeated to send notifications to multiple addresses.
5171 At least one B<Recipient> must be present for the plugin to work correctly.
5173 =item B<SMTPServer> I<Hostname>
5175 Hostname of the SMTP server to connect to.
5177 Default: C<localhost>
5179 =item B<SMTPPort> I<Port>
5181 TCP port to connect to.
5185 =item B<SMTPUser> I<Username>
5187 Username for ASMTP authentication. Optional.
5189 =item B<SMTPPassword> I<Password>
5191 Password for ASMTP authentication. Optional.
5193 =item B<Subject> I<Subject>
5195 Subject-template to use when sending emails. There must be exactly two
5196 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5197 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5200 Default: C<Collectd notify: %s@%s>
5204 =head2 Plugin C<notify_nagios>
5206 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5207 a I<passive service check result>.
5209 Available configuration options:
5213 =item B<CommandFile> I<Path>
5215 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5219 =head2 Plugin C<ntpd>
5221 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5224 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5225 the wire - using B<mode 7> specific requests. This mode is deprecated with
5226 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5227 correctly with them, the ntp daemon must be explicitly configured to
5228 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5229 manual page for details.
5231 Available configuration options for the C<ntpd> plugin:
5235 =item B<Host> I<Hostname>
5237 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5239 =item B<Port> I<Port>
5241 UDP-Port to connect to. Defaults to B<123>.
5243 =item B<ReverseLookups> B<true>|B<false>
5245 Sets whether or not to perform reverse lookups on peers. Since the name or
5246 IP-address may be used in a filename it is recommended to disable reverse
5247 lookups. The default is to do reverse lookups to preserve backwards
5248 compatibility, though.
5250 =item B<IncludeUnitID> B<true>|B<false>
5252 When a peer is a refclock, include the unit ID in the I<type instance>.
5253 Defaults to B<false> for backward compatibility.
5255 If two refclock peers use the same driver and this is B<false>, the plugin will
5256 try to write simultaneous measurements from both to the same type instance.
5257 This will result in error messages in the log and only one set of measurements
5262 =head2 Plugin C<nut>
5266 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5268 Add a UPS to collect data from. The format is identical to the one accepted by
5271 =item B<ForceSSL> B<true>|B<false>
5273 Stops connections from falling back to unsecured if an SSL connection
5274 cannot be established. Defaults to false if undeclared.
5276 =item B<VerifyPeer> I<true>|I<false>
5278 If set to true, requires a CAPath be provided. Will use the CAPath to find
5279 certificates to use as Trusted Certificates to validate a upsd server certificate.
5280 If validation of the upsd server certificate fails, the connection will not be
5281 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5282 will override and set ForceSSL to true.
5284 =item B<CAPath> I/path/to/certs/folder
5286 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5287 The folder pointed at must contain certificate(s) named according to their hash.
5288 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5289 occur because two different certs have the same hash value, Y can be incremented
5290 in order to avoid conflict. To create a symbolic link to a certificate the following
5291 command can be used from within the directory where the cert resides:
5293 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5295 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5296 generate links like the one described above for ALL certs in a given folder.
5298 C<c_rehash /path/to/certs/folder>
5302 =head2 Plugin C<olsrd>
5304 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5305 the Optimized Link State Routing daemon and reads information about the current
5306 state of the meshed network.
5308 The following configuration options are understood:
5312 =item B<Host> I<Host>
5314 Connect to I<Host>. Defaults to B<"localhost">.
5316 =item B<Port> I<Port>
5318 Specifies the port to connect to. This must be a string, even if you give the
5319 port as a number rather than a service name. Defaults to B<"2006">.
5321 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5323 Specifies what information to collect about links, i.E<nbsp>e. direct
5324 connections of the daemon queried. If set to B<No>, no information is
5325 collected. If set to B<Summary>, the number of links and the average of all
5326 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5327 If set to B<Detail> LQ and NLQ are collected per link.
5329 Defaults to B<Detail>.
5331 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5333 Specifies what information to collect about routes of the daemon queried. If
5334 set to B<No>, no information is collected. If set to B<Summary>, the number of
5335 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5336 metric and ETX are collected per route.
5338 Defaults to B<Summary>.
5340 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5342 Specifies what information to collect about the global topology. If set to
5343 B<No>, no information is collected. If set to B<Summary>, the number of links
5344 in the entire topology and the average I<link quality> (LQ) is calculated.
5345 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5347 Defaults to B<Summary>.
5351 =head2 Plugin C<onewire>
5353 B<EXPERIMENTAL!> See notes below.
5355 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5356 L<http://owfs.org/> to read sensors connected via the onewire bus.
5358 It can be used in two possible modes - standard or advanced.
5360 In the standard mode only temperature sensors (sensors with the family code
5361 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5362 other sensors you would like to have included, please send a sort request to
5363 the mailing list. You can select sensors to be read or to be ignored depending
5364 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5365 walked and all sensors are read.
5367 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5368 experimental, below.
5370 In the advanced mode you can configure any sensor to be read (only numerical
5371 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5372 In this mode you have to list all the sensors. Neither default bus walk nor
5373 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5374 the path automatically and should produce compatible structure with the "standard"
5375 mode (basically the path is expected as for example
5376 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5377 "F10FCA000800" and the rest after the slash is considered the type - here
5379 There are two advantages to this mode - you can access virtually any sensor
5380 (not just temperature), select whether to use cached or directly read values
5381 and it is slighlty faster. The downside is more complex configuration.
5383 The two modes are distinguished automatically by the format of the address.
5384 It is not possible to mix the two modes. Once a full path is detected in any
5385 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5386 (and as standard addresses will fail parsing they will be ignored).
5390 =item B<Device> I<Device>
5392 Sets the device to read the values from. This can either be a "real" hardware
5393 device, such as a serial port or an USB port, or the address of the
5394 L<owserver(1)> socket, usually B<localhost:4304>.
5396 Though the documentation claims to automatically recognize the given address
5397 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5398 with that version, the following configuration worked for us:
5401 Device "-s localhost:4304"
5404 This directive is B<required> and does not have a default value.
5406 =item B<Sensor> I<Sensor>
5408 In the standard mode selects sensors to collect or to ignore
5409 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5410 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5411 and B<not> include the leading C<10.> family byte and point.
5412 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5413 sensors (see above) are read.
5415 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5416 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5417 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5419 As there can be multiple devices on the bus you can list multiple sensor (use
5420 multiple B<Sensor> elements).
5422 See F</"IGNORELISTS"> for details.
5424 =item B<IgnoreSelected> I<true>|I<false>
5426 If no configuration is given, the B<onewire> plugin will collect data from all
5427 sensors found. This may not be practical, especially if sensors are added and
5428 removed regularly. Sometimes, however, it's easier/preferred to collect only
5429 specific sensors or all sensors I<except> a few specified ones. This option
5430 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5431 B<Sensor> is inverted: All selected interfaces are ignored and all other
5432 interfaces are collected.
5434 Used only in the standard mode - see above.
5436 =item B<Interval> I<Seconds>
5438 Sets the interval in which all sensors should be read. If not specified, the
5439 global B<Interval> setting is used.
5443 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5444 work with big setups. It works with one sensor being attached to one
5445 controller, but as soon as you throw in a couple more senors and maybe a hub
5446 or two, reading all values will take more than ten seconds (the default
5447 interval). We will probably add some separate thread for reading the sensors
5448 and some cache or something like that, but it's not done yet. We will try to
5449 maintain backwards compatibility in the future, but we can't promise. So in
5450 short: If it works for you: Great! But keep in mind that the config I<might>
5451 change, though this is unlikely. Oh, and if you want to help improving this
5452 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5454 =head2 Plugin C<openldap>
5456 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5457 server correctly. The backend database C<monitor> needs to be loaded and
5458 working. See slapd-monitor(5) for the details.
5460 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5461 blocks. Each block requires one string argument as the instance name. For
5466 URL "ldap://localhost/"
5469 URL "ldaps://localhost/"
5473 The instance name will be used as the I<plugin instance>. To emulate the old
5474 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5475 plugin to work correctly, each instance name must be unique. This is not
5476 enforced by the plugin and it is your responsibility to ensure it is.
5478 The following options are accepted within each B<Instance> block:
5482 =item B<URL> I<ldap://host/binddn>
5484 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5487 =item B<BindDN> I<BindDN>
5489 Name in the form of an LDAP distinguished name intended to be used for
5490 authentication. Defaults to empty string to establish an anonymous authorization.
5492 =item B<Password> I<Password>
5494 Password for simple bind authentication. If this option is not set,
5495 unauthenticated bind operation is used.
5497 =item B<StartTLS> B<true|false>
5499 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5500 Disabled by default.
5502 =item B<VerifyHost> B<true|false>
5504 Enables or disables peer host name verification. If enabled, the plugin checks
5505 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5506 certificate matches the host name provided by the B<URL> option. If this
5507 identity check fails, the connection is aborted. Enabled by default.
5509 =item B<CACert> I<File>
5511 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5512 may possibly need this option. What CA certificates are checked by default
5513 depends on the distribution you use and can be changed with the usual ldap
5514 client configuration mechanisms. See ldap.conf(5) for the details.
5516 =item B<Timeout> I<Seconds>
5518 Sets the timeout value for ldap operations, in seconds. By default, the
5519 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5522 =item B<Version> I<Version>
5524 An integer which sets the LDAP protocol version number to use when connecting
5525 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5529 =head2 Plugin C<openvpn>
5531 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5532 traffic statistics about connected clients.
5534 To set up OpenVPN to write to the status file periodically, use the
5535 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
5536 you need to set the required format, too. This is done by setting
5537 B<--status-version> to B<2>.
5539 So, in a nutshell you need:
5541 openvpn $OTHER_OPTIONS \
5542 --status "/var/run/openvpn-status" 10 \
5549 =item B<StatusFile> I<File>
5551 Specifies the location of the status file.
5553 =item B<ImprovedNamingSchema> B<true>|B<false>
5555 When enabled, the filename of the status file will be used as plugin instance
5556 and the client's "common name" will be used as type instance. This is required
5557 when reading multiple status files. Enabling this option is recommended, but to
5558 maintain backwards compatibility this option is disabled by default.
5560 =item B<CollectCompression> B<true>|B<false>
5562 Sets whether or not statistics about the compression used by OpenVPN should be
5563 collected. This information is only available in I<single> mode. Enabled by
5566 =item B<CollectIndividualUsers> B<true>|B<false>
5568 Sets whether or not traffic information is collected for each connected client
5569 individually. If set to false, currently no traffic data is collected at all
5570 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5572 =item B<CollectUserCount> B<true>|B<false>
5574 When enabled, the number of currently connected clients or users is collected.
5575 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5576 can be configured independently from that option. Defaults to B<false>.
5580 =head2 Plugin C<oracle>
5582 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5583 Oracle® Database and lets you execute SQL statements there. It is very similar
5584 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5585 plugin's documentation above for details.
5588 <Query "out_of_stock">
5589 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5592 # InstancePrefix "foo"
5593 InstancesFrom "category"
5597 <Database "product_information">
5598 #PluginName "warehouse"
5602 Query "out_of_stock"
5606 =head3 B<Query> blocks
5608 The Query blocks are handled identically to the Query blocks of the "dbi"
5609 plugin. Please see its documentation above for details on how to specify
5612 =head3 B<Database> blocks
5614 Database blocks define a connection to a database and which queries should be
5615 sent to that database. Each database needs a "name" as string argument in the
5616 starting tag of the block. This name will be used as "PluginInstance" in the
5617 values submitted to the daemon. Other than that, that name is not used.
5621 =item B<PluginName> I<PluginName>
5623 Use I<PluginName> as the plugin name when submitting query results from
5624 this B<Database>. Defaults to 'oracle'.
5626 =item B<ConnectID> I<ID>
5628 Defines the "database alias" or "service name" to connect to. Usually, these
5629 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5631 =item B<Host> I<Host>
5633 Hostname to use when dispatching values for this database. Defaults to using
5634 the global hostname of the I<collectd> instance.
5636 =item B<Username> I<Username>
5638 Username used for authentication.
5640 =item B<Password> I<Password>
5642 Password used for authentication.
5644 =item B<Query> I<QueryName>
5646 Associates the query named I<QueryName> with this database connection. The
5647 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5648 blocks you want to refer to must be placed above the database block you want to
5653 =head2 Plugin C<ovs_events>
5655 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5656 connected interfaces, dispatches the values to collectd and sends the
5657 notification whenever the link state change occurs. This plugin uses OVS
5658 database to get a link state change notification.
5662 <Plugin "ovs_events">
5665 Socket "/var/run/openvswitch/db.sock"
5666 Interfaces "br0" "veth0"
5667 SendNotification true
5668 DispatchValues false
5671 The plugin provides the following configuration options:
5675 =item B<Address> I<node>
5677 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5678 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5679 option. See L<ovsdb-server(1)> for more details. The option may be either
5680 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5681 format. Defaults to B<'localhost'>.
5683 =item B<Port> I<service>
5685 TCP-port to connect to. Either a service name or a port number may be given.
5686 Defaults to B<6640>.
5688 =item B<Socket> I<path>
5690 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5691 plugin. To enable the interface, the OVS DB daemon should be running with
5692 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5693 option is set, B<Address> and B<Port> options are ignored.
5695 =item B<Interfaces> [I<ifname> ...]
5697 List of interface names to be monitored by this plugin. If this option is not
5698 specified or is empty then all OVS connected interfaces on all bridges are
5701 Default: empty (all interfaces on all bridges are monitored)
5703 =item B<SendNotification> I<true|false>
5705 If set to true, OVS link notifications (interface status and OVS DB connection
5706 terminate) are sent to collectd. Default value is true.
5708 =item B<DispatchValues> I<true|false>
5710 Dispatch the OVS DB interface link status value with configured plugin interval.
5711 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
5712 options are false, no OVS information will be provided by the plugin.
5716 B<Note:> By default, the global interval setting is used within which to
5717 retrieve the OVS link status. To configure a plugin-specific interval, please
5718 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
5719 simple divide the time by 1000 for example if the desired interval is 50ms, set
5722 =head2 Plugin C<ovs_stats>
5724 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
5725 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
5726 statistics from OVSDB
5730 <Plugin "ovs_stats">
5733 Socket "/var/run/openvswitch/db.sock"
5734 Bridges "br0" "br_ext"
5737 The plugin provides the following configuration options:
5741 =item B<Address> I<node>
5743 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5744 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5745 option. See L<ovsdb-server(1)> for more details. The option may be either
5746 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5747 format. Defaults to B<'localhost'>.
5749 =item B<Port> I<service>
5751 TCP-port to connect to. Either a service name or a port number may be given.
5752 Defaults to B<6640>.
5754 =item B<Socket> I<path>
5756 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5757 plugin. To enable the interface, the OVS DB daemon should be running with
5758 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5759 option is set, B<Address> and B<Port> options are ignored.
5761 =item B<Bridges> [I<brname> ...]
5763 List of OVS bridge names to be monitored by this plugin. If this option is
5764 omitted or is empty then all OVS bridges will be monitored.
5766 Default: empty (monitor all bridges)
5770 =head2 Plugin C<perl>
5772 This plugin embeds a Perl-interpreter into collectd and provides an interface
5773 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
5775 =head2 Plugin C<pinba>
5777 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
5778 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
5779 PHP-based webpage has been delivered, the extension will send a UDP packet
5780 containing timing information, peak memory usage and so on. The plugin will
5781 wait for such packets, parse them and account the provided information, which
5782 is then dispatched to the daemon once per interval.
5789 # Overall statistics for the website.
5791 Server "www.example.com"
5793 # Statistics for www-a only
5795 Host "www-a.example.com"
5796 Server "www.example.com"
5798 # Statistics for www-b only
5800 Host "www-b.example.com"
5801 Server "www.example.com"
5805 The plugin provides the following configuration options:
5809 =item B<Address> I<Node>
5811 Configures the address used to open a listening socket. By default, plugin will
5812 bind to the I<any> address C<::0>.
5814 =item B<Port> I<Service>
5816 Configures the port (service) to bind to. By default the default Pinba port
5817 "30002" will be used. The option accepts service names in addition to port
5818 numbers and thus requires a I<string> argument.
5820 =item E<lt>B<View> I<Name>E<gt> block
5822 The packets sent by the Pinba extension include the hostname of the server, the
5823 server name (the name of the virtual host) and the script that was executed.
5824 Using B<View> blocks it is possible to separate the data into multiple groups
5825 to get more meaningful statistics. Each packet is added to all matching groups,
5826 so that a packet may be accounted for more than once.
5830 =item B<Host> I<Host>
5832 Matches the hostname of the system the webserver / script is running on. This
5833 will contain the result of the L<gethostname(2)> system call. If not
5834 configured, all hostnames will be accepted.
5836 =item B<Server> I<Server>
5838 Matches the name of the I<virtual host>, i.e. the contents of the
5839 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
5840 server names will be accepted.
5842 =item B<Script> I<Script>
5844 Matches the name of the I<script name>, i.e. the contents of the
5845 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
5846 script names will be accepted.
5852 =head2 Plugin C<ping>
5854 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
5855 configured hosts periodically and measures the network latency. Whenever the
5856 C<read> function of the plugin is called, it submits the average latency, the
5857 standard deviation and the drop rate for each host.
5859 Available configuration options:
5863 =item B<Host> I<IP-address>
5865 Host to ping periodically. This option may be repeated several times to ping
5868 =item B<Interval> I<Seconds>
5870 Sets the interval in which to send ICMP echo packets to the configured hosts.
5871 This is B<not> the interval in which metrics are read from the plugin but the
5872 interval in which the hosts are "pinged". Therefore, the setting here should be
5873 smaller than or equal to the global B<Interval> setting. Fractional times, such
5874 as "1.24" are allowed.
5878 =item B<Timeout> I<Seconds>
5880 Time to wait for a response from the host to which an ICMP packet had been
5881 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
5882 to be down or the packet to be dropped. This setting must be smaller than the
5883 B<Interval> setting above for the plugin to work correctly. Fractional
5884 arguments are accepted.
5888 =item B<TTL> I<0-255>
5890 Sets the Time-To-Live of generated ICMP packets.
5892 =item B<Size> I<size>
5894 Sets the size of the data payload in ICMP packet to specified I<size> (it
5895 will be filled with regular ASCII pattern). If not set, default 56 byte
5896 long string is used so that the packet size of an ICMPv4 packet is exactly
5897 64 bytes, similar to the behaviour of normal ping(1) command.
5899 =item B<SourceAddress> I<host>
5901 Sets the source address to use. I<host> may either be a numerical network
5902 address or a network hostname.
5904 =item B<Device> I<name>
5906 Sets the outgoing network device to be used. I<name> has to specify an
5907 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
5910 =item B<MaxMissed> I<Packets>
5912 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
5913 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
5915 Default: B<-1> (disabled)
5919 =head2 Plugin C<postgresql>
5921 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
5922 keeps a persistent connection to all configured databases and tries to
5923 reconnect if the connection has been interrupted. A database is configured by
5924 specifying a B<Database> block as described below. The default statistics are
5925 collected from PostgreSQL's B<statistics collector> which thus has to be
5926 enabled for this plugin to work correctly. This should usually be the case by
5927 default. See the section "The Statistics Collector" of the B<PostgreSQL
5928 Documentation> for details.
5930 By specifying custom database queries using a B<Query> block as described
5931 below, you may collect any data that is available from some PostgreSQL
5932 database. This way, you are able to access statistics of external daemons
5933 which are available in a PostgreSQL database or use future or special
5934 statistics provided by PostgreSQL without the need to upgrade your collectd
5937 Starting with version 5.2, the C<postgresql> plugin supports writing data to
5938 PostgreSQL databases as well. This has been implemented in a generic way. You
5939 need to specify an SQL statement which will then be executed by collectd in
5940 order to write the data (see below for details). The benefit of that approach
5941 is that there is no fixed database layout. Rather, the layout may be optimized
5942 for the current setup.
5944 The B<PostgreSQL Documentation> manual can be found at
5945 L<http://www.postgresql.org/docs/manuals/>.
5949 Statement "SELECT magic FROM wizard WHERE host = $1;"
5953 InstancePrefix "magic"
5958 <Query rt36_tickets>
5959 Statement "SELECT COUNT(type) AS count, type \
5961 WHEN resolved = 'epoch' THEN 'open' \
5962 ELSE 'resolved' END AS type \
5963 FROM tickets) type \
5967 InstancePrefix "rt36_tickets"
5968 InstancesFrom "type"
5974 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
5979 PluginName "kingdom"
5985 KRBSrvName "kerberos_service_name"
5991 Service "service_name"
5992 Query backend # predefined
6003 The B<Query> block defines one database query which may later be used by a
6004 database definition. It accepts a single mandatory argument which specifies
6005 the name of the query. The names of all queries have to be unique (see the
6006 B<MinVersion> and B<MaxVersion> options below for an exception to this
6009 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6010 B<Result> blocks may be used to extract multiple values from a single query.
6012 The following configuration options are available to define the query:
6016 =item B<Statement> I<sql query statement>
6018 Specify the I<sql query statement> which the plugin should execute. The string
6019 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6020 first, second, etc. parameter. The value of the parameters is specified by the
6021 B<Param> configuration option - see below for details. To include a literal
6022 B<$> character followed by a number, surround it with single quotes (B<'>).
6024 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6025 allowed. Note, however, that only a single command may be used. Semicolons are
6026 allowed as long as a single non-empty command has been specified only.
6028 The returned lines will be handled separately one after another.
6030 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6032 Specify the parameters which should be passed to the SQL query. The parameters
6033 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6034 they appear in the configuration file. The value of the parameter is
6035 determined depending on the value of the B<Param> option as follows:
6041 The configured hostname of the database connection. If a UNIX domain socket is
6042 used, the parameter expands to "localhost".
6046 The name of the database of the current connection.
6050 The name of the database plugin instance. See the B<Instance> option of the
6051 database specification below for details.
6055 The username used to connect to the database.
6059 The interval with which this database is queried (as specified by the database
6060 specific or global B<Interval> options).
6064 Please note that parameters are only supported by PostgreSQL's protocol
6065 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6067 =item B<PluginInstanceFrom> I<column>
6069 Specify how to create the "PluginInstance" for reporting this query results.
6070 Only one column is supported. You may concatenate fields and string values in
6071 the query statement to get the required results.
6073 =item B<MinVersion> I<version>
6075 =item B<MaxVersion> I<version>
6077 Specify the minimum or maximum version of PostgreSQL that this query should be
6078 used with. Some statistics might only be available with certain versions of
6079 PostgreSQL. This allows you to specify multiple queries with the same name but
6080 which apply to different versions, thus allowing you to use the same
6081 configuration in a heterogeneous environment.
6083 The I<version> has to be specified as the concatenation of the major, minor
6084 and patch-level versions, each represented as two-decimal-digit numbers. For
6085 example, version 8.2.3 will become 80203.
6089 The B<Result> block defines how to handle the values returned from the query.
6090 It defines which column holds which value and how to dispatch that value to
6095 =item B<Type> I<type>
6097 The I<type> name to be used when dispatching the values. The type describes
6098 how to handle the data and where to store it. See L<types.db(5)> for more
6099 details on types and their configuration. The number and type of values (as
6100 selected by the B<ValuesFrom> option) has to match the type of the given name.
6102 This option is mandatory.
6104 =item B<InstancePrefix> I<prefix>
6106 =item B<InstancesFrom> I<column0> [I<column1> ...]
6108 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6109 B<InstancePrefix> defines a static prefix that will be prepended to all type
6110 instances. B<InstancesFrom> defines the column names whose values will be used
6111 to create the type instance. Multiple values will be joined together using the
6112 hyphen (C<->) as separation character.
6114 The plugin itself does not check whether or not all built instances are
6115 different. It is your responsibility to assure that each is unique.
6117 Both options are optional. If none is specified, the type instance will be
6120 =item B<ValuesFrom> I<column0> [I<column1> ...]
6122 Names the columns whose content is used as the actual data for the data sets
6123 that are dispatched to the daemon. How many such columns you need is
6124 determined by the B<Type> setting as explained above. If you specify too many
6125 or not enough columns, the plugin will complain about that and no data will be
6126 submitted to the daemon.
6128 The actual data type, as seen by PostgreSQL, is not that important as long as
6129 it represents numbers. The plugin will automatically cast the values to the
6130 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6131 L<strtod(3)> functions, so anything supported by those functions is supported
6132 by the plugin as well.
6134 This option is required inside a B<Result> block and may be specified multiple
6135 times. If multiple B<ValuesFrom> options are specified, the columns are read
6140 The following predefined queries are available (the definitions can be found
6141 in the F<postgresql_default.conf> file which, by default, is available at
6142 C<I<prefix>/share/collectd/>):
6148 This query collects the number of backends, i.E<nbsp>e. the number of
6151 =item B<transactions>
6153 This query collects the numbers of committed and rolled-back transactions of
6158 This query collects the numbers of various table modifications (i.E<nbsp>e.
6159 insertions, updates, deletions) of the user tables.
6161 =item B<query_plans>
6163 This query collects the numbers of various table scans and returned tuples of
6166 =item B<table_states>
6168 This query collects the numbers of live and dead rows in the user tables.
6172 This query collects disk block access counts for user tables.
6176 This query collects the on-disk size of the database in bytes.
6180 In addition, the following detailed queries are available by default. Please
6181 note that each of those queries collects information B<by table>, thus,
6182 potentially producing B<a lot> of data. For details see the description of the
6183 non-by_table queries above.
6187 =item B<queries_by_table>
6189 =item B<query_plans_by_table>
6191 =item B<table_states_by_table>
6193 =item B<disk_io_by_table>
6197 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6198 mandatory argument specifying the name of the writer. This will then be used
6199 in the B<Database> specification in order to activate the writer instance. The
6200 names of all writers have to be unique. The following options may be
6205 =item B<Statement> I<sql statement>
6207 This mandatory option specifies the SQL statement that will be executed for
6208 each submitted value. A single SQL statement is allowed only. Anything after
6209 the first semicolon will be ignored.
6211 Nine parameters will be passed to the statement and should be specified as
6212 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6213 values are made available through those parameters:
6219 The timestamp of the queried value as an RFC 3339-formatted local time.
6223 The hostname of the queried value.
6227 The plugin name of the queried value.
6231 The plugin instance of the queried value. This value may be B<NULL> if there
6232 is no plugin instance.
6236 The type of the queried value (cf. L<types.db(5)>).
6240 The type instance of the queried value. This value may be B<NULL> if there is
6245 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6246 sources of the submitted value-list).
6250 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6251 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6252 B<StoreRates> is enabled (which is the default, see below), all types will be
6257 An array of the submitted values. The dimensions of the value name and value
6262 In general, it is advisable to create and call a custom function in the
6263 PostgreSQL database for this purpose. Any procedural language supported by
6264 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6267 =item B<StoreRates> B<false>|B<true>
6269 If set to B<true> (the default), convert counter values to rates. If set to
6270 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6275 The B<Database> block defines one PostgreSQL database for which to collect
6276 statistics. It accepts a single mandatory argument which specifies the
6277 database name. None of the other options are required. PostgreSQL will use
6278 default values as documented in the section "CONNECTING TO A DATABASE" in the
6279 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6280 the user collectd is run as and special environment variables. See the manpage
6285 =item B<Interval> I<seconds>
6287 Specify the interval with which the database should be queried. The default is
6288 to use the global B<Interval> setting.
6290 =item B<CommitInterval> I<seconds>
6292 This option may be used for database connections which have "writers" assigned
6293 (see above). If specified, it causes a writer to put several updates into a
6294 single transaction. This transaction will last for the specified amount of
6295 time. By default, each update will be executed in a separate transaction. Each
6296 transaction generates a fair amount of overhead which can, thus, be reduced by
6297 activating this option. The draw-back is, that data covering the specified
6298 amount of time will be lost, for example, if a single statement within the
6299 transaction fails or if the database server crashes.
6301 =item B<PluginName> I<PluginName>
6303 Use I<PluginName> as the plugin name when submitting query results from
6304 this B<Database>. Defaults to 'postgresql'.
6306 =item B<Instance> I<name>
6308 Specify the plugin instance name that should be used instead of the database
6309 name (which is the default, if this option has not been specified). This
6310 allows one to query multiple databases of the same name on the same host (e.g.
6311 when running multiple database server versions in parallel).
6312 The plugin instance name can also be set from the query result using
6313 the B<PluginInstanceFrom> option in B<Query> block.
6315 =item B<Host> I<hostname>
6317 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6318 value begins with a slash, it is interpreted as the directory name in which to
6319 look for the UNIX domain socket.
6321 This option is also used to determine the hostname that is associated with a
6322 collected data set. If it has been omitted or either begins with with a slash
6323 or equals B<localhost> it will be replaced with the global hostname definition
6324 of collectd. Any other value will be passed literally to collectd when
6325 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6327 =item B<Port> I<port>
6329 Specify the TCP port or the local UNIX domain socket file extension of the
6332 =item B<User> I<username>
6334 Specify the username to be used when connecting to the server.
6336 =item B<Password> I<password>
6338 Specify the password to be used when connecting to the server.
6340 =item B<ExpireDelay> I<delay>
6342 Skip expired values in query output.
6344 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6346 Specify whether to use an SSL connection when contacting the server. The
6347 following modes are supported:
6353 Do not use SSL at all.
6357 First, try to connect without using SSL. If that fails, try using SSL.
6359 =item I<prefer> (default)
6361 First, try to connect using SSL. If that fails, try without using SSL.
6369 =item B<Instance> I<name>
6371 Specify the plugin instance name that should be used instead of the database
6372 name (which is the default, if this option has not been specified). This
6373 allows one to query multiple databases of the same name on the same host (e.g.
6374 when running multiple database server versions in parallel).
6376 =item B<KRBSrvName> I<kerberos_service_name>
6378 Specify the Kerberos service name to use when authenticating with Kerberos 5
6379 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6380 B<PostgreSQL Documentation> for details.
6382 =item B<Service> I<service_name>
6384 Specify the PostgreSQL service name to use for additional parameters. That
6385 service has to be defined in F<pg_service.conf> and holds additional
6386 connection parameters. See the section "The Connection Service File" in the
6387 B<PostgreSQL Documentation> for details.
6389 =item B<Query> I<query>
6391 Specifies a I<query> which should be executed in the context of the database
6392 connection. This may be any of the predefined or user-defined queries. If no
6393 such option is given, it defaults to "backends", "transactions", "queries",
6394 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6395 has been specified). Else, the specified queries are used only.
6397 =item B<Writer> I<writer>
6399 Assigns the specified I<writer> backend to the database connection. This
6400 causes all collected data to be send to the database using the settings
6401 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6402 below for details on how to selectively send data to certain plugins).
6404 Each writer will register a flush callback which may be used when having long
6405 transactions enabled (see the B<CommitInterval> option above). When issuing
6406 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6407 transaction will be committed right away. Two different kinds of flush
6408 callbacks are available with the C<postgresql> plugin:
6414 Flush all writer backends.
6416 =item B<postgresql->I<database>
6418 Flush all writers of the specified I<database> only.
6424 =head2 Plugin C<powerdns>
6426 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6427 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6428 values, many of which are probably meaningless to most users, but may be useful
6429 for some. So you may chose which values to collect, but if you don't, some
6430 reasonable defaults will be collected.
6433 <Server "server_name">
6435 Collect "udp-answers" "udp-queries"
6436 Socket "/var/run/pdns.controlsocket"
6438 <Recursor "recursor_name">
6440 Collect "cache-hits" "cache-misses"
6441 Socket "/var/run/pdns_recursor.controlsocket"
6443 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6448 =item B<Server> and B<Recursor> block
6450 The B<Server> block defines one authoritative server to query, the B<Recursor>
6451 does the same for an recursing server. The possible options in both blocks are
6452 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6457 =item B<Collect> I<Field>
6459 Using the B<Collect> statement you can select which values to collect. Here,
6460 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6461 C<dlg-only-drops>, C<answers10-100>.
6463 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6464 When querying the server a C<SHOW *> command is issued in any case, because
6465 that's the only way of getting multiple values out of the server at once.
6466 collectd then picks out the values you have selected. When querying the
6467 recursor, a command is generated to query exactly these values. So if you
6468 specify invalid fields when querying the recursor, a syntax error may be
6469 returned by the daemon and collectd may not collect any values at all.
6471 If no B<Collect> statement is given, the following B<Server> values will be
6478 =item packetcache-hit
6480 =item packetcache-miss
6482 =item packetcache-size
6484 =item query-cache-hit
6486 =item query-cache-miss
6488 =item recursing-answers
6490 =item recursing-questions
6502 The following B<Recursor> values will be collected by default:
6506 =item noerror-answers
6508 =item nxdomain-answers
6510 =item servfail-answers
6528 Please note that up to that point collectd doesn't know what values are
6529 available on the server and values that are added do not need a change of the
6530 mechanism so far. However, the values must be mapped to collectd's naming
6531 scheme, which is done using a lookup table that lists all known values. If
6532 values are added in the future and collectd does not know about them, you will
6533 get an error much like this:
6535 powerdns plugin: submit: Not found in lookup table: foobar = 42
6537 In this case please file a bug report with the collectd team.
6539 =item B<Socket> I<Path>
6541 Configures the path to the UNIX domain socket to be used when connecting to the
6542 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6543 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6544 will be used for the recursor.
6548 =item B<LocalSocket> I<Path>
6550 Querying the recursor is done using UDP. When using UDP over UNIX domain
6551 sockets, the client socket needs a name in the file system, too. You can set
6552 this local name to I<Path> using the B<LocalSocket> option. The default is
6553 C<I<prefix>/var/run/collectd-powerdns>.
6557 =head2 Plugin C<processes>
6561 =item B<Process> I<Name>
6563 Select more detailed statistics of processes matching this name. The statistics
6564 collected for these selected processes are:
6565 - size of the resident segment size (RSS)
6566 - user- and system-time used
6567 - number of processes
6569 - number of open files (under Linux)
6570 - io data (where available)
6571 - context switches (under Linux)
6572 - minor and major pagefaults.
6574 Some platforms have a limit on the length of process names. I<Name> must stay
6577 =item B<ProcessMatch> I<name> I<regex>
6579 Similar to the B<Process> option this allows one to select more detailed
6580 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6581 details). The statistics of all matching processes are summed up and
6582 dispatched to the daemon using the specified I<name> as an identifier. This
6583 allows one to "group" several processes together. I<name> must not contain
6586 =item B<CollectContextSwitch> I<Boolean>
6588 Collect context switch of the process.
6592 =head2 Plugin C<protocols>
6594 Collects a lot of information about various network protocols, such as I<IP>,
6595 I<TCP>, I<UDP>, etc.
6597 Available configuration options:
6601 =item B<Value> I<Selector>
6603 Selects whether or not to select a specific value. The string being matched is
6604 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6605 plugin instance and I<ValueName> will be used as type instance. An example of
6606 the string being used would be C<Tcp:RetransSegs>.
6608 You can use regular expressions to match a large number of values with just one
6609 configuration option. To select all "extended" I<TCP> values, you could use the
6610 following statement:
6614 Whether only matched values are selected or all matched values are ignored
6615 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6616 If no value is configured at all, all values will be selected.
6618 See F</"IGNORELISTS"> for details.
6620 =item B<IgnoreSelected> B<true>|B<false>
6622 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6623 matching values will be ignored.
6627 =head2 Plugin C<python>
6629 This plugin embeds a Python-interpreter into collectd and provides an interface
6630 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6632 =head2 Plugin C<routeros>
6634 The C<routeros> plugin connects to a device running I<RouterOS>, the
6635 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6636 I<librouteros> to connect and reads information about the interfaces and
6637 wireless connections of the device. The configuration supports querying
6642 Host "router0.example.com"
6645 CollectInterface true
6650 Host "router1.example.com"
6653 CollectInterface true
6654 CollectRegistrationTable true
6660 As you can see above, the configuration of the I<routeros> plugin consists of
6661 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6662 options are understood:
6666 =item B<Host> I<Host>
6668 Hostname or IP-address of the router to connect to.
6670 =item B<Port> I<Port>
6672 Port name or port number used when connecting. If left unspecified, the default
6673 will be chosen by I<librouteros>, currently "8728". This option expects a
6674 string argument, even when a numeric port number is given.
6676 =item B<User> I<User>
6678 Use the user name I<User> to authenticate. Defaults to "admin".
6680 =item B<Password> I<Password>
6682 Set the password used to authenticate.
6684 =item B<CollectInterface> B<true>|B<false>
6686 When set to B<true>, interface statistics will be collected for all interfaces
6687 present on the device. Defaults to B<false>.
6689 =item B<CollectRegistrationTable> B<true>|B<false>
6691 When set to B<true>, information about wireless LAN connections will be
6692 collected. Defaults to B<false>.
6694 =item B<CollectCPULoad> B<true>|B<false>
6696 When set to B<true>, information about the CPU usage will be collected. The
6697 number is a dimensionless value where zero indicates no CPU usage at all.
6698 Defaults to B<false>.
6700 =item B<CollectMemory> B<true>|B<false>
6702 When enabled, the amount of used and free memory will be collected. How used
6703 memory is calculated is unknown, for example whether or not caches are counted
6705 Defaults to B<false>.
6707 =item B<CollectDF> B<true>|B<false>
6709 When enabled, the amount of used and free disk space will be collected.
6710 Defaults to B<false>.
6712 =item B<CollectDisk> B<true>|B<false>
6714 When enabled, the number of sectors written and bad blocks will be collected.
6715 Defaults to B<false>.
6719 =head2 Plugin C<redis>
6721 The I<Redis plugin> connects to one or more Redis servers and gathers
6722 information about each server's state. For each server there is a I<Node> block
6723 which configures the connection parameters for this node.
6730 <Query "LLEN myqueue">
6737 The information shown in the synopsis above is the I<default configuration>
6738 which is used by the plugin if no configuration is present.
6742 =item B<Node> I<Nodename>
6744 The B<Node> block identifies a new Redis node, that is a new Redis instance
6745 running in an specified host and port. The name for node is a canonical
6746 identifier which is used as I<plugin instance>. It is limited to
6747 64E<nbsp>characters in length.
6749 =item B<Host> I<Hostname>
6751 The B<Host> option is the hostname or IP-address where the Redis instance is
6754 =item B<Port> I<Port>
6756 The B<Port> option is the TCP port on which the Redis instance accepts
6757 connections. Either a service name of a port number may be given. Please note
6758 that numerical port numbers must be given as a string, too.
6760 =item B<Password> I<Password>
6762 Use I<Password> to authenticate when connecting to I<Redis>.
6764 =item B<Timeout> I<Milliseconds>
6766 The B<Timeout> option set the socket timeout for node response. Since the Redis
6767 read function is blocking, you should keep this value as low as possible. Keep
6768 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
6769 than B<Interval> defined globally.
6771 =item B<Query> I<Querystring>
6773 The B<Query> block identifies a query to execute against the redis server.
6774 There may be an arbitrary number of queries to execute.
6776 =item B<Type> I<Collectd type>
6778 Within a query definition, a valid collectd type to use as when submitting
6779 the result of the query. When not supplied, will default to B<gauge>.
6781 =item B<Instance> I<Type instance>
6783 Within a query definition, an optional type instance to use when submitting
6784 the result of the query. When not supplied will default to the escaped
6785 command, up to 64 chars.
6789 =head2 Plugin C<rrdcached>
6791 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
6792 to store values to RRD files in an efficient manner. The combination of the
6793 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
6794 way the C<rrdtool> plugin works (see below). The added abstraction layer
6795 provides a number of benefits, though: Because the cache is not within
6796 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
6797 restarted. This results in much shorter (if any) gaps in graphs, especially
6798 under heavy load. Also, the C<rrdtool> command line utility is aware of the
6799 daemon so that it can flush values to disk automatically when needed. This
6800 allows one to integrate automated flushing of values into graphing solutions
6803 There are disadvantages, though: The daemon may reside on a different host, so
6804 it may not be possible for C<collectd> to create the appropriate RRD files
6805 anymore. And even if C<rrdcached> runs on the same host, it may run in a
6806 different base directory, so relative paths may do weird stuff if you're not
6809 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
6810 on the same host, communicating via a UNIX domain socket. The B<DataDir>
6811 setting should be set to an absolute path, so that a changed base directory
6812 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
6816 =item B<DaemonAddress> I<Address>
6818 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
6819 library. See L<rrdcached(1)> for details. Example:
6821 <Plugin "rrdcached">
6822 DaemonAddress "unix:/var/run/rrdcached.sock"
6825 =item B<DataDir> I<Directory>
6827 Set the base directory in which the RRD files reside. If this is a relative
6828 path, it is relative to the working base directory of the C<rrdcached> daemon!
6829 Use of an absolute path is recommended.
6831 =item B<CreateFiles> B<true>|B<false>
6833 Enables or disables the creation of RRD files. If the daemon is not running
6834 locally, or B<DataDir> is set to a relative path, this will not work as
6835 expected. Default is B<true>.
6837 =item B<CreateFilesAsync> B<false>|B<true>
6839 When enabled, new RRD files are enabled asynchronously, using a separate thread
6840 that runs in the background. This prevents writes to block, which is a problem
6841 especially when many hundreds of files need to be created at once. However,
6842 since the purpose of creating the files asynchronously is I<not> to block until
6843 the file is available, values before the file is available will be discarded.
6844 When disabled (the default) files are created synchronously, blocking for a
6845 short while, while the file is being written.
6847 =item B<StepSize> I<Seconds>
6849 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6850 this setting is unset and the stepsize is set to the interval in which the data
6851 is collected. Do not use this option unless you absolutely have to for some
6852 reason. Setting this option may cause problems with the C<snmp plugin>, the
6853 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6855 =item B<HeartBeat> I<Seconds>
6857 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6858 in which case the heartbeat is set to twice the B<StepSize> which should equal
6859 the interval in which data is collected. Do not set this option unless you have
6860 a very good reason to do so.
6862 =item B<RRARows> I<NumRows>
6864 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6865 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6866 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6867 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6868 week, one month, and one year.
6870 So for each timespan, it calculates how many PDPs need to be consolidated into
6871 one CDP by calculating:
6872 number of PDPs = timespan / (stepsize * rrarows)
6874 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6877 =item B<RRATimespan> I<Seconds>
6879 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6880 more then one RRA. If this option is never used, the built-in default of (3600,
6881 86400, 604800, 2678400, 31622400) is used.
6883 For more information on how RRA-sizes are calculated see B<RRARows> above.
6885 =item B<XFF> I<Factor>
6887 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6888 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6891 =item B<CollectStatistics> B<false>|B<true>
6893 When set to B<true>, various statistics about the I<rrdcached> daemon will be
6894 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
6896 Statistics are read via I<rrdcached>s socket using the STATS command.
6897 See L<rrdcached(1)> for details.
6901 =head2 Plugin C<rrdtool>
6903 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
6904 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
6905 using these settings. If you don't want to dive into the depths of RRDtool, you
6906 can safely ignore these settings.
6910 =item B<DataDir> I<Directory>
6912 Set the directory to store RRD files under. By default RRD files are generated
6913 beneath the daemon's working directory, i.e. the B<BaseDir>.
6915 =item B<CreateFilesAsync> B<false>|B<true>
6917 When enabled, new RRD files are enabled asynchronously, using a separate thread
6918 that runs in the background. This prevents writes to block, which is a problem
6919 especially when many hundreds of files need to be created at once. However,
6920 since the purpose of creating the files asynchronously is I<not> to block until
6921 the file is available, values before the file is available will be discarded.
6922 When disabled (the default) files are created synchronously, blocking for a
6923 short while, while the file is being written.
6925 =item B<StepSize> I<Seconds>
6927 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6928 this setting is unset and the stepsize is set to the interval in which the data
6929 is collected. Do not use this option unless you absolutely have to for some
6930 reason. Setting this option may cause problems with the C<snmp plugin>, the
6931 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6933 =item B<HeartBeat> I<Seconds>
6935 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6936 in which case the heartbeat is set to twice the B<StepSize> which should equal
6937 the interval in which data is collected. Do not set this option unless you have
6938 a very good reason to do so.
6940 =item B<RRARows> I<NumRows>
6942 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6943 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6944 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6945 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6946 week, one month, and one year.
6948 So for each timespan, it calculates how many PDPs need to be consolidated into
6949 one CDP by calculating:
6950 number of PDPs = timespan / (stepsize * rrarows)
6952 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6955 =item B<RRATimespan> I<Seconds>
6957 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6958 more then one RRA. If this option is never used, the built-in default of (3600,
6959 86400, 604800, 2678400, 31622400) is used.
6961 For more information on how RRA-sizes are calculated see B<RRARows> above.
6963 =item B<XFF> I<Factor>
6965 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6966 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6969 =item B<CacheFlush> I<Seconds>
6971 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
6972 it writes all values for a certain RRD-file if the oldest value is older than
6973 (or equal to) the number of seconds specified. If some RRD-file is not updated
6974 anymore for some reason (the computer was shut down, the network is broken,
6975 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
6976 entire cache is searched for entries older than B<CacheTimeout> seconds and
6977 written to disk every I<Seconds> seconds. Since this is kind of expensive and
6978 does nothing under normal circumstances, this value should not be too small.
6979 900 seconds might be a good value, though setting this to 7200 seconds doesn't
6980 normally do much harm either.
6982 =item B<CacheTimeout> I<Seconds>
6984 If this option is set to a value greater than zero, the C<rrdtool plugin> will
6985 save values in a cache, as described above. Writing multiple values at once
6986 reduces IO-operations and thus lessens the load produced by updating the files.
6987 The trade off is that the graphs kind of "drag behind" and that more memory is
6990 =item B<WritesPerSecond> I<Updates>
6992 When collecting many statistics with collectd and the C<rrdtool> plugin, you
6993 will run serious performance problems. The B<CacheFlush> setting and the
6994 internal update queue assert that collectd continues to work just fine even
6995 under heavy load, but the system may become very unresponsive and slow. This is
6996 a problem especially if you create graphs from the RRD files on the same
6997 machine, for example using the C<graph.cgi> script included in the
6998 C<contrib/collection3/> directory.
7000 This setting is designed for very large setups. Setting this option to a value
7001 between 25 and 80 updates per second, depending on your hardware, will leave
7002 the server responsive enough to draw graphs even while all the cached values
7003 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7004 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7005 written as fast as possible, so that web frontends have up to date data when
7008 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7009 updates per second, writing all values to disk will take approximately
7010 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7011 "collection3" you'll end up with a responsive and fast system, up to date
7012 graphs and basically a "backup" of your values every hour.
7014 =item B<RandomTimeout> I<Seconds>
7016 When set, the actual timeout for each value is chosen randomly between
7017 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7018 intention is to avoid high load situations that appear when many values timeout
7019 at the same time. This is especially a problem shortly after the daemon starts,
7020 because all values were added to the internal cache at roughly the same time.
7024 =head2 Plugin C<sensors>
7026 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7027 that all the needed modules have to be loaded and lm_sensors has to be
7028 configured (most likely by editing F</etc/sensors.conf>. Read
7029 L<sensors.conf(5)> for details.
7031 The B<lm_sensors> homepage can be found at
7032 L<http://secure.netroedge.com/~lm78/>.
7036 =item B<SensorConfigFile> I<File>
7038 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7039 the library's default will be used.
7041 =item B<Sensor> I<chip-bus-address/type-feature>
7043 Selects the name of the sensor which you want to collect or ignore, depending
7044 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7045 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7046 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7048 See F</"IGNORELISTS"> for details.
7050 =item B<IgnoreSelected> I<true>|I<false>
7052 If no configuration if given, the B<sensors>-plugin will collect data from all
7053 sensors. This may not be practical, especially for uninteresting sensors.
7054 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7055 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7056 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7057 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7058 and all other sensors are collected.
7060 =item B<UseLabels> I<true>|I<false>
7062 Configures how sensor readings are reported. When set to I<true>, sensor
7063 readings are reported using their descriptive label (e.g. "VCore"). When set to
7064 I<false> (the default) the sensor name is used ("in0").
7068 =head2 Plugin C<sigrok>
7070 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7071 supported by the L<sigrok|http://sigrok.org/> project.
7077 <Device "AC Voltage">
7082 <Device "Sound Level">
7083 Driver "cem-dt-885x"
7090 =item B<LogLevel> B<0-5>
7092 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7093 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7094 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7095 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7096 their level, are always submitted to I<collectd> at its INFO log level.
7098 =item E<lt>B<Device> I<Name>E<gt>
7100 A sigrok-supported device, uniquely identified by this section's options. The
7101 I<Name> is passed to I<collectd> as the I<plugin instance>.
7103 =item B<Driver> I<DriverName>
7105 The sigrok driver to use for this device.
7107 =item B<Conn> I<ConnectionSpec>
7109 If the device cannot be auto-discovered, or more than one might be discovered
7110 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7111 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7112 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7113 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7114 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7116 =item B<SerialComm> I<SerialSpec>
7118 For serial devices with non-standard port settings, this option can be used
7119 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7120 This should not be necessary; drivers know how to communicate with devices they
7123 =item B<MinimumInterval> I<Seconds>
7125 Specifies the minimum time between measurement dispatches to I<collectd>, in
7126 seconds. Since some I<sigrok> supported devices can acquire measurements many
7127 times per second, it may be necessary to throttle these. For example, the
7128 I<RRD plugin> cannot process writes more than once per second.
7130 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7131 device are always dispatched to I<collectd>. When throttled, unused
7132 measurements are discarded.
7136 =head2 Plugin C<smart>
7138 The C<smart> plugin collects SMART information from physical
7139 disks. Values collectd include temperature, power cycle count, poweron
7140 time and bad sectors. Also, all SMART attributes are collected along
7141 with the normalized current value, the worst value, the threshold and
7142 a human readable value.
7144 Using the following two options you can ignore some disks or configure the
7145 collection only of specific disks.
7149 =item B<Disk> I<Name>
7151 Select the disk I<Name>. Whether it is collected or ignored depends on the
7152 B<IgnoreSelected> setting, see below. As with other plugins that use the
7153 daemon's ignorelist functionality, a string that starts and ends with a slash
7154 is interpreted as a regular expression. Examples:
7159 See F</"IGNORELISTS"> for details.
7161 =item B<IgnoreSelected> B<true>|B<false>
7163 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7164 statements, are ignored or if all other disks are ignored. The behavior
7165 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7166 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7167 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7168 is set to B<true>, all disks are collected B<except> the ones matched.
7170 =item B<IgnoreSleepMode> B<true>|B<false>
7172 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7173 This option disables the sleep mode check and allows the plugin to collect data
7174 from these disks anyway. This is useful in cases where libatasmart mistakenly
7175 reports disks as asleep because it has not been updated to incorporate support
7176 for newer idle states in the ATA spec.
7178 =item B<UseSerial> B<true>|B<false>
7180 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7181 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7182 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7183 storing data. This ensures that the data for a given disk will be kept together
7184 even if the kernel name changes.
7188 =head2 Plugin C<snmp>
7190 Since the configuration of the C<snmp plugin> is a little more complicated than
7191 other plugins, its documentation has been moved to an own manpage,
7192 L<collectd-snmp(5)>. Please see there for details.
7194 =head2 Plugin C<snmp_agent>
7196 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7197 from SNMP master agent and returns the data collected by read plugins.
7198 The I<snmp_agent> plugin handles requests only for OIDs specified in
7199 configuration file. To handle SNMP queries the plugin gets data from collectd
7200 and translates requested values from collectd's internal format to SNMP format.
7201 This plugin is a generic plugin and cannot work without configuration.
7202 For more details on AgentX subagent see
7203 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7208 <Data "memAvailReal">
7212 OIDs "1.3.6.1.4.1.2021.4.6.0"
7215 IndexOID "IF-MIB::ifIndex"
7216 SizeOID "IF-MIB::ifNumber"
7220 OIDs "IF-MIB::ifDescr"
7226 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7231 There are two types of blocks that can be contained in the
7232 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7234 =head3 The B<Data> block
7236 The B<Data> block defines a list OIDs that are to be handled. This block can
7237 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7238 block it reperesents table OIDs.
7239 The following options can be set:
7243 =item B<Instance> I<true|false>
7245 When B<Instance> is set to B<true>, the value for requested OID is copied from
7246 plugin instance field of corresponding collectd value. If B<Data> block defines
7247 scalar data type B<Instance> has no effect and can be omitted.
7249 =item B<Plugin> I<String>
7251 Read plugin name whose collected data will be mapped to specified OIDs.
7253 =item B<Type> I<String>
7255 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7256 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7258 =item B<TypeInstance> I<String>
7260 Collectd's type-instance that is to be used for specified OID.
7262 =item B<OIDs> I<OID> [I<OID> ...]
7264 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7265 are taken from collectd data type specified by B<Plugin>, B<Type>,
7266 B<TypeInstance> fields of this B<Data> block. Number of the OIDs configured
7267 should correspond to number of values in specified B<Type>.
7268 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7269 "rx" and "tx" values of "if_octets" type.
7271 =item B<Scale> I<Value>
7273 The values taken from collectd are multiplied by I<Value>. The field is optional
7274 and the default is B<1.0>.
7276 =item B<Shift> I<Value>
7278 I<Value> is added to values from collectd after they have been multiplied by
7279 B<Scale> value. The field is optional and the default value is B<0.0>.
7283 =head3 The B<Table> block
7285 The B<Table> block defines a collection of B<Data> blocks that belong to one
7286 snmp table. In addition to multiple B<Data> blocks the following options can be
7291 =item B<IndexOID> I<OID>
7293 OID that is handled by the plugin and is mapped to numerical index value that is
7294 generated by the plugin for each table record.
7296 =item B<SizeOID> I<OID>
7298 OID that is handled by the plugin. Returned value is the number of records in
7299 the table. The field is optional.
7303 =head2 Plugin C<statsd>
7305 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7306 protocol and dispatches rates or other aggregates of these numbers
7309 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7310 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7311 C<objects> respectively.
7313 The following configuration options are valid:
7317 =item B<Host> I<Host>
7319 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7320 "any" address, i.e. accept packets sent to any of the hosts addresses.
7322 =item B<Port> I<Port>
7324 UDP port to listen to. This can be either a service name or a port number.
7325 Defaults to C<8125>.
7327 =item B<DeleteCounters> B<false>|B<true>
7329 =item B<DeleteTimers> B<false>|B<true>
7331 =item B<DeleteGauges> B<false>|B<true>
7333 =item B<DeleteSets> B<false>|B<true>
7335 These options control what happens if metrics are not updated in an interval.
7336 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7337 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7338 are unchanged. If set to B<True>, the such metrics are not dispatched and
7339 removed from the internal cache.
7341 =item B<CounterSum> B<false>|B<true>
7343 When enabled, creates a C<count> metric which reports the change since the last
7344 read. This option primarily exists for compatibility with the I<statsd>
7345 implementation by Etsy.
7347 =item B<TimerPercentile> I<Percent>
7349 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7350 that I<Percent> of all reported timers are smaller than or equal to the
7351 computed latency. This is useful for cutting off the long tail latency, as it's
7352 often done in I<Service Level Agreements> (SLAs).
7354 Different percentiles can be calculated by setting this option several times.
7355 If none are specified, no percentiles are calculated / dispatched.
7357 =item B<TimerLower> B<false>|B<true>
7359 =item B<TimerUpper> B<false>|B<true>
7361 =item B<TimerSum> B<false>|B<true>
7363 =item B<TimerCount> B<false>|B<true>
7365 Calculate and dispatch various values out of I<Timer> metrics received during
7366 an interval. If set to B<False>, the default, these values aren't calculated /
7371 =head2 Plugin C<swap>
7373 The I<Swap plugin> collects information about used and available swap space. On
7374 I<Linux> and I<Solaris>, the following options are available:
7378 =item B<ReportByDevice> B<false>|B<true>
7380 Configures how to report physical swap devices. If set to B<false> (the
7381 default), the summary over all swap devices is reported only, i.e. the globally
7382 used and available space over all devices. If B<true> is configured, the used
7383 and available space of each device will be reported separately.
7385 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7386 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7388 =item B<ReportBytes> B<false>|B<true>
7390 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7391 I<swap I/O> is reported in pages. This option is available under Linux only.
7393 =item B<ValuesAbsolute> B<true>|B<false>
7395 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7396 available and used. Defaults to B<true>.
7398 =item B<ValuesPercentage> B<false>|B<true>
7400 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7401 available and free. Defaults to B<false>.
7403 This is useful for deploying I<collectd> in a heterogeneous environment, where
7404 swap sizes differ and you want to specify generic thresholds or similar.
7408 =head2 Plugin C<syslog>
7412 =item B<LogLevel> B<debug|info|notice|warning|err>
7414 Sets the log-level. If, for example, set to B<notice>, then all events with
7415 severity B<notice>, B<warning>, or B<err> will be submitted to the
7418 Please note that B<debug> is only available if collectd has been compiled with
7421 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7423 Controls which notifications should be sent to syslog. The default behaviour is
7424 not to send any. Less severe notifications always imply logging more severe
7425 notifications: Setting this to B<OKAY> means all notifications will be sent to
7426 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7427 notifications but will dismiss B<OKAY> notifications. Setting this option to
7428 B<FAILURE> will only send failures to syslog.
7432 =head2 Plugin C<table>
7434 The C<table plugin> provides generic means to parse tabular data and dispatch
7435 user specified values. Values are selected based on column numbers. For
7436 example, this plugin may be used to get values from the Linux L<proc(5)>
7437 filesystem or CSV (comma separated values) files.
7440 <Table "/proc/slabinfo">
7445 InstancePrefix "active_objs"
7451 InstancePrefix "objperslab"
7458 The configuration consists of one or more B<Table> blocks, each of which
7459 configures one file to parse. Within each B<Table> block, there are one or
7460 more B<Result> blocks, which configure which data to select and how to
7463 The following options are available inside a B<Table> block:
7467 =item B<Instance> I<instance>
7469 If specified, I<instance> is used as the plugin instance. So, in the above
7470 example, the plugin name C<table-slabinfo> would be used. If omitted, the
7471 filename of the table is used instead, with all special characters replaced
7472 with an underscore (C<_>).
7474 =item B<Separator> I<string>
7476 Any character of I<string> is interpreted as a delimiter between the different
7477 columns of the table. A sequence of two or more contiguous delimiters in the
7478 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7479 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7480 of a table - see its documentation for more details. This option is mandatory.
7482 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7483 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7484 required because of collectd's config parsing.
7488 The following options are available inside a B<Result> block:
7492 =item B<Type> I<type>
7494 Sets the type used to dispatch the values to the daemon. Detailed information
7495 about types and their configuration can be found in L<types.db(5)>. This
7496 option is mandatory.
7498 =item B<InstancePrefix> I<prefix>
7500 If specified, prepend I<prefix> to the type instance. If omitted, only the
7501 B<InstancesFrom> option is considered for the type instance.
7503 =item B<InstancesFrom> I<column0> [I<column1> ...]
7505 If specified, the content of the given columns (identified by the column
7506 number starting at zero) will be used to create the type instance for each
7507 row. Multiple values (and the instance prefix) will be joined together with
7508 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7509 option is considered for the type instance.
7511 The plugin itself does not check whether or not all built instances are
7512 different. It’s your responsibility to assure that each is unique. This is
7513 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7514 sure that the table only contains one row.
7516 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7519 =item B<ValuesFrom> I<column0> [I<column1> ...]
7521 Specifies the columns (identified by the column numbers starting at zero)
7522 whose content is used as the actual data for the data sets that are dispatched
7523 to the daemon. How many such columns you need is determined by the B<Type>
7524 setting above. If you specify too many or not enough columns, the plugin will
7525 complain about that and no data will be submitted to the daemon. The plugin
7526 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7527 respectively, so anything supported by those functions is supported by the
7528 plugin as well. This option is mandatory.
7532 =head2 Plugin C<tail>
7534 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7535 each line and dispatches found values. What is matched can be configured by the
7536 user using (extended) regular expressions, as described in L<regex(7)>.
7539 <File "/var/log/exim4/mainlog">
7543 Regex "S=([1-9][0-9]*)"
7549 Regex "\\<R=local_user\\>"
7550 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7553 Instance "local_user"
7556 Regex "l=([0-9]*\\.[0-9]*)"
7557 <DSType "Distribution">
7567 The config consists of one or more B<File> blocks, each of which configures one
7568 logfile to parse. Within each B<File> block, there are one or more B<Match>
7569 blocks, which configure a regular expression to search for.
7571 The B<Instance> option in the B<File> block may be used to set the plugin
7572 instance. So in the above example the plugin name C<tail-foo> would be used.
7573 This plugin instance is for all B<Match> blocks that B<follow> it, until the
7574 next B<Instance> option. This way you can extract several plugin instances from
7575 one logfile, handy when parsing syslog and the like.
7577 The B<Interval> option allows you to define the length of time between reads. If
7578 this is not set, the default Interval will be used.
7580 Each B<Match> block has the following options to describe how the match should
7585 =item B<Regex> I<regex>
7587 Sets the regular expression to use for matching against a line. The first
7588 subexpression has to match something that can be turned into a number by
7589 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7590 below. Because B<extended> regular expressions are used, you do not need to use
7591 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7592 collectd's config parsing you need to escape backslashes, though. So if you
7593 want to match literal parentheses you need to do the following:
7595 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7597 =item B<ExcludeRegex> I<regex>
7599 Sets an optional regular expression to use for excluding lines from the match.
7600 An example which excludes all connections from localhost from the match:
7602 ExcludeRegex "127\\.0\\.0\\.1"
7604 =item B<DSType> I<Type>
7606 Sets how the values are cumulated. I<Type> is one of:
7610 =item B<GaugeAverage>
7612 Calculate the average.
7616 Use the smallest number only.
7620 Use the greatest number only.
7624 Use the last number found.
7626 =item B<GaugePersist>
7628 Use the last number found. The number is not reset at the end of an interval.
7629 It is continously reported until another number is matched. This is intended
7630 for cases in which only state changes are reported, for example a thermometer
7631 that only reports the temperature when it changes.
7637 =item B<AbsoluteSet>
7639 The matched number is a counter. Simply I<sets> the internal counter to this
7640 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
7648 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
7649 matched number may be negative, which will effectively subtract from the
7658 Increase the internal counter by one. These B<DSType> are the only ones that do
7659 not use the matched subexpression, but simply count the number of matched
7660 lines. Thus, you may use a regular expression without submatch in this case.
7662 =item B<Distribution>
7664 Type to do calculations based on the distribution of values, primarily
7665 calculating percentiles. This is primarily geared towards latency, but can be
7666 used for other metrics as well. The range of values tracked with this setting
7667 must be in the range (0–2^34) and can be fractional. Please note that neither
7668 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
7671 This option must be used together with the B<Percentile> and/or B<Bucket>
7676 <DSType "Distribution">
7683 =item B<Percentile> I<Percent>
7685 Calculate and dispatch the configured percentile, i.e. compute the value, so
7686 that I<Percent> of all matched values are smaller than or equal to the computed
7689 Metrics are reported with the I<type> B<Type> (the value of the above option)
7690 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
7692 This option may be repeated to calculate more than one percentile.
7694 =item B<Bucket> I<lower_bound> I<upper_bound>
7696 Export the number of values (a C<DERIVE>) falling within the given range. Both,
7697 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
7698 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
7699 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
7700 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
7703 To export the entire (0–inf) range without overlap, use the upper bound of the
7704 previous range as the lower bound of the following range. In other words, use
7705 the following schema:
7715 Metrics are reported with the I<type> C<bucket> and the I<type instance>
7716 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
7718 This option may be repeated to calculate more than one rate.
7724 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
7725 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
7726 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
7727 B<Derive*> types interpret the submatch as a signed integer using
7728 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
7729 and it may be omitted in this case.
7731 =item B<Type> I<Type>
7733 Sets the type used to dispatch this value. Detailed information about types and
7734 their configuration can be found in L<types.db(5)>.
7736 =item B<Instance> I<TypeInstance>
7738 This optional setting sets the type instance to use.
7742 =head2 Plugin C<tail_csv>
7744 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
7745 written by I<Snort>.
7750 <Metric "snort-dropped">
7755 <File "/var/log/snort/snort.stats">
7756 Instance "snort-eth0"
7758 Collect "snort-dropped"
7762 The configuration consists of one or more B<Metric> blocks that define an index
7763 into the line of the CSV file and how this value is mapped to I<collectd's>
7764 internal representation. These are followed by one or more B<Instance> blocks
7765 which configure which file to read, in which interval and which metrics to
7770 =item E<lt>B<Metric> I<Name>E<gt>
7772 The B<Metric> block configures a new metric to be extracted from the statistics
7773 file and how it is mapped on I<collectd's> data model. The string I<Name> is
7774 only used inside the B<Instance> blocks to refer to this block, so you can use
7775 one B<Metric> block for multiple CSV files.
7779 =item B<Type> I<Type>
7781 Configures which I<Type> to use when dispatching this metric. Types are defined
7782 in the L<types.db(5)> file, see the appropriate manual page for more
7783 information on specifying types. Only types with a single I<data source> are
7784 supported by the I<tail_csv plugin>. The information whether the value is an
7785 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
7786 I<Type's> definition.
7788 =item B<Instance> I<TypeInstance>
7790 If set, I<TypeInstance> is used to populate the type instance field of the
7791 created value lists. Otherwise, no type instance is used.
7793 =item B<ValueFrom> I<Index>
7795 Configure to read the value from the field with the zero-based index I<Index>.
7796 If the value is parsed as signed integer, unsigned integer or double depends on
7797 the B<Type> setting, see above.
7801 =item E<lt>B<File> I<Path>E<gt>
7803 Each B<File> block represents one CSV file to read. There must be at least one
7804 I<File> block but there can be multiple if you have multiple CSV files.
7808 =item B<Instance> I<PluginInstance>
7810 Sets the I<plugin instance> used when dispatching the values.
7812 =item B<Collect> I<Metric>
7814 Specifies which I<Metric> to collect. This option must be specified at least
7815 once, and you can use this option multiple times to specify more than one
7816 metric to be extracted from this statistic file.
7818 =item B<Interval> I<Seconds>
7820 Configures the interval in which to read values from this instance / file.
7821 Defaults to the plugin's default interval.
7823 =item B<TimeFrom> I<Index>
7825 Rather than using the local time when dispatching a value, read the timestamp
7826 from the field with the zero-based index I<Index>. The value is interpreted as
7827 seconds since epoch. The value is parsed as a double and may be factional.
7833 =head2 Plugin C<teamspeak2>
7835 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
7836 polls interesting global and virtual server data. The plugin can query only one
7837 physical server but unlimited virtual servers. You can use the following
7838 options to configure it:
7842 =item B<Host> I<hostname/ip>
7844 The hostname or ip which identifies the physical server.
7847 =item B<Port> I<port>
7849 The query port of the physical server. This needs to be a string.
7852 =item B<Server> I<port>
7854 This option has to be added once for every virtual server the plugin should
7855 query. If you want to query the virtual server on port 8767 this is what the
7856 option would look like:
7860 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
7861 use quotes around it! If no such statement is given only global information
7866 =head2 Plugin C<ted>
7868 The I<TED> plugin connects to a device of "The Energy Detective", a device to
7869 measure power consumption. These devices are usually connected to a serial
7870 (RS232) or USB port. The plugin opens a configured device and tries to read the
7871 current energy readings. For more information on TED, visit
7872 L<http://www.theenergydetective.com/>.
7874 Available configuration options:
7878 =item B<Device> I<Path>
7880 Path to the device on which TED is connected. collectd will need read and write
7881 permissions on that file.
7883 Default: B</dev/ttyUSB0>
7885 =item B<Retries> I<Num>
7887 Apparently reading from TED is not that reliable. You can therefore configure a
7888 number of retries here. You only configure the I<retries> here, to if you
7889 specify zero, one reading will be performed (but no retries if that fails); if
7890 you specify three, a maximum of four readings are performed. Negative values
7897 =head2 Plugin C<tcpconns>
7899 The C<tcpconns plugin> counts the number of currently established TCP
7900 connections based on the local port and/or the remote port. Since there may be
7901 a lot of connections the default if to count all connections with a local port,
7902 for which a listening socket is opened. You can use the following options to
7903 fine-tune the ports you are interested in:
7907 =item B<ListeningPorts> I<true>|I<false>
7909 If this option is set to I<true>, statistics for all local ports for which a
7910 listening socket exists are collected. The default depends on B<LocalPort> and
7911 B<RemotePort> (see below): If no port at all is specifically selected, the
7912 default is to collect listening ports. If specific ports (no matter if local or
7913 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
7914 the selected ports will be collected unless this option is set to I<true>
7917 =item B<LocalPort> I<Port>
7919 Count the connections to a specific local port. This can be used to see how
7920 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
7921 You have to specify the port in numeric form, so for the mailserver example
7922 you'd need to set B<25>.
7924 =item B<RemotePort> I<Port>
7926 Count the connections to a specific remote port. This is useful to see how
7927 much a remote service is used. This is most useful if you want to know how many
7928 connections a local service has opened to remote services, e.E<nbsp>g. how many
7929 connections a mail server or news server has to other mail or news servers, or
7930 how many connections a web proxy holds to web servers. You have to give the
7931 port in numeric form.
7933 =item B<AllPortsSummary> I<true>|I<false>
7935 If this option is set to I<true> a summary of statistics from all connections
7936 are collected. This option defaults to I<false>.
7940 =head2 Plugin C<thermal>
7944 =item B<ForceUseProcfs> I<true>|I<false>
7946 By default, the I<Thermal plugin> tries to read the statistics from the Linux
7947 C<sysfs> interface. If that is not available, the plugin falls back to the
7948 C<procfs> interface. By setting this option to I<true>, you can force the
7949 plugin to use the latter. This option defaults to I<false>.
7951 =item B<Device> I<Device>
7953 Selects the name of the thermal device that you want to collect or ignore,
7954 depending on the value of the B<IgnoreSelected> option. This option may be
7955 used multiple times to specify a list of devices.
7957 See F</"IGNORELISTS"> for details.
7959 =item B<IgnoreSelected> I<true>|I<false>
7961 Invert the selection: If set to true, all devices B<except> the ones that
7962 match the device names specified by the B<Device> option are collected. By
7963 default only selected devices are collected if a selection is made. If no
7964 selection is configured at all, B<all> devices are selected.
7968 =head2 Plugin C<threshold>
7970 The I<Threshold plugin> checks values collected or received by I<collectd>
7971 against a configurable I<threshold> and issues I<notifications> if values are
7974 Documentation for this plugin is available in the L<collectd-threshold(5)>
7977 =head2 Plugin C<tokyotyrant>
7979 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
7980 couple metrics: number of records, and database size on disk.
7984 =item B<Host> I<Hostname/IP>
7986 The hostname or IP which identifies the server.
7987 Default: B<127.0.0.1>
7989 =item B<Port> I<Service/Port>
7991 The query port of the server. This needs to be a string, even if the port is
7992 given in its numeric form.
7997 =head2 Plugin C<turbostat>
7999 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8000 Intel processors by using I<Model Specific Registers>.
8004 =item B<CoreCstates> I<Bitmask(Integer)>
8006 Bit mask of the list of core C-states supported by the processor.
8007 This option should only be used if the automated detection fails.
8008 Default value extracted from the CPU model and family.
8010 Currently supported C-states (by this plugin): 3, 6, 7
8014 All states (3, 6 and 7):
8015 (1<<3) + (1<<6) + (1<<7) = 392
8017 =item B<PackageCstates> I<Bitmask(Integer)>
8019 Bit mask of the list of packages C-states supported by the processor. This
8020 option should only be used if the automated detection fails. Default value
8021 extracted from the CPU model and family.
8023 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8027 States 2, 3, 6 and 7:
8028 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8030 =item B<SystemManagementInterrupt> I<true>|I<false>
8032 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8033 This option should only be used if the automated detection fails or if you want
8034 to disable this feature.
8036 =item B<DigitalTemperatureSensor> I<true>|I<false>
8038 Boolean enabling the collection of the temperature of each core. This option
8039 should only be used if the automated detection fails or if you want to disable
8042 =item B<TCCActivationTemp> I<Temperature>
8044 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8045 temperature is used when collecting the temperature of cores or packages. This
8046 option should only be used if the automated detection fails. Default value
8047 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8049 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8051 Bit mask of the list of elements to be thermally monitored. This option should
8052 only be used if the automated detection fails or if you want to disable some
8053 collections. The different bits of this bit mask accepted by this plugin are:
8057 =item 0 ('1'): Package
8061 =item 2 ('4'): Cores
8063 =item 3 ('8'): Embedded graphic device
8067 =item B<LogicalCoreNames> I<true>|I<false>
8069 Boolean enabling the use of logical core numbering for per core statistics.
8070 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8071 sequential number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8072 where I<n> is the n-th core of the socket, causing name conflicts when there is
8073 more than one socket.
8077 =head2 Plugin C<unixsock>
8081 =item B<SocketFile> I<Path>
8083 Sets the socket-file which is to be created.
8085 =item B<SocketGroup> I<Group>
8087 If running as root change the group of the UNIX-socket after it has been
8088 created. Defaults to B<collectd>.
8090 =item B<SocketPerms> I<Permissions>
8092 Change the file permissions of the UNIX-socket after it has been created. The
8093 permissions must be given as a numeric, octal value as you would pass to
8094 L<chmod(1)>. Defaults to B<0770>.
8096 =item B<DeleteSocket> B<false>|B<true>
8098 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8099 with the given name already exists. If I<collectd> crashes a socket file may be
8100 left over, preventing the daemon from opening a new socket when restarted.
8101 Since this is potentially dangerous, this defaults to B<false>.
8105 =head2 Plugin C<uuid>
8107 This plugin, if loaded, causes the Hostname to be taken from the machine's
8108 UUID. The UUID is a universally unique designation for the machine, usually
8109 taken from the machine's BIOS. This is most useful if the machine is running in
8110 a virtual environment such as Xen, in which case the UUID is preserved across
8111 shutdowns and migration.
8113 The following methods are used to find the machine's UUID, in order:
8119 Check I</etc/uuid> (or I<UUIDFile>).
8123 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8128 Check for UUID from C<dmidecode> / SMBIOS.
8132 Check for UUID from Xen hypervisor.
8136 If no UUID can be found then the hostname is not modified.
8140 =item B<UUIDFile> I<Path>
8142 Take the UUID from the given file (default I</etc/uuid>).
8146 =head2 Plugin C<varnish>
8148 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8149 It collects a subset of the values displayed by L<varnishstat(1)>, and
8150 organizes them in categories which can be enabled or disabled. Currently only
8151 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8152 meaning of each metric can be found in L<varnish-counters(7)>.
8157 <Instance "example">
8161 CollectConnections true
8162 CollectDirectorDNS false
8166 CollectObjects false
8168 CollectSession false
8178 CollectWorkers false
8182 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8183 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8184 will collectd statistics from the default "varnishd" instance (this should work
8185 fine in most cases).
8187 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8191 =item B<CollectBackend> B<true>|B<false>
8193 Back-end connection statistics, such as successful, reused,
8194 and closed connections. True by default.
8196 =item B<CollectBan> B<true>|B<false>
8198 Statistics about ban operations, such as number of bans added, retired, and
8199 number of objects tested against ban operations. Only available with Varnish
8200 3.x and above. False by default.
8202 =item B<CollectCache> B<true>|B<false>
8204 Cache hits and misses. True by default.
8206 =item B<CollectConnections> B<true>|B<false>
8208 Number of client connections received, accepted and dropped. True by default.
8210 =item B<CollectDirectorDNS> B<true>|B<false>
8212 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8215 =item B<CollectESI> B<true>|B<false>
8217 Edge Side Includes (ESI) parse statistics. False by default.
8219 =item B<CollectFetch> B<true>|B<false>
8221 Statistics about fetches (HTTP requests sent to the backend). False by default.
8223 =item B<CollectHCB> B<true>|B<false>
8225 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8226 divided into locked and unlocked look-ups. False by default.
8228 =item B<CollectObjects> B<true>|B<false>
8230 Statistics on cached objects: number of objects expired, nuked (prematurely
8231 expired), saved, moved, etc. False by default.
8233 =item B<CollectPurge> B<true>|B<false>
8235 Statistics about purge operations, such as number of purges added, retired, and
8236 number of objects tested against purge operations. Only available with Varnish
8237 2.x. False by default.
8239 =item B<CollectSession> B<true>|B<false>
8241 Client session statistics. Number of past and current sessions, session herd and
8242 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8243 metrics found in the Connections and Threads sections with previous versions of
8244 Varnish have been moved here.
8246 =item B<CollectSHM> B<true>|B<false>
8248 Statistics about the shared memory log, a memory region to store
8249 log messages which is flushed to disk when full. True by default.
8251 =item B<CollectSMA> B<true>|B<false>
8253 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8254 component is Solaris specific. Only available with Varnish 2.x. False by
8257 =item B<CollectSMS> B<true>|B<false>
8259 synth (synthetic content) storage statistics. This storage
8260 component is used internally only. False by default.
8262 =item B<CollectSM> B<true>|B<false>
8264 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
8267 =item B<CollectStruct> B<true>|B<false>
8269 Current varnish internal state statistics. Number of current sessions, objects
8270 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8273 =item B<CollectTotals> B<true>|B<false>
8275 Collects overview counters, such as the number of sessions created,
8276 the number of requests and bytes transferred. False by default.
8278 =item B<CollectUptime> B<true>|B<false>
8280 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8282 =item B<CollectVCL> B<true>|B<false>
8284 Number of total (available + discarded) VCL (config files). False by default.
8286 =item B<CollectVSM> B<true>|B<false>
8288 Collect statistics about Varnish's shared memory usage (used by the logging and
8289 statistics subsystems). Only available with Varnish 4.x. False by default.
8291 =item B<CollectWorkers> B<true>|B<false>
8293 Collect statistics about worker threads. False by default.
8297 =head2 Plugin C<virt>
8299 This plugin allows CPU, disk, network load and other metrics to be collected for
8300 virtualized guests on the machine. The statistics are collected through libvirt
8301 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8302 installing any additional software on guests, especially I<collectd>, which runs
8303 only on the host system.
8305 Only I<Connection> is required.
8309 =item B<Connection> I<uri>
8311 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8313 Connection "xen:///"
8315 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8317 =item B<RefreshInterval> I<seconds>
8319 Refresh the list of domains and devices every I<seconds>. The default is 60
8320 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8321 the list of domains and devices to be refreshed on every iteration.
8323 Refreshing the devices in particular is quite a costly operation, so if your
8324 virtualization setup is static you might consider increasing this. If this
8325 option is set to 0, refreshing is disabled completely.
8327 =item B<Domain> I<name>
8329 =item B<BlockDevice> I<name:dev>
8331 =item B<InterfaceDevice> I<name:dev>
8333 =item B<IgnoreSelected> B<true>|B<false>
8335 Select which domains and devices are collected.
8337 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8338 disk/network devices are collected.
8340 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8341 domains and disk/network devices are ignored, while the rest are collected.
8343 The domain name and device names may use a regular expression, if the name is
8344 surrounded by I</.../> and collectd was compiled with support for regexps.
8346 The default is to collect statistics for all domains and all their devices.
8350 BlockDevice "/:hdb/"
8351 IgnoreSelected "true"
8353 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8356 =item B<BlockDeviceFormat> B<target>|B<source>
8358 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8359 seen by the guest will be used for reporting metrics.
8360 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8363 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8364 using the path of the source, e.g. an image file.
8365 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8370 If the domain XML have the following device defined:
8372 <disk type='block' device='disk'>
8373 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8374 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8375 <target dev='sda' bus='scsi'/>
8377 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8380 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8382 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8383 to C<var_lib_libvirt_images_image1.qcow2>.
8385 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8387 The B<BlockDeviceFormatBasename> controls whether the full path or the
8388 L<basename(1)> of the source is being used as the I<type instance> when
8389 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8393 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8394 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8395 be set to C<var_lib_libvirt_images_image1.qcow2>.
8396 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8397 set to C<image1.qcow2>.
8399 =item B<HostnameFormat> B<name|uuid|hostname|...>
8401 When the virt plugin logs data, it sets the hostname of the collected data
8402 according to this setting. The default is to use the guest name as provided by
8403 the hypervisor, which is equal to setting B<name>.
8405 B<uuid> means use the guest's UUID. This is useful if you want to track the
8406 same guest across migrations.
8408 B<hostname> means to use the global B<Hostname> setting, which is probably not
8409 useful on its own because all guests will appear to have the same name.
8411 You can also specify combinations of these fields. For example B<name uuid>
8412 means to concatenate the guest name and UUID (with a literal colon character
8413 between, thus I<"foo:1234-1234-1234-1234">).
8415 At the moment of writing (collectd-5.5), hostname string is limited to 62
8416 characters. In case when combination of fields exceeds 62 characters,
8417 hostname will be truncated without a warning.
8419 =item B<InterfaceFormat> B<name>|B<address>
8421 When the virt plugin logs interface data, it sets the name of the collected
8422 data according to this setting. The default is to use the path as provided by
8423 the hypervisor (the "dev" property of the target node), which is equal to
8426 B<address> means use the interface's mac address. This is useful since the
8427 interface path might change between reboots of a guest or across migrations.
8429 =item B<PluginInstanceFormat> B<name|uuid|none>
8431 When the virt plugin logs data, it sets the plugin_instance of the collected
8432 data according to this setting. The default is to not set the plugin_instance.
8434 B<name> means use the guest's name as provided by the hypervisor.
8435 B<uuid> means use the guest's UUID.
8437 You can also specify combinations of the B<name> and B<uuid> fields.
8438 For example B<name uuid> means to concatenate the guest name and UUID
8439 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8441 =item B<Instances> B<integer>
8443 How many read instances you want to use for this plugin. The default is one,
8444 and the sensible setting is a multiple of the B<ReadThreads> value.
8445 If you are not sure, just use the default setting.
8447 =item B<ExtraStats> B<string>
8449 Report additional extra statistics. The default is no extra statistics, preserving
8450 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8451 allows the plugin to reported more detailed statistics about the behaviour of
8452 Virtual Machines. The argument is a space-separated list of selectors.
8454 Currently supported selectors are:
8458 =item B<cpu_util>: report CPU utilization per domain in percentage.
8460 =item B<disk>: report extra statistics like number of flush operations and total
8461 service time for read, write and flush operations. Requires libvirt API version
8464 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8467 =item B<domain_state>: report domain state and reason in human-readable format as
8468 a notification. If libvirt API version I<0.9.2> or later is available, domain
8469 reason will be included in notification.
8471 =item B<fs_info>: report file system information as a notification. Requires
8472 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8473 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8474 version supports retrieving file system information.
8476 =item B<job_stats_background>: report statistics about progress of a background
8477 job on a domain. Only one type of job statistics can be collected at the same time.
8478 Requires libvirt API version I<1.2.9> or later.
8480 =item B<job_stats_completed>: report statistics about a recently completed job on
8481 a domain. Only one type of job statistics can be collected at the same time.
8482 Requires libvirt API version I<1.2.9> or later.
8484 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8485 Requires libvirt API version I<0.9.11> or later.
8487 =item B<perf>: report performance monitoring events. To collect performance
8488 metrics they must be enabled for domain and supported by the platform. Requires
8489 libvirt API version I<1.3.3> or later.
8490 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8492 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8498 =head2 Plugin C<vmem>
8500 The C<vmem> plugin collects information about the usage of virtual memory.
8501 Since the statistics provided by the Linux kernel are very detailed, they are
8502 collected very detailed. However, to get all the details, you have to switch
8503 them on manually. Most people just want an overview over, such as the number of
8504 pages read from swap space.
8508 =item B<Verbose> B<true>|B<false>
8510 Enables verbose collection of information. This will start collecting page
8511 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8512 Part of these statistics are collected on a "per zone" basis.
8516 =head2 Plugin C<vserver>
8518 This plugin doesn't have any options. B<VServer> support is only available for
8519 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8520 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8521 need to apply the patches and compile your own kernel, which will then provide
8522 the F</proc/virtual> filesystem that is required by this plugin.
8524 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8526 B<Note>: The traffic collected by this plugin accounts for the amount of
8527 traffic passing a socket which might be a lot less than the actual on-wire
8528 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8529 collect on-wire traffic you could, for example, use the logging facilities of
8530 iptables to feed data for the guest IPs into the iptables plugin.
8532 =head2 Plugin C<write_graphite>
8534 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8535 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8536 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8537 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8538 of at most 1428 bytes to minimize the number of network packets.
8542 <Plugin write_graphite>
8552 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8553 blocks. Inside the B<Node> blocks, the following options are recognized:
8557 =item B<Host> I<Address>
8559 Hostname or address to connect to. Defaults to C<localhost>.
8561 =item B<Port> I<Service>
8563 Service name or port number to connect to. Defaults to C<2003>.
8565 =item B<Protocol> I<String>
8567 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
8569 =item B<ReconnectInterval> I<Seconds>
8571 When set to non-zero, forces the connection to the Graphite backend to be
8572 closed and re-opend periodically. This behavior is desirable in environments
8573 where the connection to the Graphite backend is done through load balancers,
8574 for example. When set to zero, the default, the connetion is kept open for as
8577 =item B<LogSendErrors> B<false>|B<true>
8579 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
8580 If set to B<false>, it will not log the errors. This is especially useful when
8581 using Protocol UDP since many times we want to use the "fire-and-forget"
8582 approach and logging errors fills syslog with unneeded messages.
8584 =item B<Prefix> I<String>
8586 When set, I<String> is added in front of the host name. Dots and whitespace are
8587 I<not> escaped in this string (see B<EscapeCharacter> below).
8589 =item B<Postfix> I<String>
8591 When set, I<String> is appended to the host name. Dots and whitespace are
8592 I<not> escaped in this string (see B<EscapeCharacter> below).
8594 =item B<EscapeCharacter> I<Char>
8596 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
8597 in the identifier. The B<EscapeCharacter> option determines which character
8598 dots, whitespace and control characters are replaced with. Defaults to
8601 =item B<StoreRates> B<false>|B<true>
8603 If set to B<true> (the default), convert counter values to rates. If set to
8604 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
8607 =item B<SeparateInstances> B<false>|B<true>
8609 If set to B<true>, the plugin instance and type instance will be in their own
8610 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8611 default), the plugin and plugin instance (and likewise the type and type
8612 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8614 =item B<AlwaysAppendDS> B<false>|B<true>
8616 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
8617 identifier. If set to B<false> (the default), this is only done when there is
8620 =item B<PreserveSeparator> B<false>|B<true>
8622 If set to B<false> (the default) the C<.> (dot) character is replaced with
8623 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
8624 is preserved, i.e. passed through.
8626 =item B<DropDuplicateFields> B<false>|B<true>
8628 If set to B<true>, detect and remove duplicate components in Graphite metric
8629 names. For example, the metric name C<host.load.load.shortterm> will
8630 be shortened to C<host.load.shortterm>.
8634 =head2 Plugin C<write_log>
8636 The C<write_log> plugin writes metrics as INFO log messages.
8638 This plugin supports two output formats: I<Graphite> and I<JSON>.
8648 =item B<Format> I<Format>
8650 The output format to use. Can be one of C<Graphite> or C<JSON>.
8654 =head2 Plugin C<write_tsdb>
8656 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
8657 time series database. The plugin connects to a I<TSD>, a masterless, no shared
8658 state daemon that ingests metrics and stores them in HBase. The plugin uses
8659 I<TCP> over the "line based" protocol with a default port 4242. The data will
8660 be sent in blocks of at most 1428 bytes to minimize the number of network
8669 Host "tsd-1.my.domain"
8671 HostTags "status=production"
8675 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8676 blocks and global directives.
8678 Global directives are:
8682 =item B<ResolveInterval> I<seconds>
8684 =item B<ResolveJitter> I<seconds>
8686 When I<collectd> connects to a TSDB node, it will request the hostname from
8687 DNS. This can become a problem if the TSDB node is unavailable or badly
8688 configured because collectd will request DNS in order to reconnect for every
8689 metric, which can flood your DNS. So you can cache the last value for
8690 I<ResolveInterval> seconds.
8691 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8693 You can also define a jitter, a random interval to wait in addition to
8694 I<ResolveInterval>. This prevents all your collectd servers to resolve the
8695 hostname at the same time when the connection fails.
8696 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8698 B<Note:> If the DNS resolution has already been successful when the socket
8699 closes, the plugin will try to reconnect immediately with the cached
8700 information. DNS is queried only when the socket is closed for a longer than
8701 I<ResolveInterval> + I<ResolveJitter> seconds.
8705 Inside the B<Node> blocks, the following options are recognized:
8709 =item B<Host> I<Address>
8711 Hostname or address to connect to. Defaults to C<localhost>.
8713 =item B<Port> I<Service>
8715 Service name or port number to connect to. Defaults to C<4242>.
8718 =item B<HostTags> I<String>
8720 When set, I<HostTags> is added to the end of the metric. It is intended to be
8721 used for name=value pairs that the TSD will tag the metric with. Dots and
8722 whitespace are I<not> escaped in this string.
8724 =item B<StoreRates> B<false>|B<true>
8726 If set to B<true>, convert counter values to rates. If set to B<false>
8727 (the default) counter values are stored as is, as an increasing
8730 =item B<AlwaysAppendDS> B<false>|B<true>
8732 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
8733 identifier. If set to B<false> (the default), this is only done when there is
8738 =head2 Plugin C<write_mongodb>
8740 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
8745 <Plugin "write_mongodb">
8754 The plugin can send values to multiple instances of I<MongoDB> by specifying
8755 one B<Node> block for each instance. Within the B<Node> blocks, the following
8756 options are available:
8760 =item B<Host> I<Address>
8762 Hostname or address to connect to. Defaults to C<localhost>.
8764 =item B<Port> I<Service>
8766 Service name or port number to connect to. Defaults to C<27017>.
8768 =item B<Timeout> I<Milliseconds>
8770 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
8771 Setting this option to zero means no timeout, which is the default.
8773 =item B<StoreRates> B<false>|B<true>
8775 If set to B<true> (the default), convert counter values to rates. If set to
8776 B<false> counter values are stored as is, i.e. as an increasing integer
8779 =item B<Database> I<Database>
8781 =item B<User> I<User>
8783 =item B<Password> I<Password>
8785 Sets the information used when authenticating to a I<MongoDB> database. The
8786 fields are optional (in which case no authentication is attempted), but if you
8787 want to use authentication all three fields must be set.
8791 =head2 Plugin C<write_prometheus>
8793 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
8794 using I<Prometheus>.
8800 =item B<Port> I<Port>
8802 Port the embedded webserver should listen on. Defaults to B<9103>.
8804 =item B<StalenessDelta> I<Seconds>
8806 Time in seconds after which I<Prometheus> considers a metric "stale" if it
8807 hasn't seen any update for it. This value must match the setting in Prometheus.
8808 It defaults to B<300> seconds (5 minutes), same as Prometheus.
8812 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
8813 which time a metric without updates is considered "stale". This setting
8814 effectively puts an upper limit on the interval in which metrics are reported.
8816 When the I<write_prometheus plugin> encounters a metric with an interval
8817 exceeding this limit, it will inform you, the user, and provide the metric to
8818 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
8819 metric "fresh" each time it is scraped, with the time of the scrape being
8820 considered the time of the update. The result is that there appear more
8821 datapoints in I<Prometheus> than were actually created, but at least the metric
8822 doesn't disappear periodically.
8826 =head2 Plugin C<write_http>
8828 This output plugin submits values to an HTTP server using POST requests and
8829 encoding metrics with JSON or using the C<PUTVAL> command described in
8830 L<collectd-unixsock(5)>.
8834 <Plugin "write_http">
8836 URL "http://example.com/post-collectd"
8843 The plugin can send values to multiple HTTP servers by specifying one
8844 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
8845 block, the following options are available:
8851 URL to which the values are submitted to. Mandatory.
8853 =item B<User> I<Username>
8855 Optional user name needed for authentication.
8857 =item B<Password> I<Password>
8859 Optional password needed for authentication.
8861 =item B<VerifyPeer> B<true>|B<false>
8863 Enable or disable peer SSL certificate verification. See
8864 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
8866 =item B<VerifyHost> B<true|false>
8868 Enable or disable peer host name verification. If enabled, the plugin checks if
8869 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
8870 matches the host name provided by the B<URL> option. If this identity check
8871 fails, the connection is aborted. Obviously, only works when connecting to a
8872 SSL enabled server. Enabled by default.
8874 =item B<CACert> I<File>
8876 File that holds one or more SSL certificates. If you want to use HTTPS you will
8877 possibly need this option. What CA certificates come bundled with C<libcurl>
8878 and are checked by default depends on the distribution you use.
8880 =item B<CAPath> I<Directory>
8882 Directory holding one or more CA certificate files. You can use this if for
8883 some reason all the needed CA certificates aren't in the same file and can't be
8884 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
8887 =item B<ClientKey> I<File>
8889 File that holds the private key in PEM format to be used for certificate-based
8892 =item B<ClientCert> I<File>
8894 File that holds the SSL certificate to be used for certificate-based
8897 =item B<ClientKeyPass> I<Password>
8899 Password required to load the private key in B<ClientKey>.
8901 =item B<Header> I<Header>
8903 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
8905 Header "X-Custom-Header: custom_value"
8907 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
8909 Define which SSL protocol version must be used. By default C<libcurl> will
8910 attempt to figure out the remote SSL protocol version. See
8911 L<curl_easy_setopt(3)> for more details.
8913 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
8915 Format of the output to generate. If set to B<Command>, will create output that
8916 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
8917 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
8918 , will create output in the KairosDB format.
8920 Defaults to B<Command>.
8922 =item B<Attribute> I<String> I<String>
8924 Only available for the KAIROSDB output format.
8926 Consider the two given strings to be the key and value of an additional tag for
8927 each metric being sent out.
8929 You can add multiple B<Attribute>.
8933 Only available for the KAIROSDB output format.
8935 Sets the Cassandra ttl for the data points.
8937 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
8939 =item B<Metrics> B<true>|B<false>
8941 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
8943 =item B<Notifications> B<false>|B<true>
8945 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
8947 =item B<StoreRates> B<true|false>
8949 If set to B<true>, convert counter values to rates. If set to B<false> (the
8950 default) counter values are stored as is, i.e. as an increasing integer number.
8952 =item B<BufferSize> I<Bytes>
8954 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
8955 requests will be generated, but more metrics will be batched / metrics are
8956 cached for longer before being sent, introducing additional delay until they
8957 are available on the server side. I<Bytes> must be at least 1024 and cannot
8958 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
8959 Defaults to C<4096>.
8961 =item B<LowSpeedLimit> I<Bytes per Second>
8963 Sets the minimal transfer rate in I<Bytes per Second> below which the
8964 connection with the HTTP server will be considered too slow and aborted. All
8965 the data submitted over this connection will probably be lost. Defaults to 0,
8966 which means no minimum transfer rate is enforced.
8968 =item B<Timeout> I<Timeout>
8970 Sets the maximum time in milliseconds given for HTTP POST operations to
8971 complete. When this limit is reached, the POST operation will be aborted, and
8972 all the data in the current send buffer will probably be lost. Defaults to 0,
8973 which means the connection never times out.
8975 =item B<LogHttpError> B<false>|B<true>
8977 Enables printing of HTTP error code to log. Turned off by default.
8979 The C<write_http> plugin regularly submits the collected values to the HTTP
8980 server. How frequently this happens depends on how much data you are collecting
8981 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
8982 slightly below this interval, which you can estimate by monitoring the network
8983 traffic between collectd and the HTTP server.
8987 =head2 Plugin C<write_kafka>
8989 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
8993 <Plugin "write_kafka">
8994 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9000 The following options are understood by the I<write_kafka plugin>:
9004 =item E<lt>B<Topic> I<Name>E<gt>
9006 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9007 is given a unique I<Name> and specifies one kafka producer.
9008 Inside the B<Topic> block, the following per-topic options are
9013 =item B<Property> I<String> I<String>
9015 Configure the named property for the current topic. Properties are
9016 forwarded to the kafka producer library B<librdkafka>.
9018 =item B<Key> I<String>
9020 Use the specified string as a partitioning key for the topic. Kafka breaks
9021 topic into partitions and guarantees that for a given topology, the same
9022 consumer will be used for a specific key. The special (case insensitive)
9023 string B<Random> can be used to specify that an arbitrary partition should
9026 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9028 Selects the format in which messages are sent to the broker. If set to
9029 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9030 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9032 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9033 an easy and straight forward exchange format.
9035 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9036 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9038 =item B<StoreRates> B<true>|B<false>
9040 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9041 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9042 default), no conversion is performed. Otherwise the conversion is performed
9043 using the internal value cache.
9045 Please note that currently this option is only used if the B<Format> option has
9046 been set to B<JSON>.
9048 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9050 A prefix can be added in the metric name when outputting in the I<Graphite>
9051 format. It's added before the I<Host> name.
9053 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>>
9055 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9057 A postfix can be added in the metric name when outputting in the I<Graphite>
9058 format. It's added after the I<Host> name.
9060 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>>
9062 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9064 Specify a character to replace dots (.) in the host part of the metric name.
9065 In I<Graphite> metric name, dots are used as separators between different
9066 metric parts (host, plugin, type).
9067 Default is C<_> (I<Underscore>).
9069 =item B<GraphiteSeparateInstances> B<false>|B<true>
9071 If set to B<true>, the plugin instance and type instance will be in their own
9072 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9073 default), the plugin and plugin instance (and likewise the type and type
9074 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9076 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9078 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9079 identifier. If set to B<false> (the default), this is only done when there is
9082 =item B<GraphitePreserveSeparator> B<false>|B<true>
9084 If set to B<false> (the default) the C<.> (dot) character is replaced with
9085 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9086 is preserved, i.e. passed through.
9088 =item B<StoreRates> B<true>|B<false>
9090 If set to B<true> (the default), convert counter values to rates. If set to
9091 B<false> counter values are stored as is, i.e. as an increasing integer number.
9093 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9094 converted values will have "rate" appended to the data source type, e.g.
9095 C<ds_type:derive:rate>.
9099 =item B<Property> I<String> I<String>
9101 Configure the kafka producer through properties, you almost always will
9102 want to set B<metadata.broker.list> to your Kafka broker list.
9106 =head2 Plugin C<write_redis>
9108 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9112 <Plugin "write_redis">
9124 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9125 the timestamp as the score. Retrieving a date range can then be done using the
9126 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9127 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9128 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9129 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9130 with the B<Database> parameter (default is C<0>). See
9131 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9134 The information shown in the synopsis above is the I<default configuration>
9135 which is used by the plugin if no configuration is present.
9137 The plugin can send values to multiple instances of I<Redis> by specifying
9138 one B<Node> block for each instance. Within the B<Node> blocks, the following
9139 options are available:
9143 =item B<Node> I<Nodename>
9145 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9146 instance running on a specified host and port. The node name is a
9147 canonical identifier which is used as I<plugin instance>. It is limited to
9148 51E<nbsp>characters in length.
9150 =item B<Host> I<Hostname>
9152 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9155 =item B<Port> I<Port>
9157 The B<Port> option is the TCP port on which the Redis instance accepts
9158 connections. Either a service name of a port number may be given. Please note
9159 that numerical port numbers must be given as a string, too.
9161 =item B<Timeout> I<Milliseconds>
9163 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9165 =item B<Prefix> I<Prefix>
9167 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9168 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9169 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9170 is recommended but not required to include a trailing slash in I<Prefix>.
9172 =item B<Database> I<Index>
9174 This index selects the redis database to use for writing operations. Defaults
9177 =item B<MaxSetSize> I<Items>
9179 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9180 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9182 =item B<StoreRates> B<true>|B<false>
9184 If set to B<true> (the default), convert counter values to rates. If set to
9185 B<false> counter values are stored as is, i.e. as an increasing integer number.
9189 =head2 Plugin C<write_riemann>
9191 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9192 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9193 I<Riemann> using UDP packets.
9197 <Plugin "write_riemann">
9203 AlwaysAppendDS false
9207 Attribute "foo" "bar"
9210 The following options are understood by the I<write_riemann plugin>:
9214 =item E<lt>B<Node> I<Name>E<gt>
9216 The plugin's configuration consists of one or more B<Node> blocks. Each block
9217 is given a unique I<Name> and specifies one connection to an instance of
9218 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9223 =item B<Host> I<Address>
9225 Hostname or address to connect to. Defaults to C<localhost>.
9227 =item B<Port> I<Service>
9229 Service name or port number to connect to. Defaults to C<5555>.
9231 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9233 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9236 =item B<TLSCertFile> I<Path>
9238 When using the B<TLS> protocol, path to a PEM certificate to present
9241 =item B<TLSCAFile> I<Path>
9243 When using the B<TLS> protocol, path to a PEM CA certificate to
9244 use to validate the remote hosts's identity.
9246 =item B<TLSKeyFile> I<Path>
9248 When using the B<TLS> protocol, path to a PEM private key associated
9249 with the certificate defined by B<TLSCertFile>.
9251 =item B<Batch> B<true>|B<false>
9253 If set to B<true> and B<Protocol> is set to B<TCP>,
9254 events will be batched in memory and flushed at
9255 regular intervals or when B<BatchMaxSize> is exceeded.
9257 Notifications are not batched and sent as soon as possible.
9259 When enabled, it can occur that events get processed by the Riemann server
9260 close to or after their expiration time. Tune the B<TTLFactor> and
9261 B<BatchMaxSize> settings according to the amount of values collected, if this
9266 =item B<BatchMaxSize> I<size>
9268 Maximum payload size for a riemann packet. Defaults to 8192
9270 =item B<BatchFlushTimeout> I<seconds>
9272 Maximum amount of seconds to wait in between to batch flushes.
9273 No timeout by default.
9275 =item B<StoreRates> B<true>|B<false>
9277 If set to B<true> (the default), convert counter values to rates. If set to
9278 B<false> counter values are stored as is, i.e. as an increasing integer number.
9280 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9281 converted values will have "rate" appended to the data source type, e.g.
9282 C<ds_type:derive:rate>.
9284 =item B<AlwaysAppendDS> B<false>|B<true>
9286 If set to B<true>, append the name of the I<Data Source> (DS) to the
9287 "service", i.e. the field that, together with the "host" field, uniquely
9288 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9289 only done when there is more than one DS.
9291 =item B<TTLFactor> I<Factor>
9293 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9294 event is considered active. I<collectd> populates this field based on the
9295 metrics interval setting. This setting controls the factor with which the
9296 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9297 know exactly what you're doing, you should only increase this setting from its
9300 =item B<Notifications> B<false>|B<true>
9302 If set to B<true>, create riemann events for notifications. This is B<true>
9303 by default. When processing thresholds from write_riemann, it might prove
9304 useful to avoid getting notification events.
9306 =item B<CheckThresholds> B<false>|B<true>
9308 If set to B<true>, attach state to events based on thresholds defined
9309 in the B<Threshold> plugin. Defaults to B<false>.
9311 =item B<EventServicePrefix> I<String>
9313 Add the given string as a prefix to the event service name.
9314 If B<EventServicePrefix> not set or set to an empty string (""),
9315 no prefix will be used.
9319 =item B<Tag> I<String>
9321 Add the given string as an additional tag to the metric being sent to
9324 =item B<Attribute> I<String> I<String>
9326 Consider the two given strings to be the key and value of an additional
9327 attribute for each metric being sent out to I<Riemann>.
9331 =head2 Plugin C<write_sensu>
9333 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9334 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9335 a local I<Sensu> client using a TCP socket.
9337 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9338 parameter so it is not possible to use one collectd instance as a gateway for
9339 others. Each collectd host must pair with one I<Sensu> client.
9343 <Plugin "write_sensu">
9348 AlwaysAppendDS false
9349 MetricHandler "influx"
9350 MetricHandler "default"
9351 NotificationHandler "flapjack"
9352 NotificationHandler "howling_monkey"
9356 Attribute "foo" "bar"
9359 The following options are understood by the I<write_sensu plugin>:
9363 =item E<lt>B<Node> I<Name>E<gt>
9365 The plugin's configuration consists of one or more B<Node> blocks. Each block
9366 is given a unique I<Name> and specifies one connection to an instance of
9367 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9372 =item B<Host> I<Address>
9374 Hostname or address to connect to. Defaults to C<localhost>.
9376 =item B<Port> I<Service>
9378 Service name or port number to connect to. Defaults to C<3030>.
9380 =item B<StoreRates> B<true>|B<false>
9382 If set to B<true> (the default), convert counter values to rates. If set to
9383 B<false> counter values are stored as is, i.e. as an increasing integer number.
9385 This will be reflected in the C<collectd_data_source_type> tag: If
9386 B<StoreRates> is enabled, converted values will have "rate" appended to the
9387 data source type, e.g. C<collectd_data_source_type:derive:rate>.
9389 =item B<AlwaysAppendDS> B<false>|B<true>
9391 If set the B<true>, append the name of the I<Data Source> (DS) to the
9392 "service", i.e. the field that, together with the "host" field, uniquely
9393 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9394 only done when there is more than one DS.
9396 =item B<Notifications> B<false>|B<true>
9398 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9399 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9401 =item B<Metrics> B<false>|B<true>
9403 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9404 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9407 =item B<Separator> I<String>
9409 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9411 =item B<MetricHandler> I<String>
9413 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9414 several of them, one per line. Defaults to no handler.
9416 =item B<NotificationHandler> I<String>
9418 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9419 add several of them, one per line. Defaults to no handler.
9421 =item B<EventServicePrefix> I<String>
9423 Add the given string as a prefix to the event service name.
9424 If B<EventServicePrefix> not set or set to an empty string (""),
9425 no prefix will be used.
9429 =item B<Tag> I<String>
9431 Add the given string as an additional tag to the metric being sent to
9434 =item B<Attribute> I<String> I<String>
9436 Consider the two given strings to be the key and value of an additional
9437 attribute for each metric being sent out to I<Sensu>.
9441 =head2 Plugin C<xencpu>
9443 This plugin collects metrics of hardware CPU load for machine running Xen
9444 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9445 Result is reported using the C<percent> type, for each CPU (core).
9447 This plugin doesn't have any options (yet).
9449 =head2 Plugin C<zookeeper>
9451 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9452 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
9457 <Plugin "zookeeper">
9464 =item B<Host> I<Address>
9466 Hostname or address to connect to. Defaults to C<localhost>.
9468 =item B<Port> I<Service>
9470 Service name or port number to connect to. Defaults to C<2181>.
9474 =head1 THRESHOLD CONFIGURATION
9476 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9477 we mean that the values are not only stored or sent somewhere, but that they
9478 are judged and, if a problem is recognized, acted upon. The only action
9479 collectd takes itself is to generate and dispatch a "notification". Plugins can
9480 register to receive notifications and perform appropriate further actions.
9482 Since systems and what you expect them to do differ a lot, you can configure
9483 B<thresholds> for your values freely. This gives you a lot of flexibility but
9484 also a lot of responsibility.
9486 Every time a value is out of range a notification is dispatched. This means
9487 that the idle percentage of your CPU needs to be less then the configured
9488 threshold only once for a notification to be generated. There's no such thing
9489 as a moving average or similar - at least not now.
9491 Also, all values that match a threshold are considered to be relevant or
9492 "interesting". As a consequence collectd will issue a notification if they are
9493 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9494 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9495 "2" (the default) and some hosts sends it's CPU statistics to the server every
9496 60 seconds, a notification will be dispatched after about 120 seconds. It may
9497 take a little longer because the timeout is checked only once each B<Interval>
9500 When a value comes within range again or is received after it was missing, an
9501 "OKAY-notification" is dispatched.
9503 Here is a configuration example to get you started. Read below for more
9516 <Plugin "interface">
9533 WarningMin 100000000
9539 There are basically two types of configuration statements: The C<Host>,
9540 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
9541 configured. The C<Plugin> and C<Type> blocks may be specified further using the
9542 C<Instance> option. You can combine the block by nesting the blocks, though
9543 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
9544 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
9545 C<Type> may not contain other blocks. If multiple blocks apply to the same
9546 value the most specific block is used.
9548 The other statements specify the threshold to configure. They B<must> be
9549 included in a C<Type> block. Currently the following statements are recognized:
9553 =item B<FailureMax> I<Value>
9555 =item B<WarningMax> I<Value>
9557 Sets the upper bound of acceptable values. If unset defaults to positive
9558 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
9559 will be created. If the value is greater than B<WarningMax> but less than (or
9560 equal to) B<FailureMax> a B<WARNING> notification will be created.
9562 =item B<FailureMin> I<Value>
9564 =item B<WarningMin> I<Value>
9566 Sets the lower bound of acceptable values. If unset defaults to negative
9567 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
9568 be created. If the value is less than B<WarningMin> but greater than (or equal
9569 to) B<FailureMin> a B<WARNING> notification will be created.
9571 =item B<DataSource> I<DSName>
9573 Some data sets have more than one "data source". Interesting examples are the
9574 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
9575 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
9576 system load data set, C<load>, even has three data sources: C<shortterm>,
9577 C<midterm>, and C<longterm>.
9579 Normally, all data sources are checked against a configured threshold. If this
9580 is undesirable, or if you want to specify different limits for each data
9581 source, you can use the B<DataSource> option to have a threshold apply only to
9584 =item B<Invert> B<true>|B<false>
9586 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
9587 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
9588 B<WarningMax>) are not okay. Defaults to B<false>.
9590 =item B<Persist> B<true>|B<false>
9592 Sets how often notifications are generated. If set to B<true> one notification
9593 will be generated for each value that is out of the acceptable range. If set to
9594 B<false> (the default) then a notification is only generated if a value is out
9595 of range but the previous value was okay.
9597 This applies to missing values, too: If set to B<true> a notification about a
9598 missing value is generated once every B<Interval> seconds. If set to B<false>
9599 only one such notification is generated until the value appears again.
9601 =item B<Percentage> B<true>|B<false>
9603 If set to B<true>, the minimum and maximum values given are interpreted as
9604 percentage value, relative to the other data sources. This is helpful for
9605 example for the "df" type, where you may want to issue a warning when less than
9606 5E<nbsp>% of the total space is available. Defaults to B<false>.
9608 =item B<Hits> I<Number>
9610 Delay creating the notification until the threshold has been passed I<Number>
9611 times. When a notification has been generated, or when a subsequent value is
9612 inside the threshold, the counter is reset. If, for example, a value is
9613 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
9614 will be dispatched at most once every 30E<nbsp>seconds.
9616 This is useful when short bursts are not a problem. If, for example, 100% CPU
9617 usage for up to a minute is normal (and data is collected every
9618 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
9620 =item B<Hysteresis> I<Number>
9622 When set to non-zero, a hysteresis value is applied when checking minimum and
9623 maximum bounds. This is useful for values that increase slowly and fluctuate a
9624 bit while doing so. When these values come close to the threshold, they may
9625 "flap", i.e. switch between failure / warning case and okay case repeatedly.
9627 If, for example, the threshold is configures as
9632 then a I<Warning> notification is created when the value exceeds I<101> and the
9633 corresponding I<Okay> notification is only created once the value falls below
9634 I<99>, thus avoiding the "flapping".
9638 =head1 FILTER CONFIGURATION
9640 Starting with collectd 4.6 there is a powerful filtering infrastructure
9641 implemented in the daemon. The concept has mostly been copied from
9642 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
9643 terminology, so that users that are familiar with iptables feel right at home.
9647 The following are the terms used in the remainder of the filter configuration
9648 documentation. For an ASCII-art schema of the mechanism, see
9649 L<"General structure"> below.
9655 A I<match> is a criteria to select specific values. Examples are, of course, the
9656 name of the value or it's current value.
9658 Matches are implemented in plugins which you have to load prior to using the
9659 match. The name of such plugins starts with the "match_" prefix.
9663 A I<target> is some action that is to be performed with data. Such actions
9664 could, for example, be to change part of the value's identifier or to ignore
9665 the value completely.
9667 Some of these targets are built into the daemon, see L<"Built-in targets">
9668 below. Other targets are implemented in plugins which you have to load prior to
9669 using the target. The name of such plugins starts with the "target_" prefix.
9673 The combination of any number of matches and at least one target is called a
9674 I<rule>. The target actions will be performed for all values for which B<all>
9675 matches apply. If the rule does not have any matches associated with it, the
9676 target action will be performed for all values.
9680 A I<chain> is a list of rules and possibly default targets. The rules are tried
9681 in order and if one matches, the associated target will be called. If a value
9682 is handled by a rule, it depends on the target whether or not any subsequent
9683 rules are considered or if traversal of the chain is aborted, see
9684 L<"Flow control"> below. After all rules have been checked, the default targets
9689 =head2 General structure
9691 The following shows the resulting structure:
9698 +---------+ +---------+ +---------+ +---------+
9699 ! Rule !->! Match !->! Match !->! Target !
9700 +---------+ +---------+ +---------+ +---------+
9703 +---------+ +---------+ +---------+
9704 ! Rule !->! Target !->! Target !
9705 +---------+ +---------+ +---------+
9712 +---------+ +---------+ +---------+
9713 ! Rule !->! Match !->! Target !
9714 +---------+ +---------+ +---------+
9724 There are four ways to control which way a value takes through the filter
9731 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
9732 process the value with another chain. When the called chain finishes, usually
9733 the next target or rule after the jump is executed.
9737 The stop condition, signaled for example by the built-in target B<stop>, causes
9738 all processing of the value to be stopped immediately.
9742 Causes processing in the current chain to be aborted, but processing of the
9743 value generally will continue. This means that if the chain was called via
9744 B<Jump>, the next target or rule after the jump will be executed. If the chain
9745 was not called by another chain, control will be returned to the daemon and it
9746 may pass the value to another chain.
9750 Most targets will signal the B<continue> condition, meaning that processing
9751 should continue normally. There is no special built-in target for this
9758 The configuration reflects this structure directly:
9760 PostCacheChain "PostCache"
9762 <Rule "ignore_mysql_show">
9765 Type "^mysql_command$"
9766 TypeInstance "^show_"
9776 The above configuration example will ignore all values where the plugin field
9777 is "mysql", the type is "mysql_command" and the type instance begins with
9778 "show_". All other values will be sent to the C<rrdtool> write plugin via the
9779 default target of the chain. Since this chain is run after the value has been
9780 added to the cache, the MySQL C<show_*> command statistics will be available
9781 via the C<unixsock> plugin.
9783 =head2 List of configuration options
9787 =item B<PreCacheChain> I<ChainName>
9789 =item B<PostCacheChain> I<ChainName>
9791 Configure the name of the "pre-cache chain" and the "post-cache chain". The
9792 argument is the name of a I<chain> that should be executed before and/or after
9793 the values have been added to the cache.
9795 To understand the implications, it's important you know what is going on inside
9796 I<collectd>. The following diagram shows how values are passed from the
9797 read-plugins to the write-plugins:
9803 + - - - - V - - - - +
9804 : +---------------+ :
9807 : +-------+-------+ :
9810 : +-------+-------+ : +---------------+
9811 : ! Cache !--->! Value Cache !
9812 : ! insert ! : +---+---+-------+
9813 : +-------+-------+ : ! !
9814 : ! ,------------' !
9816 : +-------+---+---+ : +-------+-------+
9817 : ! Post-Cache +--->! Write-Plugins !
9818 : ! Chain ! : +---------------+
9819 : +---------------+ :
9822 + - - - - - - - - - +
9824 After the values are passed from the "read" plugins to the dispatch functions,
9825 the pre-cache chain is run first. The values are added to the internal cache
9826 afterwards. The post-cache chain is run after the values have been added to the
9827 cache. So why is it such a huge deal if chains are run before or after the
9828 values have been added to this cache?
9830 Targets that change the identifier of a value list should be executed before
9831 the values are added to the cache, so that the name in the cache matches the
9832 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
9833 this cache to receive a list of all available values. If you change the
9834 identifier after the value list has been added to the cache, this may easily
9835 lead to confusion, but it's not forbidden of course.
9837 The cache is also used to convert counter values to rates. These rates are, for
9838 example, used by the C<value> match (see below). If you use the rate stored in
9839 the cache B<before> the new value is added, you will use the old, B<previous>
9840 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
9841 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
9844 Last but not last, the B<stop> target makes a difference: If the pre-cache
9845 chain returns the stop condition, the value will not be added to the cache and
9846 the post-cache chain will not be run.
9848 =item B<Chain> I<Name>
9850 Adds a new chain with a certain name. This name can be used to refer to a
9851 specific chain, for example to jump to it.
9853 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
9855 =item B<Rule> [I<Name>]
9857 Adds a new rule to the current chain. The name of the rule is optional and
9858 currently has no meaning for the daemon.
9860 Within the B<Rule> block, there may be any number of B<Match> blocks and there
9861 must be at least one B<Target> block.
9863 =item B<Match> I<Name>
9865 Adds a match to a B<Rule> block. The name specifies what kind of match should
9866 be performed. Available matches depend on the plugins that have been loaded.
9868 The arguments inside the B<Match> block are passed to the plugin implementing
9869 the match, so which arguments are valid here depends on the plugin being used.
9870 If you do not need any to pass any arguments to a match, you can use the
9875 Which is equivalent to:
9880 =item B<Target> I<Name>
9882 Add a target to a rule or a default target to a chain. The name specifies what
9883 kind of target is to be added. Which targets are available depends on the
9884 plugins being loaded.
9886 The arguments inside the B<Target> block are passed to the plugin implementing
9887 the target, so which arguments are valid here depends on the plugin being used.
9888 If you do not need any to pass any arguments to a target, you can use the
9893 This is the same as writing:
9900 =head2 Built-in targets
9902 The following targets are built into the core daemon and therefore need no
9903 plugins to be loaded:
9909 Signals the "return" condition, see the L<"Flow control"> section above. This
9910 causes the current chain to stop processing the value and returns control to
9911 the calling chain. The calling chain will continue processing targets and rules
9912 just after the B<jump> target (see below). This is very similar to the
9913 B<RETURN> target of iptables, see L<iptables(8)>.
9915 This target does not have any options.
9923 Signals the "stop" condition, see the L<"Flow control"> section above. This
9924 causes processing of the value to be aborted immediately. This is similar to
9925 the B<DROP> target of iptables, see L<iptables(8)>.
9927 This target does not have any options.
9935 Sends the value to "write" plugins.
9941 =item B<Plugin> I<Name>
9943 Name of the write plugin to which the data should be sent. This option may be
9944 given multiple times to send the data to more than one write plugin. If the
9945 plugin supports multiple instances, the plugin's instance(s) must also be
9950 If no plugin is explicitly specified, the values will be sent to all available
9953 Single-instance plugin example:
9959 Multi-instance plugin example:
9961 <Plugin "write_graphite">
9971 Plugin "write_graphite/foo"
9976 Starts processing the rules of another chain, see L<"Flow control"> above. If
9977 the end of that chain is reached, or a stop condition is encountered,
9978 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
9979 next target or the next rule. This is similar to the B<-j> command line option
9980 of iptables, see L<iptables(8)>.
9986 =item B<Chain> I<Name>
9988 Jumps to the chain I<Name>. This argument is required and may appear only once.
10000 =head2 Available matches
10006 Matches a value using regular expressions.
10012 =item B<Host> I<Regex>
10014 =item B<Plugin> I<Regex>
10016 =item B<PluginInstance> I<Regex>
10018 =item B<Type> I<Regex>
10020 =item B<TypeInstance> I<Regex>
10022 =item B<MetaData> I<String> I<Regex>
10024 Match values where the given regular expressions match the various fields of
10025 the identifier of a value. If multiple regular expressions are given, B<all>
10026 regexen must match for a value to match.
10028 =item B<Invert> B<false>|B<true>
10030 When set to B<true>, the result of the match is inverted, i.e. all value lists
10031 where all regular expressions apply are not matched, all other value lists are
10032 matched. Defaults to B<false>.
10039 Host "customer[0-9]+"
10045 Matches values that have a time which differs from the time on the server.
10047 This match is mainly intended for servers that receive values over the
10048 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10049 is very sensitive to the timestamp used when updating the RRD files. In
10050 particular, the time must be ever increasing. If a misbehaving client sends one
10051 packet with a timestamp far in the future, all further packets with a correct
10052 time will be ignored because of that one packet. What's worse, such corrupted
10053 RRD files are hard to fix.
10055 This match lets one match all values B<outside> a specified time range
10056 (relative to the server's time), so you can use the B<stop> target (see below)
10057 to ignore the value, for example.
10063 =item B<Future> I<Seconds>
10065 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10066 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10069 =item B<Past> I<Seconds>
10071 Matches all values that are I<behind> of the server's time by I<Seconds> or
10072 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10084 This example matches all values that are five minutes or more ahead of the
10085 server or one hour (or more) lagging behind.
10089 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10090 values. If a data-set consists of more than one data-source, all data-sources
10091 must match the specified ranges for a positive match.
10097 =item B<Min> I<Value>
10099 Sets the smallest value which still results in a match. If unset, behaves like
10102 =item B<Max> I<Value>
10104 Sets the largest value which still results in a match. If unset, behaves like
10107 =item B<Invert> B<true>|B<false>
10109 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10110 no-match is returned and vice versa. Please note that the B<Invert> setting
10111 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10112 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10114 =item B<DataSource> I<DSName> [I<DSName> ...]
10116 Select one or more of the data sources. If no data source is configured, all
10117 data sources will be checked. If the type handled by the match does not have a
10118 data source of the specified name(s), this will always result in no match
10119 (independent of the B<Invert> setting).
10121 =item B<Satisfy> B<Any>|B<All>
10123 Specifies how checking with several data sources is performed. If set to
10124 B<Any>, the match succeeds if one of the data sources is in the configured
10125 range. If set to B<All> the match only succeeds if all data sources are within
10126 the configured range. Default is B<All>.
10128 Usually B<All> is used for positive matches, B<Any> is used for negative
10129 matches. This means that with B<All> you usually check that all values are in a
10130 "good" range, while with B<Any> you check if any value is within a "bad" range
10131 (or outside the "good" range).
10135 Either B<Min> or B<Max>, but not both, may be unset.
10139 # Match all values smaller than or equal to 100. Matches only if all data
10140 # sources are below 100.
10146 # Match if the value of any data source is outside the range of 0 - 100.
10154 =item B<empty_counter>
10156 Matches all values with one or more data sources of type B<COUNTER> and where
10157 all counter values are zero. These counters usually I<never> increased since
10158 they started existing (and are therefore uninteresting), or got reset recently
10159 or overflowed and you had really, I<really> bad luck.
10161 Please keep in mind that ignoring such counters can result in confusing
10162 behavior: Counters which hardly ever increase will be zero for long periods of
10163 time. If the counter is reset for some reason (machine or service restarted,
10164 usually), the graph will be empty (NAN) for a long time. People may not
10169 Calculates a hash value of the host name and matches values according to that
10170 hash value. This makes it possible to divide all hosts into groups and match
10171 only values that are in a specific group. The intended use is in load
10172 balancing, where you want to handle only part of all data and leave the rest
10175 The hashing function used tries to distribute the hosts evenly. First, it
10176 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10179 for (i = 0; host[i] != 0; i++)
10180 hash_value = (hash_value * 251) + host[i];
10182 The constant 251 is a prime number which is supposed to make this hash value
10183 more random. The code then checks the group for this host according to the
10184 I<Total> and I<Match> arguments:
10186 if ((hash_value % Total) == Match)
10191 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10192 groups), then the least significant bit of the hash value will be the XOR of
10193 all least significant bits in the host name. One consequence is that when you
10194 have two hosts, "server0.example.com" and "server1.example.com", where the host
10195 name differs in one digit only and the digits differ by one, those hosts will
10196 never end up in the same group.
10202 =item B<Match> I<Match> I<Total>
10204 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10205 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10206 be smaller than I<Total>. I<Total> must be at least one, although only values
10207 greater than one really do make any sense.
10209 You can repeat this option to match multiple groups, for example:
10214 The above config will divide the data into seven groups and match groups three
10215 and five. One use would be to keep every value on two hosts so that if one
10216 fails the missing data can later be reconstructed from the second host.
10222 # Operate on the pre-cache chain, so that ignored values are not even in the
10227 # Divide all received hosts in seven groups and accept all hosts in
10231 # If matched: Return and continue.
10234 # If not matched: Return and stop.
10240 =head2 Available targets
10244 =item B<notification>
10246 Creates and dispatches a notification.
10252 =item B<Message> I<String>
10254 This required option sets the message of the notification. The following
10255 placeholders will be replaced by an appropriate value:
10263 =item B<%{plugin_instance}>
10267 =item B<%{type_instance}>
10269 These placeholders are replaced by the identifier field of the same name.
10271 =item B<%{ds:>I<name>B<}>
10273 These placeholders are replaced by a (hopefully) human readable representation
10274 of the current rate of this data source. If you changed the instance name
10275 (using the B<set> or B<replace> targets, see below), it may not be possible to
10276 convert counter values to rates.
10280 Please note that these placeholders are B<case sensitive>!
10282 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10284 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10291 <Target "notification">
10292 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10298 Replaces parts of the identifier using regular expressions.
10304 =item B<Host> I<Regex> I<Replacement>
10306 =item B<Plugin> I<Regex> I<Replacement>
10308 =item B<PluginInstance> I<Regex> I<Replacement>
10310 =item B<TypeInstance> I<Regex> I<Replacement>
10312 =item B<MetaData> I<String> I<Regex> I<Replacement>
10314 =item B<DeleteMetaData> I<String> I<Regex>
10316 Match the appropriate field with the given regular expression I<Regex>. If the
10317 regular expression matches, that part that matches is replaced with
10318 I<Replacement>. If multiple places of the input buffer match a given regular
10319 expression, only the first occurrence will be replaced.
10321 You can specify each option multiple times to use multiple regular expressions
10329 # Replace "example.net" with "example.com"
10330 Host "\\<example.net\\>" "example.com"
10332 # Strip "www." from hostnames
10333 Host "\\<www\\." ""
10338 Sets part of the identifier of a value to a given string.
10344 =item B<Host> I<String>
10346 =item B<Plugin> I<String>
10348 =item B<PluginInstance> I<String>
10350 =item B<TypeInstance> I<String>
10352 =item B<MetaData> I<String> I<String>
10354 Set the appropriate field to the given string. The strings for plugin instance,
10355 type instance, and meta data may be empty, the strings for host and plugin may
10356 not be empty. It's currently not possible to set the type of a value this way.
10358 The following placeholders will be replaced by an appropriate value:
10366 =item B<%{plugin_instance}>
10370 =item B<%{type_instance}>
10372 These placeholders are replaced by the identifier field of the same name.
10374 =item B<%{meta:>I<name>B<}>
10376 These placeholders are replaced by the meta data value with the given name.
10380 Please note that these placeholders are B<case sensitive>!
10382 =item B<DeleteMetaData> I<String>
10384 Delete the named meta data field.
10391 PluginInstance "coretemp"
10392 TypeInstance "core3"
10397 =head2 Backwards compatibility
10399 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10400 B<Chain> block, it will behave as it used to. This is equivalent to the
10401 following configuration:
10403 <Chain "PostCache">
10407 If you specify a B<PostCacheChain>, the B<write> target will not be added
10408 anywhere and you will have to make sure that it is called where appropriate. We
10409 suggest to add the above snippet as default target to your "PostCache" chain.
10413 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10428 B<Ignorelists> are a generic framework to either ignore some metrics or report
10429 specific metircs only. Plugins usually provide one or more options to specify
10430 the items (mounts points, devices, ...) and the boolean option
10435 =item B<Select> I<String>
10437 Selects the item I<String>. This option often has a plugin specific name, e.g.
10438 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10439 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10440 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10442 By default, this option is doing a case-sensitive full-string match. The
10443 following config will match C<foo>, but not C<Foo>:
10447 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10448 I<regular expression>. For example, so match all item starting with C<foo>, use
10449 could use the following syntax:
10453 The regular expression is I<not> anchored, i.e. the following config will match
10454 C<foobar>, C<barfoo> and C<AfooZ>:
10458 The B<Select> option may be repeated to select multiple items.
10460 =item B<IgnoreSelected> B<true>|B<false>
10462 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10463 collected. If set to B<false>, matching metrics are I<collected> and all other
10464 metrics are ignored.
10471 L<collectd-exec(5)>,
10472 L<collectd-perl(5)>,
10473 L<collectd-unixsock(5)>,
10486 Florian Forster E<lt>octo@collectd.orgE<gt>