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">
2022 DriverOption "host" "localhost"
2023 DriverOption "username" "collectd"
2024 DriverOption "password" "aZo6daiw"
2025 DriverOption "dbname" "prod_info"
2026 SelectDB "prod_info"
2027 Query "out_of_stock"
2031 The configuration above defines one query with one result and one database. The
2032 query is then linked to the database with the B<Query> option I<within> the
2033 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2034 and you can also use the B<Include> statement to split up the configuration
2035 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2036 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2039 The following is a complete list of options:
2041 =head3 B<Query> blocks
2043 Query blocks define I<SQL> statements and how the returned data should be
2044 interpreted. They are identified by the name that is given in the opening line
2045 of the block. Thus the name needs to be unique. Other than that, the name is
2046 not used in collectd.
2048 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2049 define which column holds which value or instance information. You can use
2050 multiple B<Result> blocks to create multiple values from one returned row. This
2051 is especially useful, when queries take a long time and sending almost the same
2052 query again and again is not desirable.
2056 <Query "environment">
2057 Statement "select station, temperature, humidity from environment"
2060 # InstancePrefix "foo"
2061 InstancesFrom "station"
2062 ValuesFrom "temperature"
2066 InstancesFrom "station"
2067 ValuesFrom "humidity"
2071 The following options are accepted:
2075 =item B<Statement> I<SQL>
2077 Sets the statement that should be executed on the server. This is B<not>
2078 interpreted by collectd, but simply passed to the database server. Therefore,
2079 the SQL dialect that's used depends on the server collectd is connected to.
2081 The query has to return at least two columns, one for the instance and one
2082 value. You cannot omit the instance, even if the statement is guaranteed to
2083 always return exactly one line. In that case, you can usually specify something
2086 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2088 (That works with MySQL but may not be valid SQL according to the spec. If you
2089 use a more strict database server, you may have to select from a dummy table or
2092 Please note that some databases, for example B<Oracle>, will fail if you
2093 include a semicolon at the end of the statement.
2095 =item B<MinVersion> I<Version>
2097 =item B<MaxVersion> I<Value>
2099 Only use this query for the specified database version. You can use these
2100 options to provide multiple queries with the same name but with a slightly
2101 different syntax. The plugin will use only those queries, where the specified
2102 minimum and maximum versions fit the version of the database in use.
2104 The database version is determined by C<dbi_conn_get_engine_version>, see the
2105 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2106 for details. Basically, each part of the version is assumed to be in the range
2107 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2108 "40102", version "5.0.42" becomes "50042".
2110 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2111 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2112 happen. Don't to it! A valid example would be something along these lines:
2123 In the above example, there are three ranges that don't overlap. The last one
2124 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2125 before "4.0.0" are not specified.
2127 =item B<Type> I<Type>
2129 The B<type> that's used for each line returned. See L<types.db(5)> for more
2130 details on how types are defined. In short: A type is a predefined layout of
2131 data and the number of values and type of values has to match the type
2134 If you specify "temperature" here, you need exactly one gauge column. If you
2135 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2138 There must be exactly one B<Type> option inside each B<Result> block.
2140 =item B<InstancePrefix> I<prefix>
2142 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2143 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2144 all strings returned in the appropriate columns are concatenated together,
2145 separated by dashes I<("-")>.
2147 =item B<InstancesFrom> I<column0> [I<column1> ...]
2149 Specifies the columns whose values will be used to create the "type-instance"
2150 for each row. If you specify more than one column, the value of all columns
2151 will be joined together with dashes I<("-")> as separation characters.
2153 The plugin itself does not check whether or not all built instances are
2154 different. It's your responsibility to assure that each is unique. This is
2155 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2156 sure that only one row is returned in this case.
2158 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2161 =item B<ValuesFrom> I<column0> [I<column1> ...]
2163 Names the columns whose content is used as the actual data for the data sets
2164 that are dispatched to the daemon. How many such columns you need is determined
2165 by the B<Type> setting above. If you specify too many or not enough columns,
2166 the plugin will complain about that and no data will be submitted to the
2169 The actual data type in the columns is not that important. The plugin will
2170 automatically cast the values to the right type if it know how to do that. So
2171 it should be able to handle integer an floating point types, as well as strings
2172 (if they include a number at the beginning).
2174 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2176 =item B<MetadataFrom> [I<column0> I<column1> ...]
2178 Names the columns whose content is used as metadata for the data sets
2179 that are dispatched to the daemon.
2181 The actual data type in the columns is not that important. The plugin will
2182 automatically cast the values to the right type if it know how to do that. So
2183 it should be able to handle integer an floating point types, as well as strings
2184 (if they include a number at the beginning).
2188 =head3 B<Database> blocks
2190 Database blocks define a connection to a database and which queries should be
2191 sent to that database. Since the used "dbi" library can handle a wide variety
2192 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2193 documentationE<nbsp>- we stick as close to the terminology used there.
2195 Each database needs a "name" as string argument in the starting tag of the
2196 block. This name will be used as "PluginInstance" in the values submitted to
2197 the daemon. Other than that, that name is not used.
2201 =item B<Interval> I<Interval>
2203 Sets the interval (in seconds) in which the values will be collected from this
2204 database. By default the global B<Interval> setting will be used.
2206 =item B<Driver> I<Driver>
2208 Specifies the driver to use to connect to the database. In many cases those
2209 drivers are named after the database they can connect to, but this is not a
2210 technical necessity. These drivers are sometimes referred to as "DBD",
2211 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2212 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2213 project at L<http://libdbi-drivers.sourceforge.net/>.
2215 You need to give the driver name as expected by the "dbi" library here. You
2216 should be able to find that in the documentation for each driver. If you
2217 mistype the driver name, the plugin will dump a list of all known driver names
2220 =item B<DriverOption> I<Key> I<Value>
2222 Sets driver-specific options. What option a driver supports can be found in the
2223 documentation for each driver, somewhere at
2224 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2225 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2227 DBDs can register two types of options: String options and numeric options. The
2228 plugin will use the C<dbi_conn_set_option> function when the configuration
2229 provides a string and the C<dbi_conn_require_option_numeric> function when the
2230 configuration provides a number. So these two lines will actually result in
2231 different calls being used:
2233 DriverOption "Port" 1234 # numeric
2234 DriverOption "Port" "1234" # string
2236 Unfortunately, drivers are not too keen to report errors when an unknown option
2237 is passed to them, so invalid settings here may go unnoticed. This is not the
2238 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2239 the driver. If a driver complains about an option, the plugin will dump a
2240 complete list of all options understood by that driver to the log. There is no
2241 way to programmatically find out if an option expects a string or a numeric
2242 argument, so you will have to refer to the appropriate DBD's documentation to
2243 find this out. Sorry.
2245 =item B<SelectDB> I<Database>
2247 In some cases, the database name you connect with is not the database name you
2248 want to use for querying data. If this option is set, the plugin will "select"
2249 (switch to) that database after the connection is established.
2251 =item B<Query> I<QueryName>
2253 Associates the query named I<QueryName> with this database connection. The
2254 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2255 blocks you want to refer to must be placed above the database block you want to
2258 =item B<Host> I<Hostname>
2260 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2261 values. Defaults to the global hostname setting.
2269 =item B<Device> I<Device>
2271 Select partitions based on the devicename.
2273 See F</"IGNORELISTS"> for details.
2275 =item B<MountPoint> I<Directory>
2277 Select partitions based on the mountpoint.
2279 See F</"IGNORELISTS"> for details.
2281 =item B<FSType> I<FSType>
2283 Select partitions based on the filesystem type.
2285 See F</"IGNORELISTS"> for details.
2287 =item B<IgnoreSelected> B<true>|B<false>
2289 Invert the selection: If set to true, all partitions B<except> the ones that
2290 match any one of the criteria are collected. By default only selected
2291 partitions are collected if a selection is made. If no selection is configured
2292 at all, B<all> partitions are selected.
2294 =item B<ReportByDevice> B<true>|B<false>
2296 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2297 (the default), it will report a disk as "root", but with it I<true>, it will be
2298 "sda1" (or whichever).
2300 =item B<ReportInodes> B<true>|B<false>
2302 Enables or disables reporting of free, reserved and used inodes. Defaults to
2303 inode collection being disabled.
2305 Enable this option if inodes are a scarce resource for you, usually because
2306 many small files are stored on the disk. This is a usual scenario for mail
2307 transfer agents and web caches.
2309 =item B<ValuesAbsolute> B<true>|B<false>
2311 Enables or disables reporting of free and used disk space in 1K-blocks.
2312 Defaults to B<true>.
2314 =item B<ValuesPercentage> B<false>|B<true>
2316 Enables or disables reporting of free and used disk space in percentage.
2317 Defaults to B<false>.
2319 This is useful for deploying I<collectd> on the cloud, where machines with
2320 different disk size may exist. Then it is more practical to configure
2321 thresholds based on relative disk size.
2325 =head2 Plugin C<disk>
2327 The C<disk> plugin collects information about the usage of physical disks and
2328 logical disks (partitions). Values collected are the number of octets written
2329 to and read from a disk or partition, the number of read/write operations
2330 issued to the disk and a rather complex "time" it took for these commands to be
2333 Using the following two options you can ignore some disks or configure the
2334 collection only of specific disks.
2338 =item B<Disk> I<Name>
2340 Select the disk I<Name>. Whether it is collected or ignored depends on the
2341 B<IgnoreSelected> setting, see below. As with other plugins that use the
2342 daemon's ignorelist functionality, a string that starts and ends with a slash
2343 is interpreted as a regular expression. Examples:
2348 See F</"IGNORELISTS"> for details.
2350 =item B<IgnoreSelected> B<true>|B<false>
2352 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2353 statements, are ignored or if all other disks are ignored. The behavior
2354 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2355 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2356 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2357 is set to B<true>, all disks are collected B<except> the ones matched.
2359 =item B<UseBSDName> B<true>|B<false>
2361 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2362 default major/minor numbers. Requires collectd to be built with Apple's
2365 =item B<UdevNameAttr> I<Attribute>
2367 Attempt to override disk instance name with the value of a specified udev
2368 attribute when built with B<libudev>. If the attribute is not defined for the
2369 given device, the default name is used. Example:
2371 UdevNameAttr "DM_NAME"
2375 =head2 Plugin C<dns>
2379 =item B<Interface> I<Interface>
2381 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2382 option sets the interface that should be used. If this option is not set, or
2383 set to "any", the plugin will try to get packets from B<all> interfaces. This
2384 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2386 =item B<IgnoreSource> I<IP-address>
2388 Ignore packets that originate from this address.
2390 =item B<SelectNumericQueryTypes> B<true>|B<false>
2392 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2396 =head2 Plugin C<dpdkevents>
2398 The I<dpdkevents plugin> collects events from DPDK such as link status of
2399 network ports and Keep Alive status of DPDK logical cores.
2400 In order to get Keep Alive events following requirements must be met:
2402 - support for Keep Alive implemented in DPDK application. More details can
2403 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2407 <Plugin "dpdkevents">
2413 <Event "link_status">
2414 SendEventsOnUpdate true
2415 EnabledPortMask 0xffff
2416 PortName "interface1"
2417 PortName "interface2"
2418 SendNotification false
2420 <Event "keep_alive">
2421 SendEventsOnUpdate true
2423 KeepAliveShmName "/dpdk_keepalive_shm_name"
2424 SendNotification false
2431 =head3 The EAL block
2435 =item B<Coremask> I<Mask>
2437 =item B<Memorychannels> I<Channels>
2439 Number of memory channels per processor socket.
2441 =item B<FilePrefix> I<File>
2443 The prefix text used for hugepage filenames. The filename will be set to
2444 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2448 =head3 The Event block
2450 The B<Event> block defines configuration for specific event. It accepts a
2451 single argument which specifies the name of the event.
2453 =head4 Link Status event
2457 =item B<SendEventOnUpdate> I<true|false>
2459 If set to true link status value will be dispatched only when it is
2460 different from previously read value. This is an optional argument - default
2463 =item B<EnabledPortMask> I<Mask>
2465 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2466 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2467 that all ports will be enabled. This is an optional argument - by default
2468 all ports are enabled.
2470 =item B<PortName> I<Name>
2472 A string containing an optional name for the enabled DPDK ports. Each PortName
2473 option should contain only one port name; specify as many PortName options as
2474 desired. Default naming convention will be used if PortName is blank. If there
2475 are less PortName options than there are enabled ports, the default naming
2476 convention will be used for the additional ports.
2478 =item B<SendNotification> I<true|false>
2480 If set to true, link status notifications are sent, instead of link status
2481 being collected as a statistic. This is an optional argument - default
2486 =head4 Keep Alive event
2490 =item B<SendEventOnUpdate> I<true|false>
2492 If set to true keep alive value will be dispatched only when it is
2493 different from previously read value. This is an optional argument - default
2496 =item B<LCoreMask> I<Mask>
2498 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2500 =item B<KeepAliveShmName> I<Name>
2502 Shared memory name identifier that is used by secondary process to monitor
2503 the keep alive cores state.
2505 =item B<SendNotification> I<true|false>
2507 If set to true, keep alive notifications are sent, instead of keep alive
2508 information being collected as a statistic. This is an optional
2509 argument - default value is false.
2513 =head2 Plugin C<dpdkstat>
2515 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2516 extended NIC stats API in DPDK.
2527 SharedMemObj "dpdk_collectd_stats_0"
2528 EnabledPortMask 0xffff
2529 PortName "interface1"
2530 PortName "interface2"
2535 =head3 The EAL block
2539 =item B<Coremask> I<Mask>
2541 A string containing an hexadecimal bit mask of the cores to run on. Note that
2542 core numbering can change between platforms and should be determined beforehand.
2544 =item B<Memorychannels> I<Channels>
2546 A string containing a number of memory channels per processor socket.
2548 =item B<FilePrefix> I<File>
2550 The prefix text used for hugepage filenames. The filename will be set to
2551 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2553 =item B<SocketMemory> I<MB>
2555 A string containing amount of Memory to allocate from hugepages on specific
2556 sockets in MB. This is an optional value.
2562 =item B<SharedMemObj> I<Mask>
2564 A string containing the name of the shared memory object that should be used to
2565 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2566 Defaults to dpdk_collectd_stats if no other value is configured.
2568 =item B<EnabledPortMask> I<Mask>
2570 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2571 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2572 that all ports will be enabled. This is an optional argument - default
2573 is all ports enabled.
2575 =item B<PortName> I<Name>
2577 A string containing an optional name for the enabled DPDK ports. Each PortName
2578 option should contain only one port name; specify as many PortName options as
2579 desired. Default naming convention will be used if PortName is blank. If there
2580 are less PortName options than there are enabled ports, the default naming
2581 convention will be used for the additional ports.
2585 =head2 Plugin C<email>
2589 =item B<SocketFile> I<Path>
2591 Sets the socket-file which is to be created.
2593 =item B<SocketGroup> I<Group>
2595 If running as root change the group of the UNIX-socket after it has been
2596 created. Defaults to B<collectd>.
2598 =item B<SocketPerms> I<Permissions>
2600 Change the file permissions of the UNIX-socket after it has been created. The
2601 permissions must be given as a numeric, octal value as you would pass to
2602 L<chmod(1)>. Defaults to B<0770>.
2604 =item B<MaxConns> I<Number>
2606 Sets the maximum number of connections that can be handled in parallel. Since
2607 this many threads will be started immediately setting this to a very high
2608 value will waste valuable resources. Defaults to B<5> and will be forced to be
2609 at most B<16384> to prevent typos and dumb mistakes.
2613 =head2 Plugin C<ethstat>
2615 The I<ethstat plugin> collects information about network interface cards (NICs)
2616 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2622 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2623 Map "multicast" "if_multicast"
2630 =item B<Interface> I<Name>
2632 Collect statistical information about interface I<Name>.
2634 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2636 By default, the plugin will submit values as type C<derive> and I<type
2637 instance> set to I<Name>, the name of the metric as reported by the driver. If
2638 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2639 I<TypeInstance> will be used.
2641 =item B<MappedOnly> B<true>|B<false>
2643 When set to B<true>, only metrics that can be mapped to a I<type> will be
2644 collected, all other metrics will be ignored. Defaults to B<false>.
2648 =head2 Plugin C<exec>
2650 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2651 contains valuable information on when the executable is executed and the
2652 output that is expected from it.
2656 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2658 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2660 Execute the executable I<Executable> as user I<User>. If the user name is
2661 followed by a colon and a group name, the effective group is set to that group.
2662 The real group and saved-set group will be set to the default group of that
2663 user. If no group is given the effective group ID will be the same as the real
2666 Please note that in order to change the user and/or group the daemon needs
2667 superuser privileges. If the daemon is run as an unprivileged user you must
2668 specify the same user/group here. If the daemon is run with superuser
2669 privileges, you must supply a non-root user here.
2671 The executable may be followed by optional arguments that are passed to the
2672 program. Please note that due to the configuration parsing numbers and boolean
2673 values may be changed. If you want to be absolutely sure that something is
2674 passed as-is please enclose it in quotes.
2676 The B<Exec> and B<NotificationExec> statements change the semantics of the
2677 programs executed, i.E<nbsp>e. the data passed to them and the response
2678 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2682 =head2 Plugin C<fhcount>
2684 The C<fhcount> plugin provides statistics about used, unused and total number of
2685 file handles on Linux.
2687 The I<fhcount plugin> provides the following configuration options:
2691 =item B<ValuesAbsolute> B<true>|B<false>
2693 Enables or disables reporting of file handles usage in absolute numbers,
2694 e.g. file handles used. Defaults to B<true>.
2696 =item B<ValuesPercentage> B<false>|B<true>
2698 Enables or disables reporting of file handles usage in percentages, e.g.
2699 percent of file handles used. Defaults to B<false>.
2703 =head2 Plugin C<filecount>
2705 The C<filecount> plugin counts the number of files in a certain directory (and
2706 its subdirectories) and their combined size. The configuration is very straight
2709 <Plugin "filecount">
2710 <Directory "/var/qmail/queue/mess">
2711 Instance "qmail-message"
2713 <Directory "/var/qmail/queue/todo">
2714 Instance "qmail-todo"
2716 <Directory "/var/lib/php5">
2717 Instance "php5-sessions"
2722 The example above counts the number of files in QMail's queue directories and
2723 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2724 QMail has not yet looked at, the "message" queue holds the messages that were
2725 classified into "local" and "remote".
2727 As you can see, the configuration consists of one or more C<Directory> blocks,
2728 each of which specifies a directory in which to count the files. Within those
2729 blocks, the following options are recognized:
2733 =item B<Instance> I<Instance>
2735 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2736 it's your responsibility, the plugin doesn't check for that. If not given, the
2737 instance is set to the directory name with all slashes replaced by underscores
2738 and all leading underscores removed.
2740 =item B<Name> I<Pattern>
2742 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2743 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2744 against the pattern, not the entire path. In case this makes it easier for you:
2745 This option has been named after the B<-name> parameter to L<find(1)>.
2747 =item B<MTime> I<Age>
2749 Count only files of a specific age: If I<Age> is greater than zero, only files
2750 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2751 a negative number, this is inversed. For example, if B<-60> is specified, only
2752 files that have been modified in the last minute will be counted.
2754 The number can also be followed by a "multiplier" to easily specify a larger
2755 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2756 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2757 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2758 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2759 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2762 =item B<Size> I<Size>
2764 Count only files of a specific size. When I<Size> is a positive number, only
2765 files that are at least this big are counted. If I<Size> is a negative number,
2766 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2767 I<Size> are counted.
2769 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2770 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2771 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2772 note that there are 1000 bytes in a kilobyte, not 1024.
2774 =item B<Recursive> I<true>|I<false>
2776 Controls whether or not to recurse into subdirectories. Enabled by default.
2778 =item B<IncludeHidden> I<true>|I<false>
2780 Controls whether or not to include "hidden" files and directories in the count.
2781 "Hidden" files and directories are those, whose name begins with a dot.
2782 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2786 =head2 Plugin C<GenericJMX>
2788 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2789 L<collectd-java(5)>.
2791 =head2 Plugin C<gmond>
2793 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2794 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2795 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2800 MCReceiveFrom "239.2.11.71" "8649"
2801 <Metric "swap_total">
2803 TypeInstance "total"
2806 <Metric "swap_free">
2813 The following metrics are built-in:
2819 load_one, load_five, load_fifteen
2823 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2827 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2839 Available configuration options:
2843 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2845 Sets sets the multicast group and UDP port to which to subscribe.
2847 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2849 =item E<lt>B<Metric> I<Name>E<gt>
2851 These blocks add a new metric conversion to the internal table. I<Name>, the
2852 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2856 =item B<Type> I<Type>
2858 Type to map this metric to. Required.
2860 =item B<TypeInstance> I<Instance>
2862 Type-instance to use. Optional.
2864 =item B<DataSource> I<Name>
2866 Data source to map this metric to. If the configured type has exactly one data
2867 source, this is optional. Otherwise the option is required.
2873 =head2 Plugin C<gps>
2875 The C<gps plugin> connects to gpsd on the host machine.
2876 The host, port, timeout and pause are configurable.
2878 This is useful if you run an NTP server using a GPS for source and you want to
2881 Mind your GPS must send $--GSA for having the data reported!
2883 The following elements are collected:
2889 Number of satellites used for fix (type instance "used") and in view (type
2890 instance "visible"). 0 means no GPS satellites are visible.
2892 =item B<dilution_of_precision>
2894 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2895 It should be between 0 and 3.
2896 Look at the documentation of your GPS to know more.
2904 # Connect to localhost on gpsd regular port:
2909 # PauseConnect of 5 sec. between connection attempts.
2913 Available configuration options:
2917 =item B<Host> I<Host>
2919 The host on which gpsd daemon runs. Defaults to B<localhost>.
2921 =item B<Port> I<Port>
2923 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2925 =item B<Timeout> I<Seconds>
2927 Timeout in seconds (default 0.015 sec).
2929 The GPS data stream is fetch by the plugin form the daemon.
2930 It waits for data to be available, if none arrives it times out
2931 and loop for another reading.
2932 Mind to put a low value gpsd expects value in the micro-seconds area
2933 (recommended is 500 us) since the waiting function is blocking.
2934 Value must be between 500 us and 5 sec., if outside that range the
2935 default value is applied.
2937 This only applies from gpsd release-2.95.
2939 =item B<PauseConnect> I<Seconds>
2941 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
2945 =head2 Plugin C<grpc>
2947 The I<grpc> plugin provides an RPC interface to submit values to or query
2948 values from collectd based on the open source gRPC framework. It exposes an
2949 end-point for dispatching values to the daemon.
2951 The B<gRPC> homepage can be found at L<https://grpc.io/>.
2955 =item B<Server> I<Host> I<Port>
2957 The B<Server> statement sets the address of a server to which to send metrics
2958 via the C<DispatchValues> function.
2960 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2962 Optionally, B<Server> may be specified as a configuration block which supports
2963 the following options:
2967 =item B<EnableSSL> B<false>|B<true>
2969 Whether to require SSL for outgoing connections. Default: false.
2971 =item B<SSLCACertificateFile> I<Filename>
2973 =item B<SSLCertificateFile> I<Filename>
2975 =item B<SSLCertificateKeyFile> I<Filename>
2977 Filenames specifying SSL certificate and key material to be used with SSL
2982 =item B<Listen> I<Host> I<Port>
2984 The B<Listen> statement sets the network address to bind to. When multiple
2985 statements are specified, the daemon will bind to all of them. If none are
2986 specified, it defaults to B<0.0.0.0:50051>.
2988 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2990 Optionally, B<Listen> may be specified as a configuration block which
2991 supports the following options:
2995 =item B<EnableSSL> I<true>|I<false>
2997 Whether to enable SSL for incoming connections. Default: false.
2999 =item B<SSLCACertificateFile> I<Filename>
3001 =item B<SSLCertificateFile> I<Filename>
3003 =item B<SSLCertificateKeyFile> I<Filename>
3005 Filenames specifying SSL certificate and key material to be used with SSL
3012 =head2 Plugin C<hddtemp>
3014 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3015 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3016 default values, see below. C<hddtemp> has to be running to work correctly. If
3017 C<hddtemp> is not running timeouts may appear which may interfere with other
3020 The B<hddtemp> homepage can be found at
3021 L<http://www.guzu.net/linux/hddtemp.php>.
3025 =item B<Host> I<Hostname>
3027 Hostname to connect to. Defaults to B<127.0.0.1>.
3029 =item B<Port> I<Port>
3031 TCP-Port to connect to. Defaults to B<7634>.
3035 =head2 Plugin C<hugepages>
3037 To collect B<hugepages> information, collectd reads directories
3038 "/sys/devices/system/node/*/hugepages" and
3039 "/sys/kernel/mm/hugepages".
3040 Reading of these directories can be disabled by the following
3041 options (default is enabled).
3045 =item B<ReportPerNodeHP> B<true>|B<false>
3047 If enabled, information will be collected from the hugepage
3048 counters in "/sys/devices/system/node/*/hugepages".
3049 This is used to check the per-node hugepage statistics on
3052 =item B<ReportRootHP> B<true>|B<false>
3054 If enabled, information will be collected from the hugepage
3055 counters in "/sys/kernel/mm/hugepages".
3056 This can be used on both NUMA and non-NUMA systems to check
3057 the overall hugepage statistics.
3059 =item B<ValuesPages> B<true>|B<false>
3061 Whether to report hugepages metrics in number of pages.
3062 Defaults to B<true>.
3064 =item B<ValuesBytes> B<false>|B<true>
3066 Whether to report hugepages metrics in bytes.
3067 Defaults to B<false>.
3069 =item B<ValuesPercentage> B<false>|B<true>
3071 Whether to report hugepages metrics as percentage.
3072 Defaults to B<false>.
3076 =head2 Plugin C<intel_pmu>
3078 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3079 Linux perf interface. All events are reported on a per core basis.
3084 ReportHardwareCacheEvents true
3085 ReportKernelPMUEvents true
3086 ReportSoftwareEvents true
3087 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3088 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3095 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3097 Enable or disable measuring of hardware CPU cache events:
3099 - L1-dcache-load-misses
3101 - L1-dcache-store-misses
3102 - L1-dcache-prefetches
3103 - L1-dcache-prefetch-misses
3105 - L1-icache-load-misses
3106 - L1-icache-prefetches
3107 - L1-icache-prefetch-misses
3113 - LLC-prefetch-misses
3119 - dTLB-prefetch-misses
3123 - branch-load-misses
3125 =item B<ReportKernelPMUEvents> B<false>|B<true>
3127 Enable or disable measuring of the following events:
3136 =item B<ReportSoftwareEvents> B<false>|B<true>
3138 Enable or disable measuring of software events provided by kernel:
3149 =item B<EventList> I<filename>
3151 JSON performance counter event list file name. To be able to monitor all Intel
3152 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3153 event_download.py script to download event list for current CPU.
3155 =item B<HardwareEvents> I<events>
3157 This field is a list of event names or groups of comma separated event names.
3158 This option requires B<EventList> option to be configured.
3162 =head2 Plugin C<intel_rdt>
3164 The I<intel_rdt> plugin collects information provided by monitoring features of
3165 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3166 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3167 information about utilization of shared resources. CMT monitors last level cache
3168 occupancy (LLC). MBM supports two types of events reporting local and remote
3169 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3170 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3171 reports the bandwidth of accessing the remote socket. Also this technology
3172 allows to monitor instructions per clock (IPC).
3173 Monitor events are hardware dependant. Monitoring capabilities are detected on
3174 plugin initialization and only supported events are monitored.
3176 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3177 require an additional capability to be enabled if collectd is run as a service.
3178 Please refer to I<contrib/systemd.collectd.service> file for more details.
3182 <Plugin "intel_rdt">
3183 Cores "0-2" "3,4,6" "8-10,15"
3190 =item B<Interval> I<seconds>
3192 The interval within which to retrieve statistics on monitored events in seconds.
3193 For milliseconds divide the time by 1000 for example if the desired interval
3194 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3195 recommended to set interval higher than 1 sec.
3197 =item B<Cores> I<cores groups>
3199 All events are reported on a per core basis. Monitoring of the events can be
3200 configured for group of cores (aggregated statistics). This field defines groups
3201 of cores on which to monitor supported events. The field is represented as list
3202 of strings with core group values. Each string represents a list of cores in a
3203 group. Allowed formats are:
3208 If an empty string is provided as value for this field default cores
3209 configuration is applied - a separate group is created for each core.
3213 B<Note:> By default global interval is used to retrieve statistics on monitored
3214 events. To configure a plugin specific interval use B<Interval> option of the
3215 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3216 example if the desired interval is 50ms, set interval to 0.05.
3217 Due to limited capacity of counters it is not recommended to set interval higher
3220 =head2 Plugin C<interface>
3224 =item B<Interface> I<Interface>
3226 Select this interface. By default these interfaces will then be collected. For
3227 a more detailed description see B<IgnoreSelected> below.
3229 See F</"IGNORELISTS"> for details.
3231 =item B<IgnoreSelected> I<true>|I<false>
3233 If no configuration is given, the B<interface>-plugin will collect data from
3234 all interfaces. This may not be practical, especially for loopback- and
3235 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3236 interfaces you're interested in. Sometimes, however, it's easier/preferred
3237 to collect all interfaces I<except> a few ones. This option enables you to
3238 do that: By setting B<IgnoreSelected> to I<true> the effect of
3239 B<Interface> is inverted: All selected interfaces are ignored and all
3240 other interfaces are collected.
3242 It is possible to use regular expressions to match interface names, if the
3243 name is surrounded by I</.../> and collectd was compiled with support for
3244 regexps. This is useful if there's a need to collect (or ignore) data
3245 for a group of interfaces that are similarly named, without the need to
3246 explicitly list all of them (especially useful if the list is dynamic).
3251 Interface "/^tun[0-9]+/"
3252 IgnoreSelected "true"
3254 This will ignore the loopback interface, all interfaces with names starting
3255 with I<veth> and all interfaces with names starting with I<tun> followed by
3258 =item B<ReportInactive> I<true>|I<false>
3260 When set to I<false>, only interfaces with non-zero traffic will be
3261 reported. Note that the check is done by looking into whether a
3262 package was sent at any time from boot and the corresponding counter
3263 is non-zero. So, if the interface has been sending data in the past
3264 since boot, but not during the reported time-interval, it will still
3267 The default value is I<true> and results in collection of the data
3268 from all interfaces that are selected by B<Interface> and
3269 B<IgnoreSelected> options.
3271 =item B<UniqueName> I<true>|I<false>
3273 Interface name is not unique on Solaris (KSTAT), interface name is unique
3274 only within a module/instance. Following tuple is considered unique:
3275 (ks_module, ks_instance, ks_name)
3276 If this option is set to true, interface name contains above three fields
3277 separated by an underscore. For more info on KSTAT, visit
3278 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3280 This option is only available on Solaris.
3284 =head2 Plugin C<ipmi>
3288 =item B<Sensor> I<Sensor>
3290 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3292 See F</"IGNORELISTS"> for details.
3294 =item B<IgnoreSelected> I<true>|I<false>
3296 If no configuration if given, the B<ipmi> plugin will collect data from all
3297 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3298 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3299 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3300 all other sensors are collected.
3302 =item B<NotifySensorAdd> I<true>|I<false>
3304 If a sensor appears after initialization time of a minute a notification
3307 =item B<NotifySensorRemove> I<true>|I<false>
3309 If a sensor disappears a notification is sent.
3311 =item B<NotifySensorNotPresent> I<true>|I<false>
3313 If you have for example dual power supply and one of them is (un)plugged then
3314 a notification is sent.
3318 =head2 Plugin C<iptables>
3322 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3324 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3326 Select the iptables/ip6tables filter rules to count packets and bytes from.
3328 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3329 of all rules which have a comment-match. The comment is then used as
3332 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3333 the I<n>th rule will be collected. Again, the comment (or the number) will be
3334 used as the type-instance.
3336 If I<Name> is supplied, it will be used as the type-instance instead of the
3337 comment or the number.
3341 =head2 Plugin C<irq>
3347 Select this irq. By default these irqs will then be collected. For a more
3348 detailed description see B<IgnoreSelected> below.
3350 See F</"IGNORELISTS"> for details.
3352 =item B<IgnoreSelected> I<true>|I<false>
3354 If no configuration if given, the B<irq>-plugin will collect data from all
3355 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3356 can use the B<Irq>-option to pick the interrupt you're interested in.
3357 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3358 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3359 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3360 and all other interrupts are collected.
3364 =head2 Plugin C<java>
3366 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3367 This section only discusses the syntax and semantic of the configuration
3368 options. For more in-depth information on the I<Java> plugin, please read
3369 L<collectd-java(5)>.
3374 JVMArg "-verbose:jni"
3375 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3376 LoadPlugin "org.collectd.java.Foobar"
3377 <Plugin "org.collectd.java.Foobar">
3378 # To be parsed by the plugin
3382 Available configuration options:
3386 =item B<JVMArg> I<Argument>
3388 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3389 exactly the way the arguments to the I<java> binary on the command line work.
3390 Execute C<javaE<nbsp>--help> for details.
3392 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3393 any other options! When another option is found, the JVM will be started and
3394 later options will have to be ignored!
3396 =item B<LoadPlugin> I<JavaClass>
3398 Instantiates a new I<JavaClass> object. The constructor of this object very
3399 likely then registers one or more callback methods with the server.
3401 See L<collectd-java(5)> for details.
3403 When the first such option is found, the virtual machine (JVM) is created. This
3404 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3405 B<LoadPlugin> options!
3407 =item B<Plugin> I<Name>
3409 The entire block is passed to the Java plugin as an
3410 I<org.collectd.api.OConfigItem> object.
3412 For this to work, the plugin has to register a configuration callback first,
3413 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3414 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3415 depends on the (Java) plugin registering the callback and is completely
3416 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3420 =head2 Plugin C<load>
3422 The I<Load plugin> collects the system load. These numbers give a rough overview
3423 over the utilization of a machine. The system load is defined as the number of
3424 runnable tasks in the run-queue and is provided by many operating systems as a
3425 one, five or fifteen minute average.
3427 The following configuration options are available:
3431 =item B<ReportRelative> B<false>|B<true>
3433 When enabled, system load divided by number of available CPU cores is reported
3434 for intervals 1 min, 5 min and 15 min. Defaults to false.
3439 =head2 Plugin C<logfile>
3443 =item B<LogLevel> B<debug|info|notice|warning|err>
3445 Sets the log-level. If, for example, set to B<notice>, then all events with
3446 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3448 Please note that B<debug> is only available if collectd has been compiled with
3451 =item B<File> I<File>
3453 Sets the file to write log messages to. The special strings B<stdout> and
3454 B<stderr> can be used to write to the standard output and standard error
3455 channels, respectively. This, of course, only makes much sense when I<collectd>
3456 is running in foreground- or non-daemon-mode.
3458 =item B<Timestamp> B<true>|B<false>
3460 Prefix all lines printed by the current time. Defaults to B<true>.
3462 =item B<PrintSeverity> B<true>|B<false>
3464 When enabled, all lines are prefixed by the severity of the log message, for
3465 example "warning". Defaults to B<false>.
3469 B<Note>: There is no need to notify the daemon after moving or removing the
3470 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3471 for each line it writes.
3473 =head2 Plugin C<log_logstash>
3475 The I<log logstash plugin> behaves like the logfile plugin but formats
3476 messages as JSON events for logstash to parse and input.
3480 =item B<LogLevel> B<debug|info|notice|warning|err>
3482 Sets the log-level. If, for example, set to B<notice>, then all events with
3483 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3485 Please note that B<debug> is only available if collectd has been compiled with
3488 =item B<File> I<File>
3490 Sets the file to write log messages to. The special strings B<stdout> and
3491 B<stderr> can be used to write to the standard output and standard error
3492 channels, respectively. This, of course, only makes much sense when I<collectd>
3493 is running in foreground- or non-daemon-mode.
3497 B<Note>: There is no need to notify the daemon after moving or removing the
3498 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3499 for each line it writes.
3501 =head2 Plugin C<lpar>
3503 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3504 virtualization technique for IBM POWER processors. It takes into account CPU
3505 time stolen from or donated to a partition, in addition to the usual user,
3506 system, I/O statistics.
3508 The following configuration options are available:
3512 =item B<CpuPoolStats> B<false>|B<true>
3514 When enabled, statistics about the processor pool are read, too. The partition
3515 needs to have pool authority in order to be able to acquire this information.
3518 =item B<ReportBySerial> B<false>|B<true>
3520 If enabled, the serial of the physical machine the partition is currently
3521 running on is reported as I<hostname> and the logical hostname of the machine
3522 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3523 used (just like other plugins) and the I<plugin instance> will be empty.
3528 =head2 Plugin C<lua>
3530 This plugin embeds a Lua interpreter into collectd and provides an interface
3531 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3534 =head2 Plugin C<mbmon>
3536 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3538 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3539 B<Host> and B<Port> options can be used to change these values, see below.
3540 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3541 timeouts may appear which may interfere with other statistics..
3543 C<mbmon> must be run with the -r option ("print TAG and Value format");
3544 Debian's F</etc/init.d/mbmon> script already does this, other people
3545 will need to ensure that this is the case.
3549 =item B<Host> I<Hostname>
3551 Hostname to connect to. Defaults to B<127.0.0.1>.
3553 =item B<Port> I<Port>
3555 TCP-Port to connect to. Defaults to B<411>.
3559 =head2 Plugin C<mcelog>
3561 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3563 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3564 mcelog server is running. When the server is running, the plugin will tail the
3565 specified logfile to retrieve machine check exception information and send a
3566 notification with the details from the logfile. The plugin will use the mcelog
3567 client protocol to retrieve memory related machine check exceptions. Note that
3568 for memory exceptions, notifications are only sent when there is a change in
3569 the number of corrected/uncorrected memory errors.
3571 =head3 The Memory block
3573 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3578 =item B<McelogClientSocket> I<Path>
3579 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3580 Defaults to B<"/var/run/mcelog-client">.
3582 =item B<PersistentNotification> B<true>|B<false>
3583 Override default configuration to only send notifications when sent when there
3584 is a change in the number of corrected/uncorrected memory errors. When set to
3585 true notifications will be sent for every read cycle. Default is false. Does
3586 not affect the stats being dispatched.
3592 =item B<McelogLogfile> I<Path>
3594 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3595 cannot be used in conjunction with the memory block options, they are mutually
3602 The C<md plugin> collects information from Linux Software-RAID devices (md).
3604 All reported values are of the type C<md_disks>. Reported type instances are
3605 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3606 I<missing> (physically absent) disks.
3610 =item B<Device> I<Device>
3612 Select md devices based on device name. The I<device name> is the basename of
3613 the device, i.e. the name of the block device without the leading C</dev/>.
3614 See B<IgnoreSelected> for more details.
3616 See F</"IGNORELISTS"> for details.
3618 =item B<IgnoreSelected> B<true>|B<false>
3620 Invert device selection: If set to B<true>, all md devices B<except> those
3621 listed using B<Device> are collected. If B<false> (the default), only those
3622 listed are collected. If no configuration is given, the B<md> plugin will
3623 collect data from all md devices.
3627 =head2 Plugin C<memcachec>
3629 The C<memcachec plugin> connects to a memcached server, queries one or more
3630 given I<pages> and parses the returned data according to user specification.
3631 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3634 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3635 library. Please note that there is another library with a very similar name,
3636 libmemcache (notice the missing `d'), which is not applicable.
3638 Synopsis of the configuration:
3640 <Plugin "memcachec">
3641 <Page "plugin_instance">
3645 Regex "(\\d+) bytes sent"
3648 Instance "type_instance"
3653 The configuration options are:
3657 =item E<lt>B<Page> I<Name>E<gt>
3659 Each B<Page> block defines one I<page> to be queried from the memcached server.
3660 The block requires one string argument which is used as I<plugin instance>.
3662 =item B<Server> I<Address>
3664 Sets the server address to connect to when querying the page. Must be inside a
3669 When connected to the memcached server, asks for the page I<Key>.
3671 =item E<lt>B<Match>E<gt>
3673 Match blocks define which strings to look for and how matches substrings are
3674 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3678 =head2 Plugin C<memcached>
3680 The B<memcached plugin> connects to a memcached server and queries statistics
3681 about cache utilization, memory and bandwidth used.
3682 L<http://memcached.org/>
3684 <Plugin "memcached">
3686 #Host "memcache.example.com"
3692 The plugin configuration consists of one or more B<Instance> blocks which
3693 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3694 following options are allowed:
3698 =item B<Host> I<Hostname>
3700 Sets the B<host> field of dispatched values. Defaults to the global hostname
3702 For backwards compatibility, values are also dispatched with the global
3703 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3706 =item B<Address> I<Address>
3708 Hostname or IP to connect to. For backwards compatibility, defaults to the
3709 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3711 =item B<Port> I<Port>
3713 TCP port to connect to. Defaults to B<11211>.
3715 =item B<Socket> I<Path>
3717 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3718 setting is given, the B<Address> and B<Port> settings are ignored.
3722 =head2 Plugin C<mic>
3724 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3725 Intel's Many Integrated Core (MIC) systems.
3734 ShowTemperatures true
3737 IgnoreSelectedTemperature true
3742 IgnoreSelectedPower true
3745 The following options are valid inside the B<PluginE<nbsp>mic> block:
3749 =item B<ShowCPU> B<true>|B<false>
3751 If enabled (the default) a sum of the CPU usage across all cores is reported.
3753 =item B<ShowCPUCores> B<true>|B<false>
3755 If enabled (the default) per-core CPU usage is reported.
3757 =item B<ShowMemory> B<true>|B<false>
3759 If enabled (the default) the physical memory usage of the MIC system is
3762 =item B<ShowTemperatures> B<true>|B<false>
3764 If enabled (the default) various temperatures of the MIC system are reported.
3766 =item B<Temperature> I<Name>
3768 This option controls which temperatures are being reported. Whether matching
3769 temperatures are being ignored or I<only> matching temperatures are reported
3770 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3771 temperatures are reported.
3773 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3775 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3776 (the default) only temperatures matching a B<Temperature> option are reported
3777 or, if no B<Temperature> option is specified, all temperatures are reported. If
3778 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3781 Known temperature names are:
3815 =item B<ShowPower> B<true>|B<false>
3817 If enabled (the default) various temperatures of the MIC system are reported.
3819 =item B<Power> I<Name>
3821 This option controls which power readings are being reported. Whether matching
3822 power readings are being ignored or I<only> matching power readings are reported
3823 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3824 power readings are reported.
3826 =item B<IgnoreSelectedPower> B<false>|B<true>
3828 Controls the behavior of the B<Power> setting above. If set to B<false>
3829 (the default) only power readings matching a B<Power> option are reported
3830 or, if no B<Power> option is specified, all power readings are reported. If
3831 set to B<true>, matching power readings are I<ignored> and all other power readings
3834 Known power names are:
3840 Total power utilization averaged over Time Window 0 (uWatts).
3844 Total power utilization averaged over Time Window 0 (uWatts).
3848 Instantaneous power (uWatts).
3852 Max instantaneous power (uWatts).
3856 PCI-E connector power (uWatts).
3860 2x3 connector power (uWatts).
3864 2x4 connector power (uWatts).
3872 Uncore rail (uVolts).
3876 Memory subsystem rail (uVolts).
3882 =head2 Plugin C<memory>
3884 The I<memory plugin> provides the following configuration options:
3888 =item B<ValuesAbsolute> B<true>|B<false>
3890 Enables or disables reporting of physical memory usage in absolute numbers,
3891 i.e. bytes. Defaults to B<true>.
3893 =item B<ValuesPercentage> B<false>|B<true>
3895 Enables or disables reporting of physical memory usage in percentages, e.g.
3896 percent of physical memory used. Defaults to B<false>.
3898 This is useful for deploying I<collectd> in a heterogeneous environment in
3899 which the sizes of physical memory vary.
3903 =head2 Plugin C<modbus>
3905 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3906 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3907 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3908 values (two registers interpreted as IEEE floats in big endian notation).
3912 <Data "voltage-input-1">
3915 RegisterCmd ReadHolding
3920 <Data "voltage-input-2">
3923 RegisterCmd ReadHolding
3928 <Data "supply-temperature-1">
3931 RegisterCmd ReadHolding
3936 <Host "modbus.example.com">
3937 Address "192.168.0.42"
3942 Instance "power-supply"
3943 Collect "voltage-input-1"
3944 Collect "voltage-input-2"
3949 Device "/dev/ttyUSB0"
3954 Instance "temperature"
3955 Collect "supply-temperature-1"
3961 =item E<lt>B<Data> I<Name>E<gt> blocks
3963 Data blocks define a mapping between register numbers and the "types" used by
3966 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3970 =item B<RegisterBase> I<Number>
3972 Configures the base register to read from the device. If the option
3973 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3974 register will be read (the register number is increased by one).
3976 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3978 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3979 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3980 combined into one value. Defaults to B<Uint16>.
3982 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3984 Specifies register type to be collected from device. Works only with libmodbus
3985 2.9.2 or higher. Defaults to B<ReadHolding>.
3987 =item B<Type> I<Type>
3989 Specifies the "type" (data set) to use when dispatching the value to
3990 I<collectd>. Currently, only data sets with exactly one data source are
3993 =item B<Instance> I<Instance>
3995 Sets the type instance to use when dispatching the value to I<collectd>. If
3996 unset, an empty string (no type instance) is used.
4000 =item E<lt>B<Host> I<Name>E<gt> blocks
4002 Host blocks are used to specify to which hosts to connect and what data to read
4003 from their "slaves". The string argument I<Name> is used as hostname when
4004 dispatching the values to I<collectd>.
4006 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4010 =item B<Address> I<Hostname>
4012 For Modbus/TCP, specifies the node name (the actual network address) used to
4013 connect to the host. This may be an IP address or a hostname. Please note that
4014 the used I<libmodbus> library only supports IPv4 at the moment.
4016 =item B<Port> I<Service>
4018 for Modbus/TCP, specifies the port used to connect to the host. The port can
4019 either be given as a number or as a service name. Please note that the
4020 I<Service> argument must be a string, even if ports are given in their numerical
4021 form. Defaults to "502".
4023 =item B<Device> I<Devicenode>
4025 For Modbus/RTU, specifies the path to the serial device being used.
4027 =item B<Baudrate> I<Baudrate>
4029 For Modbus/RTU, specifies the baud rate of the serial device.
4030 Note, connections currently support only 8/N/1.
4032 =item B<Interval> I<Interval>
4034 Sets the interval (in seconds) in which the values will be collected from this
4035 host. By default the global B<Interval> setting will be used.
4037 =item E<lt>B<Slave> I<ID>E<gt>
4039 Over each connection, multiple Modbus devices may be reached. The slave ID
4040 is used to specify which device should be addressed. For each device you want
4041 to query, one B<Slave> block must be given.
4043 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4047 =item B<Instance> I<Instance>
4049 Specify the plugin instance to use when dispatching the values to I<collectd>.
4050 By default "slave_I<ID>" is used.
4052 =item B<Collect> I<DataName>
4054 Specifies which data to retrieve from the device. I<DataName> must be the same
4055 string as the I<Name> argument passed to a B<Data> block. You can specify this
4056 option multiple times to collect more than one value from a slave. At least one
4057 B<Collect> option is mandatory.
4065 =head2 Plugin C<mqtt>
4067 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4068 values from MQTT (B<Subscribe> blocks).
4074 Host "mqtt.example.com"
4078 Host "mqtt.example.com"
4083 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4084 configuring the sending and receiving direction respectively. The plugin will
4085 register a write callback named C<mqtt/I<name>> where I<name> is the string
4086 argument given to the B<Publish> block. Both types of blocks share many but not
4087 all of the following options. If an option is valid in only one of the blocks,
4088 it will be mentioned explicitly.
4094 =item B<Host> I<Hostname>
4096 Hostname of the MQTT broker to connect to.
4098 =item B<Port> I<Service>
4100 Port number or service name of the MQTT broker to connect to.
4102 =item B<User> I<UserName>
4104 Username used when authenticating to the MQTT broker.
4106 =item B<Password> I<Password>
4108 Password used when authenticating to the MQTT broker.
4110 =item B<ClientId> I<ClientId>
4112 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4114 =item B<QoS> [B<0>-B<2>]
4116 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4134 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4135 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4136 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4137 on a message is larger than the maximum accepted QoS of a subscriber, the
4138 message's QoS will be downgraded.
4140 =item B<Prefix> I<Prefix> (Publish only)
4142 This plugin will use one topic per I<value list> which will looks like a path.
4143 I<Prefix> is used as the first path element and defaults to B<collectd>.
4145 An example topic name would be:
4147 collectd/cpu-0/cpu-user
4149 =item B<Retain> B<false>|B<true> (Publish only)
4151 Controls whether the MQTT broker will retain (keep a copy of) the last message
4152 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4154 =item B<StoreRates> B<true>|B<false> (Publish only)
4156 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4157 before sending. Defaults to B<true>.
4159 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4161 Controls whether the MQTT "cleans" the session up after the subscriber
4162 disconnects or if it maintains the subscriber's subscriptions and all messages
4163 that arrive while the subscriber is disconnected. Defaults to B<true>.
4165 =item B<Topic> I<TopicName> (Subscribe only)
4167 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4168 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4169 the B<collectd> branch.
4171 =item B<CACert> I<file>
4173 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4174 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4175 port of the MQTT broker.
4176 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4178 =item B<CertificateFile> I<file>
4180 Path to the PEM-encoded certificate file to use as client certificate when
4181 connecting to the MQTT broker.
4182 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4184 =item B<CertificateKeyFile> I<file>
4186 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4187 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4189 =item B<TLSProtocol> I<protocol>
4191 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4192 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4193 version is used which depends on the version of OpenSSL the Mosquitto library
4196 =item B<CipherSuite> I<ciphersuite>
4198 A string describing the ciphers available for use. See L<ciphers(1)> and the
4199 C<openssl ciphers> utility for more information. If unset, the default ciphers
4205 =head2 Plugin C<mysql>
4207 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4208 one or more databases when started and keeps the connection up as long as
4209 possible. When the connection is interrupted for whatever reason it will try
4210 to re-connect. The plugin will complain loudly in case anything goes wrong.
4212 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4213 and collects information about MySQL network traffic, executed statements,
4214 requests, the query cache and threads by evaluating the
4215 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4216 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4217 Status Variables> for an explanation of these values.
4219 Optionally, master and slave statistics may be collected in a MySQL
4220 replication setup. In that case, information about the synchronization state
4221 of the nodes are collected by evaluating the C<Position> return value of the
4222 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4223 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4224 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4225 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4226 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4238 SSLKey "/path/to/key.pem"
4239 SSLCert "/path/to/cert.pem"
4240 SSLCA "/path/to/ca.pem"
4241 SSLCAPath "/path/to/cas/"
4242 SSLCipher "DHE-RSA-AES256-SHA"
4248 Socket "/var/run/mysql/mysqld.sock"
4250 SlaveNotifications true
4256 Socket "/var/run/mysql/mysqld.sock"
4261 A B<Database> block defines one connection to a MySQL database. It accepts a
4262 single argument which specifies the name of the database. None of the other
4263 options are required. MySQL will use default values as documented in the
4264 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4265 B<MySQL reference manual>.
4269 =item B<Alias> I<Alias>
4271 Alias to use as sender instead of hostname when reporting. This may be useful
4272 when having cryptic hostnames.
4274 =item B<Host> I<Hostname>
4276 Hostname of the database server. Defaults to B<localhost>.
4278 =item B<User> I<Username>
4280 Username to use when connecting to the database. The user does not have to be
4281 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4282 unless you want to collectd replication statistics (see B<MasterStats> and
4283 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4284 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4286 =item B<Password> I<Password>
4288 Password needed to log into the database.
4290 =item B<Database> I<Database>
4292 Select this database. Defaults to I<no database> which is a perfectly reasonable
4293 option for what this plugin does.
4295 =item B<Port> I<Port>
4297 TCP-port to connect to. The port must be specified in its numeric form, but it
4298 must be passed as a string nonetheless. For example:
4302 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4303 See the documentation for the C<mysql_real_connect> function for details.
4305 =item B<Socket> I<Socket>
4307 Specifies the path to the UNIX domain socket of the MySQL server. This option
4308 only has any effect, if B<Host> is set to B<localhost> (the default).
4309 Otherwise, use the B<Port> option above. See the documentation for the
4310 C<mysql_real_connect> function for details.
4312 =item B<InnodbStats> I<true|false>
4314 If enabled, metrics about the InnoDB storage engine are collected.
4315 Disabled by default.
4317 =item B<MasterStats> I<true|false>
4319 =item B<SlaveStats> I<true|false>
4321 Enable the collection of master / slave statistics in a replication setup. In
4322 order to be able to get access to these statistics, the user needs special
4323 privileges. See the B<User> documentation above. Defaults to B<false>.
4325 =item B<SlaveNotifications> I<true|false>
4327 If enabled, the plugin sends a notification if the replication slave I/O and /
4328 or SQL threads are not running. Defaults to B<false>.
4330 =item B<WsrepStats> I<true|false>
4332 Enable the collection of wsrep plugin statistics, used in Master-Master
4333 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4334 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4336 =item B<ConnectTimeout> I<Seconds>
4338 Sets the connect timeout for the MySQL client.
4340 =item B<SSLKey> I<Path>
4342 If provided, the X509 key in PEM format.
4344 =item B<SSLCert> I<Path>
4346 If provided, the X509 cert in PEM format.
4348 =item B<SSLCA> I<Path>
4350 If provided, the CA file in PEM format (check OpenSSL docs).
4352 =item B<SSLCAPath> I<Path>
4354 If provided, the CA directory (check OpenSSL docs).
4356 =item B<SSLCipher> I<String>
4358 If provided, the SSL cipher to use.
4362 =head2 Plugin C<netapp>
4364 The netapp plugin can collect various performance and capacity information
4365 from a NetApp filer using the NetApp API.
4367 Please note that NetApp has a wide line of products and a lot of different
4368 software versions for each of these products. This plugin was developed for a
4369 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4370 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4371 model and software version but it is very hard to test this.
4372 If you have used this plugin with other models and/or software version, feel
4373 free to send us a mail to tell us about the results, even if it's just a short
4376 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4377 basic authentication.
4379 B<Do not use a regular user for this!> Create a special collectd user with just
4380 the minimum of capabilities needed. The user only needs the "login-http-admin"
4381 capability as well as a few more depending on which data will be collected.
4382 Required capabilities are documented below.
4387 <Host "netapp1.example.com">
4411 IgnoreSelectedIO false
4413 IgnoreSelectedOps false
4414 GetLatency "volume0"
4415 IgnoreSelectedLatency false
4422 IgnoreSelectedCapacity false
4425 IgnoreSelectedSnapshot false
4453 The netapp plugin accepts the following configuration options:
4457 =item B<Host> I<Name>
4459 A host block defines one NetApp filer. It will appear in collectd with the name
4460 you specify here which does not have to be its real name nor its hostname (see
4461 the B<Address> option below).
4463 =item B<VFiler> I<Name>
4465 A B<VFiler> block may only be used inside a host block. It accepts all the
4466 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4467 will execute all NetApp API commands in the context of the specified
4468 VFiler(R). It will appear in collectd with the name you specify here which
4469 does not have to be its real name. The VFiler name may be specified using the
4470 B<VFilerName> option. If this is not specified, it will default to the name
4473 The VFiler block inherits all connection related settings from the surrounding
4474 B<Host> block (which appear before the B<VFiler> block) but they may be
4475 overwritten inside the B<VFiler> block.
4477 This feature is useful, for example, when using a VFiler as SnapVault target
4478 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4479 available in the host filer (vfiler0) but only in the respective VFiler
4482 =item B<Protocol> B<httpd>|B<http>
4484 The protocol collectd will use to query this host.
4492 Valid options: http, https
4494 =item B<Address> I<Address>
4496 The hostname or IP address of the host.
4502 Default: The "host" block's name.
4504 =item B<Port> I<Port>
4506 The TCP port to connect to on the host.
4512 Default: 80 for protocol "http", 443 for protocol "https"
4514 =item B<User> I<User>
4516 =item B<Password> I<Password>
4518 The username and password to use to login to the NetApp.
4524 =item B<VFilerName> I<Name>
4526 The name of the VFiler in which context to execute API commands. If not
4527 specified, the name provided to the B<VFiler> block will be used instead.
4533 Default: name of the B<VFiler> block
4535 B<Note:> This option may only be used inside B<VFiler> blocks.
4537 =item B<Interval> I<Interval>
4543 The following options decide what kind of data will be collected. You can
4544 either use them as a block and fine tune various parameters inside this block,
4545 use them as a single statement to just accept all default values, or omit it to
4546 not collect any data.
4548 The following options are valid inside all blocks:
4552 =item B<Interval> I<Seconds>
4554 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4555 host specific setting.
4559 =head3 The System block
4561 This will collect various performance data about the whole system.
4563 B<Note:> To get this data the collectd user needs the
4564 "api-perf-object-get-instances" capability.
4568 =item B<Interval> I<Seconds>
4570 Collect disk statistics every I<Seconds> seconds.
4572 =item B<GetCPULoad> B<true>|B<false>
4574 If you set this option to true the current CPU usage will be read. This will be
4575 the average usage between all CPUs in your NetApp without any information about
4578 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4579 returns in the "CPU" field.
4587 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4589 =item B<GetInterfaces> B<true>|B<false>
4591 If you set this option to true the current traffic of the network interfaces
4592 will be read. This will be the total traffic over all interfaces of your NetApp
4593 without any information about individual interfaces.
4595 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4596 in the "Net kB/s" field.
4606 Result: One value list of type "if_octects".
4608 =item B<GetDiskIO> B<true>|B<false>
4610 If you set this option to true the current IO throughput will be read. This
4611 will be the total IO of your NetApp without any information about individual
4612 disks, volumes or aggregates.
4614 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4615 in the "DiskE<nbsp>kB/s" field.
4623 Result: One value list of type "disk_octets".
4625 =item B<GetDiskOps> B<true>|B<false>
4627 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4628 iSCSI, etc. operations will be read. This will be the total number of
4629 operations on your NetApp without any information about individual volumes or
4632 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4633 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4641 Result: A variable number of value lists of type "disk_ops_complex". Each type
4642 of operation will result in one value list with the name of the operation as
4647 =head3 The WAFL block
4649 This will collect various performance data about the WAFL file system. At the
4650 moment this just means cache performance.
4652 B<Note:> To get this data the collectd user needs the
4653 "api-perf-object-get-instances" capability.
4655 B<Note:> The interface to get these values is classified as "Diagnostics" by
4656 NetApp. This means that it is not guaranteed to be stable even between minor
4661 =item B<Interval> I<Seconds>
4663 Collect disk statistics every I<Seconds> seconds.
4665 =item B<GetNameCache> B<true>|B<false>
4673 Result: One value list of type "cache_ratio" and type instance
4676 =item B<GetDirCache> B<true>|B<false>
4684 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4686 =item B<GetInodeCache> B<true>|B<false>
4694 Result: One value list of type "cache_ratio" and type instance
4697 =item B<GetBufferCache> B<true>|B<false>
4699 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4700 in the "Cache hit" field.
4708 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4712 =head3 The Disks block
4714 This will collect performance data about the individual disks in the NetApp.
4716 B<Note:> To get this data the collectd user needs the
4717 "api-perf-object-get-instances" capability.
4721 =item B<Interval> I<Seconds>
4723 Collect disk statistics every I<Seconds> seconds.
4725 =item B<GetBusy> B<true>|B<false>
4727 If you set this option to true the busy time of all disks will be calculated
4728 and the value of the busiest disk in the system will be written.
4730 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4731 in the "Disk util" field. Probably.
4739 Result: One value list of type "percent" and type instance "disk_busy".
4743 =head3 The VolumePerf block
4745 This will collect various performance data about the individual volumes.
4747 You can select which data to collect about which volume using the following
4748 options. They follow the standard ignorelist semantic.
4750 B<Note:> To get this data the collectd user needs the
4751 I<api-perf-object-get-instances> capability.
4755 =item B<Interval> I<Seconds>
4757 Collect volume performance data every I<Seconds> seconds.
4759 =item B<GetIO> I<Volume>
4761 =item B<GetOps> I<Volume>
4763 =item B<GetLatency> I<Volume>
4765 Select the given volume for IO, operations or latency statistics collection.
4766 The argument is the name of the volume without the C</vol/> prefix.
4768 Since the standard ignorelist functionality is used here, you can use a string
4769 starting and ending with a slash to specify regular expression matching: To
4770 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4773 GetIO "/^vol[027]$/"
4775 If no regular expression is specified, an exact match is required. Both,
4776 regular and exact matching are case sensitive.
4778 If no volume was specified at all for either of the three options, that data
4779 will be collected for all available volumes.
4781 See F</"IGNORELISTS"> for details.
4783 =item B<IgnoreSelectedIO> B<true>|B<false>
4785 =item B<IgnoreSelectedOps> B<true>|B<false>
4787 =item B<IgnoreSelectedLatency> B<true>|B<false>
4789 When set to B<true>, the volumes selected for IO, operations or latency
4790 statistics collection will be ignored and the data will be collected for all
4793 When set to B<false>, data will only be collected for the specified volumes and
4794 all other volumes will be ignored.
4796 If no volumes have been specified with the above B<Get*> options, all volumes
4797 will be collected regardless of the B<IgnoreSelected*> option.
4799 Defaults to B<false>
4803 =head3 The VolumeUsage block
4805 This will collect capacity data about the individual volumes.
4807 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4812 =item B<Interval> I<Seconds>
4814 Collect volume usage statistics every I<Seconds> seconds.
4816 =item B<GetCapacity> I<VolumeName>
4818 The current capacity of the volume will be collected. This will result in two
4819 to four value lists, depending on the configuration of the volume. All data
4820 sources are of type "df_complex" with the name of the volume as
4823 There will be type_instances "used" and "free" for the number of used and
4824 available bytes on the volume. If the volume has some space reserved for
4825 snapshots, a type_instance "snap_reserved" will be available. If the volume
4826 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4827 number of bytes saved by the SIS feature.
4829 B<Note:> The current NetApp API has a bug that results in this value being
4830 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4831 number which works most of the time. If you see strange values here, bug
4832 NetApp support to fix this.
4834 Repeat this option to specify multiple volumes.
4836 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4838 Specify whether to collect only the volumes selected by the B<GetCapacity>
4839 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4840 B<false>. However, if no B<GetCapacity> option is specified at all, all
4841 capacities will be selected anyway.
4843 =item B<GetSnapshot> I<VolumeName>
4845 Select volumes from which to collect snapshot information.
4847 Usually, the space used for snapshots is included in the space reported as
4848 "used". If snapshot information is collected as well, the space used for
4849 snapshots is subtracted from the used space.
4851 To make things even more interesting, it is possible to reserve space to be
4852 used for snapshots. If the space required for snapshots is less than that
4853 reserved space, there is "reserved free" and "reserved used" space in addition
4854 to "free" and "used". If the space required for snapshots exceeds the reserved
4855 space, that part allocated in the normal space is subtracted from the "used"
4858 Repeat this option to specify multiple volumes.
4860 =item B<IgnoreSelectedSnapshot>
4862 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4863 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4864 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4865 capacities will be selected anyway.
4869 =head3 The Quota block
4871 This will collect (tree) quota statistics (used disk space and number of used
4872 files). This mechanism is useful to get usage information for single qtrees.
4873 In case the quotas are not used for any other purpose, an entry similar to the
4874 following in C</etc/quotas> would be sufficient:
4876 /vol/volA/some_qtree tree - - - - -
4878 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4882 =item B<Interval> I<Seconds>
4884 Collect SnapVault(R) statistics every I<Seconds> seconds.
4888 =head3 The SnapVault block
4890 This will collect statistics about the time and traffic of SnapVault(R)
4895 =item B<Interval> I<Seconds>
4897 Collect SnapVault(R) statistics every I<Seconds> seconds.
4901 =head2 Plugin C<netlink>
4903 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4904 statistics of various interface and routing aspects.
4908 =item B<Interface> I<Interface>
4910 =item B<VerboseInterface> I<Interface>
4912 Instruct the plugin to collect interface statistics. This is basically the same
4913 as the statistics provided by the C<interface> plugin (see above) but
4914 potentially much more detailed.
4916 When configuring with B<Interface> only the basic statistics will be collected,
4917 namely octets, packets, and errors. These statistics are collected by
4918 the C<interface> plugin, too, so using both at the same time is no benefit.
4920 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4921 so that no data needs to be collected twice if you use the C<interface> plugin.
4922 This includes dropped packets, received multicast packets, collisions and a
4923 whole zoo of differentiated RX and TX errors. You can try the following command
4924 to get an idea of what awaits you:
4928 If I<Interface> is B<All>, all interfaces will be selected.
4930 =item B<QDisc> I<Interface> [I<QDisc>]
4932 =item B<Class> I<Interface> [I<Class>]
4934 =item B<Filter> I<Interface> [I<Filter>]
4936 Collect the octets and packets that pass a certain qdisc, class or filter.
4938 QDiscs and classes are identified by their type and handle (or classid).
4939 Filters don't necessarily have a handle, therefore the parent's handle is used.
4940 The notation used in collectd differs from that used in tc(1) in that it
4941 doesn't skip the major or minor number if it's zero and doesn't print special
4942 ids by their name. So, for example, a qdisc may be identified by
4943 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4944 thus not displayed by tc(1).
4946 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4947 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4948 associated with that interface will be collected.
4950 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4951 used. This may lead to problems when more than one filter is attached to a
4952 qdisc or class. This isn't nice, but we don't know how this could be done any
4953 better. If you have a idea, please don't hesitate to tell us.
4955 As with the B<Interface> option you can specify B<All> as the interface,
4956 meaning all interfaces.
4958 Here are some examples to help you understand the above text more easily:
4961 VerboseInterface "All"
4962 QDisc "eth0" "pfifo_fast-1:0"
4964 Class "ppp0" "htb-1:10"
4965 Filter "ppp0" "u32-1:0"
4968 See F</"IGNORELISTS"> for details.
4970 =item B<IgnoreSelected>
4972 The behavior is the same as with all other similar plugins: If nothing is
4973 selected at all, everything is collected. If some things are selected using the
4974 options described above, only these statistics are collected. If you set
4975 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4976 specified statistics will not be collected.
4980 =head2 Plugin C<network>
4982 The Network plugin sends data to a remote instance of collectd, receives data
4983 from a remote instance, or both at the same time. Data which has been received
4984 from the network is usually not transmitted again, but this can be activated, see
4985 the B<Forward> option below.
4987 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4988 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4990 Both, B<Server> and B<Listen> can be used as single option or as block. When
4991 used as block, given options are valid for this socket only. The following
4992 example will export the metrics twice: Once to an "internal" server (without
4993 encryption and signing) and one to an external server (with cryptographic
4997 # Export to an internal server
4998 # (demonstrates usage without additional options)
4999 Server "collectd.internal.tld"
5001 # Export to an external server
5002 # (demonstrates usage with signature options)
5003 <Server "collectd.external.tld">
5004 SecurityLevel "sign"
5005 Username "myhostname"
5012 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5014 The B<Server> statement/block sets the server to send datagrams to. The
5015 statement may occur multiple times to send each datagram to multiple
5018 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5019 optional second argument specifies a port number or a service name. If not
5020 given, the default, B<25826>, is used.
5022 The following options are recognized within B<Server> blocks:
5026 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5028 Set the security you require for network communication. When the security level
5029 has been set to B<Encrypt>, data sent over the network will be encrypted using
5030 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5031 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5032 authentication code. When set to B<None>, data is sent without any security.
5034 This feature is only available if the I<network> plugin was linked with
5037 =item B<Username> I<Username>
5039 Sets the username to transmit. This is used by the server to lookup the
5040 password. See B<AuthFile> below. All security levels except B<None> require
5043 This feature is only available if the I<network> plugin was linked with
5046 =item B<Password> I<Password>
5048 Sets a password (shared secret) for this socket. All security levels except
5049 B<None> require this setting.
5051 This feature is only available if the I<network> plugin was linked with
5054 =item B<Interface> I<Interface name>
5056 Set the outgoing interface for IP packets. This applies at least
5057 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5058 undefined or a non-existent interface name is specified, the default
5059 behavior is to let the kernel choose the appropriate interface. Be warned
5060 that the manual selection of an interface for unicast traffic is only
5061 necessary in rare cases.
5063 =item B<ResolveInterval> I<Seconds>
5065 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5066 useful to force a regular DNS lookup to support a high availability setup. If
5067 not specified, re-resolves are never attempted.
5071 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5073 The B<Listen> statement sets the interfaces to bind to. When multiple
5074 statements are found the daemon will bind to multiple interfaces.
5076 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5077 the argument is a multicast address the daemon will join that multicast group.
5078 The optional second argument specifies a port number or a service name. If not
5079 given, the default, B<25826>, is used.
5081 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5085 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5087 Set the security you require for network communication. When the security level
5088 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5089 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5090 signed and encrypted data is accepted. When set to B<None>, all data will be
5091 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5092 decrypted if possible.
5094 This feature is only available if the I<network> plugin was linked with
5097 =item B<AuthFile> I<Filename>
5099 Sets a file in which usernames are mapped to passwords. These passwords are
5100 used to verify signatures and to decrypt encrypted network packets. If
5101 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5102 verified and encrypted packets are decrypted. Otherwise, signed data is
5103 accepted without checking the signature and encrypted data cannot be decrypted.
5104 For the other security levels this option is mandatory.
5106 The file format is very simple: Each line consists of a username followed by a
5107 colon and any number of spaces followed by the password. To demonstrate, an
5108 example file could look like this:
5113 Each time a packet is received, the modification time of the file is checked
5114 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5115 the file is being read, it is locked using L<fcntl(2)>.
5117 =item B<Interface> I<Interface name>
5119 Set the incoming interface for IP packets explicitly. This applies at least
5120 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5121 undefined or a non-existent interface name is specified, the default
5122 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5123 traffic gets only accepted, if it arrives on the given interface.
5127 =item B<TimeToLive> I<1-255>
5129 Set the time-to-live of sent packets. This applies to all, unicast and
5130 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5131 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5134 =item B<MaxPacketSize> I<1024-65535>
5136 Set the maximum size for datagrams received over the network. Packets larger
5137 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5138 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5141 On the server side, this limit should be set to the largest value used on
5142 I<any> client. Likewise, the value on the client must not be larger than the
5143 value on the server, or data will be lost.
5145 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5146 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5147 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5150 =item B<Forward> I<true|false>
5152 If set to I<true>, write packets that were received via the network plugin to
5153 the sending sockets. This should only be activated when the B<Listen>- and
5154 B<Server>-statements differ. Otherwise packets may be send multiple times to
5155 the same multicast group. While this results in more network traffic than
5156 necessary it's not a huge problem since the plugin has a duplicate detection,
5157 so the values will not loop.
5159 =item B<ReportStats> B<true>|B<false>
5161 The network plugin cannot only receive and send statistics, it can also create
5162 statistics about itself. Collectd data included the number of received and
5163 sent octets and packets, the length of the receive queue and the number of
5164 values handled. When set to B<true>, the I<Network plugin> will make these
5165 statistics available. Defaults to B<false>.
5169 =head2 Plugin C<nfs>
5171 The I<nfs plugin> collects information about the usage of the Network File
5172 System (NFS). It counts the number of procedure calls for each procedure,
5173 grouped by version and whether the system runs as server or client.
5175 It is possibly to omit metrics for a specific NFS version by setting one or
5176 more of the following options to B<false> (all of them default to B<true>).
5180 =item B<ReportV2> B<true>|B<false>
5182 =item B<ReportV3> B<true>|B<false>
5184 =item B<ReportV4> B<true>|B<false>
5188 =head2 Plugin C<nginx>
5190 This plugin collects the number of connections and requests handled by the
5191 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5192 queries the page provided by the C<ngx_http_stub_status_module> module, which
5193 isn't compiled by default. Please refer to
5194 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5195 how to compile and configure nginx and this module.
5197 The following options are accepted by the C<nginx plugin>:
5201 =item B<URL> I<http://host/nginx_status>
5203 Sets the URL of the C<ngx_http_stub_status_module> output.
5205 =item B<User> I<Username>
5207 Optional user name needed for authentication.
5209 =item B<Password> I<Password>
5211 Optional password needed for authentication.
5213 =item B<VerifyPeer> B<true|false>
5215 Enable or disable peer SSL certificate verification. See
5216 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5218 =item B<VerifyHost> B<true|false>
5220 Enable or disable peer host name verification. If enabled, the plugin checks
5221 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5222 certificate matches the host name provided by the B<URL> option. If this
5223 identity check fails, the connection is aborted. Obviously, only works when
5224 connecting to a SSL enabled server. Enabled by default.
5226 =item B<CACert> I<File>
5228 File that holds one or more SSL certificates. If you want to use HTTPS you will
5229 possibly need this option. What CA certificates come bundled with C<libcurl>
5230 and are checked by default depends on the distribution you use.
5232 =item B<Timeout> I<Milliseconds>
5234 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5235 milliseconds. By default, the configured B<Interval> is used to set the
5240 =head2 Plugin C<notify_desktop>
5242 This plugin sends a desktop notification to a notification daemon, as defined
5243 in the Desktop Notification Specification. To actually display the
5244 notifications, B<notification-daemon> is required and B<collectd> has to be
5245 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5246 environment variables have to be set correctly) and the D-Bus message bus.
5248 The Desktop Notification Specification can be found at
5249 L<http://www.galago-project.org/specs/notification/>.
5253 =item B<OkayTimeout> I<timeout>
5255 =item B<WarningTimeout> I<timeout>
5257 =item B<FailureTimeout> I<timeout>
5259 Set the I<timeout>, in milliseconds, after which to expire the notification
5260 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5261 been specified, the displayed notification will not be closed at all - the
5262 user has to do so herself. These options default to 5000. If a negative number
5263 has been specified, the default is used as well.
5267 =head2 Plugin C<notify_email>
5269 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5270 configured email address.
5272 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5274 Available configuration options:
5278 =item B<From> I<Address>
5280 Email address from which the emails should appear to come from.
5282 Default: C<root@localhost>
5284 =item B<Recipient> I<Address>
5286 Configures the email address(es) to which the notifications should be mailed.
5287 May be repeated to send notifications to multiple addresses.
5289 At least one B<Recipient> must be present for the plugin to work correctly.
5291 =item B<SMTPServer> I<Hostname>
5293 Hostname of the SMTP server to connect to.
5295 Default: C<localhost>
5297 =item B<SMTPPort> I<Port>
5299 TCP port to connect to.
5303 =item B<SMTPUser> I<Username>
5305 Username for ASMTP authentication. Optional.
5307 =item B<SMTPPassword> I<Password>
5309 Password for ASMTP authentication. Optional.
5311 =item B<Subject> I<Subject>
5313 Subject-template to use when sending emails. There must be exactly two
5314 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5315 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5318 Default: C<Collectd notify: %s@%s>
5322 =head2 Plugin C<notify_nagios>
5324 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5325 a I<passive service check result>.
5327 Available configuration options:
5331 =item B<CommandFile> I<Path>
5333 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5337 =head2 Plugin C<ntpd>
5339 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5342 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5343 the wire - using B<mode 7> specific requests. This mode is deprecated with
5344 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5345 correctly with them, the ntp daemon must be explicitly configured to
5346 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5347 manual page for details.
5349 Available configuration options for the C<ntpd> plugin:
5353 =item B<Host> I<Hostname>
5355 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5357 =item B<Port> I<Port>
5359 UDP-Port to connect to. Defaults to B<123>.
5361 =item B<ReverseLookups> B<true>|B<false>
5363 Sets whether or not to perform reverse lookups on peers. Since the name or
5364 IP-address may be used in a filename it is recommended to disable reverse
5365 lookups. The default is to do reverse lookups to preserve backwards
5366 compatibility, though.
5368 =item B<IncludeUnitID> B<true>|B<false>
5370 When a peer is a refclock, include the unit ID in the I<type instance>.
5371 Defaults to B<false> for backward compatibility.
5373 If two refclock peers use the same driver and this is B<false>, the plugin will
5374 try to write simultaneous measurements from both to the same type instance.
5375 This will result in error messages in the log and only one set of measurements
5380 =head2 Plugin C<nut>
5384 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5386 Add a UPS to collect data from. The format is identical to the one accepted by
5389 =item B<ForceSSL> B<true>|B<false>
5391 Stops connections from falling back to unsecured if an SSL connection
5392 cannot be established. Defaults to false if undeclared.
5394 =item B<VerifyPeer> I<true>|I<false>
5396 If set to true, requires a CAPath be provided. Will use the CAPath to find
5397 certificates to use as Trusted Certificates to validate a upsd server certificate.
5398 If validation of the upsd server certificate fails, the connection will not be
5399 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5400 will override and set ForceSSL to true.
5402 =item B<CAPath> I/path/to/certs/folder
5404 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5405 The folder pointed at must contain certificate(s) named according to their hash.
5406 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5407 occur because two different certs have the same hash value, Y can be incremented
5408 in order to avoid conflict. To create a symbolic link to a certificate the following
5409 command can be used from within the directory where the cert resides:
5411 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5413 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5414 generate links like the one described above for ALL certs in a given folder.
5416 C<c_rehash /path/to/certs/folder>
5418 =item B<ConnectTimeout> I<Milliseconds>
5420 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5421 By default, the configured B<Interval> is used to set the timeout.
5425 =head2 Plugin C<olsrd>
5427 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5428 the Optimized Link State Routing daemon and reads information about the current
5429 state of the meshed network.
5431 The following configuration options are understood:
5435 =item B<Host> I<Host>
5437 Connect to I<Host>. Defaults to B<"localhost">.
5439 =item B<Port> I<Port>
5441 Specifies the port to connect to. This must be a string, even if you give the
5442 port as a number rather than a service name. Defaults to B<"2006">.
5444 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5446 Specifies what information to collect about links, i.E<nbsp>e. direct
5447 connections of the daemon queried. If set to B<No>, no information is
5448 collected. If set to B<Summary>, the number of links and the average of all
5449 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5450 If set to B<Detail> LQ and NLQ are collected per link.
5452 Defaults to B<Detail>.
5454 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5456 Specifies what information to collect about routes of the daemon queried. If
5457 set to B<No>, no information is collected. If set to B<Summary>, the number of
5458 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5459 metric and ETX are collected per route.
5461 Defaults to B<Summary>.
5463 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5465 Specifies what information to collect about the global topology. If set to
5466 B<No>, no information is collected. If set to B<Summary>, the number of links
5467 in the entire topology and the average I<link quality> (LQ) is calculated.
5468 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5470 Defaults to B<Summary>.
5474 =head2 Plugin C<onewire>
5476 B<EXPERIMENTAL!> See notes below.
5478 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5479 L<http://owfs.org/> to read sensors connected via the onewire bus.
5481 It can be used in two possible modes - standard or advanced.
5483 In the standard mode only temperature sensors (sensors with the family code
5484 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5485 other sensors you would like to have included, please send a sort request to
5486 the mailing list. You can select sensors to be read or to be ignored depending
5487 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5488 walked and all sensors are read.
5490 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5491 experimental, below.
5493 In the advanced mode you can configure any sensor to be read (only numerical
5494 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5495 In this mode you have to list all the sensors. Neither default bus walk nor
5496 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5497 the path automatically and should produce compatible structure with the "standard"
5498 mode (basically the path is expected as for example
5499 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5500 "F10FCA000800" and the rest after the slash is considered the type - here
5502 There are two advantages to this mode - you can access virtually any sensor
5503 (not just temperature), select whether to use cached or directly read values
5504 and it is slighlty faster. The downside is more complex configuration.
5506 The two modes are distinguished automatically by the format of the address.
5507 It is not possible to mix the two modes. Once a full path is detected in any
5508 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5509 (and as standard addresses will fail parsing they will be ignored).
5513 =item B<Device> I<Device>
5515 Sets the device to read the values from. This can either be a "real" hardware
5516 device, such as a serial port or an USB port, or the address of the
5517 L<owserver(1)> socket, usually B<localhost:4304>.
5519 Though the documentation claims to automatically recognize the given address
5520 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5521 with that version, the following configuration worked for us:
5524 Device "-s localhost:4304"
5527 This directive is B<required> and does not have a default value.
5529 =item B<Sensor> I<Sensor>
5531 In the standard mode selects sensors to collect or to ignore
5532 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5533 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5534 and B<not> include the leading C<10.> family byte and point.
5535 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5536 sensors (see above) are read.
5538 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5539 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5540 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5542 As there can be multiple devices on the bus you can list multiple sensor (use
5543 multiple B<Sensor> elements).
5545 See F</"IGNORELISTS"> for details.
5547 =item B<IgnoreSelected> I<true>|I<false>
5549 If no configuration is given, the B<onewire> plugin will collect data from all
5550 sensors found. This may not be practical, especially if sensors are added and
5551 removed regularly. Sometimes, however, it's easier/preferred to collect only
5552 specific sensors or all sensors I<except> a few specified ones. This option
5553 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5554 B<Sensor> is inverted: All selected interfaces are ignored and all other
5555 interfaces are collected.
5557 Used only in the standard mode - see above.
5559 =item B<Interval> I<Seconds>
5561 Sets the interval in which all sensors should be read. If not specified, the
5562 global B<Interval> setting is used.
5566 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5567 work with big setups. It works with one sensor being attached to one
5568 controller, but as soon as you throw in a couple more senors and maybe a hub
5569 or two, reading all values will take more than ten seconds (the default
5570 interval). We will probably add some separate thread for reading the sensors
5571 and some cache or something like that, but it's not done yet. We will try to
5572 maintain backwards compatibility in the future, but we can't promise. So in
5573 short: If it works for you: Great! But keep in mind that the config I<might>
5574 change, though this is unlikely. Oh, and if you want to help improving this
5575 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5577 =head2 Plugin C<openldap>
5579 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5580 server correctly. The backend database C<monitor> needs to be loaded and
5581 working. See slapd-monitor(5) for the details.
5583 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5584 blocks. Each block requires one string argument as the instance name. For
5589 URL "ldap://localhost/"
5592 URL "ldaps://localhost/"
5596 The instance name will be used as the I<plugin instance>. To emulate the old
5597 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5598 plugin to work correctly, each instance name must be unique. This is not
5599 enforced by the plugin and it is your responsibility to ensure it is.
5601 The following options are accepted within each B<Instance> block:
5605 =item B<URL> I<ldap://host/binddn>
5607 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5610 =item B<BindDN> I<BindDN>
5612 Name in the form of an LDAP distinguished name intended to be used for
5613 authentication. Defaults to empty string to establish an anonymous authorization.
5615 =item B<Password> I<Password>
5617 Password for simple bind authentication. If this option is not set,
5618 unauthenticated bind operation is used.
5620 =item B<StartTLS> B<true|false>
5622 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5623 Disabled by default.
5625 =item B<VerifyHost> B<true|false>
5627 Enables or disables peer host name verification. If enabled, the plugin checks
5628 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5629 certificate matches the host name provided by the B<URL> option. If this
5630 identity check fails, the connection is aborted. Enabled by default.
5632 =item B<CACert> I<File>
5634 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5635 may possibly need this option. What CA certificates are checked by default
5636 depends on the distribution you use and can be changed with the usual ldap
5637 client configuration mechanisms. See ldap.conf(5) for the details.
5639 =item B<Timeout> I<Seconds>
5641 Sets the timeout value for ldap operations, in seconds. By default, the
5642 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5645 =item B<Version> I<Version>
5647 An integer which sets the LDAP protocol version number to use when connecting
5648 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5652 =head2 Plugin C<openvpn>
5654 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5655 traffic statistics about connected clients.
5657 To set up OpenVPN to write to the status file periodically, use the
5658 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
5659 you need to set the required format, too. This is done by setting
5660 B<--status-version> to B<2>.
5662 So, in a nutshell you need:
5664 openvpn $OTHER_OPTIONS \
5665 --status "/var/run/openvpn-status" 10 \
5672 =item B<StatusFile> I<File>
5674 Specifies the location of the status file.
5676 =item B<ImprovedNamingSchema> B<true>|B<false>
5678 When enabled, the filename of the status file will be used as plugin instance
5679 and the client's "common name" will be used as type instance. This is required
5680 when reading multiple status files. Enabling this option is recommended, but to
5681 maintain backwards compatibility this option is disabled by default.
5683 =item B<CollectCompression> B<true>|B<false>
5685 Sets whether or not statistics about the compression used by OpenVPN should be
5686 collected. This information is only available in I<single> mode. Enabled by
5689 =item B<CollectIndividualUsers> B<true>|B<false>
5691 Sets whether or not traffic information is collected for each connected client
5692 individually. If set to false, currently no traffic data is collected at all
5693 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5695 =item B<CollectUserCount> B<true>|B<false>
5697 When enabled, the number of currently connected clients or users is collected.
5698 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5699 can be configured independently from that option. Defaults to B<false>.
5703 =head2 Plugin C<oracle>
5705 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5706 Oracle® Database and lets you execute SQL statements there. It is very similar
5707 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5708 plugin's documentation above for details.
5711 <Query "out_of_stock">
5712 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5715 # InstancePrefix "foo"
5716 InstancesFrom "category"
5720 <Database "product_information">
5724 Query "out_of_stock"
5728 =head3 B<Query> blocks
5730 The Query blocks are handled identically to the Query blocks of the "dbi"
5731 plugin. Please see its documentation above for details on how to specify
5734 =head3 B<Database> blocks
5736 Database blocks define a connection to a database and which queries should be
5737 sent to that database. Each database needs a "name" as string argument in the
5738 starting tag of the block. This name will be used as "PluginInstance" in the
5739 values submitted to the daemon. Other than that, that name is not used.
5743 =item B<ConnectID> I<ID>
5745 Defines the "database alias" or "service name" to connect to. Usually, these
5746 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5748 =item B<Host> I<Host>
5750 Hostname to use when dispatching values for this database. Defaults to using
5751 the global hostname of the I<collectd> instance.
5753 =item B<Username> I<Username>
5755 Username used for authentication.
5757 =item B<Password> I<Password>
5759 Password used for authentication.
5761 =item B<Query> I<QueryName>
5763 Associates the query named I<QueryName> with this database connection. The
5764 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5765 blocks you want to refer to must be placed above the database block you want to
5770 =head2 Plugin C<ovs_events>
5772 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5773 connected interfaces, dispatches the values to collectd and sends the
5774 notification whenever the link state change occurs. This plugin uses OVS
5775 database to get a link state change notification.
5779 <Plugin "ovs_events">
5782 Socket "/var/run/openvswitch/db.sock"
5783 Interfaces "br0" "veth0"
5784 SendNotification true
5785 DispatchValues false
5788 The plugin provides the following configuration options:
5792 =item B<Address> I<node>
5794 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5795 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5796 option. See L<ovsdb-server(1)> for more details. The option may be either
5797 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5798 format. Defaults to B<'localhost'>.
5800 =item B<Port> I<service>
5802 TCP-port to connect to. Either a service name or a port number may be given.
5803 Defaults to B<6640>.
5805 =item B<Socket> I<path>
5807 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5808 plugin. To enable the interface, the OVS DB daemon should be running with
5809 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5810 option is set, B<Address> and B<Port> options are ignored.
5812 =item B<Interfaces> [I<ifname> ...]
5814 List of interface names to be monitored by this plugin. If this option is not
5815 specified or is empty then all OVS connected interfaces on all bridges are
5818 Default: empty (all interfaces on all bridges are monitored)
5820 =item B<SendNotification> I<true|false>
5822 If set to true, OVS link notifications (interface status and OVS DB connection
5823 terminate) are sent to collectd. Default value is true.
5825 =item B<DispatchValues> I<true|false>
5827 Dispatch the OVS DB interface link status value with configured plugin interval.
5828 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
5829 options are false, no OVS information will be provided by the plugin.
5833 B<Note:> By default, the global interval setting is used within which to
5834 retrieve the OVS link status. To configure a plugin-specific interval, please
5835 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
5836 simple divide the time by 1000 for example if the desired interval is 50ms, set
5839 =head2 Plugin C<ovs_stats>
5841 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
5842 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
5843 statistics from OVSDB
5847 <Plugin "ovs_stats">
5850 Socket "/var/run/openvswitch/db.sock"
5851 Bridges "br0" "br_ext"
5854 The plugin provides the following configuration options:
5858 =item B<Address> I<node>
5860 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5861 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5862 option. See L<ovsdb-server(1)> for more details. The option may be either
5863 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5864 format. Defaults to B<'localhost'>.
5866 =item B<Port> I<service>
5868 TCP-port to connect to. Either a service name or a port number may be given.
5869 Defaults to B<6640>.
5871 =item B<Socket> I<path>
5873 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5874 plugin. To enable the interface, the OVS DB daemon should be running with
5875 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5876 option is set, B<Address> and B<Port> options are ignored.
5878 =item B<Bridges> [I<brname> ...]
5880 List of OVS bridge names to be monitored by this plugin. If this option is
5881 omitted or is empty then all OVS bridges will be monitored.
5883 Default: empty (monitor all bridges)
5887 =head2 Plugin C<perl>
5889 This plugin embeds a Perl-interpreter into collectd and provides an interface
5890 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
5892 =head2 Plugin C<pinba>
5894 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
5895 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
5896 PHP-based webpage has been delivered, the extension will send a UDP packet
5897 containing timing information, peak memory usage and so on. The plugin will
5898 wait for such packets, parse them and account the provided information, which
5899 is then dispatched to the daemon once per interval.
5906 # Overall statistics for the website.
5908 Server "www.example.com"
5910 # Statistics for www-a only
5912 Host "www-a.example.com"
5913 Server "www.example.com"
5915 # Statistics for www-b only
5917 Host "www-b.example.com"
5918 Server "www.example.com"
5922 The plugin provides the following configuration options:
5926 =item B<Address> I<Node>
5928 Configures the address used to open a listening socket. By default, plugin will
5929 bind to the I<any> address C<::0>.
5931 =item B<Port> I<Service>
5933 Configures the port (service) to bind to. By default the default Pinba port
5934 "30002" will be used. The option accepts service names in addition to port
5935 numbers and thus requires a I<string> argument.
5937 =item E<lt>B<View> I<Name>E<gt> block
5939 The packets sent by the Pinba extension include the hostname of the server, the
5940 server name (the name of the virtual host) and the script that was executed.
5941 Using B<View> blocks it is possible to separate the data into multiple groups
5942 to get more meaningful statistics. Each packet is added to all matching groups,
5943 so that a packet may be accounted for more than once.
5947 =item B<Host> I<Host>
5949 Matches the hostname of the system the webserver / script is running on. This
5950 will contain the result of the L<gethostname(2)> system call. If not
5951 configured, all hostnames will be accepted.
5953 =item B<Server> I<Server>
5955 Matches the name of the I<virtual host>, i.e. the contents of the
5956 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
5957 server names will be accepted.
5959 =item B<Script> I<Script>
5961 Matches the name of the I<script name>, i.e. the contents of the
5962 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
5963 script names will be accepted.
5969 =head2 Plugin C<ping>
5971 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
5972 configured hosts periodically and measures the network latency. Whenever the
5973 C<read> function of the plugin is called, it submits the average latency, the
5974 standard deviation and the drop rate for each host.
5976 Available configuration options:
5980 =item B<Host> I<IP-address>
5982 Host to ping periodically. This option may be repeated several times to ping
5985 =item B<Interval> I<Seconds>
5987 Sets the interval in which to send ICMP echo packets to the configured hosts.
5988 This is B<not> the interval in which metrics are read from the plugin but the
5989 interval in which the hosts are "pinged". Therefore, the setting here should be
5990 smaller than or equal to the global B<Interval> setting. Fractional times, such
5991 as "1.24" are allowed.
5995 =item B<Timeout> I<Seconds>
5997 Time to wait for a response from the host to which an ICMP packet had been
5998 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
5999 to be down or the packet to be dropped. This setting must be smaller than the
6000 B<Interval> setting above for the plugin to work correctly. Fractional
6001 arguments are accepted.
6005 =item B<TTL> I<0-255>
6007 Sets the Time-To-Live of generated ICMP packets.
6009 =item B<Size> I<size>
6011 Sets the size of the data payload in ICMP packet to specified I<size> (it
6012 will be filled with regular ASCII pattern). If not set, default 56 byte
6013 long string is used so that the packet size of an ICMPv4 packet is exactly
6014 64 bytes, similar to the behaviour of normal ping(1) command.
6016 =item B<SourceAddress> I<host>
6018 Sets the source address to use. I<host> may either be a numerical network
6019 address or a network hostname.
6021 =item B<Device> I<name>
6023 Sets the outgoing network device to be used. I<name> has to specify an
6024 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6027 =item B<MaxMissed> I<Packets>
6029 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6030 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6032 Default: B<-1> (disabled)
6036 =head2 Plugin C<postgresql>
6038 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6039 keeps a persistent connection to all configured databases and tries to
6040 reconnect if the connection has been interrupted. A database is configured by
6041 specifying a B<Database> block as described below. The default statistics are
6042 collected from PostgreSQL's B<statistics collector> which thus has to be
6043 enabled for this plugin to work correctly. This should usually be the case by
6044 default. See the section "The Statistics Collector" of the B<PostgreSQL
6045 Documentation> for details.
6047 By specifying custom database queries using a B<Query> block as described
6048 below, you may collect any data that is available from some PostgreSQL
6049 database. This way, you are able to access statistics of external daemons
6050 which are available in a PostgreSQL database or use future or special
6051 statistics provided by PostgreSQL without the need to upgrade your collectd
6054 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6055 PostgreSQL databases as well. This has been implemented in a generic way. You
6056 need to specify an SQL statement which will then be executed by collectd in
6057 order to write the data (see below for details). The benefit of that approach
6058 is that there is no fixed database layout. Rather, the layout may be optimized
6059 for the current setup.
6061 The B<PostgreSQL Documentation> manual can be found at
6062 L<http://www.postgresql.org/docs/manuals/>.
6066 Statement "SELECT magic FROM wizard WHERE host = $1;"
6070 InstancePrefix "magic"
6075 <Query rt36_tickets>
6076 Statement "SELECT COUNT(type) AS count, type \
6078 WHEN resolved = 'epoch' THEN 'open' \
6079 ELSE 'resolved' END AS type \
6080 FROM tickets) type \
6084 InstancePrefix "rt36_tickets"
6085 InstancesFrom "type"
6091 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6101 KRBSrvName "kerberos_service_name"
6107 Service "service_name"
6108 Query backend # predefined
6119 The B<Query> block defines one database query which may later be used by a
6120 database definition. It accepts a single mandatory argument which specifies
6121 the name of the query. The names of all queries have to be unique (see the
6122 B<MinVersion> and B<MaxVersion> options below for an exception to this
6125 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6126 B<Result> blocks may be used to extract multiple values from a single query.
6128 The following configuration options are available to define the query:
6132 =item B<Statement> I<sql query statement>
6134 Specify the I<sql query statement> which the plugin should execute. The string
6135 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6136 first, second, etc. parameter. The value of the parameters is specified by the
6137 B<Param> configuration option - see below for details. To include a literal
6138 B<$> character followed by a number, surround it with single quotes (B<'>).
6140 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6141 allowed. Note, however, that only a single command may be used. Semicolons are
6142 allowed as long as a single non-empty command has been specified only.
6144 The returned lines will be handled separately one after another.
6146 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6148 Specify the parameters which should be passed to the SQL query. The parameters
6149 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6150 they appear in the configuration file. The value of the parameter is
6151 determined depending on the value of the B<Param> option as follows:
6157 The configured hostname of the database connection. If a UNIX domain socket is
6158 used, the parameter expands to "localhost".
6162 The name of the database of the current connection.
6166 The name of the database plugin instance. See the B<Instance> option of the
6167 database specification below for details.
6171 The username used to connect to the database.
6175 The interval with which this database is queried (as specified by the database
6176 specific or global B<Interval> options).
6180 Please note that parameters are only supported by PostgreSQL's protocol
6181 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6183 =item B<PluginInstanceFrom> I<column>
6185 Specify how to create the "PluginInstance" for reporting this query results.
6186 Only one column is supported. You may concatenate fields and string values in
6187 the query statement to get the required results.
6189 =item B<MinVersion> I<version>
6191 =item B<MaxVersion> I<version>
6193 Specify the minimum or maximum version of PostgreSQL that this query should be
6194 used with. Some statistics might only be available with certain versions of
6195 PostgreSQL. This allows you to specify multiple queries with the same name but
6196 which apply to different versions, thus allowing you to use the same
6197 configuration in a heterogeneous environment.
6199 The I<version> has to be specified as the concatenation of the major, minor
6200 and patch-level versions, each represented as two-decimal-digit numbers. For
6201 example, version 8.2.3 will become 80203.
6205 The B<Result> block defines how to handle the values returned from the query.
6206 It defines which column holds which value and how to dispatch that value to
6211 =item B<Type> I<type>
6213 The I<type> name to be used when dispatching the values. The type describes
6214 how to handle the data and where to store it. See L<types.db(5)> for more
6215 details on types and their configuration. The number and type of values (as
6216 selected by the B<ValuesFrom> option) has to match the type of the given name.
6218 This option is mandatory.
6220 =item B<InstancePrefix> I<prefix>
6222 =item B<InstancesFrom> I<column0> [I<column1> ...]
6224 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6225 B<InstancePrefix> defines a static prefix that will be prepended to all type
6226 instances. B<InstancesFrom> defines the column names whose values will be used
6227 to create the type instance. Multiple values will be joined together using the
6228 hyphen (C<->) as separation character.
6230 The plugin itself does not check whether or not all built instances are
6231 different. It is your responsibility to assure that each is unique.
6233 Both options are optional. If none is specified, the type instance will be
6236 =item B<ValuesFrom> I<column0> [I<column1> ...]
6238 Names the columns whose content is used as the actual data for the data sets
6239 that are dispatched to the daemon. How many such columns you need is
6240 determined by the B<Type> setting as explained above. If you specify too many
6241 or not enough columns, the plugin will complain about that and no data will be
6242 submitted to the daemon.
6244 The actual data type, as seen by PostgreSQL, is not that important as long as
6245 it represents numbers. The plugin will automatically cast the values to the
6246 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6247 L<strtod(3)> functions, so anything supported by those functions is supported
6248 by the plugin as well.
6250 This option is required inside a B<Result> block and may be specified multiple
6251 times. If multiple B<ValuesFrom> options are specified, the columns are read
6256 The following predefined queries are available (the definitions can be found
6257 in the F<postgresql_default.conf> file which, by default, is available at
6258 C<I<prefix>/share/collectd/>):
6264 This query collects the number of backends, i.E<nbsp>e. the number of
6267 =item B<transactions>
6269 This query collects the numbers of committed and rolled-back transactions of
6274 This query collects the numbers of various table modifications (i.E<nbsp>e.
6275 insertions, updates, deletions) of the user tables.
6277 =item B<query_plans>
6279 This query collects the numbers of various table scans and returned tuples of
6282 =item B<table_states>
6284 This query collects the numbers of live and dead rows in the user tables.
6288 This query collects disk block access counts for user tables.
6292 This query collects the on-disk size of the database in bytes.
6296 In addition, the following detailed queries are available by default. Please
6297 note that each of those queries collects information B<by table>, thus,
6298 potentially producing B<a lot> of data. For details see the description of the
6299 non-by_table queries above.
6303 =item B<queries_by_table>
6305 =item B<query_plans_by_table>
6307 =item B<table_states_by_table>
6309 =item B<disk_io_by_table>
6313 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6314 mandatory argument specifying the name of the writer. This will then be used
6315 in the B<Database> specification in order to activate the writer instance. The
6316 names of all writers have to be unique. The following options may be
6321 =item B<Statement> I<sql statement>
6323 This mandatory option specifies the SQL statement that will be executed for
6324 each submitted value. A single SQL statement is allowed only. Anything after
6325 the first semicolon will be ignored.
6327 Nine parameters will be passed to the statement and should be specified as
6328 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6329 values are made available through those parameters:
6335 The timestamp of the queried value as an RFC 3339-formatted local time.
6339 The hostname of the queried value.
6343 The plugin name of the queried value.
6347 The plugin instance of the queried value. This value may be B<NULL> if there
6348 is no plugin instance.
6352 The type of the queried value (cf. L<types.db(5)>).
6356 The type instance of the queried value. This value may be B<NULL> if there is
6361 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6362 sources of the submitted value-list).
6366 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6367 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6368 B<StoreRates> is enabled (which is the default, see below), all types will be
6373 An array of the submitted values. The dimensions of the value name and value
6378 In general, it is advisable to create and call a custom function in the
6379 PostgreSQL database for this purpose. Any procedural language supported by
6380 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6383 =item B<StoreRates> B<false>|B<true>
6385 If set to B<true> (the default), convert counter values to rates. If set to
6386 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6391 The B<Database> block defines one PostgreSQL database for which to collect
6392 statistics. It accepts a single mandatory argument which specifies the
6393 database name. None of the other options are required. PostgreSQL will use
6394 default values as documented in the section "CONNECTING TO A DATABASE" in the
6395 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6396 the user collectd is run as and special environment variables. See the manpage
6401 =item B<Interval> I<seconds>
6403 Specify the interval with which the database should be queried. The default is
6404 to use the global B<Interval> setting.
6406 =item B<CommitInterval> I<seconds>
6408 This option may be used for database connections which have "writers" assigned
6409 (see above). If specified, it causes a writer to put several updates into a
6410 single transaction. This transaction will last for the specified amount of
6411 time. By default, each update will be executed in a separate transaction. Each
6412 transaction generates a fair amount of overhead which can, thus, be reduced by
6413 activating this option. The draw-back is, that data covering the specified
6414 amount of time will be lost, for example, if a single statement within the
6415 transaction fails or if the database server crashes.
6417 =item B<Instance> I<name>
6419 Specify the plugin instance name that should be used instead of the database
6420 name (which is the default, if this option has not been specified). This
6421 allows one to query multiple databases of the same name on the same host (e.g.
6422 when running multiple database server versions in parallel).
6423 The plugin instance name can also be set from the query result using
6424 the B<PluginInstanceFrom> option in B<Query> block.
6426 =item B<Host> I<hostname>
6428 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6429 value begins with a slash, it is interpreted as the directory name in which to
6430 look for the UNIX domain socket.
6432 This option is also used to determine the hostname that is associated with a
6433 collected data set. If it has been omitted or either begins with with a slash
6434 or equals B<localhost> it will be replaced with the global hostname definition
6435 of collectd. Any other value will be passed literally to collectd when
6436 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6438 =item B<Port> I<port>
6440 Specify the TCP port or the local UNIX domain socket file extension of the
6443 =item B<User> I<username>
6445 Specify the username to be used when connecting to the server.
6447 =item B<Password> I<password>
6449 Specify the password to be used when connecting to the server.
6451 =item B<ExpireDelay> I<delay>
6453 Skip expired values in query output.
6455 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6457 Specify whether to use an SSL connection when contacting the server. The
6458 following modes are supported:
6464 Do not use SSL at all.
6468 First, try to connect without using SSL. If that fails, try using SSL.
6470 =item I<prefer> (default)
6472 First, try to connect using SSL. If that fails, try without using SSL.
6480 =item B<Instance> I<name>
6482 Specify the plugin instance name that should be used instead of the database
6483 name (which is the default, if this option has not been specified). This
6484 allows one to query multiple databases of the same name on the same host (e.g.
6485 when running multiple database server versions in parallel).
6487 =item B<KRBSrvName> I<kerberos_service_name>
6489 Specify the Kerberos service name to use when authenticating with Kerberos 5
6490 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6491 B<PostgreSQL Documentation> for details.
6493 =item B<Service> I<service_name>
6495 Specify the PostgreSQL service name to use for additional parameters. That
6496 service has to be defined in F<pg_service.conf> and holds additional
6497 connection parameters. See the section "The Connection Service File" in the
6498 B<PostgreSQL Documentation> for details.
6500 =item B<Query> I<query>
6502 Specifies a I<query> which should be executed in the context of the database
6503 connection. This may be any of the predefined or user-defined queries. If no
6504 such option is given, it defaults to "backends", "transactions", "queries",
6505 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6506 has been specified). Else, the specified queries are used only.
6508 =item B<Writer> I<writer>
6510 Assigns the specified I<writer> backend to the database connection. This
6511 causes all collected data to be send to the database using the settings
6512 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6513 below for details on how to selectively send data to certain plugins).
6515 Each writer will register a flush callback which may be used when having long
6516 transactions enabled (see the B<CommitInterval> option above). When issuing
6517 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6518 transaction will be committed right away. Two different kinds of flush
6519 callbacks are available with the C<postgresql> plugin:
6525 Flush all writer backends.
6527 =item B<postgresql->I<database>
6529 Flush all writers of the specified I<database> only.
6535 =head2 Plugin C<powerdns>
6537 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6538 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6539 values, many of which are probably meaningless to most users, but may be useful
6540 for some. So you may chose which values to collect, but if you don't, some
6541 reasonable defaults will be collected.
6544 <Server "server_name">
6546 Collect "udp-answers" "udp-queries"
6547 Socket "/var/run/pdns.controlsocket"
6549 <Recursor "recursor_name">
6551 Collect "cache-hits" "cache-misses"
6552 Socket "/var/run/pdns_recursor.controlsocket"
6554 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6559 =item B<Server> and B<Recursor> block
6561 The B<Server> block defines one authoritative server to query, the B<Recursor>
6562 does the same for an recursing server. The possible options in both blocks are
6563 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6568 =item B<Collect> I<Field>
6570 Using the B<Collect> statement you can select which values to collect. Here,
6571 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6572 C<dlg-only-drops>, C<answers10-100>.
6574 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6575 When querying the server a C<SHOW *> command is issued in any case, because
6576 that's the only way of getting multiple values out of the server at once.
6577 collectd then picks out the values you have selected. When querying the
6578 recursor, a command is generated to query exactly these values. So if you
6579 specify invalid fields when querying the recursor, a syntax error may be
6580 returned by the daemon and collectd may not collect any values at all.
6582 If no B<Collect> statement is given, the following B<Server> values will be
6589 =item packetcache-hit
6591 =item packetcache-miss
6593 =item packetcache-size
6595 =item query-cache-hit
6597 =item query-cache-miss
6599 =item recursing-answers
6601 =item recursing-questions
6613 The following B<Recursor> values will be collected by default:
6617 =item noerror-answers
6619 =item nxdomain-answers
6621 =item servfail-answers
6639 Please note that up to that point collectd doesn't know what values are
6640 available on the server and values that are added do not need a change of the
6641 mechanism so far. However, the values must be mapped to collectd's naming
6642 scheme, which is done using a lookup table that lists all known values. If
6643 values are added in the future and collectd does not know about them, you will
6644 get an error much like this:
6646 powerdns plugin: submit: Not found in lookup table: foobar = 42
6648 In this case please file a bug report with the collectd team.
6650 =item B<Socket> I<Path>
6652 Configures the path to the UNIX domain socket to be used when connecting to the
6653 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6654 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6655 will be used for the recursor.
6659 =item B<LocalSocket> I<Path>
6661 Querying the recursor is done using UDP. When using UDP over UNIX domain
6662 sockets, the client socket needs a name in the file system, too. You can set
6663 this local name to I<Path> using the B<LocalSocket> option. The default is
6664 C<I<prefix>/var/run/collectd-powerdns>.
6668 =head2 Plugin C<processes>
6672 =item B<Process> I<Name>
6674 Select more detailed statistics of processes matching this name. The statistics
6675 collected for these selected processes are:
6676 - size of the resident segment size (RSS)
6677 - user- and system-time used
6678 - number of processes
6680 - number of open files (under Linux)
6681 - io data (where available)
6682 - context switches (under Linux)
6683 - minor and major pagefaults.
6685 Some platforms have a limit on the length of process names. I<Name> must stay
6688 =item B<ProcessMatch> I<name> I<regex>
6690 Similar to the B<Process> option this allows one to select more detailed
6691 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6692 details). The statistics of all matching processes are summed up and
6693 dispatched to the daemon using the specified I<name> as an identifier. This
6694 allows one to "group" several processes together. I<name> must not contain
6697 =item B<CollectContextSwitch> I<Boolean>
6699 Collect context switch of the process.
6703 =head2 Plugin C<protocols>
6705 Collects a lot of information about various network protocols, such as I<IP>,
6706 I<TCP>, I<UDP>, etc.
6708 Available configuration options:
6712 =item B<Value> I<Selector>
6714 Selects whether or not to select a specific value. The string being matched is
6715 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6716 plugin instance and I<ValueName> will be used as type instance. An example of
6717 the string being used would be C<Tcp:RetransSegs>.
6719 You can use regular expressions to match a large number of values with just one
6720 configuration option. To select all "extended" I<TCP> values, you could use the
6721 following statement:
6725 Whether only matched values are selected or all matched values are ignored
6726 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6727 If no value is configured at all, all values will be selected.
6729 See F</"IGNORELISTS"> for details.
6731 =item B<IgnoreSelected> B<true>|B<false>
6733 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6734 matching values will be ignored.
6738 =head2 Plugin C<python>
6740 This plugin embeds a Python-interpreter into collectd and provides an interface
6741 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6743 =head2 Plugin C<routeros>
6745 The C<routeros> plugin connects to a device running I<RouterOS>, the
6746 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6747 I<librouteros> to connect and reads information about the interfaces and
6748 wireless connections of the device. The configuration supports querying
6753 Host "router0.example.com"
6756 CollectInterface true
6761 Host "router1.example.com"
6764 CollectInterface true
6765 CollectRegistrationTable true
6771 As you can see above, the configuration of the I<routeros> plugin consists of
6772 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6773 options are understood:
6777 =item B<Host> I<Host>
6779 Hostname or IP-address of the router to connect to.
6781 =item B<Port> I<Port>
6783 Port name or port number used when connecting. If left unspecified, the default
6784 will be chosen by I<librouteros>, currently "8728". This option expects a
6785 string argument, even when a numeric port number is given.
6787 =item B<User> I<User>
6789 Use the user name I<User> to authenticate. Defaults to "admin".
6791 =item B<Password> I<Password>
6793 Set the password used to authenticate.
6795 =item B<CollectInterface> B<true>|B<false>
6797 When set to B<true>, interface statistics will be collected for all interfaces
6798 present on the device. Defaults to B<false>.
6800 =item B<CollectRegistrationTable> B<true>|B<false>
6802 When set to B<true>, information about wireless LAN connections will be
6803 collected. Defaults to B<false>.
6805 =item B<CollectCPULoad> B<true>|B<false>
6807 When set to B<true>, information about the CPU usage will be collected. The
6808 number is a dimensionless value where zero indicates no CPU usage at all.
6809 Defaults to B<false>.
6811 =item B<CollectMemory> B<true>|B<false>
6813 When enabled, the amount of used and free memory will be collected. How used
6814 memory is calculated is unknown, for example whether or not caches are counted
6816 Defaults to B<false>.
6818 =item B<CollectDF> B<true>|B<false>
6820 When enabled, the amount of used and free disk space will be collected.
6821 Defaults to B<false>.
6823 =item B<CollectDisk> B<true>|B<false>
6825 When enabled, the number of sectors written and bad blocks will be collected.
6826 Defaults to B<false>.
6830 =head2 Plugin C<redis>
6832 The I<Redis plugin> connects to one or more Redis servers and gathers
6833 information about each server's state. For each server there is a I<Node> block
6834 which configures the connection parameters for this node.
6841 <Query "LLEN myqueue">
6848 The information shown in the synopsis above is the I<default configuration>
6849 which is used by the plugin if no configuration is present.
6853 =item B<Node> I<Nodename>
6855 The B<Node> block identifies a new Redis node, that is a new Redis instance
6856 running in an specified host and port. The name for node is a canonical
6857 identifier which is used as I<plugin instance>. It is limited to
6858 64E<nbsp>characters in length.
6860 =item B<Host> I<Hostname>
6862 The B<Host> option is the hostname or IP-address where the Redis instance is
6865 =item B<Port> I<Port>
6867 The B<Port> option is the TCP port on which the Redis instance accepts
6868 connections. Either a service name of a port number may be given. Please note
6869 that numerical port numbers must be given as a string, too.
6871 =item B<Password> I<Password>
6873 Use I<Password> to authenticate when connecting to I<Redis>.
6875 =item B<Timeout> I<Milliseconds>
6877 The B<Timeout> option set the socket timeout for node response. Since the Redis
6878 read function is blocking, you should keep this value as low as possible. Keep
6879 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
6880 than B<Interval> defined globally.
6882 =item B<Query> I<Querystring>
6884 The B<Query> block identifies a query to execute against the redis server.
6885 There may be an arbitrary number of queries to execute.
6887 =item B<Type> I<Collectd type>
6889 Within a query definition, a valid collectd type to use as when submitting
6890 the result of the query. When not supplied, will default to B<gauge>.
6892 =item B<Instance> I<Type instance>
6894 Within a query definition, an optional type instance to use when submitting
6895 the result of the query. When not supplied will default to the escaped
6896 command, up to 64 chars.
6900 =head2 Plugin C<rrdcached>
6902 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
6903 to store values to RRD files in an efficient manner. The combination of the
6904 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
6905 way the C<rrdtool> plugin works (see below). The added abstraction layer
6906 provides a number of benefits, though: Because the cache is not within
6907 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
6908 restarted. This results in much shorter (if any) gaps in graphs, especially
6909 under heavy load. Also, the C<rrdtool> command line utility is aware of the
6910 daemon so that it can flush values to disk automatically when needed. This
6911 allows one to integrate automated flushing of values into graphing solutions
6914 There are disadvantages, though: The daemon may reside on a different host, so
6915 it may not be possible for C<collectd> to create the appropriate RRD files
6916 anymore. And even if C<rrdcached> runs on the same host, it may run in a
6917 different base directory, so relative paths may do weird stuff if you're not
6920 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
6921 on the same host, communicating via a UNIX domain socket. The B<DataDir>
6922 setting should be set to an absolute path, so that a changed base directory
6923 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
6927 =item B<DaemonAddress> I<Address>
6929 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
6930 library. See L<rrdcached(1)> for details. Example:
6932 <Plugin "rrdcached">
6933 DaemonAddress "unix:/var/run/rrdcached.sock"
6936 =item B<DataDir> I<Directory>
6938 Set the base directory in which the RRD files reside. If this is a relative
6939 path, it is relative to the working base directory of the C<rrdcached> daemon!
6940 Use of an absolute path is recommended.
6942 =item B<CreateFiles> B<true>|B<false>
6944 Enables or disables the creation of RRD files. If the daemon is not running
6945 locally, or B<DataDir> is set to a relative path, this will not work as
6946 expected. Default is B<true>.
6948 =item B<CreateFilesAsync> B<false>|B<true>
6950 When enabled, new RRD files are enabled asynchronously, using a separate thread
6951 that runs in the background. This prevents writes to block, which is a problem
6952 especially when many hundreds of files need to be created at once. However,
6953 since the purpose of creating the files asynchronously is I<not> to block until
6954 the file is available, values before the file is available will be discarded.
6955 When disabled (the default) files are created synchronously, blocking for a
6956 short while, while the file is being written.
6958 =item B<StepSize> I<Seconds>
6960 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6961 this setting is unset and the stepsize is set to the interval in which the data
6962 is collected. Do not use this option unless you absolutely have to for some
6963 reason. Setting this option may cause problems with the C<snmp plugin>, the
6964 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6966 =item B<HeartBeat> I<Seconds>
6968 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6969 in which case the heartbeat is set to twice the B<StepSize> which should equal
6970 the interval in which data is collected. Do not set this option unless you have
6971 a very good reason to do so.
6973 =item B<RRARows> I<NumRows>
6975 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6976 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6977 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6978 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6979 week, one month, and one year.
6981 So for each timespan, it calculates how many PDPs need to be consolidated into
6982 one CDP by calculating:
6983 number of PDPs = timespan / (stepsize * rrarows)
6985 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6988 =item B<RRATimespan> I<Seconds>
6990 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6991 more then one RRA. If this option is never used, the built-in default of (3600,
6992 86400, 604800, 2678400, 31622400) is used.
6994 For more information on how RRA-sizes are calculated see B<RRARows> above.
6996 =item B<XFF> I<Factor>
6998 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6999 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7002 =item B<CollectStatistics> B<false>|B<true>
7004 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7005 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7007 Statistics are read via I<rrdcached>s socket using the STATS command.
7008 See L<rrdcached(1)> for details.
7012 =head2 Plugin C<rrdtool>
7014 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7015 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7016 using these settings. If you don't want to dive into the depths of RRDtool, you
7017 can safely ignore these settings.
7021 =item B<DataDir> I<Directory>
7023 Set the directory to store RRD files under. By default RRD files are generated
7024 beneath the daemon's working directory, i.e. the B<BaseDir>.
7026 =item B<CreateFilesAsync> B<false>|B<true>
7028 When enabled, new RRD files are enabled asynchronously, using a separate thread
7029 that runs in the background. This prevents writes to block, which is a problem
7030 especially when many hundreds of files need to be created at once. However,
7031 since the purpose of creating the files asynchronously is I<not> to block until
7032 the file is available, values before the file is available will be discarded.
7033 When disabled (the default) files are created synchronously, blocking for a
7034 short while, while the file is being written.
7036 =item B<StepSize> I<Seconds>
7038 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7039 this setting is unset and the stepsize is set to the interval in which the data
7040 is collected. Do not use this option unless you absolutely have to for some
7041 reason. Setting this option may cause problems with the C<snmp plugin>, the
7042 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7044 =item B<HeartBeat> I<Seconds>
7046 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7047 in which case the heartbeat is set to twice the B<StepSize> which should equal
7048 the interval in which data is collected. Do not set this option unless you have
7049 a very good reason to do so.
7051 =item B<RRARows> I<NumRows>
7053 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7054 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7055 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7056 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7057 week, one month, and one year.
7059 So for each timespan, it calculates how many PDPs need to be consolidated into
7060 one CDP by calculating:
7061 number of PDPs = timespan / (stepsize * rrarows)
7063 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7066 =item B<RRATimespan> I<Seconds>
7068 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7069 more then one RRA. If this option is never used, the built-in default of (3600,
7070 86400, 604800, 2678400, 31622400) is used.
7072 For more information on how RRA-sizes are calculated see B<RRARows> above.
7074 =item B<XFF> I<Factor>
7076 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7077 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7080 =item B<CacheFlush> I<Seconds>
7082 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7083 it writes all values for a certain RRD-file if the oldest value is older than
7084 (or equal to) the number of seconds specified by B<CacheTimeout>.
7085 That check happens on new values arriwal. If some RRD-file is not updated
7086 anymore for some reason (the computer was shut down, the network is broken,
7087 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7088 every I<Seconds> seconds the entire cache is searched for entries older than
7089 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7090 disk. Since scanning the entire cache is kind of expensive and does nothing
7091 under normal circumstances, this value should not be too small. 900 seconds
7092 might be a good value, though setting this to 7200 seconds doesn't normally
7093 do much harm either.
7095 Defaults to 10x B<CacheTimeout>.
7096 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7097 above default is used.
7099 =item B<CacheTimeout> I<Seconds>
7101 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7102 save values in a cache, as described above. Writing multiple values at once
7103 reduces IO-operations and thus lessens the load produced by updating the files.
7104 The trade off is that the graphs kind of "drag behind" and that more memory is
7107 =item B<WritesPerSecond> I<Updates>
7109 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7110 will run serious performance problems. The B<CacheFlush> setting and the
7111 internal update queue assert that collectd continues to work just fine even
7112 under heavy load, but the system may become very unresponsive and slow. This is
7113 a problem especially if you create graphs from the RRD files on the same
7114 machine, for example using the C<graph.cgi> script included in the
7115 C<contrib/collection3/> directory.
7117 This setting is designed for very large setups. Setting this option to a value
7118 between 25 and 80 updates per second, depending on your hardware, will leave
7119 the server responsive enough to draw graphs even while all the cached values
7120 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7121 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7122 written as fast as possible, so that web frontends have up to date data when
7125 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7126 updates per second, writing all values to disk will take approximately
7127 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7128 "collection3" you'll end up with a responsive and fast system, up to date
7129 graphs and basically a "backup" of your values every hour.
7131 =item B<RandomTimeout> I<Seconds>
7133 When set, the actual timeout for each value is chosen randomly between
7134 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7135 intention is to avoid high load situations that appear when many values timeout
7136 at the same time. This is especially a problem shortly after the daemon starts,
7137 because all values were added to the internal cache at roughly the same time.
7141 =head2 Plugin C<sensors>
7143 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7144 that all the needed modules have to be loaded and lm_sensors has to be
7145 configured (most likely by editing F</etc/sensors.conf>. Read
7146 L<sensors.conf(5)> for details.
7148 The B<lm_sensors> homepage can be found at
7149 L<http://secure.netroedge.com/~lm78/>.
7153 =item B<SensorConfigFile> I<File>
7155 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7156 the library's default will be used.
7158 =item B<Sensor> I<chip-bus-address/type-feature>
7160 Selects the name of the sensor which you want to collect or ignore, depending
7161 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7162 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7163 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7165 See F</"IGNORELISTS"> for details.
7167 =item B<IgnoreSelected> I<true>|I<false>
7169 If no configuration if given, the B<sensors>-plugin will collect data from all
7170 sensors. This may not be practical, especially for uninteresting sensors.
7171 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7172 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7173 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7174 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7175 and all other sensors are collected.
7177 =item B<UseLabels> I<true>|I<false>
7179 Configures how sensor readings are reported. When set to I<true>, sensor
7180 readings are reported using their descriptive label (e.g. "VCore"). When set to
7181 I<false> (the default) the sensor name is used ("in0").
7185 =head2 Plugin C<sigrok>
7187 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7188 supported by the L<sigrok|http://sigrok.org/> project.
7194 <Device "AC Voltage">
7199 <Device "Sound Level">
7200 Driver "cem-dt-885x"
7207 =item B<LogLevel> B<0-5>
7209 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7210 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7211 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7212 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7213 their level, are always submitted to I<collectd> at its INFO log level.
7215 =item E<lt>B<Device> I<Name>E<gt>
7217 A sigrok-supported device, uniquely identified by this section's options. The
7218 I<Name> is passed to I<collectd> as the I<plugin instance>.
7220 =item B<Driver> I<DriverName>
7222 The sigrok driver to use for this device.
7224 =item B<Conn> I<ConnectionSpec>
7226 If the device cannot be auto-discovered, or more than one might be discovered
7227 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7228 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7229 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7230 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7231 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7233 =item B<SerialComm> I<SerialSpec>
7235 For serial devices with non-standard port settings, this option can be used
7236 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7237 This should not be necessary; drivers know how to communicate with devices they
7240 =item B<MinimumInterval> I<Seconds>
7242 Specifies the minimum time between measurement dispatches to I<collectd>, in
7243 seconds. Since some I<sigrok> supported devices can acquire measurements many
7244 times per second, it may be necessary to throttle these. For example, the
7245 I<RRD plugin> cannot process writes more than once per second.
7247 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7248 device are always dispatched to I<collectd>. When throttled, unused
7249 measurements are discarded.
7253 =head2 Plugin C<smart>
7255 The C<smart> plugin collects SMART information from physical
7256 disks. Values collectd include temperature, power cycle count, poweron
7257 time and bad sectors. Also, all SMART attributes are collected along
7258 with the normalized current value, the worst value, the threshold and
7259 a human readable value.
7261 Using the following two options you can ignore some disks or configure the
7262 collection only of specific disks.
7266 =item B<Disk> I<Name>
7268 Select the disk I<Name>. Whether it is collected or ignored depends on the
7269 B<IgnoreSelected> setting, see below. As with other plugins that use the
7270 daemon's ignorelist functionality, a string that starts and ends with a slash
7271 is interpreted as a regular expression. Examples:
7276 See F</"IGNORELISTS"> for details.
7278 =item B<IgnoreSelected> B<true>|B<false>
7280 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7281 statements, are ignored or if all other disks are ignored. The behavior
7282 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7283 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7284 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7285 is set to B<true>, all disks are collected B<except> the ones matched.
7287 =item B<IgnoreSleepMode> B<true>|B<false>
7289 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7290 This option disables the sleep mode check and allows the plugin to collect data
7291 from these disks anyway. This is useful in cases where libatasmart mistakenly
7292 reports disks as asleep because it has not been updated to incorporate support
7293 for newer idle states in the ATA spec.
7295 =item B<UseSerial> B<true>|B<false>
7297 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7298 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7299 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7300 storing data. This ensures that the data for a given disk will be kept together
7301 even if the kernel name changes.
7305 =head2 Plugin C<snmp>
7307 Since the configuration of the C<snmp plugin> is a little more complicated than
7308 other plugins, its documentation has been moved to an own manpage,
7309 L<collectd-snmp(5)>. Please see there for details.
7311 =head2 Plugin C<snmp_agent>
7313 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7314 from SNMP master agent and returns the data collected by read plugins.
7315 The I<snmp_agent> plugin handles requests only for OIDs specified in
7316 configuration file. To handle SNMP queries the plugin gets data from collectd
7317 and translates requested values from collectd's internal format to SNMP format.
7318 This plugin is a generic plugin and cannot work without configuration.
7319 For more details on AgentX subagent see
7320 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7325 <Data "memAvailReal">
7327 #PluginInstance "some"
7330 OIDs "1.3.6.1.4.1.2021.4.6.0"
7333 IndexOID "IF-MIB::ifIndex"
7334 SizeOID "IF-MIB::ifNumber"
7338 OIDs "IF-MIB::ifDescr"
7344 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7349 There are two types of blocks that can be contained in the
7350 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7352 =head3 The B<Data> block
7354 The B<Data> block defines a list OIDs that are to be handled. This block can
7355 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7356 block it reperesents table OIDs.
7357 The following options can be set:
7361 =item B<Instance> I<true|false>
7363 When B<Instance> is set to B<true>, the value for requested OID is copied from
7364 plugin instance field of corresponding collectd value. If B<Data> block defines
7365 scalar data type B<Instance> has no effect and can be omitted.
7367 =item B<Plugin> I<String>
7369 Read plugin name whose collected data will be mapped to specified OIDs.
7371 =item B<PluginInstance> I<String>
7373 Read plugin instance whose collected data will be mapped to specified OIDs.
7374 The field is optional and by default there is no plugin instance check.
7375 Allowed only if B<Data> block defines scalar data type.
7377 =item B<Type> I<String>
7379 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7380 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7382 =item B<TypeInstance> I<String>
7384 Collectd's type-instance that is to be used for specified OID.
7386 =item B<OIDs> I<OID> [I<OID> ...]
7388 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7389 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7390 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7391 configured should correspond to number of values in specified B<Type>.
7392 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7393 "rx" and "tx" values of "if_octets" type.
7395 =item B<Scale> I<Value>
7397 The values taken from collectd are multiplied by I<Value>. The field is optional
7398 and the default is B<1.0>.
7400 =item B<Shift> I<Value>
7402 I<Value> is added to values from collectd after they have been multiplied by
7403 B<Scale> value. The field is optional and the default value is B<0.0>.
7407 =head3 The B<Table> block
7409 The B<Table> block defines a collection of B<Data> blocks that belong to one
7410 snmp table. In addition to multiple B<Data> blocks the following options can be
7415 =item B<IndexOID> I<OID>
7417 OID that is handled by the plugin and is mapped to numerical index value that is
7418 generated by the plugin for each table record.
7420 =item B<SizeOID> I<OID>
7422 OID that is handled by the plugin. Returned value is the number of records in
7423 the table. The field is optional.
7427 =head2 Plugin C<statsd>
7429 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7430 protocol and dispatches rates or other aggregates of these numbers
7433 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7434 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7435 C<objects> respectively.
7437 The following configuration options are valid:
7441 =item B<Host> I<Host>
7443 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7444 "any" address, i.e. accept packets sent to any of the hosts addresses.
7446 =item B<Port> I<Port>
7448 UDP port to listen to. This can be either a service name or a port number.
7449 Defaults to C<8125>.
7451 =item B<DeleteCounters> B<false>|B<true>
7453 =item B<DeleteTimers> B<false>|B<true>
7455 =item B<DeleteGauges> B<false>|B<true>
7457 =item B<DeleteSets> B<false>|B<true>
7459 These options control what happens if metrics are not updated in an interval.
7460 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7461 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7462 are unchanged. If set to B<True>, the such metrics are not dispatched and
7463 removed from the internal cache.
7465 =item B<CounterSum> B<false>|B<true>
7467 When enabled, creates a C<count> metric which reports the change since the last
7468 read. This option primarily exists for compatibility with the I<statsd>
7469 implementation by Etsy.
7471 =item B<TimerPercentile> I<Percent>
7473 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7474 that I<Percent> of all reported timers are smaller than or equal to the
7475 computed latency. This is useful for cutting off the long tail latency, as it's
7476 often done in I<Service Level Agreements> (SLAs).
7478 Different percentiles can be calculated by setting this option several times.
7479 If none are specified, no percentiles are calculated / dispatched.
7481 =item B<TimerLower> B<false>|B<true>
7483 =item B<TimerUpper> B<false>|B<true>
7485 =item B<TimerSum> B<false>|B<true>
7487 =item B<TimerCount> B<false>|B<true>
7489 Calculate and dispatch various values out of I<Timer> metrics received during
7490 an interval. If set to B<False>, the default, these values aren't calculated /
7495 =head2 Plugin C<swap>
7497 The I<Swap plugin> collects information about used and available swap space. On
7498 I<Linux> and I<Solaris>, the following options are available:
7502 =item B<ReportByDevice> B<false>|B<true>
7504 Configures how to report physical swap devices. If set to B<false> (the
7505 default), the summary over all swap devices is reported only, i.e. the globally
7506 used and available space over all devices. If B<true> is configured, the used
7507 and available space of each device will be reported separately.
7509 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7510 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7512 =item B<ReportBytes> B<false>|B<true>
7514 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7515 I<swap I/O> is reported in pages. This option is available under Linux only.
7517 =item B<ValuesAbsolute> B<true>|B<false>
7519 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7520 available and used. Defaults to B<true>.
7522 =item B<ValuesPercentage> B<false>|B<true>
7524 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7525 available and free. Defaults to B<false>.
7527 This is useful for deploying I<collectd> in a heterogeneous environment, where
7528 swap sizes differ and you want to specify generic thresholds or similar.
7532 =head2 Plugin C<syslog>
7536 =item B<LogLevel> B<debug|info|notice|warning|err>
7538 Sets the log-level. If, for example, set to B<notice>, then all events with
7539 severity B<notice>, B<warning>, or B<err> will be submitted to the
7542 Please note that B<debug> is only available if collectd has been compiled with
7545 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7547 Controls which notifications should be sent to syslog. The default behaviour is
7548 not to send any. Less severe notifications always imply logging more severe
7549 notifications: Setting this to B<OKAY> means all notifications will be sent to
7550 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7551 notifications but will dismiss B<OKAY> notifications. Setting this option to
7552 B<FAILURE> will only send failures to syslog.
7556 =head2 Plugin C<table>
7558 The C<table plugin> provides generic means to parse tabular data and dispatch
7559 user specified values. Values are selected based on column numbers. For
7560 example, this plugin may be used to get values from the Linux L<proc(5)>
7561 filesystem or CSV (comma separated values) files.
7564 <Table "/proc/slabinfo">
7569 InstancePrefix "active_objs"
7575 InstancePrefix "objperslab"
7582 The configuration consists of one or more B<Table> blocks, each of which
7583 configures one file to parse. Within each B<Table> block, there are one or
7584 more B<Result> blocks, which configure which data to select and how to
7587 The following options are available inside a B<Table> block:
7591 =item B<Instance> I<instance>
7593 If specified, I<instance> is used as the plugin instance. So, in the above
7594 example, the plugin name C<table-slabinfo> would be used. If omitted, the
7595 filename of the table is used instead, with all special characters replaced
7596 with an underscore (C<_>).
7598 =item B<Separator> I<string>
7600 Any character of I<string> is interpreted as a delimiter between the different
7601 columns of the table. A sequence of two or more contiguous delimiters in the
7602 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7603 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7604 of a table - see its documentation for more details. This option is mandatory.
7606 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7607 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7608 required because of collectd's config parsing.
7612 The following options are available inside a B<Result> block:
7616 =item B<Type> I<type>
7618 Sets the type used to dispatch the values to the daemon. Detailed information
7619 about types and their configuration can be found in L<types.db(5)>. This
7620 option is mandatory.
7622 =item B<InstancePrefix> I<prefix>
7624 If specified, prepend I<prefix> to the type instance. If omitted, only the
7625 B<InstancesFrom> option is considered for the type instance.
7627 =item B<InstancesFrom> I<column0> [I<column1> ...]
7629 If specified, the content of the given columns (identified by the column
7630 number starting at zero) will be used to create the type instance for each
7631 row. Multiple values (and the instance prefix) will be joined together with
7632 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7633 option is considered for the type instance.
7635 The plugin itself does not check whether or not all built instances are
7636 different. It’s your responsibility to assure that each is unique. This is
7637 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7638 sure that the table only contains one row.
7640 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7643 =item B<ValuesFrom> I<column0> [I<column1> ...]
7645 Specifies the columns (identified by the column numbers starting at zero)
7646 whose content is used as the actual data for the data sets that are dispatched
7647 to the daemon. How many such columns you need is determined by the B<Type>
7648 setting above. If you specify too many or not enough columns, the plugin will
7649 complain about that and no data will be submitted to the daemon. The plugin
7650 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7651 respectively, so anything supported by those functions is supported by the
7652 plugin as well. This option is mandatory.
7656 =head2 Plugin C<tail>
7658 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7659 each line and dispatches found values. What is matched can be configured by the
7660 user using (extended) regular expressions, as described in L<regex(7)>.
7663 <File "/var/log/exim4/mainlog">
7667 Regex "S=([1-9][0-9]*)"
7673 Regex "\\<R=local_user\\>"
7674 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7677 Instance "local_user"
7680 Regex "l=([0-9]*\\.[0-9]*)"
7681 <DSType "Distribution">
7691 The config consists of one or more B<File> blocks, each of which configures one
7692 logfile to parse. Within each B<File> block, there are one or more B<Match>
7693 blocks, which configure a regular expression to search for.
7695 The B<Instance> option in the B<File> block may be used to set the plugin
7696 instance. So in the above example the plugin name C<tail-foo> would be used.
7697 This plugin instance is for all B<Match> blocks that B<follow> it, until the
7698 next B<Instance> option. This way you can extract several plugin instances from
7699 one logfile, handy when parsing syslog and the like.
7701 The B<Interval> option allows you to define the length of time between reads. If
7702 this is not set, the default Interval will be used.
7704 Each B<Match> block has the following options to describe how the match should
7709 =item B<Regex> I<regex>
7711 Sets the regular expression to use for matching against a line. The first
7712 subexpression has to match something that can be turned into a number by
7713 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7714 below. Because B<extended> regular expressions are used, you do not need to use
7715 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7716 collectd's config parsing you need to escape backslashes, though. So if you
7717 want to match literal parentheses you need to do the following:
7719 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7721 =item B<ExcludeRegex> I<regex>
7723 Sets an optional regular expression to use for excluding lines from the match.
7724 An example which excludes all connections from localhost from the match:
7726 ExcludeRegex "127\\.0\\.0\\.1"
7728 =item B<DSType> I<Type>
7730 Sets how the values are cumulated. I<Type> is one of:
7734 =item B<GaugeAverage>
7736 Calculate the average.
7740 Use the smallest number only.
7744 Use the greatest number only.
7748 Use the last number found.
7750 =item B<GaugePersist>
7752 Use the last number found. The number is not reset at the end of an interval.
7753 It is continously reported until another number is matched. This is intended
7754 for cases in which only state changes are reported, for example a thermometer
7755 that only reports the temperature when it changes.
7761 =item B<AbsoluteSet>
7763 The matched number is a counter. Simply I<sets> the internal counter to this
7764 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
7772 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
7773 matched number may be negative, which will effectively subtract from the
7782 Increase the internal counter by one. These B<DSType> are the only ones that do
7783 not use the matched subexpression, but simply count the number of matched
7784 lines. Thus, you may use a regular expression without submatch in this case.
7786 =item B<Distribution>
7788 Type to do calculations based on the distribution of values, primarily
7789 calculating percentiles. This is primarily geared towards latency, but can be
7790 used for other metrics as well. The range of values tracked with this setting
7791 must be in the range (0–2^34) and can be fractional. Please note that neither
7792 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
7795 This option must be used together with the B<Percentile> and/or B<Bucket>
7800 <DSType "Distribution">
7807 =item B<Percentile> I<Percent>
7809 Calculate and dispatch the configured percentile, i.e. compute the value, so
7810 that I<Percent> of all matched values are smaller than or equal to the computed
7813 Metrics are reported with the I<type> B<Type> (the value of the above option)
7814 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
7816 This option may be repeated to calculate more than one percentile.
7818 =item B<Bucket> I<lower_bound> I<upper_bound>
7820 Export the number of values (a C<DERIVE>) falling within the given range. Both,
7821 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
7822 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
7823 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
7824 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
7827 To export the entire (0–inf) range without overlap, use the upper bound of the
7828 previous range as the lower bound of the following range. In other words, use
7829 the following schema:
7839 Metrics are reported with the I<type> C<bucket> and the I<type instance>
7840 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
7842 This option may be repeated to calculate more than one rate.
7848 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
7849 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
7850 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
7851 B<Derive*> types interpret the submatch as a signed integer using
7852 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
7853 and it may be omitted in this case.
7855 =item B<Type> I<Type>
7857 Sets the type used to dispatch this value. Detailed information about types and
7858 their configuration can be found in L<types.db(5)>.
7860 =item B<Instance> I<TypeInstance>
7862 This optional setting sets the type instance to use.
7866 =head2 Plugin C<tail_csv>
7868 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
7869 written by I<Snort>.
7874 <Metric "snort-dropped">
7879 <File "/var/log/snort/snort.stats">
7880 Instance "snort-eth0"
7882 Collect "snort-dropped"
7886 The configuration consists of one or more B<Metric> blocks that define an index
7887 into the line of the CSV file and how this value is mapped to I<collectd's>
7888 internal representation. These are followed by one or more B<Instance> blocks
7889 which configure which file to read, in which interval and which metrics to
7894 =item E<lt>B<Metric> I<Name>E<gt>
7896 The B<Metric> block configures a new metric to be extracted from the statistics
7897 file and how it is mapped on I<collectd's> data model. The string I<Name> is
7898 only used inside the B<Instance> blocks to refer to this block, so you can use
7899 one B<Metric> block for multiple CSV files.
7903 =item B<Type> I<Type>
7905 Configures which I<Type> to use when dispatching this metric. Types are defined
7906 in the L<types.db(5)> file, see the appropriate manual page for more
7907 information on specifying types. Only types with a single I<data source> are
7908 supported by the I<tail_csv plugin>. The information whether the value is an
7909 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
7910 I<Type's> definition.
7912 =item B<Instance> I<TypeInstance>
7914 If set, I<TypeInstance> is used to populate the type instance field of the
7915 created value lists. Otherwise, no type instance is used.
7917 =item B<ValueFrom> I<Index>
7919 Configure to read the value from the field with the zero-based index I<Index>.
7920 If the value is parsed as signed integer, unsigned integer or double depends on
7921 the B<Type> setting, see above.
7925 =item E<lt>B<File> I<Path>E<gt>
7927 Each B<File> block represents one CSV file to read. There must be at least one
7928 I<File> block but there can be multiple if you have multiple CSV files.
7932 =item B<Instance> I<PluginInstance>
7934 Sets the I<plugin instance> used when dispatching the values.
7936 =item B<Collect> I<Metric>
7938 Specifies which I<Metric> to collect. This option must be specified at least
7939 once, and you can use this option multiple times to specify more than one
7940 metric to be extracted from this statistic file.
7942 =item B<Interval> I<Seconds>
7944 Configures the interval in which to read values from this instance / file.
7945 Defaults to the plugin's default interval.
7947 =item B<TimeFrom> I<Index>
7949 Rather than using the local time when dispatching a value, read the timestamp
7950 from the field with the zero-based index I<Index>. The value is interpreted as
7951 seconds since epoch. The value is parsed as a double and may be factional.
7957 =head2 Plugin C<teamspeak2>
7959 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
7960 polls interesting global and virtual server data. The plugin can query only one
7961 physical server but unlimited virtual servers. You can use the following
7962 options to configure it:
7966 =item B<Host> I<hostname/ip>
7968 The hostname or ip which identifies the physical server.
7971 =item B<Port> I<port>
7973 The query port of the physical server. This needs to be a string.
7976 =item B<Server> I<port>
7978 This option has to be added once for every virtual server the plugin should
7979 query. If you want to query the virtual server on port 8767 this is what the
7980 option would look like:
7984 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
7985 use quotes around it! If no such statement is given only global information
7990 =head2 Plugin C<ted>
7992 The I<TED> plugin connects to a device of "The Energy Detective", a device to
7993 measure power consumption. These devices are usually connected to a serial
7994 (RS232) or USB port. The plugin opens a configured device and tries to read the
7995 current energy readings. For more information on TED, visit
7996 L<http://www.theenergydetective.com/>.
7998 Available configuration options:
8002 =item B<Device> I<Path>
8004 Path to the device on which TED is connected. collectd will need read and write
8005 permissions on that file.
8007 Default: B</dev/ttyUSB0>
8009 =item B<Retries> I<Num>
8011 Apparently reading from TED is not that reliable. You can therefore configure a
8012 number of retries here. You only configure the I<retries> here, to if you
8013 specify zero, one reading will be performed (but no retries if that fails); if
8014 you specify three, a maximum of four readings are performed. Negative values
8021 =head2 Plugin C<tcpconns>
8023 The C<tcpconns plugin> counts the number of currently established TCP
8024 connections based on the local port and/or the remote port. Since there may be
8025 a lot of connections the default if to count all connections with a local port,
8026 for which a listening socket is opened. You can use the following options to
8027 fine-tune the ports you are interested in:
8031 =item B<ListeningPorts> I<true>|I<false>
8033 If this option is set to I<true>, statistics for all local ports for which a
8034 listening socket exists are collected. The default depends on B<LocalPort> and
8035 B<RemotePort> (see below): If no port at all is specifically selected, the
8036 default is to collect listening ports. If specific ports (no matter if local or
8037 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8038 the selected ports will be collected unless this option is set to I<true>
8041 =item B<LocalPort> I<Port>
8043 Count the connections to a specific local port. This can be used to see how
8044 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8045 You have to specify the port in numeric form, so for the mailserver example
8046 you'd need to set B<25>.
8048 =item B<RemotePort> I<Port>
8050 Count the connections to a specific remote port. This is useful to see how
8051 much a remote service is used. This is most useful if you want to know how many
8052 connections a local service has opened to remote services, e.E<nbsp>g. how many
8053 connections a mail server or news server has to other mail or news servers, or
8054 how many connections a web proxy holds to web servers. You have to give the
8055 port in numeric form.
8057 =item B<AllPortsSummary> I<true>|I<false>
8059 If this option is set to I<true> a summary of statistics from all connections
8060 are collected. This option defaults to I<false>.
8064 =head2 Plugin C<thermal>
8068 =item B<ForceUseProcfs> I<true>|I<false>
8070 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8071 C<sysfs> interface. If that is not available, the plugin falls back to the
8072 C<procfs> interface. By setting this option to I<true>, you can force the
8073 plugin to use the latter. This option defaults to I<false>.
8075 =item B<Device> I<Device>
8077 Selects the name of the thermal device that you want to collect or ignore,
8078 depending on the value of the B<IgnoreSelected> option. This option may be
8079 used multiple times to specify a list of devices.
8081 See F</"IGNORELISTS"> for details.
8083 =item B<IgnoreSelected> I<true>|I<false>
8085 Invert the selection: If set to true, all devices B<except> the ones that
8086 match the device names specified by the B<Device> option are collected. By
8087 default only selected devices are collected if a selection is made. If no
8088 selection is configured at all, B<all> devices are selected.
8092 =head2 Plugin C<threshold>
8094 The I<Threshold plugin> checks values collected or received by I<collectd>
8095 against a configurable I<threshold> and issues I<notifications> if values are
8098 Documentation for this plugin is available in the L<collectd-threshold(5)>
8101 =head2 Plugin C<tokyotyrant>
8103 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8104 couple metrics: number of records, and database size on disk.
8108 =item B<Host> I<Hostname/IP>
8110 The hostname or IP which identifies the server.
8111 Default: B<127.0.0.1>
8113 =item B<Port> I<Service/Port>
8115 The query port of the server. This needs to be a string, even if the port is
8116 given in its numeric form.
8121 =head2 Plugin C<turbostat>
8123 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8124 Intel processors by using I<Model Specific Registers>.
8128 =item B<CoreCstates> I<Bitmask(Integer)>
8130 Bit mask of the list of core C-states supported by the processor.
8131 This option should only be used if the automated detection fails.
8132 Default value extracted from the CPU model and family.
8134 Currently supported C-states (by this plugin): 3, 6, 7
8138 All states (3, 6 and 7):
8139 (1<<3) + (1<<6) + (1<<7) = 392
8141 =item B<PackageCstates> I<Bitmask(Integer)>
8143 Bit mask of the list of packages C-states supported by the processor. This
8144 option should only be used if the automated detection fails. Default value
8145 extracted from the CPU model and family.
8147 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8151 States 2, 3, 6 and 7:
8152 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8154 =item B<SystemManagementInterrupt> I<true>|I<false>
8156 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8157 This option should only be used if the automated detection fails or if you want
8158 to disable this feature.
8160 =item B<DigitalTemperatureSensor> I<true>|I<false>
8162 Boolean enabling the collection of the temperature of each core. This option
8163 should only be used if the automated detection fails or if you want to disable
8166 =item B<TCCActivationTemp> I<Temperature>
8168 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8169 temperature is used when collecting the temperature of cores or packages. This
8170 option should only be used if the automated detection fails. Default value
8171 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8173 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8175 Bit mask of the list of elements to be thermally monitored. This option should
8176 only be used if the automated detection fails or if you want to disable some
8177 collections. The different bits of this bit mask accepted by this plugin are:
8181 =item 0 ('1'): Package
8185 =item 2 ('4'): Cores
8187 =item 3 ('8'): Embedded graphic device
8191 =item B<LogicalCoreNames> I<true>|I<false>
8193 Boolean enabling the use of logical core numbering for per core statistics.
8194 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8195 sequential number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8196 where I<n> is the n-th core of the socket, causing name conflicts when there is
8197 more than one socket.
8201 =head2 Plugin C<unixsock>
8205 =item B<SocketFile> I<Path>
8207 Sets the socket-file which is to be created.
8209 =item B<SocketGroup> I<Group>
8211 If running as root change the group of the UNIX-socket after it has been
8212 created. Defaults to B<collectd>.
8214 =item B<SocketPerms> I<Permissions>
8216 Change the file permissions of the UNIX-socket after it has been created. The
8217 permissions must be given as a numeric, octal value as you would pass to
8218 L<chmod(1)>. Defaults to B<0770>.
8220 =item B<DeleteSocket> B<false>|B<true>
8222 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8223 with the given name already exists. If I<collectd> crashes a socket file may be
8224 left over, preventing the daemon from opening a new socket when restarted.
8225 Since this is potentially dangerous, this defaults to B<false>.
8229 =head2 Plugin C<uuid>
8231 This plugin, if loaded, causes the Hostname to be taken from the machine's
8232 UUID. The UUID is a universally unique designation for the machine, usually
8233 taken from the machine's BIOS. This is most useful if the machine is running in
8234 a virtual environment such as Xen, in which case the UUID is preserved across
8235 shutdowns and migration.
8237 The following methods are used to find the machine's UUID, in order:
8243 Check I</etc/uuid> (or I<UUIDFile>).
8247 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8252 Check for UUID from C<dmidecode> / SMBIOS.
8256 Check for UUID from Xen hypervisor.
8260 If no UUID can be found then the hostname is not modified.
8264 =item B<UUIDFile> I<Path>
8266 Take the UUID from the given file (default I</etc/uuid>).
8270 =head2 Plugin C<varnish>
8272 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8273 It collects a subset of the values displayed by L<varnishstat(1)>, and
8274 organizes them in categories which can be enabled or disabled. Currently only
8275 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8276 meaning of each metric can be found in L<varnish-counters(7)>.
8281 <Instance "example">
8285 CollectConnections true
8286 CollectDirectorDNS false
8290 CollectObjects false
8292 CollectSession false
8302 CollectWorkers false
8306 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8307 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8308 will collectd statistics from the default "varnishd" instance (this should work
8309 fine in most cases).
8311 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8315 =item B<CollectBackend> B<true>|B<false>
8317 Back-end connection statistics, such as successful, reused,
8318 and closed connections. True by default.
8320 =item B<CollectBan> B<true>|B<false>
8322 Statistics about ban operations, such as number of bans added, retired, and
8323 number of objects tested against ban operations. Only available with Varnish
8324 3.x and above. False by default.
8326 =item B<CollectCache> B<true>|B<false>
8328 Cache hits and misses. True by default.
8330 =item B<CollectConnections> B<true>|B<false>
8332 Number of client connections received, accepted and dropped. True by default.
8334 =item B<CollectDirectorDNS> B<true>|B<false>
8336 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8339 =item B<CollectESI> B<true>|B<false>
8341 Edge Side Includes (ESI) parse statistics. False by default.
8343 =item B<CollectFetch> B<true>|B<false>
8345 Statistics about fetches (HTTP requests sent to the backend). False by default.
8347 =item B<CollectHCB> B<true>|B<false>
8349 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8350 divided into locked and unlocked look-ups. False by default.
8352 =item B<CollectObjects> B<true>|B<false>
8354 Statistics on cached objects: number of objects expired, nuked (prematurely
8355 expired), saved, moved, etc. False by default.
8357 =item B<CollectPurge> B<true>|B<false>
8359 Statistics about purge operations, such as number of purges added, retired, and
8360 number of objects tested against purge operations. Only available with Varnish
8361 2.x. False by default.
8363 =item B<CollectSession> B<true>|B<false>
8365 Client session statistics. Number of past and current sessions, session herd and
8366 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8367 metrics found in the Connections and Threads sections with previous versions of
8368 Varnish have been moved here.
8370 =item B<CollectSHM> B<true>|B<false>
8372 Statistics about the shared memory log, a memory region to store
8373 log messages which is flushed to disk when full. True by default.
8375 =item B<CollectSMA> B<true>|B<false>
8377 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8378 component is Solaris specific. Only available with Varnish 2.x. False by
8381 =item B<CollectSMS> B<true>|B<false>
8383 synth (synthetic content) storage statistics. This storage
8384 component is used internally only. False by default.
8386 =item B<CollectSM> B<true>|B<false>
8388 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
8391 =item B<CollectStruct> B<true>|B<false>
8393 Current varnish internal state statistics. Number of current sessions, objects
8394 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8397 =item B<CollectTotals> B<true>|B<false>
8399 Collects overview counters, such as the number of sessions created,
8400 the number of requests and bytes transferred. False by default.
8402 =item B<CollectUptime> B<true>|B<false>
8404 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8406 =item B<CollectVCL> B<true>|B<false>
8408 Number of total (available + discarded) VCL (config files). False by default.
8410 =item B<CollectVSM> B<true>|B<false>
8412 Collect statistics about Varnish's shared memory usage (used by the logging and
8413 statistics subsystems). Only available with Varnish 4.x. False by default.
8415 =item B<CollectWorkers> B<true>|B<false>
8417 Collect statistics about worker threads. False by default.
8421 =head2 Plugin C<virt>
8423 This plugin allows CPU, disk, network load and other metrics to be collected for
8424 virtualized guests on the machine. The statistics are collected through libvirt
8425 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8426 installing any additional software on guests, especially I<collectd>, which runs
8427 only on the host system.
8429 Only I<Connection> is required.
8433 =item B<Connection> I<uri>
8435 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8437 Connection "xen:///"
8439 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8441 =item B<RefreshInterval> I<seconds>
8443 Refresh the list of domains and devices every I<seconds>. The default is 60
8444 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8445 the list of domains and devices to be refreshed on every iteration.
8447 Refreshing the devices in particular is quite a costly operation, so if your
8448 virtualization setup is static you might consider increasing this. If this
8449 option is set to 0, refreshing is disabled completely.
8451 =item B<Domain> I<name>
8453 =item B<BlockDevice> I<name:dev>
8455 =item B<InterfaceDevice> I<name:dev>
8457 =item B<IgnoreSelected> B<true>|B<false>
8459 Select which domains and devices are collected.
8461 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8462 disk/network devices are collected.
8464 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8465 domains and disk/network devices are ignored, while the rest are collected.
8467 The domain name and device names may use a regular expression, if the name is
8468 surrounded by I</.../> and collectd was compiled with support for regexps.
8470 The default is to collect statistics for all domains and all their devices.
8474 BlockDevice "/:hdb/"
8475 IgnoreSelected "true"
8477 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8480 =item B<BlockDeviceFormat> B<target>|B<source>
8482 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8483 seen by the guest will be used for reporting metrics.
8484 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8487 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8488 using the path of the source, e.g. an image file.
8489 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8494 If the domain XML have the following device defined:
8496 <disk type='block' device='disk'>
8497 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8498 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8499 <target dev='sda' bus='scsi'/>
8501 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8504 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8506 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8507 to C<var_lib_libvirt_images_image1.qcow2>.
8509 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8511 The B<BlockDeviceFormatBasename> controls whether the full path or the
8512 L<basename(1)> of the source is being used as the I<type instance> when
8513 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8517 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8518 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8519 be set to C<var_lib_libvirt_images_image1.qcow2>.
8520 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8521 set to C<image1.qcow2>.
8523 =item B<HostnameFormat> B<name|uuid|hostname|...>
8525 When the virt plugin logs data, it sets the hostname of the collected data
8526 according to this setting. The default is to use the guest name as provided by
8527 the hypervisor, which is equal to setting B<name>.
8529 B<uuid> means use the guest's UUID. This is useful if you want to track the
8530 same guest across migrations.
8532 B<hostname> means to use the global B<Hostname> setting, which is probably not
8533 useful on its own because all guests will appear to have the same name.
8535 You can also specify combinations of these fields. For example B<name uuid>
8536 means to concatenate the guest name and UUID (with a literal colon character
8537 between, thus I<"foo:1234-1234-1234-1234">).
8539 At the moment of writing (collectd-5.5), hostname string is limited to 62
8540 characters. In case when combination of fields exceeds 62 characters,
8541 hostname will be truncated without a warning.
8543 =item B<InterfaceFormat> B<name>|B<address>
8545 When the virt plugin logs interface data, it sets the name of the collected
8546 data according to this setting. The default is to use the path as provided by
8547 the hypervisor (the "dev" property of the target node), which is equal to
8550 B<address> means use the interface's mac address. This is useful since the
8551 interface path might change between reboots of a guest or across migrations.
8553 =item B<PluginInstanceFormat> B<name|uuid|none>
8555 When the virt plugin logs data, it sets the plugin_instance of the collected
8556 data according to this setting. The default is to not set the plugin_instance.
8558 B<name> means use the guest's name as provided by the hypervisor.
8559 B<uuid> means use the guest's UUID.
8561 You can also specify combinations of the B<name> and B<uuid> fields.
8562 For example B<name uuid> means to concatenate the guest name and UUID
8563 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8565 =item B<Instances> B<integer>
8567 How many read instances you want to use for this plugin. The default is one,
8568 and the sensible setting is a multiple of the B<ReadThreads> value.
8569 If you are not sure, just use the default setting.
8571 =item B<ExtraStats> B<string>
8573 Report additional extra statistics. The default is no extra statistics, preserving
8574 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8575 allows the plugin to reported more detailed statistics about the behaviour of
8576 Virtual Machines. The argument is a space-separated list of selectors.
8578 Currently supported selectors are:
8582 =item B<cpu_util>: report CPU utilization per domain in percentage.
8584 =item B<disk>: report extra statistics like number of flush operations and total
8585 service time for read, write and flush operations. Requires libvirt API version
8588 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8591 =item B<domain_state>: report domain state and reason in human-readable format as
8592 a notification. If libvirt API version I<0.9.2> or later is available, domain
8593 reason will be included in notification.
8595 =item B<fs_info>: report file system information as a notification. Requires
8596 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8597 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8598 version supports retrieving file system information.
8600 =item B<job_stats_background>: report statistics about progress of a background
8601 job on a domain. Only one type of job statistics can be collected at the same time.
8602 Requires libvirt API version I<1.2.9> or later.
8604 =item B<job_stats_completed>: report statistics about a recently completed job on
8605 a domain. Only one type of job statistics can be collected at the same time.
8606 Requires libvirt API version I<1.2.9> or later.
8608 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8609 Requires libvirt API version I<0.9.11> or later.
8611 =item B<perf>: report performance monitoring events. To collect performance
8612 metrics they must be enabled for domain and supported by the platform. Requires
8613 libvirt API version I<1.3.3> or later.
8614 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8616 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8622 =head2 Plugin C<vmem>
8624 The C<vmem> plugin collects information about the usage of virtual memory.
8625 Since the statistics provided by the Linux kernel are very detailed, they are
8626 collected very detailed. However, to get all the details, you have to switch
8627 them on manually. Most people just want an overview over, such as the number of
8628 pages read from swap space.
8632 =item B<Verbose> B<true>|B<false>
8634 Enables verbose collection of information. This will start collecting page
8635 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8636 Part of these statistics are collected on a "per zone" basis.
8640 =head2 Plugin C<vserver>
8642 This plugin doesn't have any options. B<VServer> support is only available for
8643 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8644 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8645 need to apply the patches and compile your own kernel, which will then provide
8646 the F</proc/virtual> filesystem that is required by this plugin.
8648 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8650 B<Note>: The traffic collected by this plugin accounts for the amount of
8651 traffic passing a socket which might be a lot less than the actual on-wire
8652 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8653 collect on-wire traffic you could, for example, use the logging facilities of
8654 iptables to feed data for the guest IPs into the iptables plugin.
8656 =head2 Plugin C<write_graphite>
8658 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8659 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8660 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8661 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8662 of at most 1428 bytes to minimize the number of network packets.
8666 <Plugin write_graphite>
8676 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8677 blocks. Inside the B<Node> blocks, the following options are recognized:
8681 =item B<Host> I<Address>
8683 Hostname or address to connect to. Defaults to C<localhost>.
8685 =item B<Port> I<Service>
8687 Service name or port number to connect to. Defaults to C<2003>.
8689 =item B<Protocol> I<String>
8691 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
8693 =item B<ReconnectInterval> I<Seconds>
8695 When set to non-zero, forces the connection to the Graphite backend to be
8696 closed and re-opend periodically. This behavior is desirable in environments
8697 where the connection to the Graphite backend is done through load balancers,
8698 for example. When set to zero, the default, the connetion is kept open for as
8701 =item B<LogSendErrors> B<false>|B<true>
8703 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
8704 If set to B<false>, it will not log the errors. This is especially useful when
8705 using Protocol UDP since many times we want to use the "fire-and-forget"
8706 approach and logging errors fills syslog with unneeded messages.
8708 =item B<Prefix> I<String>
8710 When set, I<String> is added in front of the host name. Dots and whitespace are
8711 I<not> escaped in this string (see B<EscapeCharacter> below).
8713 =item B<Postfix> I<String>
8715 When set, I<String> is appended to the host name. Dots and whitespace are
8716 I<not> escaped in this string (see B<EscapeCharacter> below).
8718 =item B<EscapeCharacter> I<Char>
8720 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
8721 in the identifier. The B<EscapeCharacter> option determines which character
8722 dots, whitespace and control characters are replaced with. Defaults to
8725 =item B<StoreRates> B<false>|B<true>
8727 If set to B<true> (the default), convert counter values to rates. If set to
8728 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
8731 =item B<SeparateInstances> B<false>|B<true>
8733 If set to B<true>, the plugin instance and type instance will be in their own
8734 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8735 default), the plugin and plugin instance (and likewise the type and type
8736 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8738 =item B<AlwaysAppendDS> B<false>|B<true>
8740 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
8741 identifier. If set to B<false> (the default), this is only done when there is
8744 =item B<PreserveSeparator> B<false>|B<true>
8746 If set to B<false> (the default) the C<.> (dot) character is replaced with
8747 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
8748 is preserved, i.e. passed through.
8750 =item B<DropDuplicateFields> B<false>|B<true>
8752 If set to B<true>, detect and remove duplicate components in Graphite metric
8753 names. For example, the metric name C<host.load.load.shortterm> will
8754 be shortened to C<host.load.shortterm>.
8758 =head2 Plugin C<write_log>
8760 The C<write_log> plugin writes metrics as INFO log messages.
8762 This plugin supports two output formats: I<Graphite> and I<JSON>.
8772 =item B<Format> I<Format>
8774 The output format to use. Can be one of C<Graphite> or C<JSON>.
8778 =head2 Plugin C<write_tsdb>
8780 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
8781 time series database. The plugin connects to a I<TSD>, a masterless, no shared
8782 state daemon that ingests metrics and stores them in HBase. The plugin uses
8783 I<TCP> over the "line based" protocol with a default port 4242. The data will
8784 be sent in blocks of at most 1428 bytes to minimize the number of network
8793 Host "tsd-1.my.domain"
8795 HostTags "status=production"
8799 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8800 blocks and global directives.
8802 Global directives are:
8806 =item B<ResolveInterval> I<seconds>
8808 =item B<ResolveJitter> I<seconds>
8810 When I<collectd> connects to a TSDB node, it will request the hostname from
8811 DNS. This can become a problem if the TSDB node is unavailable or badly
8812 configured because collectd will request DNS in order to reconnect for every
8813 metric, which can flood your DNS. So you can cache the last value for
8814 I<ResolveInterval> seconds.
8815 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8817 You can also define a jitter, a random interval to wait in addition to
8818 I<ResolveInterval>. This prevents all your collectd servers to resolve the
8819 hostname at the same time when the connection fails.
8820 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8822 B<Note:> If the DNS resolution has already been successful when the socket
8823 closes, the plugin will try to reconnect immediately with the cached
8824 information. DNS is queried only when the socket is closed for a longer than
8825 I<ResolveInterval> + I<ResolveJitter> seconds.
8829 Inside the B<Node> blocks, the following options are recognized:
8833 =item B<Host> I<Address>
8835 Hostname or address to connect to. Defaults to C<localhost>.
8837 =item B<Port> I<Service>
8839 Service name or port number to connect to. Defaults to C<4242>.
8842 =item B<HostTags> I<String>
8844 When set, I<HostTags> is added to the end of the metric. It is intended to be
8845 used for name=value pairs that the TSD will tag the metric with. Dots and
8846 whitespace are I<not> escaped in this string.
8848 =item B<StoreRates> B<false>|B<true>
8850 If set to B<true>, convert counter values to rates. If set to B<false>
8851 (the default) counter values are stored as is, as an increasing
8854 =item B<AlwaysAppendDS> B<false>|B<true>
8856 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
8857 identifier. If set to B<false> (the default), this is only done when there is
8862 =head2 Plugin C<write_mongodb>
8864 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
8869 <Plugin "write_mongodb">
8878 The plugin can send values to multiple instances of I<MongoDB> by specifying
8879 one B<Node> block for each instance. Within the B<Node> blocks, the following
8880 options are available:
8884 =item B<Host> I<Address>
8886 Hostname or address to connect to. Defaults to C<localhost>.
8888 =item B<Port> I<Service>
8890 Service name or port number to connect to. Defaults to C<27017>.
8892 =item B<Timeout> I<Milliseconds>
8894 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
8895 Setting this option to zero means no timeout, which is the default.
8897 =item B<StoreRates> B<false>|B<true>
8899 If set to B<true> (the default), convert counter values to rates. If set to
8900 B<false> counter values are stored as is, i.e. as an increasing integer
8903 =item B<Database> I<Database>
8905 =item B<User> I<User>
8907 =item B<Password> I<Password>
8909 Sets the information used when authenticating to a I<MongoDB> database. The
8910 fields are optional (in which case no authentication is attempted), but if you
8911 want to use authentication all three fields must be set.
8915 =head2 Plugin C<write_prometheus>
8917 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
8918 using I<Prometheus>.
8924 =item B<Port> I<Port>
8926 Port the embedded webserver should listen on. Defaults to B<9103>.
8928 =item B<StalenessDelta> I<Seconds>
8930 Time in seconds after which I<Prometheus> considers a metric "stale" if it
8931 hasn't seen any update for it. This value must match the setting in Prometheus.
8932 It defaults to B<300> seconds (5 minutes), same as Prometheus.
8936 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
8937 which time a metric without updates is considered "stale". This setting
8938 effectively puts an upper limit on the interval in which metrics are reported.
8940 When the I<write_prometheus plugin> encounters a metric with an interval
8941 exceeding this limit, it will inform you, the user, and provide the metric to
8942 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
8943 metric "fresh" each time it is scraped, with the time of the scrape being
8944 considered the time of the update. The result is that there appear more
8945 datapoints in I<Prometheus> than were actually created, but at least the metric
8946 doesn't disappear periodically.
8950 =head2 Plugin C<write_http>
8952 This output plugin submits values to an HTTP server using POST requests and
8953 encoding metrics with JSON or using the C<PUTVAL> command described in
8954 L<collectd-unixsock(5)>.
8958 <Plugin "write_http">
8960 URL "http://example.com/post-collectd"
8967 The plugin can send values to multiple HTTP servers by specifying one
8968 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
8969 block, the following options are available:
8975 URL to which the values are submitted to. Mandatory.
8977 =item B<User> I<Username>
8979 Optional user name needed for authentication.
8981 =item B<Password> I<Password>
8983 Optional password needed for authentication.
8985 =item B<VerifyPeer> B<true>|B<false>
8987 Enable or disable peer SSL certificate verification. See
8988 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
8990 =item B<VerifyHost> B<true|false>
8992 Enable or disable peer host name verification. If enabled, the plugin checks if
8993 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
8994 matches the host name provided by the B<URL> option. If this identity check
8995 fails, the connection is aborted. Obviously, only works when connecting to a
8996 SSL enabled server. Enabled by default.
8998 =item B<CACert> I<File>
9000 File that holds one or more SSL certificates. If you want to use HTTPS you will
9001 possibly need this option. What CA certificates come bundled with C<libcurl>
9002 and are checked by default depends on the distribution you use.
9004 =item B<CAPath> I<Directory>
9006 Directory holding one or more CA certificate files. You can use this if for
9007 some reason all the needed CA certificates aren't in the same file and can't be
9008 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9011 =item B<ClientKey> I<File>
9013 File that holds the private key in PEM format to be used for certificate-based
9016 =item B<ClientCert> I<File>
9018 File that holds the SSL certificate to be used for certificate-based
9021 =item B<ClientKeyPass> I<Password>
9023 Password required to load the private key in B<ClientKey>.
9025 =item B<Header> I<Header>
9027 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9029 Header "X-Custom-Header: custom_value"
9031 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9033 Define which SSL protocol version must be used. By default C<libcurl> will
9034 attempt to figure out the remote SSL protocol version. See
9035 L<curl_easy_setopt(3)> for more details.
9037 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9039 Format of the output to generate. If set to B<Command>, will create output that
9040 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9041 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9042 , will create output in the KairosDB format.
9044 Defaults to B<Command>.
9046 =item B<Attribute> I<String> I<String>
9048 Only available for the KAIROSDB output format.
9050 Consider the two given strings to be the key and value of an additional tag for
9051 each metric being sent out.
9053 You can add multiple B<Attribute>.
9057 Only available for the KAIROSDB output format.
9059 Sets the Cassandra ttl for the data points.
9061 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9063 =item B<Metrics> B<true>|B<false>
9065 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9067 =item B<Notifications> B<false>|B<true>
9069 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9071 =item B<StoreRates> B<true|false>
9073 If set to B<true>, convert counter values to rates. If set to B<false> (the
9074 default) counter values are stored as is, i.e. as an increasing integer number.
9076 =item B<BufferSize> I<Bytes>
9078 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9079 requests will be generated, but more metrics will be batched / metrics are
9080 cached for longer before being sent, introducing additional delay until they
9081 are available on the server side. I<Bytes> must be at least 1024 and cannot
9082 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9083 Defaults to C<4096>.
9085 =item B<LowSpeedLimit> I<Bytes per Second>
9087 Sets the minimal transfer rate in I<Bytes per Second> below which the
9088 connection with the HTTP server will be considered too slow and aborted. All
9089 the data submitted over this connection will probably be lost. Defaults to 0,
9090 which means no minimum transfer rate is enforced.
9092 =item B<Timeout> I<Timeout>
9094 Sets the maximum time in milliseconds given for HTTP POST operations to
9095 complete. When this limit is reached, the POST operation will be aborted, and
9096 all the data in the current send buffer will probably be lost. Defaults to 0,
9097 which means the connection never times out.
9099 =item B<LogHttpError> B<false>|B<true>
9101 Enables printing of HTTP error code to log. Turned off by default.
9103 The C<write_http> plugin regularly submits the collected values to the HTTP
9104 server. How frequently this happens depends on how much data you are collecting
9105 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9106 slightly below this interval, which you can estimate by monitoring the network
9107 traffic between collectd and the HTTP server.
9111 =head2 Plugin C<write_kafka>
9113 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9117 <Plugin "write_kafka">
9118 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9124 The following options are understood by the I<write_kafka plugin>:
9128 =item E<lt>B<Topic> I<Name>E<gt>
9130 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9131 is given a unique I<Name> and specifies one kafka producer.
9132 Inside the B<Topic> block, the following per-topic options are
9137 =item B<Property> I<String> I<String>
9139 Configure the named property for the current topic. Properties are
9140 forwarded to the kafka producer library B<librdkafka>.
9142 =item B<Key> I<String>
9144 Use the specified string as a partitioning key for the topic. Kafka breaks
9145 topic into partitions and guarantees that for a given topology, the same
9146 consumer will be used for a specific key. The special (case insensitive)
9147 string B<Random> can be used to specify that an arbitrary partition should
9150 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9152 Selects the format in which messages are sent to the broker. If set to
9153 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9154 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9156 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9157 an easy and straight forward exchange format.
9159 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9160 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9162 =item B<StoreRates> B<true>|B<false>
9164 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9165 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9166 default), no conversion is performed. Otherwise the conversion is performed
9167 using the internal value cache.
9169 Please note that currently this option is only used if the B<Format> option has
9170 been set to B<JSON>.
9172 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9174 A prefix can be added in the metric name when outputting in the I<Graphite>
9175 format. It's added before the I<Host> name.
9177 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>>
9179 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9181 A postfix can be added in the metric name when outputting in the I<Graphite>
9182 format. It's added after the I<Host> name.
9184 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>>
9186 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9188 Specify a character to replace dots (.) in the host part of the metric name.
9189 In I<Graphite> metric name, dots are used as separators between different
9190 metric parts (host, plugin, type).
9191 Default is C<_> (I<Underscore>).
9193 =item B<GraphiteSeparateInstances> B<false>|B<true>
9195 If set to B<true>, the plugin instance and type instance will be in their own
9196 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9197 default), the plugin and plugin instance (and likewise the type and type
9198 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9200 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9202 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9203 identifier. If set to B<false> (the default), this is only done when there is
9206 =item B<GraphitePreserveSeparator> B<false>|B<true>
9208 If set to B<false> (the default) the C<.> (dot) character is replaced with
9209 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9210 is preserved, i.e. passed through.
9212 =item B<StoreRates> B<true>|B<false>
9214 If set to B<true> (the default), convert counter values to rates. If set to
9215 B<false> counter values are stored as is, i.e. as an increasing integer number.
9217 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9218 converted values will have "rate" appended to the data source type, e.g.
9219 C<ds_type:derive:rate>.
9223 =item B<Property> I<String> I<String>
9225 Configure the kafka producer through properties, you almost always will
9226 want to set B<metadata.broker.list> to your Kafka broker list.
9230 =head2 Plugin C<write_redis>
9232 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9236 <Plugin "write_redis">
9248 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9249 the timestamp as the score. Retrieving a date range can then be done using the
9250 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9251 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9252 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9253 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9254 with the B<Database> parameter (default is C<0>). See
9255 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9258 The information shown in the synopsis above is the I<default configuration>
9259 which is used by the plugin if no configuration is present.
9261 The plugin can send values to multiple instances of I<Redis> by specifying
9262 one B<Node> block for each instance. Within the B<Node> blocks, the following
9263 options are available:
9267 =item B<Node> I<Nodename>
9269 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9270 instance running on a specified host and port. The node name is a
9271 canonical identifier which is used as I<plugin instance>. It is limited to
9272 51E<nbsp>characters in length.
9274 =item B<Host> I<Hostname>
9276 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9279 =item B<Port> I<Port>
9281 The B<Port> option is the TCP port on which the Redis instance accepts
9282 connections. Either a service name of a port number may be given. Please note
9283 that numerical port numbers must be given as a string, too.
9285 =item B<Timeout> I<Milliseconds>
9287 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9289 =item B<Prefix> I<Prefix>
9291 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9292 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9293 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9294 is recommended but not required to include a trailing slash in I<Prefix>.
9296 =item B<Database> I<Index>
9298 This index selects the redis database to use for writing operations. Defaults
9301 =item B<MaxSetSize> I<Items>
9303 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9304 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9306 =item B<StoreRates> B<true>|B<false>
9308 If set to B<true> (the default), convert counter values to rates. If set to
9309 B<false> counter values are stored as is, i.e. as an increasing integer number.
9313 =head2 Plugin C<write_riemann>
9315 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9316 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9317 I<Riemann> using UDP packets.
9321 <Plugin "write_riemann">
9327 AlwaysAppendDS false
9331 Attribute "foo" "bar"
9334 The following options are understood by the I<write_riemann plugin>:
9338 =item E<lt>B<Node> I<Name>E<gt>
9340 The plugin's configuration consists of one or more B<Node> blocks. Each block
9341 is given a unique I<Name> and specifies one connection to an instance of
9342 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9347 =item B<Host> I<Address>
9349 Hostname or address to connect to. Defaults to C<localhost>.
9351 =item B<Port> I<Service>
9353 Service name or port number to connect to. Defaults to C<5555>.
9355 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9357 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9360 =item B<TLSCertFile> I<Path>
9362 When using the B<TLS> protocol, path to a PEM certificate to present
9365 =item B<TLSCAFile> I<Path>
9367 When using the B<TLS> protocol, path to a PEM CA certificate to
9368 use to validate the remote hosts's identity.
9370 =item B<TLSKeyFile> I<Path>
9372 When using the B<TLS> protocol, path to a PEM private key associated
9373 with the certificate defined by B<TLSCertFile>.
9375 =item B<Batch> B<true>|B<false>
9377 If set to B<true> and B<Protocol> is set to B<TCP>,
9378 events will be batched in memory and flushed at
9379 regular intervals or when B<BatchMaxSize> is exceeded.
9381 Notifications are not batched and sent as soon as possible.
9383 When enabled, it can occur that events get processed by the Riemann server
9384 close to or after their expiration time. Tune the B<TTLFactor> and
9385 B<BatchMaxSize> settings according to the amount of values collected, if this
9390 =item B<BatchMaxSize> I<size>
9392 Maximum payload size for a riemann packet. Defaults to 8192
9394 =item B<BatchFlushTimeout> I<seconds>
9396 Maximum amount of seconds to wait in between to batch flushes.
9397 No timeout by default.
9399 =item B<StoreRates> B<true>|B<false>
9401 If set to B<true> (the default), convert counter values to rates. If set to
9402 B<false> counter values are stored as is, i.e. as an increasing integer number.
9404 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9405 converted values will have "rate" appended to the data source type, e.g.
9406 C<ds_type:derive:rate>.
9408 =item B<AlwaysAppendDS> B<false>|B<true>
9410 If set to B<true>, append the name of the I<Data Source> (DS) to the
9411 "service", i.e. the field that, together with the "host" field, uniquely
9412 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9413 only done when there is more than one DS.
9415 =item B<TTLFactor> I<Factor>
9417 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9418 event is considered active. I<collectd> populates this field based on the
9419 metrics interval setting. This setting controls the factor with which the
9420 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9421 know exactly what you're doing, you should only increase this setting from its
9424 =item B<Notifications> B<false>|B<true>
9426 If set to B<true>, create riemann events for notifications. This is B<true>
9427 by default. When processing thresholds from write_riemann, it might prove
9428 useful to avoid getting notification events.
9430 =item B<CheckThresholds> B<false>|B<true>
9432 If set to B<true>, attach state to events based on thresholds defined
9433 in the B<Threshold> plugin. Defaults to B<false>.
9435 =item B<EventServicePrefix> I<String>
9437 Add the given string as a prefix to the event service name.
9438 If B<EventServicePrefix> not set or set to an empty string (""),
9439 no prefix will be used.
9443 =item B<Tag> I<String>
9445 Add the given string as an additional tag to the metric being sent to
9448 =item B<Attribute> I<String> I<String>
9450 Consider the two given strings to be the key and value of an additional
9451 attribute for each metric being sent out to I<Riemann>.
9455 =head2 Plugin C<write_sensu>
9457 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9458 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9459 a local I<Sensu> client using a TCP socket.
9461 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9462 parameter so it is not possible to use one collectd instance as a gateway for
9463 others. Each collectd host must pair with one I<Sensu> client.
9467 <Plugin "write_sensu">
9472 AlwaysAppendDS false
9473 MetricHandler "influx"
9474 MetricHandler "default"
9475 NotificationHandler "flapjack"
9476 NotificationHandler "howling_monkey"
9480 Attribute "foo" "bar"
9483 The following options are understood by the I<write_sensu plugin>:
9487 =item E<lt>B<Node> I<Name>E<gt>
9489 The plugin's configuration consists of one or more B<Node> blocks. Each block
9490 is given a unique I<Name> and specifies one connection to an instance of
9491 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9496 =item B<Host> I<Address>
9498 Hostname or address to connect to. Defaults to C<localhost>.
9500 =item B<Port> I<Service>
9502 Service name or port number to connect to. Defaults to C<3030>.
9504 =item B<StoreRates> B<true>|B<false>
9506 If set to B<true> (the default), convert counter values to rates. If set to
9507 B<false> counter values are stored as is, i.e. as an increasing integer number.
9509 This will be reflected in the C<collectd_data_source_type> tag: If
9510 B<StoreRates> is enabled, converted values will have "rate" appended to the
9511 data source type, e.g. C<collectd_data_source_type:derive:rate>.
9513 =item B<AlwaysAppendDS> B<false>|B<true>
9515 If set the B<true>, append the name of the I<Data Source> (DS) to the
9516 "service", i.e. the field that, together with the "host" field, uniquely
9517 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9518 only done when there is more than one DS.
9520 =item B<Notifications> B<false>|B<true>
9522 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9523 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9525 =item B<Metrics> B<false>|B<true>
9527 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9528 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9531 =item B<Separator> I<String>
9533 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9535 =item B<MetricHandler> I<String>
9537 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9538 several of them, one per line. Defaults to no handler.
9540 =item B<NotificationHandler> I<String>
9542 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9543 add several of them, one per line. Defaults to no handler.
9545 =item B<EventServicePrefix> I<String>
9547 Add the given string as a prefix to the event service name.
9548 If B<EventServicePrefix> not set or set to an empty string (""),
9549 no prefix will be used.
9553 =item B<Tag> I<String>
9555 Add the given string as an additional tag to the metric being sent to
9558 =item B<Attribute> I<String> I<String>
9560 Consider the two given strings to be the key and value of an additional
9561 attribute for each metric being sent out to I<Sensu>.
9565 =head2 Plugin C<xencpu>
9567 This plugin collects metrics of hardware CPU load for machine running Xen
9568 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9569 Result is reported using the C<percent> type, for each CPU (core).
9571 This plugin doesn't have any options (yet).
9573 =head2 Plugin C<zookeeper>
9575 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9576 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
9581 <Plugin "zookeeper">
9588 =item B<Host> I<Address>
9590 Hostname or address to connect to. Defaults to C<localhost>.
9592 =item B<Port> I<Service>
9594 Service name or port number to connect to. Defaults to C<2181>.
9598 =head1 THRESHOLD CONFIGURATION
9600 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9601 we mean that the values are not only stored or sent somewhere, but that they
9602 are judged and, if a problem is recognized, acted upon. The only action
9603 collectd takes itself is to generate and dispatch a "notification". Plugins can
9604 register to receive notifications and perform appropriate further actions.
9606 Since systems and what you expect them to do differ a lot, you can configure
9607 B<thresholds> for your values freely. This gives you a lot of flexibility but
9608 also a lot of responsibility.
9610 Every time a value is out of range a notification is dispatched. This means
9611 that the idle percentage of your CPU needs to be less then the configured
9612 threshold only once for a notification to be generated. There's no such thing
9613 as a moving average or similar - at least not now.
9615 Also, all values that match a threshold are considered to be relevant or
9616 "interesting". As a consequence collectd will issue a notification if they are
9617 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9618 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9619 "2" (the default) and some hosts sends it's CPU statistics to the server every
9620 60 seconds, a notification will be dispatched after about 120 seconds. It may
9621 take a little longer because the timeout is checked only once each B<Interval>
9624 When a value comes within range again or is received after it was missing, an
9625 "OKAY-notification" is dispatched.
9627 Here is a configuration example to get you started. Read below for more
9640 <Plugin "interface">
9657 WarningMin 100000000
9663 There are basically two types of configuration statements: The C<Host>,
9664 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
9665 configured. The C<Plugin> and C<Type> blocks may be specified further using the
9666 C<Instance> option. You can combine the block by nesting the blocks, though
9667 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
9668 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
9669 C<Type> may not contain other blocks. If multiple blocks apply to the same
9670 value the most specific block is used.
9672 The other statements specify the threshold to configure. They B<must> be
9673 included in a C<Type> block. Currently the following statements are recognized:
9677 =item B<FailureMax> I<Value>
9679 =item B<WarningMax> I<Value>
9681 Sets the upper bound of acceptable values. If unset defaults to positive
9682 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
9683 will be created. If the value is greater than B<WarningMax> but less than (or
9684 equal to) B<FailureMax> a B<WARNING> notification will be created.
9686 =item B<FailureMin> I<Value>
9688 =item B<WarningMin> I<Value>
9690 Sets the lower bound of acceptable values. If unset defaults to negative
9691 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
9692 be created. If the value is less than B<WarningMin> but greater than (or equal
9693 to) B<FailureMin> a B<WARNING> notification will be created.
9695 =item B<DataSource> I<DSName>
9697 Some data sets have more than one "data source". Interesting examples are the
9698 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
9699 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
9700 system load data set, C<load>, even has three data sources: C<shortterm>,
9701 C<midterm>, and C<longterm>.
9703 Normally, all data sources are checked against a configured threshold. If this
9704 is undesirable, or if you want to specify different limits for each data
9705 source, you can use the B<DataSource> option to have a threshold apply only to
9708 =item B<Invert> B<true>|B<false>
9710 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
9711 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
9712 B<WarningMax>) are not okay. Defaults to B<false>.
9714 =item B<Persist> B<true>|B<false>
9716 Sets how often notifications are generated. If set to B<true> one notification
9717 will be generated for each value that is out of the acceptable range. If set to
9718 B<false> (the default) then a notification is only generated if a value is out
9719 of range but the previous value was okay.
9721 This applies to missing values, too: If set to B<true> a notification about a
9722 missing value is generated once every B<Interval> seconds. If set to B<false>
9723 only one such notification is generated until the value appears again.
9725 =item B<Percentage> B<true>|B<false>
9727 If set to B<true>, the minimum and maximum values given are interpreted as
9728 percentage value, relative to the other data sources. This is helpful for
9729 example for the "df" type, where you may want to issue a warning when less than
9730 5E<nbsp>% of the total space is available. Defaults to B<false>.
9732 =item B<Hits> I<Number>
9734 Delay creating the notification until the threshold has been passed I<Number>
9735 times. When a notification has been generated, or when a subsequent value is
9736 inside the threshold, the counter is reset. If, for example, a value is
9737 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
9738 will be dispatched at most once every 30E<nbsp>seconds.
9740 This is useful when short bursts are not a problem. If, for example, 100% CPU
9741 usage for up to a minute is normal (and data is collected every
9742 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
9744 =item B<Hysteresis> I<Number>
9746 When set to non-zero, a hysteresis value is applied when checking minimum and
9747 maximum bounds. This is useful for values that increase slowly and fluctuate a
9748 bit while doing so. When these values come close to the threshold, they may
9749 "flap", i.e. switch between failure / warning case and okay case repeatedly.
9751 If, for example, the threshold is configures as
9756 then a I<Warning> notification is created when the value exceeds I<101> and the
9757 corresponding I<Okay> notification is only created once the value falls below
9758 I<99>, thus avoiding the "flapping".
9762 =head1 FILTER CONFIGURATION
9764 Starting with collectd 4.6 there is a powerful filtering infrastructure
9765 implemented in the daemon. The concept has mostly been copied from
9766 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
9767 terminology, so that users that are familiar with iptables feel right at home.
9771 The following are the terms used in the remainder of the filter configuration
9772 documentation. For an ASCII-art schema of the mechanism, see
9773 L<"General structure"> below.
9779 A I<match> is a criteria to select specific values. Examples are, of course, the
9780 name of the value or it's current value.
9782 Matches are implemented in plugins which you have to load prior to using the
9783 match. The name of such plugins starts with the "match_" prefix.
9787 A I<target> is some action that is to be performed with data. Such actions
9788 could, for example, be to change part of the value's identifier or to ignore
9789 the value completely.
9791 Some of these targets are built into the daemon, see L<"Built-in targets">
9792 below. Other targets are implemented in plugins which you have to load prior to
9793 using the target. The name of such plugins starts with the "target_" prefix.
9797 The combination of any number of matches and at least one target is called a
9798 I<rule>. The target actions will be performed for all values for which B<all>
9799 matches apply. If the rule does not have any matches associated with it, the
9800 target action will be performed for all values.
9804 A I<chain> is a list of rules and possibly default targets. The rules are tried
9805 in order and if one matches, the associated target will be called. If a value
9806 is handled by a rule, it depends on the target whether or not any subsequent
9807 rules are considered or if traversal of the chain is aborted, see
9808 L<"Flow control"> below. After all rules have been checked, the default targets
9813 =head2 General structure
9815 The following shows the resulting structure:
9822 +---------+ +---------+ +---------+ +---------+
9823 ! Rule !->! Match !->! Match !->! Target !
9824 +---------+ +---------+ +---------+ +---------+
9827 +---------+ +---------+ +---------+
9828 ! Rule !->! Target !->! Target !
9829 +---------+ +---------+ +---------+
9836 +---------+ +---------+ +---------+
9837 ! Rule !->! Match !->! Target !
9838 +---------+ +---------+ +---------+
9848 There are four ways to control which way a value takes through the filter
9855 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
9856 process the value with another chain. When the called chain finishes, usually
9857 the next target or rule after the jump is executed.
9861 The stop condition, signaled for example by the built-in target B<stop>, causes
9862 all processing of the value to be stopped immediately.
9866 Causes processing in the current chain to be aborted, but processing of the
9867 value generally will continue. This means that if the chain was called via
9868 B<Jump>, the next target or rule after the jump will be executed. If the chain
9869 was not called by another chain, control will be returned to the daemon and it
9870 may pass the value to another chain.
9874 Most targets will signal the B<continue> condition, meaning that processing
9875 should continue normally. There is no special built-in target for this
9882 The configuration reflects this structure directly:
9884 PostCacheChain "PostCache"
9886 <Rule "ignore_mysql_show">
9889 Type "^mysql_command$"
9890 TypeInstance "^show_"
9900 The above configuration example will ignore all values where the plugin field
9901 is "mysql", the type is "mysql_command" and the type instance begins with
9902 "show_". All other values will be sent to the C<rrdtool> write plugin via the
9903 default target of the chain. Since this chain is run after the value has been
9904 added to the cache, the MySQL C<show_*> command statistics will be available
9905 via the C<unixsock> plugin.
9907 =head2 List of configuration options
9911 =item B<PreCacheChain> I<ChainName>
9913 =item B<PostCacheChain> I<ChainName>
9915 Configure the name of the "pre-cache chain" and the "post-cache chain". The
9916 argument is the name of a I<chain> that should be executed before and/or after
9917 the values have been added to the cache.
9919 To understand the implications, it's important you know what is going on inside
9920 I<collectd>. The following diagram shows how values are passed from the
9921 read-plugins to the write-plugins:
9927 + - - - - V - - - - +
9928 : +---------------+ :
9931 : +-------+-------+ :
9934 : +-------+-------+ : +---------------+
9935 : ! Cache !--->! Value Cache !
9936 : ! insert ! : +---+---+-------+
9937 : +-------+-------+ : ! !
9938 : ! ,------------' !
9940 : +-------+---+---+ : +-------+-------+
9941 : ! Post-Cache +--->! Write-Plugins !
9942 : ! Chain ! : +---------------+
9943 : +---------------+ :
9946 + - - - - - - - - - +
9948 After the values are passed from the "read" plugins to the dispatch functions,
9949 the pre-cache chain is run first. The values are added to the internal cache
9950 afterwards. The post-cache chain is run after the values have been added to the
9951 cache. So why is it such a huge deal if chains are run before or after the
9952 values have been added to this cache?
9954 Targets that change the identifier of a value list should be executed before
9955 the values are added to the cache, so that the name in the cache matches the
9956 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
9957 this cache to receive a list of all available values. If you change the
9958 identifier after the value list has been added to the cache, this may easily
9959 lead to confusion, but it's not forbidden of course.
9961 The cache is also used to convert counter values to rates. These rates are, for
9962 example, used by the C<value> match (see below). If you use the rate stored in
9963 the cache B<before> the new value is added, you will use the old, B<previous>
9964 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
9965 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
9968 Last but not last, the B<stop> target makes a difference: If the pre-cache
9969 chain returns the stop condition, the value will not be added to the cache and
9970 the post-cache chain will not be run.
9972 =item B<Chain> I<Name>
9974 Adds a new chain with a certain name. This name can be used to refer to a
9975 specific chain, for example to jump to it.
9977 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
9979 =item B<Rule> [I<Name>]
9981 Adds a new rule to the current chain. The name of the rule is optional and
9982 currently has no meaning for the daemon.
9984 Within the B<Rule> block, there may be any number of B<Match> blocks and there
9985 must be at least one B<Target> block.
9987 =item B<Match> I<Name>
9989 Adds a match to a B<Rule> block. The name specifies what kind of match should
9990 be performed. Available matches depend on the plugins that have been loaded.
9992 The arguments inside the B<Match> block are passed to the plugin implementing
9993 the match, so which arguments are valid here depends on the plugin being used.
9994 If you do not need any to pass any arguments to a match, you can use the
9999 Which is equivalent to:
10004 =item B<Target> I<Name>
10006 Add a target to a rule or a default target to a chain. The name specifies what
10007 kind of target is to be added. Which targets are available depends on the
10008 plugins being loaded.
10010 The arguments inside the B<Target> block are passed to the plugin implementing
10011 the target, so which arguments are valid here depends on the plugin being used.
10012 If you do not need any to pass any arguments to a target, you can use the
10017 This is the same as writing:
10024 =head2 Built-in targets
10026 The following targets are built into the core daemon and therefore need no
10027 plugins to be loaded:
10033 Signals the "return" condition, see the L<"Flow control"> section above. This
10034 causes the current chain to stop processing the value and returns control to
10035 the calling chain. The calling chain will continue processing targets and rules
10036 just after the B<jump> target (see below). This is very similar to the
10037 B<RETURN> target of iptables, see L<iptables(8)>.
10039 This target does not have any options.
10047 Signals the "stop" condition, see the L<"Flow control"> section above. This
10048 causes processing of the value to be aborted immediately. This is similar to
10049 the B<DROP> target of iptables, see L<iptables(8)>.
10051 This target does not have any options.
10059 Sends the value to "write" plugins.
10065 =item B<Plugin> I<Name>
10067 Name of the write plugin to which the data should be sent. This option may be
10068 given multiple times to send the data to more than one write plugin. If the
10069 plugin supports multiple instances, the plugin's instance(s) must also be
10074 If no plugin is explicitly specified, the values will be sent to all available
10077 Single-instance plugin example:
10083 Multi-instance plugin example:
10085 <Plugin "write_graphite">
10095 Plugin "write_graphite/foo"
10100 Starts processing the rules of another chain, see L<"Flow control"> above. If
10101 the end of that chain is reached, or a stop condition is encountered,
10102 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10103 next target or the next rule. This is similar to the B<-j> command line option
10104 of iptables, see L<iptables(8)>.
10110 =item B<Chain> I<Name>
10112 Jumps to the chain I<Name>. This argument is required and may appear only once.
10124 =head2 Available matches
10130 Matches a value using regular expressions.
10136 =item B<Host> I<Regex>
10138 =item B<Plugin> I<Regex>
10140 =item B<PluginInstance> I<Regex>
10142 =item B<Type> I<Regex>
10144 =item B<TypeInstance> I<Regex>
10146 =item B<MetaData> I<String> I<Regex>
10148 Match values where the given regular expressions match the various fields of
10149 the identifier of a value. If multiple regular expressions are given, B<all>
10150 regexen must match for a value to match.
10152 =item B<Invert> B<false>|B<true>
10154 When set to B<true>, the result of the match is inverted, i.e. all value lists
10155 where all regular expressions apply are not matched, all other value lists are
10156 matched. Defaults to B<false>.
10163 Host "customer[0-9]+"
10169 Matches values that have a time which differs from the time on the server.
10171 This match is mainly intended for servers that receive values over the
10172 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10173 is very sensitive to the timestamp used when updating the RRD files. In
10174 particular, the time must be ever increasing. If a misbehaving client sends one
10175 packet with a timestamp far in the future, all further packets with a correct
10176 time will be ignored because of that one packet. What's worse, such corrupted
10177 RRD files are hard to fix.
10179 This match lets one match all values B<outside> a specified time range
10180 (relative to the server's time), so you can use the B<stop> target (see below)
10181 to ignore the value, for example.
10187 =item B<Future> I<Seconds>
10189 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10190 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10193 =item B<Past> I<Seconds>
10195 Matches all values that are I<behind> of the server's time by I<Seconds> or
10196 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10208 This example matches all values that are five minutes or more ahead of the
10209 server or one hour (or more) lagging behind.
10213 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10214 values. If a data-set consists of more than one data-source, all data-sources
10215 must match the specified ranges for a positive match.
10221 =item B<Min> I<Value>
10223 Sets the smallest value which still results in a match. If unset, behaves like
10226 =item B<Max> I<Value>
10228 Sets the largest value which still results in a match. If unset, behaves like
10231 =item B<Invert> B<true>|B<false>
10233 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10234 no-match is returned and vice versa. Please note that the B<Invert> setting
10235 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10236 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10238 =item B<DataSource> I<DSName> [I<DSName> ...]
10240 Select one or more of the data sources. If no data source is configured, all
10241 data sources will be checked. If the type handled by the match does not have a
10242 data source of the specified name(s), this will always result in no match
10243 (independent of the B<Invert> setting).
10245 =item B<Satisfy> B<Any>|B<All>
10247 Specifies how checking with several data sources is performed. If set to
10248 B<Any>, the match succeeds if one of the data sources is in the configured
10249 range. If set to B<All> the match only succeeds if all data sources are within
10250 the configured range. Default is B<All>.
10252 Usually B<All> is used for positive matches, B<Any> is used for negative
10253 matches. This means that with B<All> you usually check that all values are in a
10254 "good" range, while with B<Any> you check if any value is within a "bad" range
10255 (or outside the "good" range).
10259 Either B<Min> or B<Max>, but not both, may be unset.
10263 # Match all values smaller than or equal to 100. Matches only if all data
10264 # sources are below 100.
10270 # Match if the value of any data source is outside the range of 0 - 100.
10278 =item B<empty_counter>
10280 Matches all values with one or more data sources of type B<COUNTER> and where
10281 all counter values are zero. These counters usually I<never> increased since
10282 they started existing (and are therefore uninteresting), or got reset recently
10283 or overflowed and you had really, I<really> bad luck.
10285 Please keep in mind that ignoring such counters can result in confusing
10286 behavior: Counters which hardly ever increase will be zero for long periods of
10287 time. If the counter is reset for some reason (machine or service restarted,
10288 usually), the graph will be empty (NAN) for a long time. People may not
10293 Calculates a hash value of the host name and matches values according to that
10294 hash value. This makes it possible to divide all hosts into groups and match
10295 only values that are in a specific group. The intended use is in load
10296 balancing, where you want to handle only part of all data and leave the rest
10299 The hashing function used tries to distribute the hosts evenly. First, it
10300 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10303 for (i = 0; host[i] != 0; i++)
10304 hash_value = (hash_value * 251) + host[i];
10306 The constant 251 is a prime number which is supposed to make this hash value
10307 more random. The code then checks the group for this host according to the
10308 I<Total> and I<Match> arguments:
10310 if ((hash_value % Total) == Match)
10315 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10316 groups), then the least significant bit of the hash value will be the XOR of
10317 all least significant bits in the host name. One consequence is that when you
10318 have two hosts, "server0.example.com" and "server1.example.com", where the host
10319 name differs in one digit only and the digits differ by one, those hosts will
10320 never end up in the same group.
10326 =item B<Match> I<Match> I<Total>
10328 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10329 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10330 be smaller than I<Total>. I<Total> must be at least one, although only values
10331 greater than one really do make any sense.
10333 You can repeat this option to match multiple groups, for example:
10338 The above config will divide the data into seven groups and match groups three
10339 and five. One use would be to keep every value on two hosts so that if one
10340 fails the missing data can later be reconstructed from the second host.
10346 # Operate on the pre-cache chain, so that ignored values are not even in the
10351 # Divide all received hosts in seven groups and accept all hosts in
10355 # If matched: Return and continue.
10358 # If not matched: Return and stop.
10364 =head2 Available targets
10368 =item B<notification>
10370 Creates and dispatches a notification.
10376 =item B<Message> I<String>
10378 This required option sets the message of the notification. The following
10379 placeholders will be replaced by an appropriate value:
10387 =item B<%{plugin_instance}>
10391 =item B<%{type_instance}>
10393 These placeholders are replaced by the identifier field of the same name.
10395 =item B<%{ds:>I<name>B<}>
10397 These placeholders are replaced by a (hopefully) human readable representation
10398 of the current rate of this data source. If you changed the instance name
10399 (using the B<set> or B<replace> targets, see below), it may not be possible to
10400 convert counter values to rates.
10404 Please note that these placeholders are B<case sensitive>!
10406 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10408 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10415 <Target "notification">
10416 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10422 Replaces parts of the identifier using regular expressions.
10428 =item B<Host> I<Regex> I<Replacement>
10430 =item B<Plugin> I<Regex> I<Replacement>
10432 =item B<PluginInstance> I<Regex> I<Replacement>
10434 =item B<TypeInstance> I<Regex> I<Replacement>
10436 =item B<MetaData> I<String> I<Regex> I<Replacement>
10438 =item B<DeleteMetaData> I<String> I<Regex>
10440 Match the appropriate field with the given regular expression I<Regex>. If the
10441 regular expression matches, that part that matches is replaced with
10442 I<Replacement>. If multiple places of the input buffer match a given regular
10443 expression, only the first occurrence will be replaced.
10445 You can specify each option multiple times to use multiple regular expressions
10453 # Replace "example.net" with "example.com"
10454 Host "\\<example.net\\>" "example.com"
10456 # Strip "www." from hostnames
10457 Host "\\<www\\." ""
10462 Sets part of the identifier of a value to a given string.
10468 =item B<Host> I<String>
10470 =item B<Plugin> I<String>
10472 =item B<PluginInstance> I<String>
10474 =item B<TypeInstance> I<String>
10476 =item B<MetaData> I<String> I<String>
10478 Set the appropriate field to the given string. The strings for plugin instance,
10479 type instance, and meta data may be empty, the strings for host and plugin may
10480 not be empty. It's currently not possible to set the type of a value this way.
10482 The following placeholders will be replaced by an appropriate value:
10490 =item B<%{plugin_instance}>
10494 =item B<%{type_instance}>
10496 These placeholders are replaced by the identifier field of the same name.
10498 =item B<%{meta:>I<name>B<}>
10500 These placeholders are replaced by the meta data value with the given name.
10504 Please note that these placeholders are B<case sensitive>!
10506 =item B<DeleteMetaData> I<String>
10508 Delete the named meta data field.
10515 PluginInstance "coretemp"
10516 TypeInstance "core3"
10521 =head2 Backwards compatibility
10523 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10524 B<Chain> block, it will behave as it used to. This is equivalent to the
10525 following configuration:
10527 <Chain "PostCache">
10531 If you specify a B<PostCacheChain>, the B<write> target will not be added
10532 anywhere and you will have to make sure that it is called where appropriate. We
10533 suggest to add the above snippet as default target to your "PostCache" chain.
10537 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10552 B<Ignorelists> are a generic framework to either ignore some metrics or report
10553 specific metircs only. Plugins usually provide one or more options to specify
10554 the items (mounts points, devices, ...) and the boolean option
10559 =item B<Select> I<String>
10561 Selects the item I<String>. This option often has a plugin specific name, e.g.
10562 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10563 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10564 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10566 By default, this option is doing a case-sensitive full-string match. The
10567 following config will match C<foo>, but not C<Foo>:
10571 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10572 I<regular expression>. For example, so match all item starting with C<foo>, use
10573 could use the following syntax:
10577 The regular expression is I<not> anchored, i.e. the following config will match
10578 C<foobar>, C<barfoo> and C<AfooZ>:
10582 The B<Select> option may be repeated to select multiple items.
10584 =item B<IgnoreSelected> B<true>|B<false>
10586 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10587 collected. If set to B<false>, matching metrics are I<collected> and all other
10588 metrics are ignored.
10595 L<collectd-exec(5)>,
10596 L<collectd-perl(5)>,
10597 L<collectd-unixsock(5)>,
10610 Florian Forster E<lt>octo@collectd.orgE<gt>