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">
1615 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1621 CACert "/path/to/ca.crt"
1622 Header "X-Custom-Header: foobar"
1625 MeasureResponseTime false
1626 MeasureResponseCode false
1629 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1630 DSType "GaugeAverage"
1631 # Note: `stock_value' is not a standard type.
1638 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1639 a web page and one or more "matches" to be performed on the returned data. The
1640 string argument to the B<Page> block is used as plugin instance.
1642 The following options are valid within B<Page> blocks:
1646 =item B<PluginName> I<PluginName>
1648 Use I<PluginName> as the plugin name when submitting values.
1653 URL of the web site to retrieve. Since a regular expression will be used to
1654 extract information from this data, non-binary data is a big plus here ;)
1656 =item B<User> I<Name>
1658 Username to use if authorization is required to read the page.
1660 =item B<Password> I<Password>
1662 Password to use if authorization is required to read the page.
1664 =item B<Digest> B<true>|B<false>
1666 Enable HTTP digest authentication.
1668 =item B<VerifyPeer> B<true>|B<false>
1670 Enable or disable peer SSL certificate verification. See
1671 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1673 =item B<VerifyHost> B<true>|B<false>
1675 Enable or disable peer host name verification. If enabled, the plugin checks if
1676 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1677 matches the host name provided by the B<URL> option. If this identity check
1678 fails, the connection is aborted. Obviously, only works when connecting to a
1679 SSL enabled server. Enabled by default.
1681 =item B<CACert> I<file>
1683 File that holds one or more SSL certificates. If you want to use HTTPS you will
1684 possibly need this option. What CA certificates come bundled with C<libcurl>
1685 and are checked by default depends on the distribution you use.
1687 =item B<Header> I<Header>
1689 A HTTP header to add to the request. Multiple headers are added if this option
1690 is specified more than once.
1692 =item B<Post> I<Body>
1694 Specifies that the HTTP operation should be a POST instead of a GET. The
1695 complete data to be posted is given as the argument. This option will usually
1696 need to be accompanied by a B<Header> option to set an appropriate
1697 C<Content-Type> for the post body (e.g. to
1698 C<application/x-www-form-urlencoded>).
1700 =item B<MeasureResponseTime> B<true>|B<false>
1702 Measure response time for the request. If this setting is enabled, B<Match>
1703 blocks (see below) are optional. Disabled by default.
1705 Beware that requests will get aborted if they take too long to complete. Adjust
1706 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1709 This option is similar to enabling the B<TotalTime> statistic but it's
1710 measured by collectd instead of cURL.
1712 =item B<MeasureResponseCode> B<true>|B<false>
1714 Measure response code for the request. If this setting is enabled, B<Match>
1715 blocks (see below) are optional. Disabled by default.
1717 =item B<E<lt>StatisticsE<gt>>
1719 One B<Statistics> block can be used to specify cURL statistics to be collected
1720 for each request to the remote web site. See the section "cURL Statistics"
1721 above for details. If this setting is enabled, B<Match> blocks (see below) are
1724 =item B<E<lt>MatchE<gt>>
1726 One or more B<Match> blocks that define how to match information in the data
1727 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1728 used by the C<tail> plugin, so please see the documentation of the C<tail>
1729 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1730 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1733 =item B<Timeout> I<Milliseconds>
1735 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1736 milliseconds. By default, the configured B<Interval> is used to set the
1737 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1738 indefinitely. This legacy behaviour can be achieved by setting the value of
1741 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1742 network connection will stall one read thread. Adjust the B<ReadThreads> global
1743 setting accordingly to prevent this from blocking other plugins.
1747 =head2 Plugin C<curl_json>
1749 The B<curl_json plugin> collects values from JSON data to be parsed by
1750 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1751 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1752 unix socket. The former can be used, for example, to collect values
1753 from CouchDB documents (which are stored JSON notation), and the
1754 latter to collect values from a uWSGI stats socket.
1756 The following example will collect several values from the built-in
1757 C<_stats> runtime statistics module of I<CouchDB>
1758 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1761 <URL "http://localhost:5984/_stats">
1763 <Key "httpd/requests/count">
1764 Type "http_requests"
1767 <Key "httpd_request_methods/*/count">
1768 Type "http_request_methods"
1771 <Key "httpd_status_codes/*/count">
1772 Type "http_response_codes"
1777 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1780 <Sock "/var/run/uwsgi.stats.sock">
1782 <Key "workers/*/requests">
1783 Type "http_requests"
1786 <Key "workers/*/apps/*/requests">
1787 Type "http_requests"
1792 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1793 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1794 blocks defining a unix socket to read JSON from directly. Each of
1795 these blocks may have one or more B<Key> blocks.
1797 The B<Key> string argument must be in a path format. Each component is
1798 used to match the key from a JSON map or the index of an JSON
1799 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1800 values for all map keys or array indices will be collectd.
1802 The following options are valid within B<URL> blocks:
1806 =item B<Host> I<Name>
1808 Use I<Name> as the host name when submitting values. Defaults to the global
1811 =item B<Instance> I<Instance>
1813 Sets the plugin instance to I<Instance>.
1815 =item B<Interval> I<Interval>
1817 Sets the interval (in seconds) in which the values will be collected from this
1818 URL. By default the global B<Interval> setting will be used.
1820 =item B<User> I<Name>
1822 =item B<Password> I<Password>
1824 =item B<Digest> B<true>|B<false>
1826 =item B<VerifyPeer> B<true>|B<false>
1828 =item B<VerifyHost> B<true>|B<false>
1830 =item B<CACert> I<file>
1832 =item B<Header> I<Header>
1834 =item B<Post> I<Body>
1836 =item B<Timeout> I<Milliseconds>
1838 These options behave exactly equivalent to the appropriate options of the
1839 I<cURL> plugin. Please see there for a detailed description.
1841 =item B<E<lt>StatisticsE<gt>>
1843 One B<Statistics> block can be used to specify cURL statistics to be collected
1844 for each request to the remote URL. See the section "cURL Statistics" above
1849 The following options are valid within B<Key> blocks:
1853 =item B<Type> I<Type>
1855 Sets the type used to dispatch the values to the daemon. Detailed information
1856 about types and their configuration can be found in L<types.db(5)>. This
1857 option is mandatory.
1859 =item B<Instance> I<Instance>
1861 Type-instance to use. Defaults to the current map key or current string array element value.
1865 =head2 Plugin C<curl_xml>
1867 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1868 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1871 <URL "http://localhost/stats.xml">
1873 Instance "some_instance"
1878 CACert "/path/to/ca.crt"
1879 Header "X-Custom-Header: foobar"
1882 <XPath "table[@id=\"magic_level\"]/tr">
1884 #InstancePrefix "prefix-"
1885 InstanceFrom "td[1]"
1886 ValuesFrom "td[2]/span[@class=\"level\"]"
1891 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1892 URL to be fetched using libcurl. Within each B<URL> block there are
1893 options which specify the connection parameters, for example authentication
1894 information, and one or more B<XPath> blocks.
1896 Each B<XPath> block specifies how to get one type of information. The
1897 string argument must be a valid XPath expression which returns a list
1898 of "base elements". One value is dispatched for each "base element". The
1899 I<type instance> and values are looked up using further I<XPath> expressions
1900 that should be relative to the base element.
1902 Within the B<URL> block the following options are accepted:
1906 =item B<Host> I<Name>
1908 Use I<Name> as the host name when submitting values. Defaults to the global
1911 =item B<Instance> I<Instance>
1913 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1914 empty string (no plugin instance).
1916 =item B<Namespace> I<Prefix> I<URL>
1918 If an XPath expression references namespaces, they must be specified
1919 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1920 I<URL> is the "namespace name", an URI reference uniquely identifying the
1921 namespace. The option can be repeated to register multiple namespaces.
1925 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1926 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1928 =item B<User> I<User>
1930 =item B<Password> I<Password>
1932 =item B<Digest> B<true>|B<false>
1934 =item B<VerifyPeer> B<true>|B<false>
1936 =item B<VerifyHost> B<true>|B<false>
1938 =item B<CACert> I<CA Cert File>
1940 =item B<Header> I<Header>
1942 =item B<Post> I<Body>
1944 =item B<Timeout> I<Milliseconds>
1946 These options behave exactly equivalent to the appropriate options of the
1947 I<cURL plugin>. Please see there for a detailed description.
1949 =item B<E<lt>StatisticsE<gt>>
1951 One B<Statistics> block can be used to specify cURL statistics to be collected
1952 for each request to the remote URL. See the section "cURL Statistics" above
1955 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1957 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1958 B<XPath> block specifies how to get one type of information. The string
1959 argument must be a valid XPath expression which returns a list of "base
1960 elements". One value is dispatched for each "base element".
1962 Within the B<XPath> block the following options are accepted:
1966 =item B<Type> I<Type>
1968 Specifies the I<Type> used for submitting patches. This determines the number
1969 of values that are required / expected and whether the strings are parsed as
1970 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1971 This option is required.
1973 =item B<InstancePrefix> I<InstancePrefix>
1975 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1976 concatenated together without any separator.
1977 This option is optional.
1979 =item B<InstanceFrom> I<InstanceFrom>
1981 Specifies a XPath expression to use for determining the I<type instance>. The
1982 XPath expression must return exactly one element. The element's value is then
1983 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1985 This value is required. As a special exception, if the "base XPath expression"
1986 (the argument to the B<XPath> block) returns exactly one argument, then this
1987 option may be omitted.
1989 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1991 Specifies one or more XPath expression to use for reading the values. The
1992 number of XPath expressions must match the number of data sources in the
1993 I<type> specified with B<Type> (see above). Each XPath expression must return
1994 exactly one element. The element's value is then parsed as a number and used as
1995 value for the appropriate value in the value list dispatched to the daemon.
2001 =head2 Plugin C<dbi>
2003 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2004 connect to various databases, execute I<SQL> statements and read back the
2005 results. I<dbi> is an acronym for "database interface" in case you were
2006 wondering about the name. You can configure how each column is to be
2007 interpreted and the plugin will generate one or more data sets from each row
2008 returned according to these rules.
2010 Because the plugin is very generic, the configuration is a little more complex
2011 than those of other plugins. It usually looks something like this:
2014 <Query "out_of_stock">
2015 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2016 # Use with MySQL 5.0.0 or later
2020 InstancePrefix "out_of_stock"
2021 InstancesFrom "category"
2025 <Database "product_information">
2028 DriverOption "host" "localhost"
2029 DriverOption "username" "collectd"
2030 DriverOption "password" "aZo6daiw"
2031 DriverOption "dbname" "prod_info"
2032 SelectDB "prod_info"
2033 Query "out_of_stock"
2037 The configuration above defines one query with one result and one database. The
2038 query is then linked to the database with the B<Query> option I<within> the
2039 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2040 and you can also use the B<Include> statement to split up the configuration
2041 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2042 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2045 The following is a complete list of options:
2047 =head3 B<Query> blocks
2049 Query blocks define I<SQL> statements and how the returned data should be
2050 interpreted. They are identified by the name that is given in the opening line
2051 of the block. Thus the name needs to be unique. Other than that, the name is
2052 not used in collectd.
2054 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2055 define which column holds which value or instance information. You can use
2056 multiple B<Result> blocks to create multiple values from one returned row. This
2057 is especially useful, when queries take a long time and sending almost the same
2058 query again and again is not desirable.
2062 <Query "environment">
2063 Statement "select station, temperature, humidity from environment"
2066 # InstancePrefix "foo"
2067 InstancesFrom "station"
2068 ValuesFrom "temperature"
2072 InstancesFrom "station"
2073 ValuesFrom "humidity"
2077 The following options are accepted:
2081 =item B<Statement> I<SQL>
2083 Sets the statement that should be executed on the server. This is B<not>
2084 interpreted by collectd, but simply passed to the database server. Therefore,
2085 the SQL dialect that's used depends on the server collectd is connected to.
2087 The query has to return at least two columns, one for the instance and one
2088 value. You cannot omit the instance, even if the statement is guaranteed to
2089 always return exactly one line. In that case, you can usually specify something
2092 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2094 (That works with MySQL but may not be valid SQL according to the spec. If you
2095 use a more strict database server, you may have to select from a dummy table or
2098 Please note that some databases, for example B<Oracle>, will fail if you
2099 include a semicolon at the end of the statement.
2101 =item B<MinVersion> I<Version>
2103 =item B<MaxVersion> I<Value>
2105 Only use this query for the specified database version. You can use these
2106 options to provide multiple queries with the same name but with a slightly
2107 different syntax. The plugin will use only those queries, where the specified
2108 minimum and maximum versions fit the version of the database in use.
2110 The database version is determined by C<dbi_conn_get_engine_version>, see the
2111 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2112 for details. Basically, each part of the version is assumed to be in the range
2113 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2114 "40102", version "5.0.42" becomes "50042".
2116 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2117 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2118 happen. Don't to it! A valid example would be something along these lines:
2129 In the above example, there are three ranges that don't overlap. The last one
2130 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2131 before "4.0.0" are not specified.
2133 =item B<Type> I<Type>
2135 The B<type> that's used for each line returned. See L<types.db(5)> for more
2136 details on how types are defined. In short: A type is a predefined layout of
2137 data and the number of values and type of values has to match the type
2140 If you specify "temperature" here, you need exactly one gauge column. If you
2141 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2144 There must be exactly one B<Type> option inside each B<Result> block.
2146 =item B<InstancePrefix> I<prefix>
2148 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2149 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2150 all strings returned in the appropriate columns are concatenated together,
2151 separated by dashes I<("-")>.
2153 =item B<InstancesFrom> I<column0> [I<column1> ...]
2155 Specifies the columns whose values will be used to create the "type-instance"
2156 for each row. If you specify more than one column, the value of all columns
2157 will be joined together with dashes I<("-")> as separation characters.
2159 The plugin itself does not check whether or not all built instances are
2160 different. It's your responsibility to assure that each is unique. This is
2161 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2162 sure that only one row is returned in this case.
2164 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2167 =item B<ValuesFrom> I<column0> [I<column1> ...]
2169 Names the columns whose content is used as the actual data for the data sets
2170 that are dispatched to the daemon. How many such columns you need is determined
2171 by the B<Type> setting above. If you specify too many or not enough columns,
2172 the plugin will complain about that and no data will be submitted to the
2175 The actual data type in the columns is not that important. The plugin will
2176 automatically cast the values to the right type if it know how to do that. So
2177 it should be able to handle integer an floating point types, as well as strings
2178 (if they include a number at the beginning).
2180 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2182 =item B<MetadataFrom> [I<column0> I<column1> ...]
2184 Names the columns whose content is used as metadata for the data sets
2185 that are dispatched to the daemon.
2187 The actual data type in the columns is not that important. The plugin will
2188 automatically cast the values to the right type if it know how to do that. So
2189 it should be able to handle integer an floating point types, as well as strings
2190 (if they include a number at the beginning).
2194 =head3 B<Database> blocks
2196 Database blocks define a connection to a database and which queries should be
2197 sent to that database. Since the used "dbi" library can handle a wide variety
2198 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2199 documentationE<nbsp>- we stick as close to the terminology used there.
2201 Each database needs a "name" as string argument in the starting tag of the
2202 block. This name will be used as "PluginInstance" in the values submitted to
2203 the daemon. Other than that, that name is not used.
2207 =item B<Interval> I<Interval>
2209 Sets the interval (in seconds) in which the values will be collected from this
2210 database. By default the global B<Interval> setting will be used.
2212 =item B<Driver> I<Driver>
2214 Specifies the driver to use to connect to the database. In many cases those
2215 drivers are named after the database they can connect to, but this is not a
2216 technical necessity. These drivers are sometimes referred to as "DBD",
2217 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2218 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2219 project at L<http://libdbi-drivers.sourceforge.net/>.
2221 You need to give the driver name as expected by the "dbi" library here. You
2222 should be able to find that in the documentation for each driver. If you
2223 mistype the driver name, the plugin will dump a list of all known driver names
2226 =item B<DriverOption> I<Key> I<Value>
2228 Sets driver-specific options. What option a driver supports can be found in the
2229 documentation for each driver, somewhere at
2230 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2231 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2233 DBDs can register two types of options: String options and numeric options. The
2234 plugin will use the C<dbi_conn_set_option> function when the configuration
2235 provides a string and the C<dbi_conn_require_option_numeric> function when the
2236 configuration provides a number. So these two lines will actually result in
2237 different calls being used:
2239 DriverOption "Port" 1234 # numeric
2240 DriverOption "Port" "1234" # string
2242 Unfortunately, drivers are not too keen to report errors when an unknown option
2243 is passed to them, so invalid settings here may go unnoticed. This is not the
2244 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2245 the driver. If a driver complains about an option, the plugin will dump a
2246 complete list of all options understood by that driver to the log. There is no
2247 way to programmatically find out if an option expects a string or a numeric
2248 argument, so you will have to refer to the appropriate DBD's documentation to
2249 find this out. Sorry.
2251 =item B<SelectDB> I<Database>
2253 In some cases, the database name you connect with is not the database name you
2254 want to use for querying data. If this option is set, the plugin will "select"
2255 (switch to) that database after the connection is established.
2257 =item B<Query> I<QueryName>
2259 Associates the query named I<QueryName> with this database connection. The
2260 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2261 blocks you want to refer to must be placed above the database block you want to
2264 =item B<Host> I<Hostname>
2266 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2267 values. Defaults to the global hostname setting.
2275 =item B<Device> I<Device>
2277 Select partitions based on the devicename.
2279 See F</"IGNORELISTS"> for details.
2281 =item B<MountPoint> I<Directory>
2283 Select partitions based on the mountpoint.
2285 See F</"IGNORELISTS"> for details.
2287 =item B<FSType> I<FSType>
2289 Select partitions based on the filesystem type.
2291 See F</"IGNORELISTS"> for details.
2293 =item B<IgnoreSelected> B<true>|B<false>
2295 Invert the selection: If set to true, all partitions B<except> the ones that
2296 match any one of the criteria are collected. By default only selected
2297 partitions are collected if a selection is made. If no selection is configured
2298 at all, B<all> partitions are selected.
2300 =item B<ReportByDevice> B<true>|B<false>
2302 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2303 (the default), it will report a disk as "root", but with it I<true>, it will be
2304 "sda1" (or whichever).
2306 =item B<ReportInodes> B<true>|B<false>
2308 Enables or disables reporting of free, reserved and used inodes. Defaults to
2309 inode collection being disabled.
2311 Enable this option if inodes are a scarce resource for you, usually because
2312 many small files are stored on the disk. This is a usual scenario for mail
2313 transfer agents and web caches.
2315 =item B<ValuesAbsolute> B<true>|B<false>
2317 Enables or disables reporting of free and used disk space in 1K-blocks.
2318 Defaults to B<true>.
2320 =item B<ValuesPercentage> B<false>|B<true>
2322 Enables or disables reporting of free and used disk space in percentage.
2323 Defaults to B<false>.
2325 This is useful for deploying I<collectd> on the cloud, where machines with
2326 different disk size may exist. Then it is more practical to configure
2327 thresholds based on relative disk size.
2331 =head2 Plugin C<disk>
2333 The C<disk> plugin collects information about the usage of physical disks and
2334 logical disks (partitions). Values collected are the number of octets written
2335 to and read from a disk or partition, the number of read/write operations
2336 issued to the disk and a rather complex "time" it took for these commands to be
2339 Using the following two options you can ignore some disks or configure the
2340 collection only of specific disks.
2344 =item B<Disk> I<Name>
2346 Select the disk I<Name>. Whether it is collected or ignored depends on the
2347 B<IgnoreSelected> setting, see below. As with other plugins that use the
2348 daemon's ignorelist functionality, a string that starts and ends with a slash
2349 is interpreted as a regular expression. Examples:
2354 See F</"IGNORELISTS"> for details.
2356 =item B<IgnoreSelected> B<true>|B<false>
2358 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2359 statements, are ignored or if all other disks are ignored. The behavior
2360 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2361 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2362 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2363 is set to B<true>, all disks are collected B<except> the ones matched.
2365 =item B<UseBSDName> B<true>|B<false>
2367 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2368 default major/minor numbers. Requires collectd to be built with Apple's
2371 =item B<UdevNameAttr> I<Attribute>
2373 Attempt to override disk instance name with the value of a specified udev
2374 attribute when built with B<libudev>. If the attribute is not defined for the
2375 given device, the default name is used. Example:
2377 UdevNameAttr "DM_NAME"
2381 =head2 Plugin C<dns>
2385 =item B<Interface> I<Interface>
2387 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2388 option sets the interface that should be used. If this option is not set, or
2389 set to "any", the plugin will try to get packets from B<all> interfaces. This
2390 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2392 =item B<IgnoreSource> I<IP-address>
2394 Ignore packets that originate from this address.
2396 =item B<SelectNumericQueryTypes> B<true>|B<false>
2398 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2402 =head2 Plugin C<dpdkevents>
2404 The I<dpdkevents plugin> collects events from DPDK such as link status of
2405 network ports and Keep Alive status of DPDK logical cores.
2406 In order to get Keep Alive events following requirements must be met:
2408 - support for Keep Alive implemented in DPDK application. More details can
2409 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2413 <Plugin "dpdkevents">
2419 <Event "link_status">
2420 SendEventsOnUpdate true
2421 EnabledPortMask 0xffff
2422 PortName "interface1"
2423 PortName "interface2"
2424 SendNotification false
2426 <Event "keep_alive">
2427 SendEventsOnUpdate true
2429 KeepAliveShmName "/dpdk_keepalive_shm_name"
2430 SendNotification false
2437 =head3 The EAL block
2441 =item B<Coremask> I<Mask>
2443 =item B<Memorychannels> I<Channels>
2445 Number of memory channels per processor socket.
2447 =item B<FilePrefix> I<File>
2449 The prefix text used for hugepage filenames. The filename will be set to
2450 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2454 =head3 The Event block
2456 The B<Event> block defines configuration for specific event. It accepts a
2457 single argument which specifies the name of the event.
2459 =head4 Link Status event
2463 =item B<SendEventOnUpdate> I<true|false>
2465 If set to true link status value will be dispatched only when it is
2466 different from previously read value. This is an optional argument - default
2469 =item B<EnabledPortMask> I<Mask>
2471 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2472 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2473 that all ports will be enabled. This is an optional argument - by default
2474 all ports are enabled.
2476 =item B<PortName> I<Name>
2478 A string containing an optional name for the enabled DPDK ports. Each PortName
2479 option should contain only one port name; specify as many PortName options as
2480 desired. Default naming convention will be used if PortName is blank. If there
2481 are less PortName options than there are enabled ports, the default naming
2482 convention will be used for the additional ports.
2484 =item B<SendNotification> I<true|false>
2486 If set to true, link status notifications are sent, instead of link status
2487 being collected as a statistic. This is an optional argument - default
2492 =head4 Keep Alive event
2496 =item B<SendEventOnUpdate> I<true|false>
2498 If set to true keep alive value will be dispatched only when it is
2499 different from previously read value. This is an optional argument - default
2502 =item B<LCoreMask> I<Mask>
2504 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2506 =item B<KeepAliveShmName> I<Name>
2508 Shared memory name identifier that is used by secondary process to monitor
2509 the keep alive cores state.
2511 =item B<SendNotification> I<true|false>
2513 If set to true, keep alive notifications are sent, instead of keep alive
2514 information being collected as a statistic. This is an optional
2515 argument - default value is false.
2519 =head2 Plugin C<dpdkstat>
2521 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2522 extended NIC stats API in DPDK.
2533 SharedMemObj "dpdk_collectd_stats_0"
2534 EnabledPortMask 0xffff
2535 PortName "interface1"
2536 PortName "interface2"
2541 =head3 The EAL block
2545 =item B<Coremask> I<Mask>
2547 A string containing an hexadecimal bit mask of the cores to run on. Note that
2548 core numbering can change between platforms and should be determined beforehand.
2550 =item B<Memorychannels> I<Channels>
2552 A string containing a number of memory channels per processor socket.
2554 =item B<FilePrefix> I<File>
2556 The prefix text used for hugepage filenames. The filename will be set to
2557 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2559 =item B<SocketMemory> I<MB>
2561 A string containing amount of Memory to allocate from hugepages on specific
2562 sockets in MB. This is an optional value.
2568 =item B<SharedMemObj> I<Mask>
2570 A string containing the name of the shared memory object that should be used to
2571 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2572 Defaults to dpdk_collectd_stats if no other value is configured.
2574 =item B<EnabledPortMask> I<Mask>
2576 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2577 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2578 that all ports will be enabled. This is an optional argument - default
2579 is all ports enabled.
2581 =item B<PortName> I<Name>
2583 A string containing an optional name for the enabled DPDK ports. Each PortName
2584 option should contain only one port name; specify as many PortName options as
2585 desired. Default naming convention will be used if PortName is blank. If there
2586 are less PortName options than there are enabled ports, the default naming
2587 convention will be used for the additional ports.
2591 =head2 Plugin C<email>
2595 =item B<SocketFile> I<Path>
2597 Sets the socket-file which is to be created.
2599 =item B<SocketGroup> I<Group>
2601 If running as root change the group of the UNIX-socket after it has been
2602 created. Defaults to B<collectd>.
2604 =item B<SocketPerms> I<Permissions>
2606 Change the file permissions of the UNIX-socket after it has been created. The
2607 permissions must be given as a numeric, octal value as you would pass to
2608 L<chmod(1)>. Defaults to B<0770>.
2610 =item B<MaxConns> I<Number>
2612 Sets the maximum number of connections that can be handled in parallel. Since
2613 this many threads will be started immediately setting this to a very high
2614 value will waste valuable resources. Defaults to B<5> and will be forced to be
2615 at most B<16384> to prevent typos and dumb mistakes.
2619 =head2 Plugin C<ethstat>
2621 The I<ethstat plugin> collects information about network interface cards (NICs)
2622 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2628 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2629 Map "multicast" "if_multicast"
2636 =item B<Interface> I<Name>
2638 Collect statistical information about interface I<Name>.
2640 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2642 By default, the plugin will submit values as type C<derive> and I<type
2643 instance> set to I<Name>, the name of the metric as reported by the driver. If
2644 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2645 I<TypeInstance> will be used.
2647 =item B<MappedOnly> B<true>|B<false>
2649 When set to B<true>, only metrics that can be mapped to a I<type> will be
2650 collected, all other metrics will be ignored. Defaults to B<false>.
2654 =head2 Plugin C<exec>
2656 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2657 contains valuable information on when the executable is executed and the
2658 output that is expected from it.
2662 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2664 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2666 Execute the executable I<Executable> as user I<User>. If the user name is
2667 followed by a colon and a group name, the effective group is set to that group.
2668 The real group and saved-set group will be set to the default group of that
2669 user. If no group is given the effective group ID will be the same as the real
2672 Please note that in order to change the user and/or group the daemon needs
2673 superuser privileges. If the daemon is run as an unprivileged user you must
2674 specify the same user/group here. If the daemon is run with superuser
2675 privileges, you must supply a non-root user here.
2677 The executable may be followed by optional arguments that are passed to the
2678 program. Please note that due to the configuration parsing numbers and boolean
2679 values may be changed. If you want to be absolutely sure that something is
2680 passed as-is please enclose it in quotes.
2682 The B<Exec> and B<NotificationExec> statements change the semantics of the
2683 programs executed, i.E<nbsp>e. the data passed to them and the response
2684 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2688 =head2 Plugin C<fhcount>
2690 The C<fhcount> plugin provides statistics about used, unused and total number of
2691 file handles on Linux.
2693 The I<fhcount plugin> provides the following configuration options:
2697 =item B<ValuesAbsolute> B<true>|B<false>
2699 Enables or disables reporting of file handles usage in absolute numbers,
2700 e.g. file handles used. Defaults to B<true>.
2702 =item B<ValuesPercentage> B<false>|B<true>
2704 Enables or disables reporting of file handles usage in percentages, e.g.
2705 percent of file handles used. Defaults to B<false>.
2709 =head2 Plugin C<filecount>
2711 The C<filecount> plugin counts the number of files in a certain directory (and
2712 its subdirectories) and their combined size. The configuration is very straight
2715 <Plugin "filecount">
2716 <Directory "/var/qmail/queue/mess">
2717 Instance "qmail-message"
2719 <Directory "/var/qmail/queue/todo">
2720 Instance "qmail-todo"
2722 <Directory "/var/lib/php5">
2723 Instance "php5-sessions"
2728 The example above counts the number of files in QMail's queue directories and
2729 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2730 QMail has not yet looked at, the "message" queue holds the messages that were
2731 classified into "local" and "remote".
2733 As you can see, the configuration consists of one or more C<Directory> blocks,
2734 each of which specifies a directory in which to count the files. Within those
2735 blocks, the following options are recognized:
2739 =item B<Instance> I<Instance>
2741 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2742 it's your responsibility, the plugin doesn't check for that. If not given, the
2743 instance is set to the directory name with all slashes replaced by underscores
2744 and all leading underscores removed.
2746 =item B<Name> I<Pattern>
2748 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2749 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2750 against the pattern, not the entire path. In case this makes it easier for you:
2751 This option has been named after the B<-name> parameter to L<find(1)>.
2753 =item B<MTime> I<Age>
2755 Count only files of a specific age: If I<Age> is greater than zero, only files
2756 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2757 a negative number, this is inversed. For example, if B<-60> is specified, only
2758 files that have been modified in the last minute will be counted.
2760 The number can also be followed by a "multiplier" to easily specify a larger
2761 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2762 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2763 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2764 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2765 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2768 =item B<Size> I<Size>
2770 Count only files of a specific size. When I<Size> is a positive number, only
2771 files that are at least this big are counted. If I<Size> is a negative number,
2772 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2773 I<Size> are counted.
2775 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2776 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2777 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2778 note that there are 1000 bytes in a kilobyte, not 1024.
2780 =item B<Recursive> I<true>|I<false>
2782 Controls whether or not to recurse into subdirectories. Enabled by default.
2784 =item B<IncludeHidden> I<true>|I<false>
2786 Controls whether or not to include "hidden" files and directories in the count.
2787 "Hidden" files and directories are those, whose name begins with a dot.
2788 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2792 =head2 Plugin C<GenericJMX>
2794 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2795 L<collectd-java(5)>.
2797 =head2 Plugin C<gmond>
2799 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2800 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2801 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2806 MCReceiveFrom "239.2.11.71" "8649"
2807 <Metric "swap_total">
2809 TypeInstance "total"
2812 <Metric "swap_free">
2819 The following metrics are built-in:
2825 load_one, load_five, load_fifteen
2829 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2833 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2845 Available configuration options:
2849 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2851 Sets sets the multicast group and UDP port to which to subscribe.
2853 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2855 =item E<lt>B<Metric> I<Name>E<gt>
2857 These blocks add a new metric conversion to the internal table. I<Name>, the
2858 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2862 =item B<Type> I<Type>
2864 Type to map this metric to. Required.
2866 =item B<TypeInstance> I<Instance>
2868 Type-instance to use. Optional.
2870 =item B<DataSource> I<Name>
2872 Data source to map this metric to. If the configured type has exactly one data
2873 source, this is optional. Otherwise the option is required.
2879 =head2 Plugin C<gps>
2881 The C<gps plugin> connects to gpsd on the host machine.
2882 The host, port, timeout and pause are configurable.
2884 This is useful if you run an NTP server using a GPS for source and you want to
2887 Mind your GPS must send $--GSA for having the data reported!
2889 The following elements are collected:
2895 Number of satellites used for fix (type instance "used") and in view (type
2896 instance "visible"). 0 means no GPS satellites are visible.
2898 =item B<dilution_of_precision>
2900 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2901 It should be between 0 and 3.
2902 Look at the documentation of your GPS to know more.
2910 # Connect to localhost on gpsd regular port:
2915 # PauseConnect of 5 sec. between connection attempts.
2919 Available configuration options:
2923 =item B<Host> I<Host>
2925 The host on which gpsd daemon runs. Defaults to B<localhost>.
2927 =item B<Port> I<Port>
2929 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2931 =item B<Timeout> I<Seconds>
2933 Timeout in seconds (default 0.015 sec).
2935 The GPS data stream is fetch by the plugin form the daemon.
2936 It waits for data to be available, if none arrives it times out
2937 and loop for another reading.
2938 Mind to put a low value gpsd expects value in the micro-seconds area
2939 (recommended is 500 us) since the waiting function is blocking.
2940 Value must be between 500 us and 5 sec., if outside that range the
2941 default value is applied.
2943 This only applies from gpsd release-2.95.
2945 =item B<PauseConnect> I<Seconds>
2947 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
2951 =head2 Plugin C<grpc>
2953 The I<grpc> plugin provides an RPC interface to submit values to or query
2954 values from collectd based on the open source gRPC framework. It exposes an
2955 end-point for dispatching values to the daemon.
2957 The B<gRPC> homepage can be found at L<https://grpc.io/>.
2961 =item B<Server> I<Host> I<Port>
2963 The B<Server> statement sets the address of a server to which to send metrics
2964 via the C<DispatchValues> function.
2966 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2968 Optionally, B<Server> may be specified as a configuration block which supports
2969 the following options:
2973 =item B<EnableSSL> B<false>|B<true>
2975 Whether to require SSL for outgoing connections. Default: false.
2977 =item B<SSLCACertificateFile> I<Filename>
2979 =item B<SSLCertificateFile> I<Filename>
2981 =item B<SSLCertificateKeyFile> I<Filename>
2983 Filenames specifying SSL certificate and key material to be used with SSL
2988 =item B<Listen> I<Host> I<Port>
2990 The B<Listen> statement sets the network address to bind to. When multiple
2991 statements are specified, the daemon will bind to all of them. If none are
2992 specified, it defaults to B<0.0.0.0:50051>.
2994 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2996 Optionally, B<Listen> may be specified as a configuration block which
2997 supports the following options:
3001 =item B<EnableSSL> I<true>|I<false>
3003 Whether to enable SSL for incoming connections. Default: false.
3005 =item B<SSLCACertificateFile> I<Filename>
3007 =item B<SSLCertificateFile> I<Filename>
3009 =item B<SSLCertificateKeyFile> I<Filename>
3011 Filenames specifying SSL certificate and key material to be used with SSL
3018 =head2 Plugin C<hddtemp>
3020 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3021 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3022 default values, see below. C<hddtemp> has to be running to work correctly. If
3023 C<hddtemp> is not running timeouts may appear which may interfere with other
3026 The B<hddtemp> homepage can be found at
3027 L<http://www.guzu.net/linux/hddtemp.php>.
3031 =item B<Host> I<Hostname>
3033 Hostname to connect to. Defaults to B<127.0.0.1>.
3035 =item B<Port> I<Port>
3037 TCP-Port to connect to. Defaults to B<7634>.
3041 =head2 Plugin C<hugepages>
3043 To collect B<hugepages> information, collectd reads directories
3044 "/sys/devices/system/node/*/hugepages" and
3045 "/sys/kernel/mm/hugepages".
3046 Reading of these directories can be disabled by the following
3047 options (default is enabled).
3051 =item B<ReportPerNodeHP> B<true>|B<false>
3053 If enabled, information will be collected from the hugepage
3054 counters in "/sys/devices/system/node/*/hugepages".
3055 This is used to check the per-node hugepage statistics on
3058 =item B<ReportRootHP> B<true>|B<false>
3060 If enabled, information will be collected from the hugepage
3061 counters in "/sys/kernel/mm/hugepages".
3062 This can be used on both NUMA and non-NUMA systems to check
3063 the overall hugepage statistics.
3065 =item B<ValuesPages> B<true>|B<false>
3067 Whether to report hugepages metrics in number of pages.
3068 Defaults to B<true>.
3070 =item B<ValuesBytes> B<false>|B<true>
3072 Whether to report hugepages metrics in bytes.
3073 Defaults to B<false>.
3075 =item B<ValuesPercentage> B<false>|B<true>
3077 Whether to report hugepages metrics as percentage.
3078 Defaults to B<false>.
3082 =head2 Plugin C<intel_rdt>
3084 The I<intel_rdt> plugin collects information provided by monitoring features of
3085 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3086 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3087 information about utilization of shared resources. CMT monitors last level cache
3088 occupancy (LLC). MBM supports two types of events reporting local and remote
3089 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3090 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3091 reports the bandwidth of accessing the remote socket. Also this technology
3092 allows to monitor instructions per clock (IPC).
3093 Monitor events are hardware dependant. Monitoring capabilities are detected on
3094 plugin initialization and only supported events are monitored.
3096 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3097 require an additional capability to be enabled if collectd is run as a service.
3098 Please refer to I<contrib/systemd.collectd.service> file for more details.
3102 <Plugin "intel_rdt">
3103 Cores "0-2" "3,4,6" "8-10,15"
3110 =item B<Interval> I<seconds>
3112 The interval within which to retrieve statistics on monitored events in seconds.
3113 For milliseconds divide the time by 1000 for example if the desired interval
3114 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3115 recommended to set interval higher than 1 sec.
3117 =item B<Cores> I<cores groups>
3119 All events are reported on a per core basis. Monitoring of the events can be
3120 configured for group of cores (aggregated statistics). This field defines groups
3121 of cores on which to monitor supported events. The field is represented as list
3122 of strings with core group values. Each string represents a list of cores in a
3123 group. Allowed formats are:
3128 If an empty string is provided as value for this field default cores
3129 configuration is applied - a separate group is created for each core.
3133 B<Note:> By default global interval is used to retrieve statistics on monitored
3134 events. To configure a plugin specific interval use B<Interval> option of the
3135 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3136 example if the desired interval is 50ms, set interval to 0.05.
3137 Due to limited capacity of counters it is not recommended to set interval higher
3140 =head2 Plugin C<interface>
3144 =item B<Interface> I<Interface>
3146 Select this interface. By default these interfaces will then be collected. For
3147 a more detailed description see B<IgnoreSelected> below.
3149 See F</"IGNORELISTS"> for details.
3151 =item B<IgnoreSelected> I<true>|I<false>
3153 If no configuration is given, the B<interface>-plugin will collect data from
3154 all interfaces. This may not be practical, especially for loopback- and
3155 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3156 interfaces you're interested in. Sometimes, however, it's easier/preferred
3157 to collect all interfaces I<except> a few ones. This option enables you to
3158 do that: By setting B<IgnoreSelected> to I<true> the effect of
3159 B<Interface> is inverted: All selected interfaces are ignored and all
3160 other interfaces are collected.
3162 It is possible to use regular expressions to match interface names, if the
3163 name is surrounded by I</.../> and collectd was compiled with support for
3164 regexps. This is useful if there's a need to collect (or ignore) data
3165 for a group of interfaces that are similarly named, without the need to
3166 explicitly list all of them (especially useful if the list is dynamic).
3171 Interface "/^tun[0-9]+/"
3172 IgnoreSelected "true"
3174 This will ignore the loopback interface, all interfaces with names starting
3175 with I<veth> and all interfaces with names starting with I<tun> followed by
3178 =item B<ReportInactive> I<true>|I<false>
3180 When set to I<false>, only interfaces with non-zero traffic will be
3181 reported. Note that the check is done by looking into whether a
3182 package was sent at any time from boot and the corresponding counter
3183 is non-zero. So, if the interface has been sending data in the past
3184 since boot, but not during the reported time-interval, it will still
3187 The default value is I<true> and results in collection of the data
3188 from all interfaces that are selected by B<Interface> and
3189 B<IgnoreSelected> options.
3191 =item B<UniqueName> I<true>|I<false>
3193 Interface name is not unique on Solaris (KSTAT), interface name is unique
3194 only within a module/instance. Following tuple is considered unique:
3195 (ks_module, ks_instance, ks_name)
3196 If this option is set to true, interface name contains above three fields
3197 separated by an underscore. For more info on KSTAT, visit
3198 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3200 This option is only available on Solaris.
3204 =head2 Plugin C<ipmi>
3208 =item B<Sensor> I<Sensor>
3210 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3212 See F</"IGNORELISTS"> for details.
3214 =item B<IgnoreSelected> I<true>|I<false>
3216 If no configuration if given, the B<ipmi> plugin will collect data from all
3217 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3218 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3219 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3220 all other sensors are collected.
3222 =item B<NotifySensorAdd> I<true>|I<false>
3224 If a sensor appears after initialization time of a minute a notification
3227 =item B<NotifySensorRemove> I<true>|I<false>
3229 If a sensor disappears a notification is sent.
3231 =item B<NotifySensorNotPresent> I<true>|I<false>
3233 If you have for example dual power supply and one of them is (un)plugged then
3234 a notification is sent.
3238 =head2 Plugin C<iptables>
3242 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3244 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3246 Select the iptables/ip6tables filter rules to count packets and bytes from.
3248 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3249 of all rules which have a comment-match. The comment is then used as
3252 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3253 the I<n>th rule will be collected. Again, the comment (or the number) will be
3254 used as the type-instance.
3256 If I<Name> is supplied, it will be used as the type-instance instead of the
3257 comment or the number.
3261 =head2 Plugin C<irq>
3267 Select this irq. By default these irqs will then be collected. For a more
3268 detailed description see B<IgnoreSelected> below.
3270 See F</"IGNORELISTS"> for details.
3272 =item B<IgnoreSelected> I<true>|I<false>
3274 If no configuration if given, the B<irq>-plugin will collect data from all
3275 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3276 can use the B<Irq>-option to pick the interrupt you're interested in.
3277 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3278 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3279 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3280 and all other interrupts are collected.
3284 =head2 Plugin C<java>
3286 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3287 This section only discusses the syntax and semantic of the configuration
3288 options. For more in-depth information on the I<Java> plugin, please read
3289 L<collectd-java(5)>.
3294 JVMArg "-verbose:jni"
3295 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3296 LoadPlugin "org.collectd.java.Foobar"
3297 <Plugin "org.collectd.java.Foobar">
3298 # To be parsed by the plugin
3302 Available configuration options:
3306 =item B<JVMArg> I<Argument>
3308 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3309 exactly the way the arguments to the I<java> binary on the command line work.
3310 Execute C<javaE<nbsp>--help> for details.
3312 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3313 any other options! When another option is found, the JVM will be started and
3314 later options will have to be ignored!
3316 =item B<LoadPlugin> I<JavaClass>
3318 Instantiates a new I<JavaClass> object. The constructor of this object very
3319 likely then registers one or more callback methods with the server.
3321 See L<collectd-java(5)> for details.
3323 When the first such option is found, the virtual machine (JVM) is created. This
3324 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3325 B<LoadPlugin> options!
3327 =item B<Plugin> I<Name>
3329 The entire block is passed to the Java plugin as an
3330 I<org.collectd.api.OConfigItem> object.
3332 For this to work, the plugin has to register a configuration callback first,
3333 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3334 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3335 depends on the (Java) plugin registering the callback and is completely
3336 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3340 =head2 Plugin C<load>
3342 The I<Load plugin> collects the system load. These numbers give a rough overview
3343 over the utilization of a machine. The system load is defined as the number of
3344 runnable tasks in the run-queue and is provided by many operating systems as a
3345 one, five or fifteen minute average.
3347 The following configuration options are available:
3351 =item B<ReportRelative> B<false>|B<true>
3353 When enabled, system load divided by number of available CPU cores is reported
3354 for intervals 1 min, 5 min and 15 min. Defaults to false.
3359 =head2 Plugin C<logfile>
3363 =item B<LogLevel> B<debug|info|notice|warning|err>
3365 Sets the log-level. If, for example, set to B<notice>, then all events with
3366 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3368 Please note that B<debug> is only available if collectd has been compiled with
3371 =item B<File> I<File>
3373 Sets the file to write log messages to. The special strings B<stdout> and
3374 B<stderr> can be used to write to the standard output and standard error
3375 channels, respectively. This, of course, only makes much sense when I<collectd>
3376 is running in foreground- or non-daemon-mode.
3378 =item B<Timestamp> B<true>|B<false>
3380 Prefix all lines printed by the current time. Defaults to B<true>.
3382 =item B<PrintSeverity> B<true>|B<false>
3384 When enabled, all lines are prefixed by the severity of the log message, for
3385 example "warning". Defaults to B<false>.
3389 B<Note>: There is no need to notify the daemon after moving or removing the
3390 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3391 for each line it writes.
3393 =head2 Plugin C<log_logstash>
3395 The I<log logstash plugin> behaves like the logfile plugin but formats
3396 messages as JSON events for logstash to parse and input.
3400 =item B<LogLevel> B<debug|info|notice|warning|err>
3402 Sets the log-level. If, for example, set to B<notice>, then all events with
3403 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3405 Please note that B<debug> is only available if collectd has been compiled with
3408 =item B<File> I<File>
3410 Sets the file to write log messages to. The special strings B<stdout> and
3411 B<stderr> can be used to write to the standard output and standard error
3412 channels, respectively. This, of course, only makes much sense when I<collectd>
3413 is running in foreground- or non-daemon-mode.
3417 B<Note>: There is no need to notify the daemon after moving or removing the
3418 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3419 for each line it writes.
3421 =head2 Plugin C<lpar>
3423 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3424 virtualization technique for IBM POWER processors. It takes into account CPU
3425 time stolen from or donated to a partition, in addition to the usual user,
3426 system, I/O statistics.
3428 The following configuration options are available:
3432 =item B<CpuPoolStats> B<false>|B<true>
3434 When enabled, statistics about the processor pool are read, too. The partition
3435 needs to have pool authority in order to be able to acquire this information.
3438 =item B<ReportBySerial> B<false>|B<true>
3440 If enabled, the serial of the physical machine the partition is currently
3441 running on is reported as I<hostname> and the logical hostname of the machine
3442 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3443 used (just like other plugins) and the I<plugin instance> will be empty.
3448 =head2 Plugin C<lua>
3450 This plugin embeds a Lua interpreter into collectd and provides an interface
3451 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3454 =head2 Plugin C<mbmon>
3456 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3458 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3459 B<Host> and B<Port> options can be used to change these values, see below.
3460 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3461 timeouts may appear which may interfere with other statistics..
3463 C<mbmon> must be run with the -r option ("print TAG and Value format");
3464 Debian's F</etc/init.d/mbmon> script already does this, other people
3465 will need to ensure that this is the case.
3469 =item B<Host> I<Hostname>
3471 Hostname to connect to. Defaults to B<127.0.0.1>.
3473 =item B<Port> I<Port>
3475 TCP-Port to connect to. Defaults to B<411>.
3479 =head2 Plugin C<mcelog>
3481 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3483 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3484 mcelog server is running. When the server is running, the plugin will tail the
3485 specified logfile to retrieve machine check exception information and send a
3486 notification with the details from the logfile. The plugin will use the mcelog
3487 client protocol to retrieve memory related machine check exceptions.
3491 =item B<McelogClientSocket> I<Path>
3492 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3493 Defaults to B<"/var/run/mcelog-client">.
3495 =item B<McelogLogfile> I<Path>
3497 The mcelog file to parse. Defaults to B<"/var/log/mcelog">.
3503 The C<md plugin> collects information from Linux Software-RAID devices (md).
3505 All reported values are of the type C<md_disks>. Reported type instances are
3506 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3507 I<missing> (physically absent) disks.
3511 =item B<Device> I<Device>
3513 Select md devices based on device name. The I<device name> is the basename of
3514 the device, i.e. the name of the block device without the leading C</dev/>.
3515 See B<IgnoreSelected> for more details.
3517 See F</"IGNORELISTS"> for details.
3519 =item B<IgnoreSelected> B<true>|B<false>
3521 Invert device selection: If set to B<true>, all md devices B<except> those
3522 listed using B<Device> are collected. If B<false> (the default), only those
3523 listed are collected. If no configuration is given, the B<md> plugin will
3524 collect data from all md devices.
3528 =head2 Plugin C<memcachec>
3530 The C<memcachec plugin> connects to a memcached server, queries one or more
3531 given I<pages> and parses the returned data according to user specification.
3532 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3535 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3536 library. Please note that there is another library with a very similar name,
3537 libmemcache (notice the missing `d'), which is not applicable.
3539 Synopsis of the configuration:
3541 <Plugin "memcachec">
3542 <Page "plugin_instance">
3545 PluginName "plugin_name"
3547 Regex "(\\d+) bytes sent"
3550 Instance "type_instance"
3555 The configuration options are:
3559 =item E<lt>B<Page> I<Name>E<gt>
3561 Each B<Page> block defines one I<page> to be queried from the memcached server.
3562 The block requires one string argument which is used as I<plugin instance>.
3564 =item B<Server> I<Address>
3566 Sets the server address to connect to when querying the page. Must be inside a
3571 When connected to the memcached server, asks for the page I<Key>.
3573 =item B<PluginName> I<PluginName>
3575 Use I<PluginName> as the plugin name when submitting values.
3576 Defaults to 'memcachec'.
3578 =item E<lt>B<Match>E<gt>
3580 Match blocks define which strings to look for and how matches substrings are
3581 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3585 =head2 Plugin C<memcached>
3587 The B<memcached plugin> connects to a memcached server and queries statistics
3588 about cache utilization, memory and bandwidth used.
3589 L<http://memcached.org/>
3591 <Plugin "memcached">
3593 #Host "memcache.example.com"
3599 The plugin configuration consists of one or more B<Instance> blocks which
3600 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3601 following options are allowed:
3605 =item B<Host> I<Hostname>
3607 Sets the B<host> field of dispatched values. Defaults to the global hostname
3609 For backwards compatibility, values are also dispatched with the global
3610 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3613 =item B<Address> I<Address>
3615 Hostname or IP to connect to. For backwards compatibility, defaults to the
3616 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3618 =item B<Port> I<Port>
3620 TCP port to connect to. Defaults to B<11211>.
3622 =item B<Socket> I<Path>
3624 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3625 setting is given, the B<Address> and B<Port> settings are ignored.
3629 =head2 Plugin C<mic>
3631 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3632 Intel's Many Integrated Core (MIC) systems.
3641 ShowTemperatures true
3644 IgnoreSelectedTemperature true
3649 IgnoreSelectedPower true
3652 The following options are valid inside the B<PluginE<nbsp>mic> block:
3656 =item B<ShowCPU> B<true>|B<false>
3658 If enabled (the default) a sum of the CPU usage across all cores is reported.
3660 =item B<ShowCPUCores> B<true>|B<false>
3662 If enabled (the default) per-core CPU usage is reported.
3664 =item B<ShowMemory> B<true>|B<false>
3666 If enabled (the default) the physical memory usage of the MIC system is
3669 =item B<ShowTemperatures> B<true>|B<false>
3671 If enabled (the default) various temperatures of the MIC system are reported.
3673 =item B<Temperature> I<Name>
3675 This option controls which temperatures are being reported. Whether matching
3676 temperatures are being ignored or I<only> matching temperatures are reported
3677 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3678 temperatures are reported.
3680 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3682 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3683 (the default) only temperatures matching a B<Temperature> option are reported
3684 or, if no B<Temperature> option is specified, all temperatures are reported. If
3685 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3688 Known temperature names are:
3722 =item B<ShowPower> B<true>|B<false>
3724 If enabled (the default) various temperatures of the MIC system are reported.
3726 =item B<Power> I<Name>
3728 This option controls which power readings are being reported. Whether matching
3729 power readings are being ignored or I<only> matching power readings are reported
3730 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3731 power readings are reported.
3733 =item B<IgnoreSelectedPower> B<false>|B<true>
3735 Controls the behavior of the B<Power> setting above. If set to B<false>
3736 (the default) only power readings matching a B<Power> option are reported
3737 or, if no B<Power> option is specified, all power readings are reported. If
3738 set to B<true>, matching power readings are I<ignored> and all other power readings
3741 Known power names are:
3747 Total power utilization averaged over Time Window 0 (uWatts).
3751 Total power utilization averaged over Time Window 0 (uWatts).
3755 Instantaneous power (uWatts).
3759 Max instantaneous power (uWatts).
3763 PCI-E connector power (uWatts).
3767 2x3 connector power (uWatts).
3771 2x4 connector power (uWatts).
3779 Uncore rail (uVolts).
3783 Memory subsystem rail (uVolts).
3789 =head2 Plugin C<memory>
3791 The I<memory plugin> provides the following configuration options:
3795 =item B<ValuesAbsolute> B<true>|B<false>
3797 Enables or disables reporting of physical memory usage in absolute numbers,
3798 i.e. bytes. Defaults to B<true>.
3800 =item B<ValuesPercentage> B<false>|B<true>
3802 Enables or disables reporting of physical memory usage in percentages, e.g.
3803 percent of physical memory used. Defaults to B<false>.
3805 This is useful for deploying I<collectd> in a heterogeneous environment in
3806 which the sizes of physical memory vary.
3810 =head2 Plugin C<modbus>
3812 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3813 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3814 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3815 values (two registers interpreted as IEEE floats in big endian notation).
3819 <Data "voltage-input-1">
3822 RegisterCmd ReadHolding
3827 <Data "voltage-input-2">
3830 RegisterCmd ReadHolding
3835 <Data "supply-temperature-1">
3838 RegisterCmd ReadHolding
3843 <Host "modbus.example.com">
3844 Address "192.168.0.42"
3849 Instance "power-supply"
3850 Collect "voltage-input-1"
3851 Collect "voltage-input-2"
3856 Device "/dev/ttyUSB0"
3861 Instance "temperature"
3862 Collect "supply-temperature-1"
3868 =item E<lt>B<Data> I<Name>E<gt> blocks
3870 Data blocks define a mapping between register numbers and the "types" used by
3873 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3877 =item B<RegisterBase> I<Number>
3879 Configures the base register to read from the device. If the option
3880 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3881 register will be read (the register number is increased by one).
3883 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3885 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3886 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3887 combined into one value. Defaults to B<Uint16>.
3889 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3891 Specifies register type to be collected from device. Works only with libmodbus
3892 2.9.2 or higher. Defaults to B<ReadHolding>.
3894 =item B<Type> I<Type>
3896 Specifies the "type" (data set) to use when dispatching the value to
3897 I<collectd>. Currently, only data sets with exactly one data source are
3900 =item B<Instance> I<Instance>
3902 Sets the type instance to use when dispatching the value to I<collectd>. If
3903 unset, an empty string (no type instance) is used.
3907 =item E<lt>B<Host> I<Name>E<gt> blocks
3909 Host blocks are used to specify to which hosts to connect and what data to read
3910 from their "slaves". The string argument I<Name> is used as hostname when
3911 dispatching the values to I<collectd>.
3913 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3917 =item B<Address> I<Hostname>
3919 For Modbus/TCP, specifies the node name (the actual network address) used to
3920 connect to the host. This may be an IP address or a hostname. Please note that
3921 the used I<libmodbus> library only supports IPv4 at the moment.
3923 =item B<Port> I<Service>
3925 for Modbus/TCP, specifies the port used to connect to the host. The port can
3926 either be given as a number or as a service name. Please note that the
3927 I<Service> argument must be a string, even if ports are given in their numerical
3928 form. Defaults to "502".
3930 =item B<Device> I<Devicenode>
3932 For Modbus/RTU, specifies the path to the serial device being used.
3934 =item B<Baudrate> I<Baudrate>
3936 For Modbus/RTU, specifies the baud rate of the serial device.
3937 Note, connections currently support only 8/N/1.
3939 =item B<Interval> I<Interval>
3941 Sets the interval (in seconds) in which the values will be collected from this
3942 host. By default the global B<Interval> setting will be used.
3944 =item E<lt>B<Slave> I<ID>E<gt>
3946 Over each connection, multiple Modbus devices may be reached. The slave ID
3947 is used to specify which device should be addressed. For each device you want
3948 to query, one B<Slave> block must be given.
3950 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3954 =item B<Instance> I<Instance>
3956 Specify the plugin instance to use when dispatching the values to I<collectd>.
3957 By default "slave_I<ID>" is used.
3959 =item B<Collect> I<DataName>
3961 Specifies which data to retrieve from the device. I<DataName> must be the same
3962 string as the I<Name> argument passed to a B<Data> block. You can specify this
3963 option multiple times to collect more than one value from a slave. At least one
3964 B<Collect> option is mandatory.
3972 =head2 Plugin C<mqtt>
3974 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
3975 values from MQTT (B<Subscribe> blocks).
3981 Host "mqtt.example.com"
3985 Host "mqtt.example.com"
3990 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
3991 configuring the sending and receiving direction respectively. The plugin will
3992 register a write callback named C<mqtt/I<name>> where I<name> is the string
3993 argument given to the B<Publish> block. Both types of blocks share many but not
3994 all of the following options. If an option is valid in only one of the blocks,
3995 it will be mentioned explicitly.
4001 =item B<Host> I<Hostname>
4003 Hostname of the MQTT broker to connect to.
4005 =item B<Port> I<Service>
4007 Port number or service name of the MQTT broker to connect to.
4009 =item B<User> I<UserName>
4011 Username used when authenticating to the MQTT broker.
4013 =item B<Password> I<Password>
4015 Password used when authenticating to the MQTT broker.
4017 =item B<ClientId> I<ClientId>
4019 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4021 =item B<QoS> [B<0>-B<2>]
4023 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4041 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4042 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4043 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4044 on a message is larger than the maximum accepted QoS of a subscriber, the
4045 message's QoS will be downgraded.
4047 =item B<Prefix> I<Prefix> (Publish only)
4049 This plugin will use one topic per I<value list> which will looks like a path.
4050 I<Prefix> is used as the first path element and defaults to B<collectd>.
4052 An example topic name would be:
4054 collectd/cpu-0/cpu-user
4056 =item B<Retain> B<false>|B<true> (Publish only)
4058 Controls whether the MQTT broker will retain (keep a copy of) the last message
4059 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4061 =item B<StoreRates> B<true>|B<false> (Publish only)
4063 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4064 before sending. Defaults to B<true>.
4066 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4068 Controls whether the MQTT "cleans" the session up after the subscriber
4069 disconnects or if it maintains the subscriber's subscriptions and all messages
4070 that arrive while the subscriber is disconnected. Defaults to B<true>.
4072 =item B<Topic> I<TopicName> (Subscribe only)
4074 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4075 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4076 the B<collectd> branch.
4078 =item B<CACert> I<file>
4080 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4081 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4082 port of the MQTT broker.
4083 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4085 =item B<CertificateFile> I<file>
4087 Path to the PEM-encoded certificate file to use as client certificate when
4088 connecting to the MQTT broker.
4089 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4091 =item B<CertificateKeyFile> I<file>
4093 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4094 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4096 =item B<TLSProtocol> I<protocol>
4098 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4099 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4100 version is used which depends on the version of OpenSSL the Mosquitto library
4103 =item B<CipherSuite> I<ciphersuite>
4105 A string describing the ciphers available for use. See L<ciphers(1)> and the
4106 C<openssl ciphers> utility for more information. If unset, the default ciphers
4112 =head2 Plugin C<mysql>
4114 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4115 one or more databases when started and keeps the connection up as long as
4116 possible. When the connection is interrupted for whatever reason it will try
4117 to re-connect. The plugin will complain loudly in case anything goes wrong.
4119 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4120 and collects information about MySQL network traffic, executed statements,
4121 requests, the query cache and threads by evaluating the
4122 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4123 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4124 Status Variables> for an explanation of these values.
4126 Optionally, master and slave statistics may be collected in a MySQL
4127 replication setup. In that case, information about the synchronization state
4128 of the nodes are collected by evaluating the C<Position> return value of the
4129 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4130 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4131 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4132 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4133 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4145 SSLKey "/path/to/key.pem"
4146 SSLCert "/path/to/cert.pem"
4147 SSLCA "/path/to/ca.pem"
4148 SSLCAPath "/path/to/cas/"
4149 SSLCipher "DHE-RSA-AES256-SHA"
4155 Socket "/var/run/mysql/mysqld.sock"
4157 SlaveNotifications true
4163 Socket "/var/run/mysql/mysqld.sock"
4168 A B<Database> block defines one connection to a MySQL database. It accepts a
4169 single argument which specifies the name of the database. None of the other
4170 options are required. MySQL will use default values as documented in the
4171 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4172 B<MySQL reference manual>.
4176 =item B<Alias> I<Alias>
4178 Alias to use as sender instead of hostname when reporting. This may be useful
4179 when having cryptic hostnames.
4181 =item B<Host> I<Hostname>
4183 Hostname of the database server. Defaults to B<localhost>.
4185 =item B<User> I<Username>
4187 Username to use when connecting to the database. The user does not have to be
4188 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4189 unless you want to collectd replication statistics (see B<MasterStats> and
4190 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4191 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4193 =item B<Password> I<Password>
4195 Password needed to log into the database.
4197 =item B<Database> I<Database>
4199 Select this database. Defaults to I<no database> which is a perfectly reasonable
4200 option for what this plugin does.
4202 =item B<Port> I<Port>
4204 TCP-port to connect to. The port must be specified in its numeric form, but it
4205 must be passed as a string nonetheless. For example:
4209 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4210 See the documentation for the C<mysql_real_connect> function for details.
4212 =item B<Socket> I<Socket>
4214 Specifies the path to the UNIX domain socket of the MySQL server. This option
4215 only has any effect, if B<Host> is set to B<localhost> (the default).
4216 Otherwise, use the B<Port> option above. See the documentation for the
4217 C<mysql_real_connect> function for details.
4219 =item B<InnodbStats> I<true|false>
4221 If enabled, metrics about the InnoDB storage engine are collected.
4222 Disabled by default.
4224 =item B<MasterStats> I<true|false>
4226 =item B<SlaveStats> I<true|false>
4228 Enable the collection of master / slave statistics in a replication setup. In
4229 order to be able to get access to these statistics, the user needs special
4230 privileges. See the B<User> documentation above. Defaults to B<false>.
4232 =item B<SlaveNotifications> I<true|false>
4234 If enabled, the plugin sends a notification if the replication slave I/O and /
4235 or SQL threads are not running. Defaults to B<false>.
4237 =item B<WsrepStats> I<true|false>
4239 Enable the collection of wsrep plugin statistics, used in Master-Master
4240 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4241 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4243 =item B<ConnectTimeout> I<Seconds>
4245 Sets the connect timeout for the MySQL client.
4247 =item B<SSLKey> I<Path>
4249 If provided, the X509 key in PEM format.
4251 =item B<SSLCert> I<Path>
4253 If provided, the X509 cert in PEM format.
4255 =item B<SSLCA> I<Path>
4257 If provided, the CA file in PEM format (check OpenSSL docs).
4259 =item B<SSLCAPath> I<Path>
4261 If provided, the CA directory (check OpenSSL docs).
4263 =item B<SSLCipher> I<String>
4265 If provided, the SSL cipher to use.
4269 =head2 Plugin C<netapp>
4271 The netapp plugin can collect various performance and capacity information
4272 from a NetApp filer using the NetApp API.
4274 Please note that NetApp has a wide line of products and a lot of different
4275 software versions for each of these products. This plugin was developed for a
4276 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4277 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4278 model and software version but it is very hard to test this.
4279 If you have used this plugin with other models and/or software version, feel
4280 free to send us a mail to tell us about the results, even if it's just a short
4283 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4284 basic authentication.
4286 B<Do not use a regular user for this!> Create a special collectd user with just
4287 the minimum of capabilities needed. The user only needs the "login-http-admin"
4288 capability as well as a few more depending on which data will be collected.
4289 Required capabilities are documented below.
4294 <Host "netapp1.example.com">
4318 IgnoreSelectedIO false
4320 IgnoreSelectedOps false
4321 GetLatency "volume0"
4322 IgnoreSelectedLatency false
4329 IgnoreSelectedCapacity false
4332 IgnoreSelectedSnapshot false
4360 The netapp plugin accepts the following configuration options:
4364 =item B<Host> I<Name>
4366 A host block defines one NetApp filer. It will appear in collectd with the name
4367 you specify here which does not have to be its real name nor its hostname (see
4368 the B<Address> option below).
4370 =item B<VFiler> I<Name>
4372 A B<VFiler> block may only be used inside a host block. It accepts all the
4373 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4374 will execute all NetApp API commands in the context of the specified
4375 VFiler(R). It will appear in collectd with the name you specify here which
4376 does not have to be its real name. The VFiler name may be specified using the
4377 B<VFilerName> option. If this is not specified, it will default to the name
4380 The VFiler block inherits all connection related settings from the surrounding
4381 B<Host> block (which appear before the B<VFiler> block) but they may be
4382 overwritten inside the B<VFiler> block.
4384 This feature is useful, for example, when using a VFiler as SnapVault target
4385 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4386 available in the host filer (vfiler0) but only in the respective VFiler
4389 =item B<Protocol> B<httpd>|B<http>
4391 The protocol collectd will use to query this host.
4399 Valid options: http, https
4401 =item B<Address> I<Address>
4403 The hostname or IP address of the host.
4409 Default: The "host" block's name.
4411 =item B<Port> I<Port>
4413 The TCP port to connect to on the host.
4419 Default: 80 for protocol "http", 443 for protocol "https"
4421 =item B<User> I<User>
4423 =item B<Password> I<Password>
4425 The username and password to use to login to the NetApp.
4431 =item B<VFilerName> I<Name>
4433 The name of the VFiler in which context to execute API commands. If not
4434 specified, the name provided to the B<VFiler> block will be used instead.
4440 Default: name of the B<VFiler> block
4442 B<Note:> This option may only be used inside B<VFiler> blocks.
4444 =item B<Interval> I<Interval>
4450 The following options decide what kind of data will be collected. You can
4451 either use them as a block and fine tune various parameters inside this block,
4452 use them as a single statement to just accept all default values, or omit it to
4453 not collect any data.
4455 The following options are valid inside all blocks:
4459 =item B<Interval> I<Seconds>
4461 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4462 host specific setting.
4466 =head3 The System block
4468 This will collect various performance data about the whole system.
4470 B<Note:> To get this data the collectd user needs the
4471 "api-perf-object-get-instances" capability.
4475 =item B<Interval> I<Seconds>
4477 Collect disk statistics every I<Seconds> seconds.
4479 =item B<GetCPULoad> B<true>|B<false>
4481 If you set this option to true the current CPU usage will be read. This will be
4482 the average usage between all CPUs in your NetApp without any information about
4485 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4486 returns in the "CPU" field.
4494 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4496 =item B<GetInterfaces> B<true>|B<false>
4498 If you set this option to true the current traffic of the network interfaces
4499 will be read. This will be the total traffic over all interfaces of your NetApp
4500 without any information about individual interfaces.
4502 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4503 in the "Net kB/s" field.
4513 Result: One value list of type "if_octects".
4515 =item B<GetDiskIO> B<true>|B<false>
4517 If you set this option to true the current IO throughput will be read. This
4518 will be the total IO of your NetApp without any information about individual
4519 disks, volumes or aggregates.
4521 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4522 in the "DiskE<nbsp>kB/s" field.
4530 Result: One value list of type "disk_octets".
4532 =item B<GetDiskOps> B<true>|B<false>
4534 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4535 iSCSI, etc. operations will be read. This will be the total number of
4536 operations on your NetApp without any information about individual volumes or
4539 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4540 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4548 Result: A variable number of value lists of type "disk_ops_complex". Each type
4549 of operation will result in one value list with the name of the operation as
4554 =head3 The WAFL block
4556 This will collect various performance data about the WAFL file system. At the
4557 moment this just means cache performance.
4559 B<Note:> To get this data the collectd user needs the
4560 "api-perf-object-get-instances" capability.
4562 B<Note:> The interface to get these values is classified as "Diagnostics" by
4563 NetApp. This means that it is not guaranteed to be stable even between minor
4568 =item B<Interval> I<Seconds>
4570 Collect disk statistics every I<Seconds> seconds.
4572 =item B<GetNameCache> B<true>|B<false>
4580 Result: One value list of type "cache_ratio" and type instance
4583 =item B<GetDirCache> B<true>|B<false>
4591 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4593 =item B<GetInodeCache> B<true>|B<false>
4601 Result: One value list of type "cache_ratio" and type instance
4604 =item B<GetBufferCache> B<true>|B<false>
4606 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4607 in the "Cache hit" field.
4615 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4619 =head3 The Disks block
4621 This will collect performance data about the individual disks in the NetApp.
4623 B<Note:> To get this data the collectd user needs the
4624 "api-perf-object-get-instances" capability.
4628 =item B<Interval> I<Seconds>
4630 Collect disk statistics every I<Seconds> seconds.
4632 =item B<GetBusy> B<true>|B<false>
4634 If you set this option to true the busy time of all disks will be calculated
4635 and the value of the busiest disk in the system will be written.
4637 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4638 in the "Disk util" field. Probably.
4646 Result: One value list of type "percent" and type instance "disk_busy".
4650 =head3 The VolumePerf block
4652 This will collect various performance data about the individual volumes.
4654 You can select which data to collect about which volume using the following
4655 options. They follow the standard ignorelist semantic.
4657 B<Note:> To get this data the collectd user needs the
4658 I<api-perf-object-get-instances> capability.
4662 =item B<Interval> I<Seconds>
4664 Collect volume performance data every I<Seconds> seconds.
4666 =item B<GetIO> I<Volume>
4668 =item B<GetOps> I<Volume>
4670 =item B<GetLatency> I<Volume>
4672 Select the given volume for IO, operations or latency statistics collection.
4673 The argument is the name of the volume without the C</vol/> prefix.
4675 Since the standard ignorelist functionality is used here, you can use a string
4676 starting and ending with a slash to specify regular expression matching: To
4677 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4680 GetIO "/^vol[027]$/"
4682 If no regular expression is specified, an exact match is required. Both,
4683 regular and exact matching are case sensitive.
4685 If no volume was specified at all for either of the three options, that data
4686 will be collected for all available volumes.
4688 See F</"IGNORELISTS"> for details.
4690 =item B<IgnoreSelectedIO> B<true>|B<false>
4692 =item B<IgnoreSelectedOps> B<true>|B<false>
4694 =item B<IgnoreSelectedLatency> B<true>|B<false>
4696 When set to B<true>, the volumes selected for IO, operations or latency
4697 statistics collection will be ignored and the data will be collected for all
4700 When set to B<false>, data will only be collected for the specified volumes and
4701 all other volumes will be ignored.
4703 If no volumes have been specified with the above B<Get*> options, all volumes
4704 will be collected regardless of the B<IgnoreSelected*> option.
4706 Defaults to B<false>
4710 =head3 The VolumeUsage block
4712 This will collect capacity data about the individual volumes.
4714 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4719 =item B<Interval> I<Seconds>
4721 Collect volume usage statistics every I<Seconds> seconds.
4723 =item B<GetCapacity> I<VolumeName>
4725 The current capacity of the volume will be collected. This will result in two
4726 to four value lists, depending on the configuration of the volume. All data
4727 sources are of type "df_complex" with the name of the volume as
4730 There will be type_instances "used" and "free" for the number of used and
4731 available bytes on the volume. If the volume has some space reserved for
4732 snapshots, a type_instance "snap_reserved" will be available. If the volume
4733 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4734 number of bytes saved by the SIS feature.
4736 B<Note:> The current NetApp API has a bug that results in this value being
4737 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4738 number which works most of the time. If you see strange values here, bug
4739 NetApp support to fix this.
4741 Repeat this option to specify multiple volumes.
4743 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4745 Specify whether to collect only the volumes selected by the B<GetCapacity>
4746 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4747 B<false>. However, if no B<GetCapacity> option is specified at all, all
4748 capacities will be selected anyway.
4750 =item B<GetSnapshot> I<VolumeName>
4752 Select volumes from which to collect snapshot information.
4754 Usually, the space used for snapshots is included in the space reported as
4755 "used". If snapshot information is collected as well, the space used for
4756 snapshots is subtracted from the used space.
4758 To make things even more interesting, it is possible to reserve space to be
4759 used for snapshots. If the space required for snapshots is less than that
4760 reserved space, there is "reserved free" and "reserved used" space in addition
4761 to "free" and "used". If the space required for snapshots exceeds the reserved
4762 space, that part allocated in the normal space is subtracted from the "used"
4765 Repeat this option to specify multiple volumes.
4767 =item B<IgnoreSelectedSnapshot>
4769 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4770 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4771 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4772 capacities will be selected anyway.
4776 =head3 The Quota block
4778 This will collect (tree) quota statistics (used disk space and number of used
4779 files). This mechanism is useful to get usage information for single qtrees.
4780 In case the quotas are not used for any other purpose, an entry similar to the
4781 following in C</etc/quotas> would be sufficient:
4783 /vol/volA/some_qtree tree - - - - -
4785 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4789 =item B<Interval> I<Seconds>
4791 Collect SnapVault(R) statistics every I<Seconds> seconds.
4795 =head3 The SnapVault block
4797 This will collect statistics about the time and traffic of SnapVault(R)
4802 =item B<Interval> I<Seconds>
4804 Collect SnapVault(R) statistics every I<Seconds> seconds.
4808 =head2 Plugin C<netlink>
4810 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4811 statistics of various interface and routing aspects.
4815 =item B<Interface> I<Interface>
4817 =item B<VerboseInterface> I<Interface>
4819 Instruct the plugin to collect interface statistics. This is basically the same
4820 as the statistics provided by the C<interface> plugin (see above) but
4821 potentially much more detailed.
4823 When configuring with B<Interface> only the basic statistics will be collected,
4824 namely octets, packets, and errors. These statistics are collected by
4825 the C<interface> plugin, too, so using both at the same time is no benefit.
4827 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4828 so that no data needs to be collected twice if you use the C<interface> plugin.
4829 This includes dropped packets, received multicast packets, collisions and a
4830 whole zoo of differentiated RX and TX errors. You can try the following command
4831 to get an idea of what awaits you:
4835 If I<Interface> is B<All>, all interfaces will be selected.
4837 =item B<QDisc> I<Interface> [I<QDisc>]
4839 =item B<Class> I<Interface> [I<Class>]
4841 =item B<Filter> I<Interface> [I<Filter>]
4843 Collect the octets and packets that pass a certain qdisc, class or filter.
4845 QDiscs and classes are identified by their type and handle (or classid).
4846 Filters don't necessarily have a handle, therefore the parent's handle is used.
4847 The notation used in collectd differs from that used in tc(1) in that it
4848 doesn't skip the major or minor number if it's zero and doesn't print special
4849 ids by their name. So, for example, a qdisc may be identified by
4850 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4851 thus not displayed by tc(1).
4853 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4854 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4855 associated with that interface will be collected.
4857 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4858 used. This may lead to problems when more than one filter is attached to a
4859 qdisc or class. This isn't nice, but we don't know how this could be done any
4860 better. If you have a idea, please don't hesitate to tell us.
4862 As with the B<Interface> option you can specify B<All> as the interface,
4863 meaning all interfaces.
4865 Here are some examples to help you understand the above text more easily:
4868 VerboseInterface "All"
4869 QDisc "eth0" "pfifo_fast-1:0"
4871 Class "ppp0" "htb-1:10"
4872 Filter "ppp0" "u32-1:0"
4875 See F</"IGNORELISTS"> for details.
4877 =item B<IgnoreSelected>
4879 The behavior is the same as with all other similar plugins: If nothing is
4880 selected at all, everything is collected. If some things are selected using the
4881 options described above, only these statistics are collected. If you set
4882 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4883 specified statistics will not be collected.
4887 =head2 Plugin C<network>
4889 The Network plugin sends data to a remote instance of collectd, receives data
4890 from a remote instance, or both at the same time. Data which has been received
4891 from the network is usually not transmitted again, but this can be activated, see
4892 the B<Forward> option below.
4894 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4895 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4897 Both, B<Server> and B<Listen> can be used as single option or as block. When
4898 used as block, given options are valid for this socket only. The following
4899 example will export the metrics twice: Once to an "internal" server (without
4900 encryption and signing) and one to an external server (with cryptographic
4904 # Export to an internal server
4905 # (demonstrates usage without additional options)
4906 Server "collectd.internal.tld"
4908 # Export to an external server
4909 # (demonstrates usage with signature options)
4910 <Server "collectd.external.tld">
4911 SecurityLevel "sign"
4912 Username "myhostname"
4919 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4921 The B<Server> statement/block sets the server to send datagrams to. The
4922 statement may occur multiple times to send each datagram to multiple
4925 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
4926 optional second argument specifies a port number or a service name. If not
4927 given, the default, B<25826>, is used.
4929 The following options are recognized within B<Server> blocks:
4933 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4935 Set the security you require for network communication. When the security level
4936 has been set to B<Encrypt>, data sent over the network will be encrypted using
4937 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4938 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4939 authentication code. When set to B<None>, data is sent without any security.
4941 This feature is only available if the I<network> plugin was linked with
4944 =item B<Username> I<Username>
4946 Sets the username to transmit. This is used by the server to lookup the
4947 password. See B<AuthFile> below. All security levels except B<None> require
4950 This feature is only available if the I<network> plugin was linked with
4953 =item B<Password> I<Password>
4955 Sets a password (shared secret) for this socket. All security levels except
4956 B<None> require this setting.
4958 This feature is only available if the I<network> plugin was linked with
4961 =item B<Interface> I<Interface name>
4963 Set the outgoing interface for IP packets. This applies at least
4964 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4965 undefined or a non-existent interface name is specified, the default
4966 behavior is to let the kernel choose the appropriate interface. Be warned
4967 that the manual selection of an interface for unicast traffic is only
4968 necessary in rare cases.
4970 =item B<ResolveInterval> I<Seconds>
4972 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4973 useful to force a regular DNS lookup to support a high availability setup. If
4974 not specified, re-resolves are never attempted.
4978 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4980 The B<Listen> statement sets the interfaces to bind to. When multiple
4981 statements are found the daemon will bind to multiple interfaces.
4983 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4984 the argument is a multicast address the daemon will join that multicast group.
4985 The optional second argument specifies a port number or a service name. If not
4986 given, the default, B<25826>, is used.
4988 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4992 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4994 Set the security you require for network communication. When the security level
4995 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4996 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4997 signed and encrypted data is accepted. When set to B<None>, all data will be
4998 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4999 decrypted if possible.
5001 This feature is only available if the I<network> plugin was linked with
5004 =item B<AuthFile> I<Filename>
5006 Sets a file in which usernames are mapped to passwords. These passwords are
5007 used to verify signatures and to decrypt encrypted network packets. If
5008 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5009 verified and encrypted packets are decrypted. Otherwise, signed data is
5010 accepted without checking the signature and encrypted data cannot be decrypted.
5011 For the other security levels this option is mandatory.
5013 The file format is very simple: Each line consists of a username followed by a
5014 colon and any number of spaces followed by the password. To demonstrate, an
5015 example file could look like this:
5020 Each time a packet is received, the modification time of the file is checked
5021 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5022 the file is being read, it is locked using L<fcntl(2)>.
5024 =item B<Interface> I<Interface name>
5026 Set the incoming interface for IP packets explicitly. This applies at least
5027 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5028 undefined or a non-existent interface name is specified, the default
5029 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5030 traffic gets only accepted, if it arrives on the given interface.
5034 =item B<TimeToLive> I<1-255>
5036 Set the time-to-live of sent packets. This applies to all, unicast and
5037 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5038 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5041 =item B<MaxPacketSize> I<1024-65535>
5043 Set the maximum size for datagrams received over the network. Packets larger
5044 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5045 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5048 On the server side, this limit should be set to the largest value used on
5049 I<any> client. Likewise, the value on the client must not be larger than the
5050 value on the server, or data will be lost.
5052 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5053 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5054 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5057 =item B<Forward> I<true|false>
5059 If set to I<true>, write packets that were received via the network plugin to
5060 the sending sockets. This should only be activated when the B<Listen>- and
5061 B<Server>-statements differ. Otherwise packets may be send multiple times to
5062 the same multicast group. While this results in more network traffic than
5063 necessary it's not a huge problem since the plugin has a duplicate detection,
5064 so the values will not loop.
5066 =item B<ReportStats> B<true>|B<false>
5068 The network plugin cannot only receive and send statistics, it can also create
5069 statistics about itself. Collectd data included the number of received and
5070 sent octets and packets, the length of the receive queue and the number of
5071 values handled. When set to B<true>, the I<Network plugin> will make these
5072 statistics available. Defaults to B<false>.
5076 =head2 Plugin C<nginx>
5078 This plugin collects the number of connections and requests handled by the
5079 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5080 queries the page provided by the C<ngx_http_stub_status_module> module, which
5081 isn't compiled by default. Please refer to
5082 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5083 how to compile and configure nginx and this module.
5085 The following options are accepted by the C<nginx plugin>:
5089 =item B<URL> I<http://host/nginx_status>
5091 Sets the URL of the C<ngx_http_stub_status_module> output.
5093 =item B<User> I<Username>
5095 Optional user name needed for authentication.
5097 =item B<Password> I<Password>
5099 Optional password needed for authentication.
5101 =item B<VerifyPeer> B<true|false>
5103 Enable or disable peer SSL certificate verification. See
5104 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5106 =item B<VerifyHost> B<true|false>
5108 Enable or disable peer host name verification. If enabled, the plugin checks
5109 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5110 certificate matches the host name provided by the B<URL> option. If this
5111 identity check fails, the connection is aborted. Obviously, only works when
5112 connecting to a SSL enabled server. Enabled by default.
5114 =item B<CACert> I<File>
5116 File that holds one or more SSL certificates. If you want to use HTTPS you will
5117 possibly need this option. What CA certificates come bundled with C<libcurl>
5118 and are checked by default depends on the distribution you use.
5120 =item B<Timeout> I<Milliseconds>
5122 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5123 milliseconds. By default, the configured B<Interval> is used to set the
5128 =head2 Plugin C<notify_desktop>
5130 This plugin sends a desktop notification to a notification daemon, as defined
5131 in the Desktop Notification Specification. To actually display the
5132 notifications, B<notification-daemon> is required and B<collectd> has to be
5133 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5134 environment variables have to be set correctly) and the D-Bus message bus.
5136 The Desktop Notification Specification can be found at
5137 L<http://www.galago-project.org/specs/notification/>.
5141 =item B<OkayTimeout> I<timeout>
5143 =item B<WarningTimeout> I<timeout>
5145 =item B<FailureTimeout> I<timeout>
5147 Set the I<timeout>, in milliseconds, after which to expire the notification
5148 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5149 been specified, the displayed notification will not be closed at all - the
5150 user has to do so herself. These options default to 5000. If a negative number
5151 has been specified, the default is used as well.
5155 =head2 Plugin C<notify_email>
5157 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5158 configured email address.
5160 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5162 Available configuration options:
5166 =item B<From> I<Address>
5168 Email address from which the emails should appear to come from.
5170 Default: C<root@localhost>
5172 =item B<Recipient> I<Address>
5174 Configures the email address(es) to which the notifications should be mailed.
5175 May be repeated to send notifications to multiple addresses.
5177 At least one B<Recipient> must be present for the plugin to work correctly.
5179 =item B<SMTPServer> I<Hostname>
5181 Hostname of the SMTP server to connect to.
5183 Default: C<localhost>
5185 =item B<SMTPPort> I<Port>
5187 TCP port to connect to.
5191 =item B<SMTPUser> I<Username>
5193 Username for ASMTP authentication. Optional.
5195 =item B<SMTPPassword> I<Password>
5197 Password for ASMTP authentication. Optional.
5199 =item B<Subject> I<Subject>
5201 Subject-template to use when sending emails. There must be exactly two
5202 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5203 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5206 Default: C<Collectd notify: %s@%s>
5210 =head2 Plugin C<notify_nagios>
5212 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5213 a I<passive service check result>.
5215 Available configuration options:
5219 =item B<CommandFile> I<Path>
5221 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5225 =head2 Plugin C<ntpd>
5227 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5230 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5231 the wire - using B<mode 7> specific requests. This mode is deprecated with
5232 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5233 correctly with them, the ntp daemon must be explicitly configured to
5234 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5235 manual page for details.
5237 Available configuration options for the C<ntpd> plugin:
5241 =item B<Host> I<Hostname>
5243 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5245 =item B<Port> I<Port>
5247 UDP-Port to connect to. Defaults to B<123>.
5249 =item B<ReverseLookups> B<true>|B<false>
5251 Sets whether or not to perform reverse lookups on peers. Since the name or
5252 IP-address may be used in a filename it is recommended to disable reverse
5253 lookups. The default is to do reverse lookups to preserve backwards
5254 compatibility, though.
5256 =item B<IncludeUnitID> B<true>|B<false>
5258 When a peer is a refclock, include the unit ID in the I<type instance>.
5259 Defaults to B<false> for backward compatibility.
5261 If two refclock peers use the same driver and this is B<false>, the plugin will
5262 try to write simultaneous measurements from both to the same type instance.
5263 This will result in error messages in the log and only one set of measurements
5268 =head2 Plugin C<nut>
5272 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5274 Add a UPS to collect data from. The format is identical to the one accepted by
5277 =item B<ForceSSL> B<true>|B<false>
5279 Stops connections from falling back to unsecured if an SSL connection
5280 cannot be established. Defaults to false if undeclared.
5282 =item B<VerifyPeer> I<true>|I<false>
5284 If set to true, requires a CAPath be provided. Will use the CAPath to find
5285 certificates to use as Trusted Certificates to validate a upsd server certificate.
5286 If validation of the upsd server certificate fails, the connection will not be
5287 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5288 will override and set ForceSSL to true.
5290 =item B<CAPath> I/path/to/certs/folder
5292 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5293 The folder pointed at must contain certificate(s) named according to their hash.
5294 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5295 occur because two different certs have the same hash value, Y can be incremented
5296 in order to avoid conflict. To create a symbolic link to a certificate the following
5297 command can be used from within the directory where the cert resides:
5299 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5301 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5302 generate links like the one described above for ALL certs in a given folder.
5304 C<c_rehash /path/to/certs/folder>
5308 =head2 Plugin C<olsrd>
5310 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5311 the Optimized Link State Routing daemon and reads information about the current
5312 state of the meshed network.
5314 The following configuration options are understood:
5318 =item B<Host> I<Host>
5320 Connect to I<Host>. Defaults to B<"localhost">.
5322 =item B<Port> I<Port>
5324 Specifies the port to connect to. This must be a string, even if you give the
5325 port as a number rather than a service name. Defaults to B<"2006">.
5327 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5329 Specifies what information to collect about links, i.E<nbsp>e. direct
5330 connections of the daemon queried. If set to B<No>, no information is
5331 collected. If set to B<Summary>, the number of links and the average of all
5332 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5333 If set to B<Detail> LQ and NLQ are collected per link.
5335 Defaults to B<Detail>.
5337 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5339 Specifies what information to collect about routes of the daemon queried. If
5340 set to B<No>, no information is collected. If set to B<Summary>, the number of
5341 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5342 metric and ETX are collected per route.
5344 Defaults to B<Summary>.
5346 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5348 Specifies what information to collect about the global topology. If set to
5349 B<No>, no information is collected. If set to B<Summary>, the number of links
5350 in the entire topology and the average I<link quality> (LQ) is calculated.
5351 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5353 Defaults to B<Summary>.
5357 =head2 Plugin C<onewire>
5359 B<EXPERIMENTAL!> See notes below.
5361 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5362 L<http://owfs.org/> to read sensors connected via the onewire bus.
5364 It can be used in two possible modes - standard or advanced.
5366 In the standard mode only temperature sensors (sensors with the family code
5367 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5368 other sensors you would like to have included, please send a sort request to
5369 the mailing list. You can select sensors to be read or to be ignored depending
5370 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5371 walked and all sensors are read.
5373 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5374 experimental, below.
5376 In the advanced mode you can configure any sensor to be read (only numerical
5377 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5378 In this mode you have to list all the sensors. Neither default bus walk nor
5379 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5380 the path automatically and should produce compatible structure with the "standard"
5381 mode (basically the path is expected as for example
5382 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5383 "F10FCA000800" and the rest after the slash is considered the type - here
5385 There are two advantages to this mode - you can access virtually any sensor
5386 (not just temperature), select whether to use cached or directly read values
5387 and it is slighlty faster. The downside is more complex configuration.
5389 The two modes are distinguished automatically by the format of the address.
5390 It is not possible to mix the two modes. Once a full path is detected in any
5391 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5392 (and as standard addresses will fail parsing they will be ignored).
5396 =item B<Device> I<Device>
5398 Sets the device to read the values from. This can either be a "real" hardware
5399 device, such as a serial port or an USB port, or the address of the
5400 L<owserver(1)> socket, usually B<localhost:4304>.
5402 Though the documentation claims to automatically recognize the given address
5403 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5404 with that version, the following configuration worked for us:
5407 Device "-s localhost:4304"
5410 This directive is B<required> and does not have a default value.
5412 =item B<Sensor> I<Sensor>
5414 In the standard mode selects sensors to collect or to ignore
5415 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5416 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5417 and B<not> include the leading C<10.> family byte and point.
5418 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5419 sensors (see above) are read.
5421 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5422 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5423 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5425 As there can be multiple devices on the bus you can list multiple sensor (use
5426 multiple B<Sensor> elements).
5428 See F</"IGNORELISTS"> for details.
5430 =item B<IgnoreSelected> I<true>|I<false>
5432 If no configuration is given, the B<onewire> plugin will collect data from all
5433 sensors found. This may not be practical, especially if sensors are added and
5434 removed regularly. Sometimes, however, it's easier/preferred to collect only
5435 specific sensors or all sensors I<except> a few specified ones. This option
5436 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5437 B<Sensor> is inverted: All selected interfaces are ignored and all other
5438 interfaces are collected.
5440 Used only in the standard mode - see above.
5442 =item B<Interval> I<Seconds>
5444 Sets the interval in which all sensors should be read. If not specified, the
5445 global B<Interval> setting is used.
5449 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5450 work with big setups. It works with one sensor being attached to one
5451 controller, but as soon as you throw in a couple more senors and maybe a hub
5452 or two, reading all values will take more than ten seconds (the default
5453 interval). We will probably add some separate thread for reading the sensors
5454 and some cache or something like that, but it's not done yet. We will try to
5455 maintain backwards compatibility in the future, but we can't promise. So in
5456 short: If it works for you: Great! But keep in mind that the config I<might>
5457 change, though this is unlikely. Oh, and if you want to help improving this
5458 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5460 =head2 Plugin C<openldap>
5462 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5463 server correctly. The backend database C<monitor> needs to be loaded and
5464 working. See slapd-monitor(5) for the details.
5466 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5467 blocks. Each block requires one string argument as the instance name. For
5472 URL "ldap://localhost/"
5475 URL "ldaps://localhost/"
5479 The instance name will be used as the I<plugin instance>. To emulate the old
5480 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5481 plugin to work correctly, each instance name must be unique. This is not
5482 enforced by the plugin and it is your responsibility to ensure it is.
5484 The following options are accepted within each B<Instance> block:
5488 =item B<URL> I<ldap://host/binddn>
5490 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5493 =item B<BindDN> I<BindDN>
5495 Name in the form of an LDAP distinguished name intended to be used for
5496 authentication. Defaults to empty string to establish an anonymous authorization.
5498 =item B<Password> I<Password>
5500 Password for simple bind authentication. If this option is not set,
5501 unauthenticated bind operation is used.
5503 =item B<StartTLS> B<true|false>
5505 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5506 Disabled by default.
5508 =item B<VerifyHost> B<true|false>
5510 Enables or disables peer host name verification. If enabled, the plugin checks
5511 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5512 certificate matches the host name provided by the B<URL> option. If this
5513 identity check fails, the connection is aborted. Enabled by default.
5515 =item B<CACert> I<File>
5517 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5518 may possibly need this option. What CA certificates are checked by default
5519 depends on the distribution you use and can be changed with the usual ldap
5520 client configuration mechanisms. See ldap.conf(5) for the details.
5522 =item B<Timeout> I<Seconds>
5524 Sets the timeout value for ldap operations, in seconds. By default, the
5525 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5528 =item B<Version> I<Version>
5530 An integer which sets the LDAP protocol version number to use when connecting
5531 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5535 =head2 Plugin C<openvpn>
5537 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5538 traffic statistics about connected clients.
5540 To set up OpenVPN to write to the status file periodically, use the
5541 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
5542 you need to set the required format, too. This is done by setting
5543 B<--status-version> to B<2>.
5545 So, in a nutshell you need:
5547 openvpn $OTHER_OPTIONS \
5548 --status "/var/run/openvpn-status" 10 \
5555 =item B<StatusFile> I<File>
5557 Specifies the location of the status file.
5559 =item B<ImprovedNamingSchema> B<true>|B<false>
5561 When enabled, the filename of the status file will be used as plugin instance
5562 and the client's "common name" will be used as type instance. This is required
5563 when reading multiple status files. Enabling this option is recommended, but to
5564 maintain backwards compatibility this option is disabled by default.
5566 =item B<CollectCompression> B<true>|B<false>
5568 Sets whether or not statistics about the compression used by OpenVPN should be
5569 collected. This information is only available in I<single> mode. Enabled by
5572 =item B<CollectIndividualUsers> B<true>|B<false>
5574 Sets whether or not traffic information is collected for each connected client
5575 individually. If set to false, currently no traffic data is collected at all
5576 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5578 =item B<CollectUserCount> B<true>|B<false>
5580 When enabled, the number of currently connected clients or users is collected.
5581 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5582 can be configured independently from that option. Defaults to B<false>.
5586 =head2 Plugin C<oracle>
5588 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5589 Oracle® Database and lets you execute SQL statements there. It is very similar
5590 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5591 plugin's documentation above for details.
5594 <Query "out_of_stock">
5595 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5598 # InstancePrefix "foo"
5599 InstancesFrom "category"
5603 <Database "product_information">
5607 Query "out_of_stock"
5611 =head3 B<Query> blocks
5613 The Query blocks are handled identically to the Query blocks of the "dbi"
5614 plugin. Please see its documentation above for details on how to specify
5617 =head3 B<Database> blocks
5619 Database blocks define a connection to a database and which queries should be
5620 sent to that database. Each database needs a "name" as string argument in the
5621 starting tag of the block. This name will be used as "PluginInstance" in the
5622 values submitted to the daemon. Other than that, that name is not used.
5626 =item B<ConnectID> I<ID>
5628 Defines the "database alias" or "service name" to connect to. Usually, these
5629 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5631 =item B<Host> I<Host>
5633 Hostname to use when dispatching values for this database. Defaults to using
5634 the global hostname of the I<collectd> instance.
5636 =item B<Username> I<Username>
5638 Username used for authentication.
5640 =item B<Password> I<Password>
5642 Password used for authentication.
5644 =item B<Query> I<QueryName>
5646 Associates the query named I<QueryName> with this database connection. The
5647 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5648 blocks you want to refer to must be placed above the database block you want to
5653 =head2 Plugin C<ovs_events>
5655 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5656 connected interfaces, dispatches the values to collectd and sends the
5657 notification whenever the link state change occurs. This plugin uses OVS
5658 database to get a link state change notification.
5662 <Plugin "ovs_events">
5665 Socket "/var/run/openvswitch/db.sock"
5666 Interfaces "br0" "veth0"
5667 SendNotification true
5668 DispatchValues false
5671 The plugin provides the following configuration options:
5675 =item B<Address> I<node>
5677 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5678 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5679 option. See L<ovsdb-server(1)> for more details. The option may be either
5680 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5681 format. Defaults to B<'localhost'>.
5683 =item B<Port> I<service>
5685 TCP-port to connect to. Either a service name or a port number may be given.
5686 Defaults to B<6640>.
5688 =item B<Socket> I<path>
5690 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5691 plugin. To enable the interface, the OVS DB daemon should be running with
5692 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5693 option is set, B<Address> and B<Port> options are ignored.
5695 =item B<Interfaces> [I<ifname> ...]
5697 List of interface names to be monitored by this plugin. If this option is not
5698 specified or is empty then all OVS connected interfaces on all bridges are
5701 Default: empty (all interfaces on all bridges are monitored)
5703 =item B<SendNotification> I<true|false>
5705 If set to true, OVS link notifications (interface status and OVS DB connection
5706 terminate) are sent to collectd. Default value is true.
5708 =item B<DispatchValues> I<true|false>
5710 Dispatch the OVS DB interface link status value with configured plugin interval.
5711 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
5712 options are false, no OVS information will be provided by the plugin.
5716 B<Note:> By default, the global interval setting is used within which to
5717 retrieve the OVS link status. To configure a plugin-specific interval, please
5718 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
5719 simple divide the time by 1000 for example if the desired interval is 50ms, set
5722 =head2 Plugin C<ovs_stats>
5724 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
5725 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
5726 statistics from OVSDB
5730 <Plugin "ovs_stats">
5733 Socket "/var/run/openvswitch/db.sock"
5734 Bridges "br0" "br_ext"
5737 The plugin provides the following configuration options:
5741 =item B<Address> I<node>
5743 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5744 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5745 option. See L<ovsdb-server(1)> for more details. The option may be either
5746 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5747 format. Defaults to B<'localhost'>.
5749 =item B<Port> I<service>
5751 TCP-port to connect to. Either a service name or a port number may be given.
5752 Defaults to B<6640>.
5754 =item B<Socket> I<path>
5756 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5757 plugin. To enable the interface, the OVS DB daemon should be running with
5758 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5759 option is set, B<Address> and B<Port> options are ignored.
5761 =item B<Bridges> [I<brname> ...]
5763 List of OVS bridge names to be monitored by this plugin. If this option is
5764 omitted or is empty then all OVS bridges will be monitored.
5766 Default: empty (monitor all bridges)
5770 =head2 Plugin C<perl>
5772 This plugin embeds a Perl-interpreter into collectd and provides an interface
5773 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
5775 =head2 Plugin C<pinba>
5777 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
5778 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
5779 PHP-based webpage has been delivered, the extension will send a UDP packet
5780 containing timing information, peak memory usage and so on. The plugin will
5781 wait for such packets, parse them and account the provided information, which
5782 is then dispatched to the daemon once per interval.
5789 # Overall statistics for the website.
5791 Server "www.example.com"
5793 # Statistics for www-a only
5795 Host "www-a.example.com"
5796 Server "www.example.com"
5798 # Statistics for www-b only
5800 Host "www-b.example.com"
5801 Server "www.example.com"
5805 The plugin provides the following configuration options:
5809 =item B<Address> I<Node>
5811 Configures the address used to open a listening socket. By default, plugin will
5812 bind to the I<any> address C<::0>.
5814 =item B<Port> I<Service>
5816 Configures the port (service) to bind to. By default the default Pinba port
5817 "30002" will be used. The option accepts service names in addition to port
5818 numbers and thus requires a I<string> argument.
5820 =item E<lt>B<View> I<Name>E<gt> block
5822 The packets sent by the Pinba extension include the hostname of the server, the
5823 server name (the name of the virtual host) and the script that was executed.
5824 Using B<View> blocks it is possible to separate the data into multiple groups
5825 to get more meaningful statistics. Each packet is added to all matching groups,
5826 so that a packet may be accounted for more than once.
5830 =item B<Host> I<Host>
5832 Matches the hostname of the system the webserver / script is running on. This
5833 will contain the result of the L<gethostname(2)> system call. If not
5834 configured, all hostnames will be accepted.
5836 =item B<Server> I<Server>
5838 Matches the name of the I<virtual host>, i.e. the contents of the
5839 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
5840 server names will be accepted.
5842 =item B<Script> I<Script>
5844 Matches the name of the I<script name>, i.e. the contents of the
5845 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
5846 script names will be accepted.
5852 =head2 Plugin C<ping>
5854 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
5855 configured hosts periodically and measures the network latency. Whenever the
5856 C<read> function of the plugin is called, it submits the average latency, the
5857 standard deviation and the drop rate for each host.
5859 Available configuration options:
5863 =item B<Host> I<IP-address>
5865 Host to ping periodically. This option may be repeated several times to ping
5868 =item B<Interval> I<Seconds>
5870 Sets the interval in which to send ICMP echo packets to the configured hosts.
5871 This is B<not> the interval in which metrics are read from the plugin but the
5872 interval in which the hosts are "pinged". Therefore, the setting here should be
5873 smaller than or equal to the global B<Interval> setting. Fractional times, such
5874 as "1.24" are allowed.
5878 =item B<Timeout> I<Seconds>
5880 Time to wait for a response from the host to which an ICMP packet had been
5881 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
5882 to be down or the packet to be dropped. This setting must be smaller than the
5883 B<Interval> setting above for the plugin to work correctly. Fractional
5884 arguments are accepted.
5888 =item B<TTL> I<0-255>
5890 Sets the Time-To-Live of generated ICMP packets.
5892 =item B<Size> I<size>
5894 Sets the size of the data payload in ICMP packet to specified I<size> (it
5895 will be filled with regular ASCII pattern). If not set, default 56 byte
5896 long string is used so that the packet size of an ICMPv4 packet is exactly
5897 64 bytes, similar to the behaviour of normal ping(1) command.
5899 =item B<SourceAddress> I<host>
5901 Sets the source address to use. I<host> may either be a numerical network
5902 address or a network hostname.
5904 =item B<Device> I<name>
5906 Sets the outgoing network device to be used. I<name> has to specify an
5907 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
5910 =item B<MaxMissed> I<Packets>
5912 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
5913 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
5915 Default: B<-1> (disabled)
5919 =head2 Plugin C<postgresql>
5921 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
5922 keeps a persistent connection to all configured databases and tries to
5923 reconnect if the connection has been interrupted. A database is configured by
5924 specifying a B<Database> block as described below. The default statistics are
5925 collected from PostgreSQL's B<statistics collector> which thus has to be
5926 enabled for this plugin to work correctly. This should usually be the case by
5927 default. See the section "The Statistics Collector" of the B<PostgreSQL
5928 Documentation> for details.
5930 By specifying custom database queries using a B<Query> block as described
5931 below, you may collect any data that is available from some PostgreSQL
5932 database. This way, you are able to access statistics of external daemons
5933 which are available in a PostgreSQL database or use future or special
5934 statistics provided by PostgreSQL without the need to upgrade your collectd
5937 Starting with version 5.2, the C<postgresql> plugin supports writing data to
5938 PostgreSQL databases as well. This has been implemented in a generic way. You
5939 need to specify an SQL statement which will then be executed by collectd in
5940 order to write the data (see below for details). The benefit of that approach
5941 is that there is no fixed database layout. Rather, the layout may be optimized
5942 for the current setup.
5944 The B<PostgreSQL Documentation> manual can be found at
5945 L<http://www.postgresql.org/docs/manuals/>.
5949 Statement "SELECT magic FROM wizard WHERE host = $1;"
5953 InstancePrefix "magic"
5958 <Query rt36_tickets>
5959 Statement "SELECT COUNT(type) AS count, type \
5961 WHEN resolved = 'epoch' THEN 'open' \
5962 ELSE 'resolved' END AS type \
5963 FROM tickets) type \
5967 InstancePrefix "rt36_tickets"
5968 InstancesFrom "type"
5974 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
5984 KRBSrvName "kerberos_service_name"
5990 Service "service_name"
5991 Query backend # predefined
6002 The B<Query> block defines one database query which may later be used by a
6003 database definition. It accepts a single mandatory argument which specifies
6004 the name of the query. The names of all queries have to be unique (see the
6005 B<MinVersion> and B<MaxVersion> options below for an exception to this
6008 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6009 B<Result> blocks may be used to extract multiple values from a single query.
6011 The following configuration options are available to define the query:
6015 =item B<Statement> I<sql query statement>
6017 Specify the I<sql query statement> which the plugin should execute. The string
6018 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6019 first, second, etc. parameter. The value of the parameters is specified by the
6020 B<Param> configuration option - see below for details. To include a literal
6021 B<$> character followed by a number, surround it with single quotes (B<'>).
6023 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6024 allowed. Note, however, that only a single command may be used. Semicolons are
6025 allowed as long as a single non-empty command has been specified only.
6027 The returned lines will be handled separately one after another.
6029 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6031 Specify the parameters which should be passed to the SQL query. The parameters
6032 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6033 they appear in the configuration file. The value of the parameter is
6034 determined depending on the value of the B<Param> option as follows:
6040 The configured hostname of the database connection. If a UNIX domain socket is
6041 used, the parameter expands to "localhost".
6045 The name of the database of the current connection.
6049 The name of the database plugin instance. See the B<Instance> option of the
6050 database specification below for details.
6054 The username used to connect to the database.
6058 The interval with which this database is queried (as specified by the database
6059 specific or global B<Interval> options).
6063 Please note that parameters are only supported by PostgreSQL's protocol
6064 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6066 =item B<PluginInstanceFrom> I<column>
6068 Specify how to create the "PluginInstance" for reporting this query results.
6069 Only one column is supported. You may concatenate fields and string values in
6070 the query statement to get the required results.
6072 =item B<MinVersion> I<version>
6074 =item B<MaxVersion> I<version>
6076 Specify the minimum or maximum version of PostgreSQL that this query should be
6077 used with. Some statistics might only be available with certain versions of
6078 PostgreSQL. This allows you to specify multiple queries with the same name but
6079 which apply to different versions, thus allowing you to use the same
6080 configuration in a heterogeneous environment.
6082 The I<version> has to be specified as the concatenation of the major, minor
6083 and patch-level versions, each represented as two-decimal-digit numbers. For
6084 example, version 8.2.3 will become 80203.
6088 The B<Result> block defines how to handle the values returned from the query.
6089 It defines which column holds which value and how to dispatch that value to
6094 =item B<Type> I<type>
6096 The I<type> name to be used when dispatching the values. The type describes
6097 how to handle the data and where to store it. See L<types.db(5)> for more
6098 details on types and their configuration. The number and type of values (as
6099 selected by the B<ValuesFrom> option) has to match the type of the given name.
6101 This option is mandatory.
6103 =item B<InstancePrefix> I<prefix>
6105 =item B<InstancesFrom> I<column0> [I<column1> ...]
6107 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6108 B<InstancePrefix> defines a static prefix that will be prepended to all type
6109 instances. B<InstancesFrom> defines the column names whose values will be used
6110 to create the type instance. Multiple values will be joined together using the
6111 hyphen (C<->) as separation character.
6113 The plugin itself does not check whether or not all built instances are
6114 different. It is your responsibility to assure that each is unique.
6116 Both options are optional. If none is specified, the type instance will be
6119 =item B<ValuesFrom> I<column0> [I<column1> ...]
6121 Names the columns whose content is used as the actual data for the data sets
6122 that are dispatched to the daemon. How many such columns you need is
6123 determined by the B<Type> setting as explained above. If you specify too many
6124 or not enough columns, the plugin will complain about that and no data will be
6125 submitted to the daemon.
6127 The actual data type, as seen by PostgreSQL, is not that important as long as
6128 it represents numbers. The plugin will automatically cast the values to the
6129 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6130 L<strtod(3)> functions, so anything supported by those functions is supported
6131 by the plugin as well.
6133 This option is required inside a B<Result> block and may be specified multiple
6134 times. If multiple B<ValuesFrom> options are specified, the columns are read
6139 The following predefined queries are available (the definitions can be found
6140 in the F<postgresql_default.conf> file which, by default, is available at
6141 C<I<prefix>/share/collectd/>):
6147 This query collects the number of backends, i.E<nbsp>e. the number of
6150 =item B<transactions>
6152 This query collects the numbers of committed and rolled-back transactions of
6157 This query collects the numbers of various table modifications (i.E<nbsp>e.
6158 insertions, updates, deletions) of the user tables.
6160 =item B<query_plans>
6162 This query collects the numbers of various table scans and returned tuples of
6165 =item B<table_states>
6167 This query collects the numbers of live and dead rows in the user tables.
6171 This query collects disk block access counts for user tables.
6175 This query collects the on-disk size of the database in bytes.
6179 In addition, the following detailed queries are available by default. Please
6180 note that each of those queries collects information B<by table>, thus,
6181 potentially producing B<a lot> of data. For details see the description of the
6182 non-by_table queries above.
6186 =item B<queries_by_table>
6188 =item B<query_plans_by_table>
6190 =item B<table_states_by_table>
6192 =item B<disk_io_by_table>
6196 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6197 mandatory argument specifying the name of the writer. This will then be used
6198 in the B<Database> specification in order to activate the writer instance. The
6199 names of all writers have to be unique. The following options may be
6204 =item B<Statement> I<sql statement>
6206 This mandatory option specifies the SQL statement that will be executed for
6207 each submitted value. A single SQL statement is allowed only. Anything after
6208 the first semicolon will be ignored.
6210 Nine parameters will be passed to the statement and should be specified as
6211 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6212 values are made available through those parameters:
6218 The timestamp of the queried value as an RFC 3339-formatted local time.
6222 The hostname of the queried value.
6226 The plugin name of the queried value.
6230 The plugin instance of the queried value. This value may be B<NULL> if there
6231 is no plugin instance.
6235 The type of the queried value (cf. L<types.db(5)>).
6239 The type instance of the queried value. This value may be B<NULL> if there is
6244 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6245 sources of the submitted value-list).
6249 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6250 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6251 B<StoreRates> is enabled (which is the default, see below), all types will be
6256 An array of the submitted values. The dimensions of the value name and value
6261 In general, it is advisable to create and call a custom function in the
6262 PostgreSQL database for this purpose. Any procedural language supported by
6263 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6266 =item B<StoreRates> B<false>|B<true>
6268 If set to B<true> (the default), convert counter values to rates. If set to
6269 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6274 The B<Database> block defines one PostgreSQL database for which to collect
6275 statistics. It accepts a single mandatory argument which specifies the
6276 database name. None of the other options are required. PostgreSQL will use
6277 default values as documented in the section "CONNECTING TO A DATABASE" in the
6278 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6279 the user collectd is run as and special environment variables. See the manpage
6284 =item B<Interval> I<seconds>
6286 Specify the interval with which the database should be queried. The default is
6287 to use the global B<Interval> setting.
6289 =item B<CommitInterval> I<seconds>
6291 This option may be used for database connections which have "writers" assigned
6292 (see above). If specified, it causes a writer to put several updates into a
6293 single transaction. This transaction will last for the specified amount of
6294 time. By default, each update will be executed in a separate transaction. Each
6295 transaction generates a fair amount of overhead which can, thus, be reduced by
6296 activating this option. The draw-back is, that data covering the specified
6297 amount of time will be lost, for example, if a single statement within the
6298 transaction fails or if the database server crashes.
6300 =item B<Instance> I<name>
6302 Specify the plugin instance name that should be used instead of the database
6303 name (which is the default, if this option has not been specified). This
6304 allows one to query multiple databases of the same name on the same host (e.g.
6305 when running multiple database server versions in parallel).
6306 The plugin instance name can also be set from the query result using
6307 the B<PluginInstanceFrom> option in B<Query> block.
6309 =item B<Host> I<hostname>
6311 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6312 value begins with a slash, it is interpreted as the directory name in which to
6313 look for the UNIX domain socket.
6315 This option is also used to determine the hostname that is associated with a
6316 collected data set. If it has been omitted or either begins with with a slash
6317 or equals B<localhost> it will be replaced with the global hostname definition
6318 of collectd. Any other value will be passed literally to collectd when
6319 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6321 =item B<Port> I<port>
6323 Specify the TCP port or the local UNIX domain socket file extension of the
6326 =item B<User> I<username>
6328 Specify the username to be used when connecting to the server.
6330 =item B<Password> I<password>
6332 Specify the password to be used when connecting to the server.
6334 =item B<ExpireDelay> I<delay>
6336 Skip expired values in query output.
6338 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6340 Specify whether to use an SSL connection when contacting the server. The
6341 following modes are supported:
6347 Do not use SSL at all.
6351 First, try to connect without using SSL. If that fails, try using SSL.
6353 =item I<prefer> (default)
6355 First, try to connect using SSL. If that fails, try without using SSL.
6363 =item B<Instance> I<name>
6365 Specify the plugin instance name that should be used instead of the database
6366 name (which is the default, if this option has not been specified). This
6367 allows one to query multiple databases of the same name on the same host (e.g.
6368 when running multiple database server versions in parallel).
6370 =item B<KRBSrvName> I<kerberos_service_name>
6372 Specify the Kerberos service name to use when authenticating with Kerberos 5
6373 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6374 B<PostgreSQL Documentation> for details.
6376 =item B<Service> I<service_name>
6378 Specify the PostgreSQL service name to use for additional parameters. That
6379 service has to be defined in F<pg_service.conf> and holds additional
6380 connection parameters. See the section "The Connection Service File" in the
6381 B<PostgreSQL Documentation> for details.
6383 =item B<Query> I<query>
6385 Specifies a I<query> which should be executed in the context of the database
6386 connection. This may be any of the predefined or user-defined queries. If no
6387 such option is given, it defaults to "backends", "transactions", "queries",
6388 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6389 has been specified). Else, the specified queries are used only.
6391 =item B<Writer> I<writer>
6393 Assigns the specified I<writer> backend to the database connection. This
6394 causes all collected data to be send to the database using the settings
6395 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6396 below for details on how to selectively send data to certain plugins).
6398 Each writer will register a flush callback which may be used when having long
6399 transactions enabled (see the B<CommitInterval> option above). When issuing
6400 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6401 transaction will be committed right away. Two different kinds of flush
6402 callbacks are available with the C<postgresql> plugin:
6408 Flush all writer backends.
6410 =item B<postgresql->I<database>
6412 Flush all writers of the specified I<database> only.
6418 =head2 Plugin C<powerdns>
6420 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6421 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6422 values, many of which are probably meaningless to most users, but may be useful
6423 for some. So you may chose which values to collect, but if you don't, some
6424 reasonable defaults will be collected.
6427 <Server "server_name">
6429 Collect "udp-answers" "udp-queries"
6430 Socket "/var/run/pdns.controlsocket"
6432 <Recursor "recursor_name">
6434 Collect "cache-hits" "cache-misses"
6435 Socket "/var/run/pdns_recursor.controlsocket"
6437 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6442 =item B<Server> and B<Recursor> block
6444 The B<Server> block defines one authoritative server to query, the B<Recursor>
6445 does the same for an recursing server. The possible options in both blocks are
6446 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6451 =item B<Collect> I<Field>
6453 Using the B<Collect> statement you can select which values to collect. Here,
6454 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6455 C<dlg-only-drops>, C<answers10-100>.
6457 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6458 When querying the server a C<SHOW *> command is issued in any case, because
6459 that's the only way of getting multiple values out of the server at once.
6460 collectd then picks out the values you have selected. When querying the
6461 recursor, a command is generated to query exactly these values. So if you
6462 specify invalid fields when querying the recursor, a syntax error may be
6463 returned by the daemon and collectd may not collect any values at all.
6465 If no B<Collect> statement is given, the following B<Server> values will be
6472 =item packetcache-hit
6474 =item packetcache-miss
6476 =item packetcache-size
6478 =item query-cache-hit
6480 =item query-cache-miss
6482 =item recursing-answers
6484 =item recursing-questions
6496 The following B<Recursor> values will be collected by default:
6500 =item noerror-answers
6502 =item nxdomain-answers
6504 =item servfail-answers
6522 Please note that up to that point collectd doesn't know what values are
6523 available on the server and values that are added do not need a change of the
6524 mechanism so far. However, the values must be mapped to collectd's naming
6525 scheme, which is done using a lookup table that lists all known values. If
6526 values are added in the future and collectd does not know about them, you will
6527 get an error much like this:
6529 powerdns plugin: submit: Not found in lookup table: foobar = 42
6531 In this case please file a bug report with the collectd team.
6533 =item B<Socket> I<Path>
6535 Configures the path to the UNIX domain socket to be used when connecting to the
6536 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6537 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6538 will be used for the recursor.
6542 =item B<LocalSocket> I<Path>
6544 Querying the recursor is done using UDP. When using UDP over UNIX domain
6545 sockets, the client socket needs a name in the file system, too. You can set
6546 this local name to I<Path> using the B<LocalSocket> option. The default is
6547 C<I<prefix>/var/run/collectd-powerdns>.
6551 =head2 Plugin C<processes>
6555 =item B<Process> I<Name>
6557 Select more detailed statistics of processes matching this name. The statistics
6558 collected for these selected processes are:
6559 - size of the resident segment size (RSS)
6560 - user- and system-time used
6561 - number of processes
6563 - number of open files (under Linux)
6564 - io data (where available)
6565 - context switches (under Linux)
6566 - minor and major pagefaults.
6568 Some platforms have a limit on the length of process names. I<Name> must stay
6571 =item B<ProcessMatch> I<name> I<regex>
6573 Similar to the B<Process> option this allows one to select more detailed
6574 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6575 details). The statistics of all matching processes are summed up and
6576 dispatched to the daemon using the specified I<name> as an identifier. This
6577 allows one to "group" several processes together. I<name> must not contain
6580 =item B<CollectContextSwitch> I<Boolean>
6582 Collect context switch of the process.
6586 =head2 Plugin C<protocols>
6588 Collects a lot of information about various network protocols, such as I<IP>,
6589 I<TCP>, I<UDP>, etc.
6591 Available configuration options:
6595 =item B<Value> I<Selector>
6597 Selects whether or not to select a specific value. The string being matched is
6598 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6599 plugin instance and I<ValueName> will be used as type instance. An example of
6600 the string being used would be C<Tcp:RetransSegs>.
6602 You can use regular expressions to match a large number of values with just one
6603 configuration option. To select all "extended" I<TCP> values, you could use the
6604 following statement:
6608 Whether only matched values are selected or all matched values are ignored
6609 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6610 If no value is configured at all, all values will be selected.
6612 See F</"IGNORELISTS"> for details.
6614 =item B<IgnoreSelected> B<true>|B<false>
6616 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6617 matching values will be ignored.
6621 =head2 Plugin C<python>
6623 This plugin embeds a Python-interpreter into collectd and provides an interface
6624 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6626 =head2 Plugin C<routeros>
6628 The C<routeros> plugin connects to a device running I<RouterOS>, the
6629 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6630 I<librouteros> to connect and reads information about the interfaces and
6631 wireless connections of the device. The configuration supports querying
6636 Host "router0.example.com"
6639 CollectInterface true
6644 Host "router1.example.com"
6647 CollectInterface true
6648 CollectRegistrationTable true
6654 As you can see above, the configuration of the I<routeros> plugin consists of
6655 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6656 options are understood:
6660 =item B<Host> I<Host>
6662 Hostname or IP-address of the router to connect to.
6664 =item B<Port> I<Port>
6666 Port name or port number used when connecting. If left unspecified, the default
6667 will be chosen by I<librouteros>, currently "8728". This option expects a
6668 string argument, even when a numeric port number is given.
6670 =item B<User> I<User>
6672 Use the user name I<User> to authenticate. Defaults to "admin".
6674 =item B<Password> I<Password>
6676 Set the password used to authenticate.
6678 =item B<CollectInterface> B<true>|B<false>
6680 When set to B<true>, interface statistics will be collected for all interfaces
6681 present on the device. Defaults to B<false>.
6683 =item B<CollectRegistrationTable> B<true>|B<false>
6685 When set to B<true>, information about wireless LAN connections will be
6686 collected. Defaults to B<false>.
6688 =item B<CollectCPULoad> B<true>|B<false>
6690 When set to B<true>, information about the CPU usage will be collected. The
6691 number is a dimensionless value where zero indicates no CPU usage at all.
6692 Defaults to B<false>.
6694 =item B<CollectMemory> B<true>|B<false>
6696 When enabled, the amount of used and free memory will be collected. How used
6697 memory is calculated is unknown, for example whether or not caches are counted
6699 Defaults to B<false>.
6701 =item B<CollectDF> B<true>|B<false>
6703 When enabled, the amount of used and free disk space will be collected.
6704 Defaults to B<false>.
6706 =item B<CollectDisk> B<true>|B<false>
6708 When enabled, the number of sectors written and bad blocks will be collected.
6709 Defaults to B<false>.
6713 =head2 Plugin C<redis>
6715 The I<Redis plugin> connects to one or more Redis servers and gathers
6716 information about each server's state. For each server there is a I<Node> block
6717 which configures the connection parameters for this node.
6724 <Query "LLEN myqueue">
6731 The information shown in the synopsis above is the I<default configuration>
6732 which is used by the plugin if no configuration is present.
6736 =item B<Node> I<Nodename>
6738 The B<Node> block identifies a new Redis node, that is a new Redis instance
6739 running in an specified host and port. The name for node is a canonical
6740 identifier which is used as I<plugin instance>. It is limited to
6741 64E<nbsp>characters in length.
6743 =item B<Host> I<Hostname>
6745 The B<Host> option is the hostname or IP-address where the Redis instance is
6748 =item B<Port> I<Port>
6750 The B<Port> option is the TCP port on which the Redis instance accepts
6751 connections. Either a service name of a port number may be given. Please note
6752 that numerical port numbers must be given as a string, too.
6754 =item B<Password> I<Password>
6756 Use I<Password> to authenticate when connecting to I<Redis>.
6758 =item B<Timeout> I<Milliseconds>
6760 The B<Timeout> option set the socket timeout for node response. Since the Redis
6761 read function is blocking, you should keep this value as low as possible. Keep
6762 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
6763 than B<Interval> defined globally.
6765 =item B<Query> I<Querystring>
6767 The B<Query> block identifies a query to execute against the redis server.
6768 There may be an arbitrary number of queries to execute.
6770 =item B<Type> I<Collectd type>
6772 Within a query definition, a valid collectd type to use as when submitting
6773 the result of the query. When not supplied, will default to B<gauge>.
6775 =item B<Instance> I<Type instance>
6777 Within a query definition, an optional type instance to use when submitting
6778 the result of the query. When not supplied will default to the escaped
6779 command, up to 64 chars.
6783 =head2 Plugin C<rrdcached>
6785 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
6786 to store values to RRD files in an efficient manner. The combination of the
6787 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
6788 way the C<rrdtool> plugin works (see below). The added abstraction layer
6789 provides a number of benefits, though: Because the cache is not within
6790 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
6791 restarted. This results in much shorter (if any) gaps in graphs, especially
6792 under heavy load. Also, the C<rrdtool> command line utility is aware of the
6793 daemon so that it can flush values to disk automatically when needed. This
6794 allows one to integrate automated flushing of values into graphing solutions
6797 There are disadvantages, though: The daemon may reside on a different host, so
6798 it may not be possible for C<collectd> to create the appropriate RRD files
6799 anymore. And even if C<rrdcached> runs on the same host, it may run in a
6800 different base directory, so relative paths may do weird stuff if you're not
6803 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
6804 on the same host, communicating via a UNIX domain socket. The B<DataDir>
6805 setting should be set to an absolute path, so that a changed base directory
6806 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
6810 =item B<DaemonAddress> I<Address>
6812 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
6813 library. See L<rrdcached(1)> for details. Example:
6815 <Plugin "rrdcached">
6816 DaemonAddress "unix:/var/run/rrdcached.sock"
6819 =item B<DataDir> I<Directory>
6821 Set the base directory in which the RRD files reside. If this is a relative
6822 path, it is relative to the working base directory of the C<rrdcached> daemon!
6823 Use of an absolute path is recommended.
6825 =item B<CreateFiles> B<true>|B<false>
6827 Enables or disables the creation of RRD files. If the daemon is not running
6828 locally, or B<DataDir> is set to a relative path, this will not work as
6829 expected. Default is B<true>.
6831 =item B<CreateFilesAsync> B<false>|B<true>
6833 When enabled, new RRD files are enabled asynchronously, using a separate thread
6834 that runs in the background. This prevents writes to block, which is a problem
6835 especially when many hundreds of files need to be created at once. However,
6836 since the purpose of creating the files asynchronously is I<not> to block until
6837 the file is available, values before the file is available will be discarded.
6838 When disabled (the default) files are created synchronously, blocking for a
6839 short while, while the file is being written.
6841 =item B<StepSize> I<Seconds>
6843 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6844 this setting is unset and the stepsize is set to the interval in which the data
6845 is collected. Do not use this option unless you absolutely have to for some
6846 reason. Setting this option may cause problems with the C<snmp plugin>, the
6847 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6849 =item B<HeartBeat> I<Seconds>
6851 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6852 in which case the heartbeat is set to twice the B<StepSize> which should equal
6853 the interval in which data is collected. Do not set this option unless you have
6854 a very good reason to do so.
6856 =item B<RRARows> I<NumRows>
6858 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6859 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6860 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6861 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6862 week, one month, and one year.
6864 So for each timespan, it calculates how many PDPs need to be consolidated into
6865 one CDP by calculating:
6866 number of PDPs = timespan / (stepsize * rrarows)
6868 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6871 =item B<RRATimespan> I<Seconds>
6873 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6874 more then one RRA. If this option is never used, the built-in default of (3600,
6875 86400, 604800, 2678400, 31622400) is used.
6877 For more information on how RRA-sizes are calculated see B<RRARows> above.
6879 =item B<XFF> I<Factor>
6881 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6882 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6885 =item B<CollectStatistics> B<false>|B<true>
6887 When set to B<true>, various statistics about the I<rrdcached> daemon will be
6888 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
6890 Statistics are read via I<rrdcached>s socket using the STATS command.
6891 See L<rrdcached(1)> for details.
6895 =head2 Plugin C<rrdtool>
6897 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
6898 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
6899 using these settings. If you don't want to dive into the depths of RRDtool, you
6900 can safely ignore these settings.
6904 =item B<DataDir> I<Directory>
6906 Set the directory to store RRD files under. By default RRD files are generated
6907 beneath the daemon's working directory, i.e. the B<BaseDir>.
6909 =item B<CreateFilesAsync> B<false>|B<true>
6911 When enabled, new RRD files are enabled asynchronously, using a separate thread
6912 that runs in the background. This prevents writes to block, which is a problem
6913 especially when many hundreds of files need to be created at once. However,
6914 since the purpose of creating the files asynchronously is I<not> to block until
6915 the file is available, values before the file is available will be discarded.
6916 When disabled (the default) files are created synchronously, blocking for a
6917 short while, while the file is being written.
6919 =item B<StepSize> I<Seconds>
6921 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6922 this setting is unset and the stepsize is set to the interval in which the data
6923 is collected. Do not use this option unless you absolutely have to for some
6924 reason. Setting this option may cause problems with the C<snmp plugin>, the
6925 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6927 =item B<HeartBeat> I<Seconds>
6929 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6930 in which case the heartbeat is set to twice the B<StepSize> which should equal
6931 the interval in which data is collected. Do not set this option unless you have
6932 a very good reason to do so.
6934 =item B<RRARows> I<NumRows>
6936 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6937 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6938 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6939 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6940 week, one month, and one year.
6942 So for each timespan, it calculates how many PDPs need to be consolidated into
6943 one CDP by calculating:
6944 number of PDPs = timespan / (stepsize * rrarows)
6946 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6949 =item B<RRATimespan> I<Seconds>
6951 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6952 more then one RRA. If this option is never used, the built-in default of (3600,
6953 86400, 604800, 2678400, 31622400) is used.
6955 For more information on how RRA-sizes are calculated see B<RRARows> above.
6957 =item B<XFF> I<Factor>
6959 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6960 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6963 =item B<CacheFlush> I<Seconds>
6965 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
6966 it writes all values for a certain RRD-file if the oldest value is older than
6967 (or equal to) the number of seconds specified. If some RRD-file is not updated
6968 anymore for some reason (the computer was shut down, the network is broken,
6969 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
6970 entire cache is searched for entries older than B<CacheTimeout> seconds and
6971 written to disk every I<Seconds> seconds. Since this is kind of expensive and
6972 does nothing under normal circumstances, this value should not be too small.
6973 900 seconds might be a good value, though setting this to 7200 seconds doesn't
6974 normally do much harm either.
6976 =item B<CacheTimeout> I<Seconds>
6978 If this option is set to a value greater than zero, the C<rrdtool plugin> will
6979 save values in a cache, as described above. Writing multiple values at once
6980 reduces IO-operations and thus lessens the load produced by updating the files.
6981 The trade off is that the graphs kind of "drag behind" and that more memory is
6984 =item B<WritesPerSecond> I<Updates>
6986 When collecting many statistics with collectd and the C<rrdtool> plugin, you
6987 will run serious performance problems. The B<CacheFlush> setting and the
6988 internal update queue assert that collectd continues to work just fine even
6989 under heavy load, but the system may become very unresponsive and slow. This is
6990 a problem especially if you create graphs from the RRD files on the same
6991 machine, for example using the C<graph.cgi> script included in the
6992 C<contrib/collection3/> directory.
6994 This setting is designed for very large setups. Setting this option to a value
6995 between 25 and 80 updates per second, depending on your hardware, will leave
6996 the server responsive enough to draw graphs even while all the cached values
6997 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
6998 by the B<FLUSH> command, are B<not> effected by this limit. They are still
6999 written as fast as possible, so that web frontends have up to date data when
7002 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7003 updates per second, writing all values to disk will take approximately
7004 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7005 "collection3" you'll end up with a responsive and fast system, up to date
7006 graphs and basically a "backup" of your values every hour.
7008 =item B<RandomTimeout> I<Seconds>
7010 When set, the actual timeout for each value is chosen randomly between
7011 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7012 intention is to avoid high load situations that appear when many values timeout
7013 at the same time. This is especially a problem shortly after the daemon starts,
7014 because all values were added to the internal cache at roughly the same time.
7018 =head2 Plugin C<sensors>
7020 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7021 that all the needed modules have to be loaded and lm_sensors has to be
7022 configured (most likely by editing F</etc/sensors.conf>. Read
7023 L<sensors.conf(5)> for details.
7025 The B<lm_sensors> homepage can be found at
7026 L<http://secure.netroedge.com/~lm78/>.
7030 =item B<SensorConfigFile> I<File>
7032 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7033 the library's default will be used.
7035 =item B<Sensor> I<chip-bus-address/type-feature>
7037 Selects the name of the sensor which you want to collect or ignore, depending
7038 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7039 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7040 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7042 See F</"IGNORELISTS"> for details.
7044 =item B<IgnoreSelected> I<true>|I<false>
7046 If no configuration if given, the B<sensors>-plugin will collect data from all
7047 sensors. This may not be practical, especially for uninteresting sensors.
7048 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7049 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7050 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7051 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7052 and all other sensors are collected.
7054 =item B<UseLabels> I<true>|I<false>
7056 Configures how sensor readings are reported. When set to I<true>, sensor
7057 readings are reported using their descriptive label (e.g. "VCore"). When set to
7058 I<false> (the default) the sensor name is used ("in0").
7062 =head2 Plugin C<sigrok>
7064 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7065 supported by the L<sigrok|http://sigrok.org/> project.
7071 <Device "AC Voltage">
7076 <Device "Sound Level">
7077 Driver "cem-dt-885x"
7084 =item B<LogLevel> B<0-5>
7086 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7087 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7088 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7089 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7090 their level, are always submitted to I<collectd> at its INFO log level.
7092 =item E<lt>B<Device> I<Name>E<gt>
7094 A sigrok-supported device, uniquely identified by this section's options. The
7095 I<Name> is passed to I<collectd> as the I<plugin instance>.
7097 =item B<Driver> I<DriverName>
7099 The sigrok driver to use for this device.
7101 =item B<Conn> I<ConnectionSpec>
7103 If the device cannot be auto-discovered, or more than one might be discovered
7104 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7105 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7106 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7107 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7108 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7110 =item B<SerialComm> I<SerialSpec>
7112 For serial devices with non-standard port settings, this option can be used
7113 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7114 This should not be necessary; drivers know how to communicate with devices they
7117 =item B<MinimumInterval> I<Seconds>
7119 Specifies the minimum time between measurement dispatches to I<collectd>, in
7120 seconds. Since some I<sigrok> supported devices can acquire measurements many
7121 times per second, it may be necessary to throttle these. For example, the
7122 I<RRD plugin> cannot process writes more than once per second.
7124 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7125 device are always dispatched to I<collectd>. When throttled, unused
7126 measurements are discarded.
7130 =head2 Plugin C<smart>
7132 The C<smart> plugin collects SMART information from physical
7133 disks. Values collectd include temperature, power cycle count, poweron
7134 time and bad sectors. Also, all SMART attributes are collected along
7135 with the normalized current value, the worst value, the threshold and
7136 a human readable value.
7138 Using the following two options you can ignore some disks or configure the
7139 collection only of specific disks.
7143 =item B<Disk> I<Name>
7145 Select the disk I<Name>. Whether it is collected or ignored depends on the
7146 B<IgnoreSelected> setting, see below. As with other plugins that use the
7147 daemon's ignorelist functionality, a string that starts and ends with a slash
7148 is interpreted as a regular expression. Examples:
7153 See F</"IGNORELISTS"> for details.
7155 =item B<IgnoreSelected> B<true>|B<false>
7157 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7158 statements, are ignored or if all other disks are ignored. The behavior
7159 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7160 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7161 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7162 is set to B<true>, all disks are collected B<except> the ones matched.
7164 =item B<IgnoreSleepMode> B<true>|B<false>
7166 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7167 This option disables the sleep mode check and allows the plugin to collect data
7168 from these disks anyway. This is useful in cases where libatasmart mistakenly
7169 reports disks as asleep because it has not been updated to incorporate support
7170 for newer idle states in the ATA spec.
7172 =item B<UseSerial> B<true>|B<false>
7174 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7175 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7176 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7177 storing data. This ensures that the data for a given disk will be kept together
7178 even if the kernel name changes.
7182 =head2 Plugin C<snmp>
7184 Since the configuration of the C<snmp plugin> is a little more complicated than
7185 other plugins, its documentation has been moved to an own manpage,
7186 L<collectd-snmp(5)>. Please see there for details.
7188 =head2 Plugin C<snmp_agent>
7190 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7191 from SNMP master agent and returns the data collected by read plugins.
7192 The I<snmp_agent> plugin handles requests only for OIDs specified in
7193 configuration file. To handle SNMP queries the plugin gets data from collectd
7194 and translates requested values from collectd's internal format to SNMP format.
7195 This plugin is a generic plugin and cannot work without configuration.
7196 For more details on AgentX subagent see
7197 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7202 <Data "memAvailReal">
7206 OIDs "1.3.6.1.4.1.2021.4.6.0"
7209 IndexOID "IF-MIB::ifIndex"
7210 SizeOID "IF-MIB::ifNumber"
7214 OIDs "IF-MIB::ifDescr"
7220 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7225 There are two types of blocks that can be contained in the
7226 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7228 =head3 The B<Data> block
7230 The B<Data> block defines a list OIDs that are to be handled. This block can
7231 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7232 block it reperesents table OIDs.
7233 The following options can be set:
7237 =item B<Instance> I<true|false>
7239 When B<Instance> is set to B<true>, the value for requested OID is copied from
7240 plugin instance field of corresponding collectd value. If B<Data> block defines
7241 scalar data type B<Instance> has no effect and can be omitted.
7243 =item B<Plugin> I<String>
7245 Read plugin name whose collected data will be mapped to specified OIDs.
7247 =item B<Type> I<String>
7249 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7250 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7252 =item B<TypeInstance> I<String>
7254 Collectd's type-instance that is to be used for specified OID.
7256 =item B<OIDs> I<OID> [I<OID> ...]
7258 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7259 are taken from collectd data type specified by B<Plugin>, B<Type>,
7260 B<TypeInstance> fields of this B<Data> block. Number of the OIDs configured
7261 should correspond to number of values in specified B<Type>.
7262 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7263 "rx" and "tx" values of "if_octets" type.
7265 =item B<Scale> I<Value>
7267 The values taken from collectd are multiplied by I<Value>. The field is optional
7268 and the default is B<1.0>.
7270 =item B<Shift> I<Value>
7272 I<Value> is added to values from collectd after they have been multiplied by
7273 B<Scale> value. The field is optional and the default value is B<0.0>.
7277 =head3 The B<Table> block
7279 The B<Table> block defines a collection of B<Data> blocks that belong to one
7280 snmp table. In addition to multiple B<Data> blocks the following options can be
7285 =item B<IndexOID> I<OID>
7287 OID that is handled by the plugin and is mapped to numerical index value that is
7288 generated by the plugin for each table record.
7290 =item B<SizeOID> I<OID>
7292 OID that is handled by the plugin. Returned value is the number of records in
7293 the table. The field is optional.
7297 =head2 Plugin C<statsd>
7299 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7300 protocol and dispatches rates or other aggregates of these numbers
7303 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7304 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7305 C<objects> respectively.
7307 The following configuration options are valid:
7311 =item B<Host> I<Host>
7313 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7314 "any" address, i.e. accept packets sent to any of the hosts addresses.
7316 =item B<Port> I<Port>
7318 UDP port to listen to. This can be either a service name or a port number.
7319 Defaults to C<8125>.
7321 =item B<DeleteCounters> B<false>|B<true>
7323 =item B<DeleteTimers> B<false>|B<true>
7325 =item B<DeleteGauges> B<false>|B<true>
7327 =item B<DeleteSets> B<false>|B<true>
7329 These options control what happens if metrics are not updated in an interval.
7330 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7331 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7332 are unchanged. If set to B<True>, the such metrics are not dispatched and
7333 removed from the internal cache.
7335 =item B<CounterSum> B<false>|B<true>
7337 When enabled, creates a C<count> metric which reports the change since the last
7338 read. This option primarily exists for compatibility with the I<statsd>
7339 implementation by Etsy.
7341 =item B<TimerPercentile> I<Percent>
7343 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7344 that I<Percent> of all reported timers are smaller than or equal to the
7345 computed latency. This is useful for cutting off the long tail latency, as it's
7346 often done in I<Service Level Agreements> (SLAs).
7348 Different percentiles can be calculated by setting this option several times.
7349 If none are specified, no percentiles are calculated / dispatched.
7351 =item B<TimerLower> B<false>|B<true>
7353 =item B<TimerUpper> B<false>|B<true>
7355 =item B<TimerSum> B<false>|B<true>
7357 =item B<TimerCount> B<false>|B<true>
7359 Calculate and dispatch various values out of I<Timer> metrics received during
7360 an interval. If set to B<False>, the default, these values aren't calculated /
7365 =head2 Plugin C<swap>
7367 The I<Swap plugin> collects information about used and available swap space. On
7368 I<Linux> and I<Solaris>, the following options are available:
7372 =item B<ReportByDevice> B<false>|B<true>
7374 Configures how to report physical swap devices. If set to B<false> (the
7375 default), the summary over all swap devices is reported only, i.e. the globally
7376 used and available space over all devices. If B<true> is configured, the used
7377 and available space of each device will be reported separately.
7379 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7380 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7382 =item B<ReportBytes> B<false>|B<true>
7384 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7385 I<swap I/O> is reported in pages. This option is available under Linux only.
7387 =item B<ValuesAbsolute> B<true>|B<false>
7389 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7390 available and used. Defaults to B<true>.
7392 =item B<ValuesPercentage> B<false>|B<true>
7394 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7395 available and free. Defaults to B<false>.
7397 This is useful for deploying I<collectd> in a heterogeneous environment, where
7398 swap sizes differ and you want to specify generic thresholds or similar.
7402 =head2 Plugin C<syslog>
7406 =item B<LogLevel> B<debug|info|notice|warning|err>
7408 Sets the log-level. If, for example, set to B<notice>, then all events with
7409 severity B<notice>, B<warning>, or B<err> will be submitted to the
7412 Please note that B<debug> is only available if collectd has been compiled with
7415 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7417 Controls which notifications should be sent to syslog. The default behaviour is
7418 not to send any. Less severe notifications always imply logging more severe
7419 notifications: Setting this to B<OKAY> means all notifications will be sent to
7420 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7421 notifications but will dismiss B<OKAY> notifications. Setting this option to
7422 B<FAILURE> will only send failures to syslog.
7426 =head2 Plugin C<table>
7428 The C<table plugin> provides generic means to parse tabular data and dispatch
7429 user specified values. Values are selected based on column numbers. For
7430 example, this plugin may be used to get values from the Linux L<proc(5)>
7431 filesystem or CSV (comma separated values) files.
7434 <Table "/proc/slabinfo">
7439 InstancePrefix "active_objs"
7445 InstancePrefix "objperslab"
7452 The configuration consists of one or more B<Table> blocks, each of which
7453 configures one file to parse. Within each B<Table> block, there are one or
7454 more B<Result> blocks, which configure which data to select and how to
7457 The following options are available inside a B<Table> block:
7461 =item B<Instance> I<instance>
7463 If specified, I<instance> is used as the plugin instance. So, in the above
7464 example, the plugin name C<table-slabinfo> would be used. If omitted, the
7465 filename of the table is used instead, with all special characters replaced
7466 with an underscore (C<_>).
7468 =item B<Separator> I<string>
7470 Any character of I<string> is interpreted as a delimiter between the different
7471 columns of the table. A sequence of two or more contiguous delimiters in the
7472 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7473 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7474 of a table - see its documentation for more details. This option is mandatory.
7476 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7477 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7478 required because of collectd's config parsing.
7482 The following options are available inside a B<Result> block:
7486 =item B<Type> I<type>
7488 Sets the type used to dispatch the values to the daemon. Detailed information
7489 about types and their configuration can be found in L<types.db(5)>. This
7490 option is mandatory.
7492 =item B<InstancePrefix> I<prefix>
7494 If specified, prepend I<prefix> to the type instance. If omitted, only the
7495 B<InstancesFrom> option is considered for the type instance.
7497 =item B<InstancesFrom> I<column0> [I<column1> ...]
7499 If specified, the content of the given columns (identified by the column
7500 number starting at zero) will be used to create the type instance for each
7501 row. Multiple values (and the instance prefix) will be joined together with
7502 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7503 option is considered for the type instance.
7505 The plugin itself does not check whether or not all built instances are
7506 different. It’s your responsibility to assure that each is unique. This is
7507 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7508 sure that the table only contains one row.
7510 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7513 =item B<ValuesFrom> I<column0> [I<column1> ...]
7515 Specifies the columns (identified by the column numbers starting at zero)
7516 whose content is used as the actual data for the data sets that are dispatched
7517 to the daemon. How many such columns you need is determined by the B<Type>
7518 setting above. If you specify too many or not enough columns, the plugin will
7519 complain about that and no data will be submitted to the daemon. The plugin
7520 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7521 respectively, so anything supported by those functions is supported by the
7522 plugin as well. This option is mandatory.
7526 =head2 Plugin C<tail>
7528 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7529 each line and dispatches found values. What is matched can be configured by the
7530 user using (extended) regular expressions, as described in L<regex(7)>.
7533 <File "/var/log/exim4/mainlog">
7538 Regex "S=([1-9][0-9]*)"
7544 Regex "\\<R=local_user\\>"
7545 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7548 Instance "local_user"
7551 Regex "l=([0-9]*\\.[0-9]*)"
7552 <DSType "Distribution">
7562 The config consists of one or more B<File> blocks, each of which configures one
7563 logfile to parse. Within each B<File> block, there are one or more B<Match>
7564 blocks, which configure a regular expression to search for.
7566 The B<PluginName> and B<Instance> options in the B<File> block may be used to set
7567 the plugin name and instance respectively. So in the above example the plugin name
7568 C<mail-exim> would be used.
7570 These options are applied for all B<Match> blocks that B<follow> it, until the
7571 next B<PluginName> or B<Instance> option. This way you can extract several plugin
7572 instances from one logfile, handy when parsing syslog and the like.
7574 The B<Interval> option allows you to define the length of time between reads. If
7575 this is not set, the default Interval will be used.
7577 Each B<Match> block has the following options to describe how the match should
7582 =item B<Regex> I<regex>
7584 Sets the regular expression to use for matching against a line. The first
7585 subexpression has to match something that can be turned into a number by
7586 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7587 below. Because B<extended> regular expressions are used, you do not need to use
7588 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7589 collectd's config parsing you need to escape backslashes, though. So if you
7590 want to match literal parentheses you need to do the following:
7592 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7594 =item B<ExcludeRegex> I<regex>
7596 Sets an optional regular expression to use for excluding lines from the match.
7597 An example which excludes all connections from localhost from the match:
7599 ExcludeRegex "127\\.0\\.0\\.1"
7601 =item B<DSType> I<Type>
7603 Sets how the values are cumulated. I<Type> is one of:
7607 =item B<GaugeAverage>
7609 Calculate the average.
7613 Use the smallest number only.
7617 Use the greatest number only.
7621 Use the last number found.
7623 =item B<GaugePersist>
7625 Use the last number found. The number is not reset at the end of an interval.
7626 It is continously reported until another number is matched. This is intended
7627 for cases in which only state changes are reported, for example a thermometer
7628 that only reports the temperature when it changes.
7634 =item B<AbsoluteSet>
7636 The matched number is a counter. Simply I<sets> the internal counter to this
7637 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
7645 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
7646 matched number may be negative, which will effectively subtract from the
7655 Increase the internal counter by one. These B<DSType> are the only ones that do
7656 not use the matched subexpression, but simply count the number of matched
7657 lines. Thus, you may use a regular expression without submatch in this case.
7659 =item B<Distribution>
7661 Type to do calculations based on the distribution of values, primarily
7662 calculating percentiles. This is primarily geared towards latency, but can be
7663 used for other metrics as well. The range of values tracked with this setting
7664 must be in the range (0–2^34) and can be fractional. Please note that neither
7665 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
7668 This option must be used together with the B<Percentile> and/or B<Bucket>
7673 <DSType "Distribution">
7680 =item B<Percentile> I<Percent>
7682 Calculate and dispatch the configured percentile, i.e. compute the value, so
7683 that I<Percent> of all matched values are smaller than or equal to the computed
7686 Metrics are reported with the I<type> B<Type> (the value of the above option)
7687 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
7689 This option may be repeated to calculate more than one percentile.
7691 =item B<Bucket> I<lower_bound> I<upper_bound>
7693 Export the number of values (a C<DERIVE>) falling within the given range. Both,
7694 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
7695 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
7696 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
7697 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
7700 To export the entire (0–inf) range without overlap, use the upper bound of the
7701 previous range as the lower bound of the following range. In other words, use
7702 the following schema:
7712 Metrics are reported with the I<type> C<bucket> and the I<type instance>
7713 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
7715 This option may be repeated to calculate more than one rate.
7721 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
7722 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
7723 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
7724 B<Derive*> types interpret the submatch as a signed integer using
7725 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
7726 and it may be omitted in this case.
7728 =item B<Type> I<Type>
7730 Sets the type used to dispatch this value. Detailed information about types and
7731 their configuration can be found in L<types.db(5)>.
7733 =item B<Instance> I<TypeInstance>
7735 This optional setting sets the type instance to use.
7739 =head2 Plugin C<tail_csv>
7741 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
7742 written by I<Snort>.
7747 <Metric "snort-dropped">
7752 <File "/var/log/snort/snort.stats">
7753 PluginName "snortstats"
7756 Collect "snort-dropped"
7760 The configuration consists of one or more B<Metric> blocks that define an index
7761 into the line of the CSV file and how this value is mapped to I<collectd's>
7762 internal representation. These are followed by one or more B<Instance> blocks
7763 which configure which file to read, in which interval and which metrics to
7768 =item E<lt>B<Metric> I<Name>E<gt>
7770 The B<Metric> block configures a new metric to be extracted from the statistics
7771 file and how it is mapped on I<collectd's> data model. The string I<Name> is
7772 only used inside the B<Instance> blocks to refer to this block, so you can use
7773 one B<Metric> block for multiple CSV files.
7777 =item B<Type> I<Type>
7779 Configures which I<Type> to use when dispatching this metric. Types are defined
7780 in the L<types.db(5)> file, see the appropriate manual page for more
7781 information on specifying types. Only types with a single I<data source> are
7782 supported by the I<tail_csv plugin>. The information whether the value is an
7783 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
7784 I<Type's> definition.
7786 =item B<Instance> I<TypeInstance>
7788 If set, I<TypeInstance> is used to populate the type instance field of the
7789 created value lists. Otherwise, no type instance is used.
7791 =item B<ValueFrom> I<Index>
7793 Configure to read the value from the field with the zero-based index I<Index>.
7794 If the value is parsed as signed integer, unsigned integer or double depends on
7795 the B<Type> setting, see above.
7799 =item E<lt>B<File> I<Path>E<gt>
7801 Each B<File> block represents one CSV file to read. There must be at least one
7802 I<File> block but there can be multiple if you have multiple CSV files.
7806 =item B<PluginName> I<PluginName>
7808 Use I<PluginName> as the plugin name when submitting values.
7809 Defaults to 'tail_csv'.
7811 =item B<Instance> I<PluginInstance>
7813 Sets the I<plugin instance> used when dispatching the values.
7815 =item B<Collect> I<Metric>
7817 Specifies which I<Metric> to collect. This option must be specified at least
7818 once, and you can use this option multiple times to specify more than one
7819 metric to be extracted from this statistic file.
7821 =item B<Interval> I<Seconds>
7823 Configures the interval in which to read values from this instance / file.
7824 Defaults to the plugin's default interval.
7826 =item B<TimeFrom> I<Index>
7828 Rather than using the local time when dispatching a value, read the timestamp
7829 from the field with the zero-based index I<Index>. The value is interpreted as
7830 seconds since epoch. The value is parsed as a double and may be factional.
7836 =head2 Plugin C<teamspeak2>
7838 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
7839 polls interesting global and virtual server data. The plugin can query only one
7840 physical server but unlimited virtual servers. You can use the following
7841 options to configure it:
7845 =item B<Host> I<hostname/ip>
7847 The hostname or ip which identifies the physical server.
7850 =item B<Port> I<port>
7852 The query port of the physical server. This needs to be a string.
7855 =item B<Server> I<port>
7857 This option has to be added once for every virtual server the plugin should
7858 query. If you want to query the virtual server on port 8767 this is what the
7859 option would look like:
7863 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
7864 use quotes around it! If no such statement is given only global information
7869 =head2 Plugin C<ted>
7871 The I<TED> plugin connects to a device of "The Energy Detective", a device to
7872 measure power consumption. These devices are usually connected to a serial
7873 (RS232) or USB port. The plugin opens a configured device and tries to read the
7874 current energy readings. For more information on TED, visit
7875 L<http://www.theenergydetective.com/>.
7877 Available configuration options:
7881 =item B<Device> I<Path>
7883 Path to the device on which TED is connected. collectd will need read and write
7884 permissions on that file.
7886 Default: B</dev/ttyUSB0>
7888 =item B<Retries> I<Num>
7890 Apparently reading from TED is not that reliable. You can therefore configure a
7891 number of retries here. You only configure the I<retries> here, to if you
7892 specify zero, one reading will be performed (but no retries if that fails); if
7893 you specify three, a maximum of four readings are performed. Negative values
7900 =head2 Plugin C<tcpconns>
7902 The C<tcpconns plugin> counts the number of currently established TCP
7903 connections based on the local port and/or the remote port. Since there may be
7904 a lot of connections the default if to count all connections with a local port,
7905 for which a listening socket is opened. You can use the following options to
7906 fine-tune the ports you are interested in:
7910 =item B<ListeningPorts> I<true>|I<false>
7912 If this option is set to I<true>, statistics for all local ports for which a
7913 listening socket exists are collected. The default depends on B<LocalPort> and
7914 B<RemotePort> (see below): If no port at all is specifically selected, the
7915 default is to collect listening ports. If specific ports (no matter if local or
7916 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
7917 the selected ports will be collected unless this option is set to I<true>
7920 =item B<LocalPort> I<Port>
7922 Count the connections to a specific local port. This can be used to see how
7923 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
7924 You have to specify the port in numeric form, so for the mailserver example
7925 you'd need to set B<25>.
7927 =item B<RemotePort> I<Port>
7929 Count the connections to a specific remote port. This is useful to see how
7930 much a remote service is used. This is most useful if you want to know how many
7931 connections a local service has opened to remote services, e.E<nbsp>g. how many
7932 connections a mail server or news server has to other mail or news servers, or
7933 how many connections a web proxy holds to web servers. You have to give the
7934 port in numeric form.
7936 =item B<AllPortsSummary> I<true>|I<false>
7938 If this option is set to I<true> a summary of statistics from all connections
7939 are collected. This option defaults to I<false>.
7943 =head2 Plugin C<thermal>
7947 =item B<ForceUseProcfs> I<true>|I<false>
7949 By default, the I<Thermal plugin> tries to read the statistics from the Linux
7950 C<sysfs> interface. If that is not available, the plugin falls back to the
7951 C<procfs> interface. By setting this option to I<true>, you can force the
7952 plugin to use the latter. This option defaults to I<false>.
7954 =item B<Device> I<Device>
7956 Selects the name of the thermal device that you want to collect or ignore,
7957 depending on the value of the B<IgnoreSelected> option. This option may be
7958 used multiple times to specify a list of devices.
7960 See F</"IGNORELISTS"> for details.
7962 =item B<IgnoreSelected> I<true>|I<false>
7964 Invert the selection: If set to true, all devices B<except> the ones that
7965 match the device names specified by the B<Device> option are collected. By
7966 default only selected devices are collected if a selection is made. If no
7967 selection is configured at all, B<all> devices are selected.
7971 =head2 Plugin C<threshold>
7973 The I<Threshold plugin> checks values collected or received by I<collectd>
7974 against a configurable I<threshold> and issues I<notifications> if values are
7977 Documentation for this plugin is available in the L<collectd-threshold(5)>
7980 =head2 Plugin C<tokyotyrant>
7982 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
7983 couple metrics: number of records, and database size on disk.
7987 =item B<Host> I<Hostname/IP>
7989 The hostname or IP which identifies the server.
7990 Default: B<127.0.0.1>
7992 =item B<Port> I<Service/Port>
7994 The query port of the server. This needs to be a string, even if the port is
7995 given in its numeric form.
8000 =head2 Plugin C<turbostat>
8002 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8003 Intel processors by using I<Model Specific Registers>.
8007 =item B<CoreCstates> I<Bitmask(Integer)>
8009 Bit mask of the list of core C-states supported by the processor.
8010 This option should only be used if the automated detection fails.
8011 Default value extracted from the CPU model and family.
8013 Currently supported C-states (by this plugin): 3, 6, 7
8017 All states (3, 6 and 7):
8018 (1<<3) + (1<<6) + (1<<7) = 392
8020 =item B<PackageCstates> I<Bitmask(Integer)>
8022 Bit mask of the list of packages C-states supported by the processor. This
8023 option should only be used if the automated detection fails. Default value
8024 extracted from the CPU model and family.
8026 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8030 States 2, 3, 6 and 7:
8031 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8033 =item B<SystemManagementInterrupt> I<true>|I<false>
8035 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8036 This option should only be used if the automated detection fails or if you want
8037 to disable this feature.
8039 =item B<DigitalTemperatureSensor> I<true>|I<false>
8041 Boolean enabling the collection of the temperature of each core. This option
8042 should only be used if the automated detection fails or if you want to disable
8045 =item B<TCCActivationTemp> I<Temperature>
8047 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8048 temperature is used when collecting the temperature of cores or packages. This
8049 option should only be used if the automated detection fails. Default value
8050 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8052 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8054 Bit mask of the list of elements to be thermally monitored. This option should
8055 only be used if the automated detection fails or if you want to disable some
8056 collections. The different bits of this bit mask accepted by this plugin are:
8060 =item 0 ('1'): Package
8064 =item 2 ('4'): Cores
8066 =item 3 ('8'): Embedded graphic device
8070 =item B<LogicalCoreNames> I<true>|I<false>
8072 Boolean enabling the use of logical core numbering for per core statistics.
8073 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8074 sequential number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8075 where I<n> is the n-th core of the socket, causing name conflicts when there is
8076 more than one socket.
8080 =head2 Plugin C<unixsock>
8084 =item B<SocketFile> I<Path>
8086 Sets the socket-file which is to be created.
8088 =item B<SocketGroup> I<Group>
8090 If running as root change the group of the UNIX-socket after it has been
8091 created. Defaults to B<collectd>.
8093 =item B<SocketPerms> I<Permissions>
8095 Change the file permissions of the UNIX-socket after it has been created. The
8096 permissions must be given as a numeric, octal value as you would pass to
8097 L<chmod(1)>. Defaults to B<0770>.
8099 =item B<DeleteSocket> B<false>|B<true>
8101 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8102 with the given name already exists. If I<collectd> crashes a socket file may be
8103 left over, preventing the daemon from opening a new socket when restarted.
8104 Since this is potentially dangerous, this defaults to B<false>.
8108 =head2 Plugin C<uuid>
8110 This plugin, if loaded, causes the Hostname to be taken from the machine's
8111 UUID. The UUID is a universally unique designation for the machine, usually
8112 taken from the machine's BIOS. This is most useful if the machine is running in
8113 a virtual environment such as Xen, in which case the UUID is preserved across
8114 shutdowns and migration.
8116 The following methods are used to find the machine's UUID, in order:
8122 Check I</etc/uuid> (or I<UUIDFile>).
8126 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8131 Check for UUID from C<dmidecode> / SMBIOS.
8135 Check for UUID from Xen hypervisor.
8139 If no UUID can be found then the hostname is not modified.
8143 =item B<UUIDFile> I<Path>
8145 Take the UUID from the given file (default I</etc/uuid>).
8149 =head2 Plugin C<varnish>
8151 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8152 It collects a subset of the values displayed by L<varnishstat(1)>, and
8153 organizes them in categories which can be enabled or disabled. Currently only
8154 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8155 meaning of each metric can be found in L<varnish-counters(7)>.
8160 <Instance "example">
8164 CollectConnections true
8165 CollectDirectorDNS false
8169 CollectObjects false
8171 CollectSession false
8181 CollectWorkers false
8185 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8186 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8187 will collectd statistics from the default "varnishd" instance (this should work
8188 fine in most cases).
8190 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8194 =item B<CollectBackend> B<true>|B<false>
8196 Back-end connection statistics, such as successful, reused,
8197 and closed connections. True by default.
8199 =item B<CollectBan> B<true>|B<false>
8201 Statistics about ban operations, such as number of bans added, retired, and
8202 number of objects tested against ban operations. Only available with Varnish
8203 3.x and above. False by default.
8205 =item B<CollectCache> B<true>|B<false>
8207 Cache hits and misses. True by default.
8209 =item B<CollectConnections> B<true>|B<false>
8211 Number of client connections received, accepted and dropped. True by default.
8213 =item B<CollectDirectorDNS> B<true>|B<false>
8215 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8218 =item B<CollectESI> B<true>|B<false>
8220 Edge Side Includes (ESI) parse statistics. False by default.
8222 =item B<CollectFetch> B<true>|B<false>
8224 Statistics about fetches (HTTP requests sent to the backend). False by default.
8226 =item B<CollectHCB> B<true>|B<false>
8228 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8229 divided into locked and unlocked look-ups. False by default.
8231 =item B<CollectObjects> B<true>|B<false>
8233 Statistics on cached objects: number of objects expired, nuked (prematurely
8234 expired), saved, moved, etc. False by default.
8236 =item B<CollectPurge> B<true>|B<false>
8238 Statistics about purge operations, such as number of purges added, retired, and
8239 number of objects tested against purge operations. Only available with Varnish
8240 2.x. False by default.
8242 =item B<CollectSession> B<true>|B<false>
8244 Client session statistics. Number of past and current sessions, session herd and
8245 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8246 metrics found in the Connections and Threads sections with previous versions of
8247 Varnish have been moved here.
8249 =item B<CollectSHM> B<true>|B<false>
8251 Statistics about the shared memory log, a memory region to store
8252 log messages which is flushed to disk when full. True by default.
8254 =item B<CollectSMA> B<true>|B<false>
8256 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8257 component is Solaris specific. Only available with Varnish 2.x. False by
8260 =item B<CollectSMS> B<true>|B<false>
8262 synth (synthetic content) storage statistics. This storage
8263 component is used internally only. False by default.
8265 =item B<CollectSM> B<true>|B<false>
8267 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
8270 =item B<CollectStruct> B<true>|B<false>
8272 Current varnish internal state statistics. Number of current sessions, objects
8273 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8276 =item B<CollectTotals> B<true>|B<false>
8278 Collects overview counters, such as the number of sessions created,
8279 the number of requests and bytes transferred. False by default.
8281 =item B<CollectUptime> B<true>|B<false>
8283 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8285 =item B<CollectVCL> B<true>|B<false>
8287 Number of total (available + discarded) VCL (config files). False by default.
8289 =item B<CollectVSM> B<true>|B<false>
8291 Collect statistics about Varnish's shared memory usage (used by the logging and
8292 statistics subsystems). Only available with Varnish 4.x. False by default.
8294 =item B<CollectWorkers> B<true>|B<false>
8296 Collect statistics about worker threads. False by default.
8300 =head2 Plugin C<virt>
8302 This plugin allows CPU, disk, network load and other metrics to be collected for
8303 virtualized guests on the machine. The statistics are collected through libvirt
8304 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8305 installing any additional software on guests, especially I<collectd>, which runs
8306 only on the host system.
8308 Only I<Connection> is required.
8312 =item B<Connection> I<uri>
8314 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8316 Connection "xen:///"
8318 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8320 =item B<RefreshInterval> I<seconds>
8322 Refresh the list of domains and devices every I<seconds>. The default is 60
8323 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8324 the list of domains and devices to be refreshed on every iteration.
8326 Refreshing the devices in particular is quite a costly operation, so if your
8327 virtualization setup is static you might consider increasing this. If this
8328 option is set to 0, refreshing is disabled completely.
8330 =item B<Domain> I<name>
8332 =item B<BlockDevice> I<name:dev>
8334 =item B<InterfaceDevice> I<name:dev>
8336 =item B<IgnoreSelected> B<true>|B<false>
8338 Select which domains and devices are collected.
8340 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8341 disk/network devices are collected.
8343 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8344 domains and disk/network devices are ignored, while the rest are collected.
8346 The domain name and device names may use a regular expression, if the name is
8347 surrounded by I</.../> and collectd was compiled with support for regexps.
8349 The default is to collect statistics for all domains and all their devices.
8353 BlockDevice "/:hdb/"
8354 IgnoreSelected "true"
8356 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8359 =item B<BlockDeviceFormat> B<target>|B<source>
8361 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8362 seen by the guest will be used for reporting metrics.
8363 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8366 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8367 using the path of the source, e.g. an image file.
8368 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8373 If the domain XML have the following device defined:
8375 <disk type='block' device='disk'>
8376 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8377 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8378 <target dev='sda' bus='scsi'/>
8380 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8383 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8385 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8386 to C<var_lib_libvirt_images_image1.qcow2>.
8388 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8390 The B<BlockDeviceFormatBasename> controls whether the full path or the
8391 L<basename(1)> of the source is being used as the I<type instance> when
8392 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8396 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8397 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8398 be set to C<var_lib_libvirt_images_image1.qcow2>.
8399 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8400 set to C<image1.qcow2>.
8402 =item B<HostnameFormat> B<name|uuid|hostname|...>
8404 When the virt plugin logs data, it sets the hostname of the collected data
8405 according to this setting. The default is to use the guest name as provided by
8406 the hypervisor, which is equal to setting B<name>.
8408 B<uuid> means use the guest's UUID. This is useful if you want to track the
8409 same guest across migrations.
8411 B<hostname> means to use the global B<Hostname> setting, which is probably not
8412 useful on its own because all guests will appear to have the same name.
8414 You can also specify combinations of these fields. For example B<name uuid>
8415 means to concatenate the guest name and UUID (with a literal colon character
8416 between, thus I<"foo:1234-1234-1234-1234">).
8418 At the moment of writing (collectd-5.5), hostname string is limited to 62
8419 characters. In case when combination of fields exceeds 62 characters,
8420 hostname will be truncated without a warning.
8422 =item B<InterfaceFormat> B<name>|B<address>
8424 When the virt plugin logs interface data, it sets the name of the collected
8425 data according to this setting. The default is to use the path as provided by
8426 the hypervisor (the "dev" property of the target node), which is equal to
8429 B<address> means use the interface's mac address. This is useful since the
8430 interface path might change between reboots of a guest or across migrations.
8432 =item B<PluginInstanceFormat> B<name|uuid|none>
8434 When the virt plugin logs data, it sets the plugin_instance of the collected
8435 data according to this setting. The default is to not set the plugin_instance.
8437 B<name> means use the guest's name as provided by the hypervisor.
8438 B<uuid> means use the guest's UUID.
8440 You can also specify combinations of the B<name> and B<uuid> fields.
8441 For example B<name uuid> means to concatenate the guest name and UUID
8442 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8444 =item B<Instances> B<integer>
8446 How many read instances you want to use for this plugin. The default is one,
8447 and the sensible setting is a multiple of the B<ReadThreads> value.
8448 If you are not sure, just use the default setting.
8450 =item B<ExtraStats> B<string>
8452 Report additional extra statistics. The default is no extra statistics, preserving
8453 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8454 allows the plugin to reported more detailed statistics about the behaviour of
8455 Virtual Machines. The argument is a space-separated list of selectors.
8457 Currently supported selectors are:
8461 =item B<cpu_util>: report CPU utilization per domain in percentage.
8463 =item B<disk>: report extra statistics like number of flush operations and total
8464 service time for read, write and flush operations. Requires libvirt API version
8467 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8470 =item B<domain_state>: report domain state and reason in human-readable format as
8471 a notification. If libvirt API version I<0.9.2> or later is available, domain
8472 reason will be included in notification.
8474 =item B<fs_info>: report file system information as a notification. Requires
8475 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8476 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8477 version supports retrieving file system information.
8479 =item B<job_stats_background>: report statistics about progress of a background
8480 job on a domain. Only one type of job statistics can be collected at the same time.
8481 Requires libvirt API version I<1.2.9> or later.
8483 =item B<job_stats_completed>: report statistics about a recently completed job on
8484 a domain. Only one type of job statistics can be collected at the same time.
8485 Requires libvirt API version I<1.2.9> or later.
8487 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8488 Requires libvirt API version I<0.9.11> or later.
8490 =item B<perf>: report performance monitoring events. To collect performance
8491 metrics they must be enabled for domain and supported by the platform. Requires
8492 libvirt API version I<1.3.3> or later.
8493 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8495 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8501 =head2 Plugin C<vmem>
8503 The C<vmem> plugin collects information about the usage of virtual memory.
8504 Since the statistics provided by the Linux kernel are very detailed, they are
8505 collected very detailed. However, to get all the details, you have to switch
8506 them on manually. Most people just want an overview over, such as the number of
8507 pages read from swap space.
8511 =item B<Verbose> B<true>|B<false>
8513 Enables verbose collection of information. This will start collecting page
8514 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8515 Part of these statistics are collected on a "per zone" basis.
8519 =head2 Plugin C<vserver>
8521 This plugin doesn't have any options. B<VServer> support is only available for
8522 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8523 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8524 need to apply the patches and compile your own kernel, which will then provide
8525 the F</proc/virtual> filesystem that is required by this plugin.
8527 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8529 B<Note>: The traffic collected by this plugin accounts for the amount of
8530 traffic passing a socket which might be a lot less than the actual on-wire
8531 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8532 collect on-wire traffic you could, for example, use the logging facilities of
8533 iptables to feed data for the guest IPs into the iptables plugin.
8535 =head2 Plugin C<write_graphite>
8537 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8538 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8539 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8540 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8541 of at most 1428 bytes to minimize the number of network packets.
8545 <Plugin write_graphite>
8555 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8556 blocks. Inside the B<Node> blocks, the following options are recognized:
8560 =item B<Host> I<Address>
8562 Hostname or address to connect to. Defaults to C<localhost>.
8564 =item B<Port> I<Service>
8566 Service name or port number to connect to. Defaults to C<2003>.
8568 =item B<Protocol> I<String>
8570 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
8572 =item B<ReconnectInterval> I<Seconds>
8574 When set to non-zero, forces the connection to the Graphite backend to be
8575 closed and re-opend periodically. This behavior is desirable in environments
8576 where the connection to the Graphite backend is done through load balancers,
8577 for example. When set to zero, the default, the connetion is kept open for as
8580 =item B<LogSendErrors> B<false>|B<true>
8582 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
8583 If set to B<false>, it will not log the errors. This is especially useful when
8584 using Protocol UDP since many times we want to use the "fire-and-forget"
8585 approach and logging errors fills syslog with unneeded messages.
8587 =item B<Prefix> I<String>
8589 When set, I<String> is added in front of the host name. Dots and whitespace are
8590 I<not> escaped in this string (see B<EscapeCharacter> below).
8592 =item B<Postfix> I<String>
8594 When set, I<String> is appended to the host name. Dots and whitespace are
8595 I<not> escaped in this string (see B<EscapeCharacter> below).
8597 =item B<EscapeCharacter> I<Char>
8599 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
8600 in the identifier. The B<EscapeCharacter> option determines which character
8601 dots, whitespace and control characters are replaced with. Defaults to
8604 =item B<StoreRates> B<false>|B<true>
8606 If set to B<true> (the default), convert counter values to rates. If set to
8607 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
8610 =item B<SeparateInstances> B<false>|B<true>
8612 If set to B<true>, the plugin instance and type instance will be in their own
8613 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8614 default), the plugin and plugin instance (and likewise the type and type
8615 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8617 =item B<AlwaysAppendDS> B<false>|B<true>
8619 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
8620 identifier. If set to B<false> (the default), this is only done when there is
8623 =item B<PreserveSeparator> B<false>|B<true>
8625 If set to B<false> (the default) the C<.> (dot) character is replaced with
8626 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
8627 is preserved, i.e. passed through.
8629 =item B<DropDuplicateFields> B<false>|B<true>
8631 If set to B<true>, detect and remove duplicate components in Graphite metric
8632 names. For example, the metric name C<host.load.load.shortterm> will
8633 be shortened to C<host.load.shortterm>.
8637 =head2 Plugin C<write_log>
8639 The C<write_log> plugin writes metrics as INFO log messages.
8641 This plugin supports two output formats: I<Graphite> and I<JSON>.
8651 =item B<Format> I<Format>
8653 The output format to use. Can be one of C<Graphite> or C<JSON>.
8657 =head2 Plugin C<write_tsdb>
8659 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
8660 time series database. The plugin connects to a I<TSD>, a masterless, no shared
8661 state daemon that ingests metrics and stores them in HBase. The plugin uses
8662 I<TCP> over the "line based" protocol with a default port 4242. The data will
8663 be sent in blocks of at most 1428 bytes to minimize the number of network
8672 Host "tsd-1.my.domain"
8674 HostTags "status=production"
8678 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8679 blocks and global directives.
8681 Global directives are:
8685 =item B<ResolveInterval> I<seconds>
8687 =item B<ResolveJitter> I<seconds>
8689 When I<collectd> connects to a TSDB node, it will request the hostname from
8690 DNS. This can become a problem if the TSDB node is unavailable or badly
8691 configured because collectd will request DNS in order to reconnect for every
8692 metric, which can flood your DNS. So you can cache the last value for
8693 I<ResolveInterval> seconds.
8694 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8696 You can also define a jitter, a random interval to wait in addition to
8697 I<ResolveInterval>. This prevents all your collectd servers to resolve the
8698 hostname at the same time when the connection fails.
8699 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8701 B<Note:> If the DNS resolution has already been successful when the socket
8702 closes, the plugin will try to reconnect immediately with the cached
8703 information. DNS is queried only when the socket is closed for a longer than
8704 I<ResolveInterval> + I<ResolveJitter> seconds.
8708 Inside the B<Node> blocks, the following options are recognized:
8712 =item B<Host> I<Address>
8714 Hostname or address to connect to. Defaults to C<localhost>.
8716 =item B<Port> I<Service>
8718 Service name or port number to connect to. Defaults to C<4242>.
8721 =item B<HostTags> I<String>
8723 When set, I<HostTags> is added to the end of the metric. It is intended to be
8724 used for name=value pairs that the TSD will tag the metric with. Dots and
8725 whitespace are I<not> escaped in this string.
8727 =item B<StoreRates> B<false>|B<true>
8729 If set to B<true>, convert counter values to rates. If set to B<false>
8730 (the default) counter values are stored as is, as an increasing
8733 =item B<AlwaysAppendDS> B<false>|B<true>
8735 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
8736 identifier. If set to B<false> (the default), this is only done when there is
8741 =head2 Plugin C<write_mongodb>
8743 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
8748 <Plugin "write_mongodb">
8757 The plugin can send values to multiple instances of I<MongoDB> by specifying
8758 one B<Node> block for each instance. Within the B<Node> blocks, the following
8759 options are available:
8763 =item B<Host> I<Address>
8765 Hostname or address to connect to. Defaults to C<localhost>.
8767 =item B<Port> I<Service>
8769 Service name or port number to connect to. Defaults to C<27017>.
8771 =item B<Timeout> I<Milliseconds>
8773 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
8774 Setting this option to zero means no timeout, which is the default.
8776 =item B<StoreRates> B<false>|B<true>
8778 If set to B<true> (the default), convert counter values to rates. If set to
8779 B<false> counter values are stored as is, i.e. as an increasing integer
8782 =item B<Database> I<Database>
8784 =item B<User> I<User>
8786 =item B<Password> I<Password>
8788 Sets the information used when authenticating to a I<MongoDB> database. The
8789 fields are optional (in which case no authentication is attempted), but if you
8790 want to use authentication all three fields must be set.
8794 =head2 Plugin C<write_prometheus>
8796 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
8797 using I<Prometheus>.
8803 =item B<Port> I<Port>
8805 Port the embedded webserver should listen on. Defaults to B<9103>.
8807 =item B<StalenessDelta> I<Seconds>
8809 Time in seconds after which I<Prometheus> considers a metric "stale" if it
8810 hasn't seen any update for it. This value must match the setting in Prometheus.
8811 It defaults to B<300> seconds (5 minutes), same as Prometheus.
8815 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
8816 which time a metric without updates is considered "stale". This setting
8817 effectively puts an upper limit on the interval in which metrics are reported.
8819 When the I<write_prometheus plugin> encounters a metric with an interval
8820 exceeding this limit, it will inform you, the user, and provide the metric to
8821 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
8822 metric "fresh" each time it is scraped, with the time of the scrape being
8823 considered the time of the update. The result is that there appear more
8824 datapoints in I<Prometheus> than were actually created, but at least the metric
8825 doesn't disappear periodically.
8829 =head2 Plugin C<write_http>
8831 This output plugin submits values to an HTTP server using POST requests and
8832 encoding metrics with JSON or using the C<PUTVAL> command described in
8833 L<collectd-unixsock(5)>.
8837 <Plugin "write_http">
8839 URL "http://example.com/post-collectd"
8846 The plugin can send values to multiple HTTP servers by specifying one
8847 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
8848 block, the following options are available:
8854 URL to which the values are submitted to. Mandatory.
8856 =item B<User> I<Username>
8858 Optional user name needed for authentication.
8860 =item B<Password> I<Password>
8862 Optional password needed for authentication.
8864 =item B<VerifyPeer> B<true>|B<false>
8866 Enable or disable peer SSL certificate verification. See
8867 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
8869 =item B<VerifyHost> B<true|false>
8871 Enable or disable peer host name verification. If enabled, the plugin checks if
8872 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
8873 matches the host name provided by the B<URL> option. If this identity check
8874 fails, the connection is aborted. Obviously, only works when connecting to a
8875 SSL enabled server. Enabled by default.
8877 =item B<CACert> I<File>
8879 File that holds one or more SSL certificates. If you want to use HTTPS you will
8880 possibly need this option. What CA certificates come bundled with C<libcurl>
8881 and are checked by default depends on the distribution you use.
8883 =item B<CAPath> I<Directory>
8885 Directory holding one or more CA certificate files. You can use this if for
8886 some reason all the needed CA certificates aren't in the same file and can't be
8887 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
8890 =item B<ClientKey> I<File>
8892 File that holds the private key in PEM format to be used for certificate-based
8895 =item B<ClientCert> I<File>
8897 File that holds the SSL certificate to be used for certificate-based
8900 =item B<ClientKeyPass> I<Password>
8902 Password required to load the private key in B<ClientKey>.
8904 =item B<Header> I<Header>
8906 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
8908 Header "X-Custom-Header: custom_value"
8910 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
8912 Define which SSL protocol version must be used. By default C<libcurl> will
8913 attempt to figure out the remote SSL protocol version. See
8914 L<curl_easy_setopt(3)> for more details.
8916 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
8918 Format of the output to generate. If set to B<Command>, will create output that
8919 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
8920 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
8921 , will create output in the KairosDB format.
8923 Defaults to B<Command>.
8925 =item B<Attribute> I<String> I<String>
8927 Only available for the KAIROSDB output format.
8929 Consider the two given strings to be the key and value of an additional tag for
8930 each metric being sent out.
8932 You can add multiple B<Attribute>.
8936 Only available for the KAIROSDB output format.
8938 Sets the Cassandra ttl for the data points.
8940 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
8942 =item B<Metrics> B<true>|B<false>
8944 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
8946 =item B<Notifications> B<false>|B<true>
8948 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
8950 =item B<StoreRates> B<true|false>
8952 If set to B<true>, convert counter values to rates. If set to B<false> (the
8953 default) counter values are stored as is, i.e. as an increasing integer number.
8955 =item B<BufferSize> I<Bytes>
8957 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
8958 requests will be generated, but more metrics will be batched / metrics are
8959 cached for longer before being sent, introducing additional delay until they
8960 are available on the server side. I<Bytes> must be at least 1024 and cannot
8961 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
8962 Defaults to C<4096>.
8964 =item B<LowSpeedLimit> I<Bytes per Second>
8966 Sets the minimal transfer rate in I<Bytes per Second> below which the
8967 connection with the HTTP server will be considered too slow and aborted. All
8968 the data submitted over this connection will probably be lost. Defaults to 0,
8969 which means no minimum transfer rate is enforced.
8971 =item B<Timeout> I<Timeout>
8973 Sets the maximum time in milliseconds given for HTTP POST operations to
8974 complete. When this limit is reached, the POST operation will be aborted, and
8975 all the data in the current send buffer will probably be lost. Defaults to 0,
8976 which means the connection never times out.
8978 =item B<LogHttpError> B<false>|B<true>
8980 Enables printing of HTTP error code to log. Turned off by default.
8982 The C<write_http> plugin regularly submits the collected values to the HTTP
8983 server. How frequently this happens depends on how much data you are collecting
8984 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
8985 slightly below this interval, which you can estimate by monitoring the network
8986 traffic between collectd and the HTTP server.
8990 =head2 Plugin C<write_kafka>
8992 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
8996 <Plugin "write_kafka">
8997 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9003 The following options are understood by the I<write_kafka plugin>:
9007 =item E<lt>B<Topic> I<Name>E<gt>
9009 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9010 is given a unique I<Name> and specifies one kafka producer.
9011 Inside the B<Topic> block, the following per-topic options are
9016 =item B<Property> I<String> I<String>
9018 Configure the named property for the current topic. Properties are
9019 forwarded to the kafka producer library B<librdkafka>.
9021 =item B<Key> I<String>
9023 Use the specified string as a partitioning key for the topic. Kafka breaks
9024 topic into partitions and guarantees that for a given topology, the same
9025 consumer will be used for a specific key. The special (case insensitive)
9026 string B<Random> can be used to specify that an arbitrary partition should
9029 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9031 Selects the format in which messages are sent to the broker. If set to
9032 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9033 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9035 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9036 an easy and straight forward exchange format.
9038 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9039 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9041 =item B<StoreRates> B<true>|B<false>
9043 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9044 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9045 default), no conversion is performed. Otherwise the conversion is performed
9046 using the internal value cache.
9048 Please note that currently this option is only used if the B<Format> option has
9049 been set to B<JSON>.
9051 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9053 A prefix can be added in the metric name when outputting in the I<Graphite>
9054 format. It's added before the I<Host> name.
9056 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>>
9058 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9060 A postfix can be added in the metric name when outputting in the I<Graphite>
9061 format. It's added after the I<Host> name.
9063 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>>
9065 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9067 Specify a character to replace dots (.) in the host part of the metric name.
9068 In I<Graphite> metric name, dots are used as separators between different
9069 metric parts (host, plugin, type).
9070 Default is C<_> (I<Underscore>).
9072 =item B<GraphiteSeparateInstances> B<false>|B<true>
9074 If set to B<true>, the plugin instance and type instance will be in their own
9075 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9076 default), the plugin and plugin instance (and likewise the type and type
9077 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9079 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9081 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9082 identifier. If set to B<false> (the default), this is only done when there is
9085 =item B<GraphitePreserveSeparator> B<false>|B<true>
9087 If set to B<false> (the default) the C<.> (dot) character is replaced with
9088 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9089 is preserved, i.e. passed through.
9091 =item B<StoreRates> B<true>|B<false>
9093 If set to B<true> (the default), convert counter values to rates. If set to
9094 B<false> counter values are stored as is, i.e. as an increasing integer number.
9096 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9097 converted values will have "rate" appended to the data source type, e.g.
9098 C<ds_type:derive:rate>.
9102 =item B<Property> I<String> I<String>
9104 Configure the kafka producer through properties, you almost always will
9105 want to set B<metadata.broker.list> to your Kafka broker list.
9109 =head2 Plugin C<write_redis>
9111 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9115 <Plugin "write_redis">
9127 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9128 the timestamp as the score. Retrieving a date range can then be done using the
9129 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9130 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9131 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9132 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9133 with the B<Database> parameter (default is C<0>). See
9134 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9137 The information shown in the synopsis above is the I<default configuration>
9138 which is used by the plugin if no configuration is present.
9140 The plugin can send values to multiple instances of I<Redis> by specifying
9141 one B<Node> block for each instance. Within the B<Node> blocks, the following
9142 options are available:
9146 =item B<Node> I<Nodename>
9148 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9149 instance running on a specified host and port. The node name is a
9150 canonical identifier which is used as I<plugin instance>. It is limited to
9151 51E<nbsp>characters in length.
9153 =item B<Host> I<Hostname>
9155 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9158 =item B<Port> I<Port>
9160 The B<Port> option is the TCP port on which the Redis instance accepts
9161 connections. Either a service name of a port number may be given. Please note
9162 that numerical port numbers must be given as a string, too.
9164 =item B<Timeout> I<Milliseconds>
9166 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9168 =item B<Prefix> I<Prefix>
9170 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9171 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9172 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9173 is recommended but not required to include a trailing slash in I<Prefix>.
9175 =item B<Database> I<Index>
9177 This index selects the redis database to use for writing operations. Defaults
9180 =item B<MaxSetSize> I<Items>
9182 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9183 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9185 =item B<StoreRates> B<true>|B<false>
9187 If set to B<true> (the default), convert counter values to rates. If set to
9188 B<false> counter values are stored as is, i.e. as an increasing integer number.
9192 =head2 Plugin C<write_riemann>
9194 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9195 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9196 I<Riemann> using UDP packets.
9200 <Plugin "write_riemann">
9206 AlwaysAppendDS false
9210 Attribute "foo" "bar"
9213 The following options are understood by the I<write_riemann plugin>:
9217 =item E<lt>B<Node> I<Name>E<gt>
9219 The plugin's configuration consists of one or more B<Node> blocks. Each block
9220 is given a unique I<Name> and specifies one connection to an instance of
9221 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9226 =item B<Host> I<Address>
9228 Hostname or address to connect to. Defaults to C<localhost>.
9230 =item B<Port> I<Service>
9232 Service name or port number to connect to. Defaults to C<5555>.
9234 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9236 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9239 =item B<TLSCertFile> I<Path>
9241 When using the B<TLS> protocol, path to a PEM certificate to present
9244 =item B<TLSCAFile> I<Path>
9246 When using the B<TLS> protocol, path to a PEM CA certificate to
9247 use to validate the remote hosts's identity.
9249 =item B<TLSKeyFile> I<Path>
9251 When using the B<TLS> protocol, path to a PEM private key associated
9252 with the certificate defined by B<TLSCertFile>.
9254 =item B<Batch> B<true>|B<false>
9256 If set to B<true> and B<Protocol> is set to B<TCP>,
9257 events will be batched in memory and flushed at
9258 regular intervals or when B<BatchMaxSize> is exceeded.
9260 Notifications are not batched and sent as soon as possible.
9262 When enabled, it can occur that events get processed by the Riemann server
9263 close to or after their expiration time. Tune the B<TTLFactor> and
9264 B<BatchMaxSize> settings according to the amount of values collected, if this
9269 =item B<BatchMaxSize> I<size>
9271 Maximum payload size for a riemann packet. Defaults to 8192
9273 =item B<BatchFlushTimeout> I<seconds>
9275 Maximum amount of seconds to wait in between to batch flushes.
9276 No timeout by default.
9278 =item B<StoreRates> B<true>|B<false>
9280 If set to B<true> (the default), convert counter values to rates. If set to
9281 B<false> counter values are stored as is, i.e. as an increasing integer number.
9283 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9284 converted values will have "rate" appended to the data source type, e.g.
9285 C<ds_type:derive:rate>.
9287 =item B<AlwaysAppendDS> B<false>|B<true>
9289 If set to B<true>, append the name of the I<Data Source> (DS) to the
9290 "service", i.e. the field that, together with the "host" field, uniquely
9291 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9292 only done when there is more than one DS.
9294 =item B<TTLFactor> I<Factor>
9296 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9297 event is considered active. I<collectd> populates this field based on the
9298 metrics interval setting. This setting controls the factor with which the
9299 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9300 know exactly what you're doing, you should only increase this setting from its
9303 =item B<Notifications> B<false>|B<true>
9305 If set to B<true>, create riemann events for notifications. This is B<true>
9306 by default. When processing thresholds from write_riemann, it might prove
9307 useful to avoid getting notification events.
9309 =item B<CheckThresholds> B<false>|B<true>
9311 If set to B<true>, attach state to events based on thresholds defined
9312 in the B<Threshold> plugin. Defaults to B<false>.
9314 =item B<EventServicePrefix> I<String>
9316 Add the given string as a prefix to the event service name.
9317 If B<EventServicePrefix> not set or set to an empty string (""),
9318 no prefix will be used.
9322 =item B<Tag> I<String>
9324 Add the given string as an additional tag to the metric being sent to
9327 =item B<Attribute> I<String> I<String>
9329 Consider the two given strings to be the key and value of an additional
9330 attribute for each metric being sent out to I<Riemann>.
9334 =head2 Plugin C<write_sensu>
9336 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9337 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9338 a local I<Sensu> client using a TCP socket.
9340 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9341 parameter so it is not possible to use one collectd instance as a gateway for
9342 others. Each collectd host must pair with one I<Sensu> client.
9346 <Plugin "write_sensu">
9351 AlwaysAppendDS false
9352 MetricHandler "influx"
9353 MetricHandler "default"
9354 NotificationHandler "flapjack"
9355 NotificationHandler "howling_monkey"
9359 Attribute "foo" "bar"
9362 The following options are understood by the I<write_sensu plugin>:
9366 =item E<lt>B<Node> I<Name>E<gt>
9368 The plugin's configuration consists of one or more B<Node> blocks. Each block
9369 is given a unique I<Name> and specifies one connection to an instance of
9370 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9375 =item B<Host> I<Address>
9377 Hostname or address to connect to. Defaults to C<localhost>.
9379 =item B<Port> I<Service>
9381 Service name or port number to connect to. Defaults to C<3030>.
9383 =item B<StoreRates> B<true>|B<false>
9385 If set to B<true> (the default), convert counter values to rates. If set to
9386 B<false> counter values are stored as is, i.e. as an increasing integer number.
9388 This will be reflected in the C<collectd_data_source_type> tag: If
9389 B<StoreRates> is enabled, converted values will have "rate" appended to the
9390 data source type, e.g. C<collectd_data_source_type:derive:rate>.
9392 =item B<AlwaysAppendDS> B<false>|B<true>
9394 If set the B<true>, append the name of the I<Data Source> (DS) to the
9395 "service", i.e. the field that, together with the "host" field, uniquely
9396 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9397 only done when there is more than one DS.
9399 =item B<Notifications> B<false>|B<true>
9401 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9402 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9404 =item B<Metrics> B<false>|B<true>
9406 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9407 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9410 =item B<Separator> I<String>
9412 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9414 =item B<MetricHandler> I<String>
9416 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9417 several of them, one per line. Defaults to no handler.
9419 =item B<NotificationHandler> I<String>
9421 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9422 add several of them, one per line. Defaults to no handler.
9424 =item B<EventServicePrefix> I<String>
9426 Add the given string as a prefix to the event service name.
9427 If B<EventServicePrefix> not set or set to an empty string (""),
9428 no prefix will be used.
9432 =item B<Tag> I<String>
9434 Add the given string as an additional tag to the metric being sent to
9437 =item B<Attribute> I<String> I<String>
9439 Consider the two given strings to be the key and value of an additional
9440 attribute for each metric being sent out to I<Sensu>.
9444 =head2 Plugin C<xencpu>
9446 This plugin collects metrics of hardware CPU load for machine running Xen
9447 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9448 Result is reported using the C<percent> type, for each CPU (core).
9450 This plugin doesn't have any options (yet).
9452 =head2 Plugin C<zookeeper>
9454 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9455 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
9460 <Plugin "zookeeper">
9467 =item B<Host> I<Address>
9469 Hostname or address to connect to. Defaults to C<localhost>.
9471 =item B<Port> I<Service>
9473 Service name or port number to connect to. Defaults to C<2181>.
9477 =head1 THRESHOLD CONFIGURATION
9479 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9480 we mean that the values are not only stored or sent somewhere, but that they
9481 are judged and, if a problem is recognized, acted upon. The only action
9482 collectd takes itself is to generate and dispatch a "notification". Plugins can
9483 register to receive notifications and perform appropriate further actions.
9485 Since systems and what you expect them to do differ a lot, you can configure
9486 B<thresholds> for your values freely. This gives you a lot of flexibility but
9487 also a lot of responsibility.
9489 Every time a value is out of range a notification is dispatched. This means
9490 that the idle percentage of your CPU needs to be less then the configured
9491 threshold only once for a notification to be generated. There's no such thing
9492 as a moving average or similar - at least not now.
9494 Also, all values that match a threshold are considered to be relevant or
9495 "interesting". As a consequence collectd will issue a notification if they are
9496 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9497 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9498 "2" (the default) and some hosts sends it's CPU statistics to the server every
9499 60 seconds, a notification will be dispatched after about 120 seconds. It may
9500 take a little longer because the timeout is checked only once each B<Interval>
9503 When a value comes within range again or is received after it was missing, an
9504 "OKAY-notification" is dispatched.
9506 Here is a configuration example to get you started. Read below for more
9519 <Plugin "interface">
9536 WarningMin 100000000
9542 There are basically two types of configuration statements: The C<Host>,
9543 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
9544 configured. The C<Plugin> and C<Type> blocks may be specified further using the
9545 C<Instance> option. You can combine the block by nesting the blocks, though
9546 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
9547 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
9548 C<Type> may not contain other blocks. If multiple blocks apply to the same
9549 value the most specific block is used.
9551 The other statements specify the threshold to configure. They B<must> be
9552 included in a C<Type> block. Currently the following statements are recognized:
9556 =item B<FailureMax> I<Value>
9558 =item B<WarningMax> I<Value>
9560 Sets the upper bound of acceptable values. If unset defaults to positive
9561 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
9562 will be created. If the value is greater than B<WarningMax> but less than (or
9563 equal to) B<FailureMax> a B<WARNING> notification will be created.
9565 =item B<FailureMin> I<Value>
9567 =item B<WarningMin> I<Value>
9569 Sets the lower bound of acceptable values. If unset defaults to negative
9570 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
9571 be created. If the value is less than B<WarningMin> but greater than (or equal
9572 to) B<FailureMin> a B<WARNING> notification will be created.
9574 =item B<DataSource> I<DSName>
9576 Some data sets have more than one "data source". Interesting examples are the
9577 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
9578 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
9579 system load data set, C<load>, even has three data sources: C<shortterm>,
9580 C<midterm>, and C<longterm>.
9582 Normally, all data sources are checked against a configured threshold. If this
9583 is undesirable, or if you want to specify different limits for each data
9584 source, you can use the B<DataSource> option to have a threshold apply only to
9587 =item B<Invert> B<true>|B<false>
9589 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
9590 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
9591 B<WarningMax>) are not okay. Defaults to B<false>.
9593 =item B<Persist> B<true>|B<false>
9595 Sets how often notifications are generated. If set to B<true> one notification
9596 will be generated for each value that is out of the acceptable range. If set to
9597 B<false> (the default) then a notification is only generated if a value is out
9598 of range but the previous value was okay.
9600 This applies to missing values, too: If set to B<true> a notification about a
9601 missing value is generated once every B<Interval> seconds. If set to B<false>
9602 only one such notification is generated until the value appears again.
9604 =item B<Percentage> B<true>|B<false>
9606 If set to B<true>, the minimum and maximum values given are interpreted as
9607 percentage value, relative to the other data sources. This is helpful for
9608 example for the "df" type, where you may want to issue a warning when less than
9609 5E<nbsp>% of the total space is available. Defaults to B<false>.
9611 =item B<Hits> I<Number>
9613 Delay creating the notification until the threshold has been passed I<Number>
9614 times. When a notification has been generated, or when a subsequent value is
9615 inside the threshold, the counter is reset. If, for example, a value is
9616 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
9617 will be dispatched at most once every 30E<nbsp>seconds.
9619 This is useful when short bursts are not a problem. If, for example, 100% CPU
9620 usage for up to a minute is normal (and data is collected every
9621 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
9623 =item B<Hysteresis> I<Number>
9625 When set to non-zero, a hysteresis value is applied when checking minimum and
9626 maximum bounds. This is useful for values that increase slowly and fluctuate a
9627 bit while doing so. When these values come close to the threshold, they may
9628 "flap", i.e. switch between failure / warning case and okay case repeatedly.
9630 If, for example, the threshold is configures as
9635 then a I<Warning> notification is created when the value exceeds I<101> and the
9636 corresponding I<Okay> notification is only created once the value falls below
9637 I<99>, thus avoiding the "flapping".
9641 =head1 FILTER CONFIGURATION
9643 Starting with collectd 4.6 there is a powerful filtering infrastructure
9644 implemented in the daemon. The concept has mostly been copied from
9645 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
9646 terminology, so that users that are familiar with iptables feel right at home.
9650 The following are the terms used in the remainder of the filter configuration
9651 documentation. For an ASCII-art schema of the mechanism, see
9652 L<"General structure"> below.
9658 A I<match> is a criteria to select specific values. Examples are, of course, the
9659 name of the value or it's current value.
9661 Matches are implemented in plugins which you have to load prior to using the
9662 match. The name of such plugins starts with the "match_" prefix.
9666 A I<target> is some action that is to be performed with data. Such actions
9667 could, for example, be to change part of the value's identifier or to ignore
9668 the value completely.
9670 Some of these targets are built into the daemon, see L<"Built-in targets">
9671 below. Other targets are implemented in plugins which you have to load prior to
9672 using the target. The name of such plugins starts with the "target_" prefix.
9676 The combination of any number of matches and at least one target is called a
9677 I<rule>. The target actions will be performed for all values for which B<all>
9678 matches apply. If the rule does not have any matches associated with it, the
9679 target action will be performed for all values.
9683 A I<chain> is a list of rules and possibly default targets. The rules are tried
9684 in order and if one matches, the associated target will be called. If a value
9685 is handled by a rule, it depends on the target whether or not any subsequent
9686 rules are considered or if traversal of the chain is aborted, see
9687 L<"Flow control"> below. After all rules have been checked, the default targets
9692 =head2 General structure
9694 The following shows the resulting structure:
9701 +---------+ +---------+ +---------+ +---------+
9702 ! Rule !->! Match !->! Match !->! Target !
9703 +---------+ +---------+ +---------+ +---------+
9706 +---------+ +---------+ +---------+
9707 ! Rule !->! Target !->! Target !
9708 +---------+ +---------+ +---------+
9715 +---------+ +---------+ +---------+
9716 ! Rule !->! Match !->! Target !
9717 +---------+ +---------+ +---------+
9727 There are four ways to control which way a value takes through the filter
9734 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
9735 process the value with another chain. When the called chain finishes, usually
9736 the next target or rule after the jump is executed.
9740 The stop condition, signaled for example by the built-in target B<stop>, causes
9741 all processing of the value to be stopped immediately.
9745 Causes processing in the current chain to be aborted, but processing of the
9746 value generally will continue. This means that if the chain was called via
9747 B<Jump>, the next target or rule after the jump will be executed. If the chain
9748 was not called by another chain, control will be returned to the daemon and it
9749 may pass the value to another chain.
9753 Most targets will signal the B<continue> condition, meaning that processing
9754 should continue normally. There is no special built-in target for this
9761 The configuration reflects this structure directly:
9763 PostCacheChain "PostCache"
9765 <Rule "ignore_mysql_show">
9768 Type "^mysql_command$"
9769 TypeInstance "^show_"
9779 The above configuration example will ignore all values where the plugin field
9780 is "mysql", the type is "mysql_command" and the type instance begins with
9781 "show_". All other values will be sent to the C<rrdtool> write plugin via the
9782 default target of the chain. Since this chain is run after the value has been
9783 added to the cache, the MySQL C<show_*> command statistics will be available
9784 via the C<unixsock> plugin.
9786 =head2 List of configuration options
9790 =item B<PreCacheChain> I<ChainName>
9792 =item B<PostCacheChain> I<ChainName>
9794 Configure the name of the "pre-cache chain" and the "post-cache chain". The
9795 argument is the name of a I<chain> that should be executed before and/or after
9796 the values have been added to the cache.
9798 To understand the implications, it's important you know what is going on inside
9799 I<collectd>. The following diagram shows how values are passed from the
9800 read-plugins to the write-plugins:
9806 + - - - - V - - - - +
9807 : +---------------+ :
9810 : +-------+-------+ :
9813 : +-------+-------+ : +---------------+
9814 : ! Cache !--->! Value Cache !
9815 : ! insert ! : +---+---+-------+
9816 : +-------+-------+ : ! !
9817 : ! ,------------' !
9819 : +-------+---+---+ : +-------+-------+
9820 : ! Post-Cache +--->! Write-Plugins !
9821 : ! Chain ! : +---------------+
9822 : +---------------+ :
9825 + - - - - - - - - - +
9827 After the values are passed from the "read" plugins to the dispatch functions,
9828 the pre-cache chain is run first. The values are added to the internal cache
9829 afterwards. The post-cache chain is run after the values have been added to the
9830 cache. So why is it such a huge deal if chains are run before or after the
9831 values have been added to this cache?
9833 Targets that change the identifier of a value list should be executed before
9834 the values are added to the cache, so that the name in the cache matches the
9835 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
9836 this cache to receive a list of all available values. If you change the
9837 identifier after the value list has been added to the cache, this may easily
9838 lead to confusion, but it's not forbidden of course.
9840 The cache is also used to convert counter values to rates. These rates are, for
9841 example, used by the C<value> match (see below). If you use the rate stored in
9842 the cache B<before> the new value is added, you will use the old, B<previous>
9843 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
9844 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
9847 Last but not last, the B<stop> target makes a difference: If the pre-cache
9848 chain returns the stop condition, the value will not be added to the cache and
9849 the post-cache chain will not be run.
9851 =item B<Chain> I<Name>
9853 Adds a new chain with a certain name. This name can be used to refer to a
9854 specific chain, for example to jump to it.
9856 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
9858 =item B<Rule> [I<Name>]
9860 Adds a new rule to the current chain. The name of the rule is optional and
9861 currently has no meaning for the daemon.
9863 Within the B<Rule> block, there may be any number of B<Match> blocks and there
9864 must be at least one B<Target> block.
9866 =item B<Match> I<Name>
9868 Adds a match to a B<Rule> block. The name specifies what kind of match should
9869 be performed. Available matches depend on the plugins that have been loaded.
9871 The arguments inside the B<Match> block are passed to the plugin implementing
9872 the match, so which arguments are valid here depends on the plugin being used.
9873 If you do not need any to pass any arguments to a match, you can use the
9878 Which is equivalent to:
9883 =item B<Target> I<Name>
9885 Add a target to a rule or a default target to a chain. The name specifies what
9886 kind of target is to be added. Which targets are available depends on the
9887 plugins being loaded.
9889 The arguments inside the B<Target> block are passed to the plugin implementing
9890 the target, so which arguments are valid here depends on the plugin being used.
9891 If you do not need any to pass any arguments to a target, you can use the
9896 This is the same as writing:
9903 =head2 Built-in targets
9905 The following targets are built into the core daemon and therefore need no
9906 plugins to be loaded:
9912 Signals the "return" condition, see the L<"Flow control"> section above. This
9913 causes the current chain to stop processing the value and returns control to
9914 the calling chain. The calling chain will continue processing targets and rules
9915 just after the B<jump> target (see below). This is very similar to the
9916 B<RETURN> target of iptables, see L<iptables(8)>.
9918 This target does not have any options.
9926 Signals the "stop" condition, see the L<"Flow control"> section above. This
9927 causes processing of the value to be aborted immediately. This is similar to
9928 the B<DROP> target of iptables, see L<iptables(8)>.
9930 This target does not have any options.
9938 Sends the value to "write" plugins.
9944 =item B<Plugin> I<Name>
9946 Name of the write plugin to which the data should be sent. This option may be
9947 given multiple times to send the data to more than one write plugin. If the
9948 plugin supports multiple instances, the plugin's instance(s) must also be
9953 If no plugin is explicitly specified, the values will be sent to all available
9956 Single-instance plugin example:
9962 Multi-instance plugin example:
9964 <Plugin "write_graphite">
9974 Plugin "write_graphite/foo"
9979 Starts processing the rules of another chain, see L<"Flow control"> above. If
9980 the end of that chain is reached, or a stop condition is encountered,
9981 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
9982 next target or the next rule. This is similar to the B<-j> command line option
9983 of iptables, see L<iptables(8)>.
9989 =item B<Chain> I<Name>
9991 Jumps to the chain I<Name>. This argument is required and may appear only once.
10003 =head2 Available matches
10009 Matches a value using regular expressions.
10015 =item B<Host> I<Regex>
10017 =item B<Plugin> I<Regex>
10019 =item B<PluginInstance> I<Regex>
10021 =item B<Type> I<Regex>
10023 =item B<TypeInstance> I<Regex>
10025 =item B<MetaData> I<String> I<Regex>
10027 Match values where the given regular expressions match the various fields of
10028 the identifier of a value. If multiple regular expressions are given, B<all>
10029 regexen must match for a value to match.
10031 =item B<Invert> B<false>|B<true>
10033 When set to B<true>, the result of the match is inverted, i.e. all value lists
10034 where all regular expressions apply are not matched, all other value lists are
10035 matched. Defaults to B<false>.
10042 Host "customer[0-9]+"
10048 Matches values that have a time which differs from the time on the server.
10050 This match is mainly intended for servers that receive values over the
10051 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10052 is very sensitive to the timestamp used when updating the RRD files. In
10053 particular, the time must be ever increasing. If a misbehaving client sends one
10054 packet with a timestamp far in the future, all further packets with a correct
10055 time will be ignored because of that one packet. What's worse, such corrupted
10056 RRD files are hard to fix.
10058 This match lets one match all values B<outside> a specified time range
10059 (relative to the server's time), so you can use the B<stop> target (see below)
10060 to ignore the value, for example.
10066 =item B<Future> I<Seconds>
10068 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10069 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10072 =item B<Past> I<Seconds>
10074 Matches all values that are I<behind> of the server's time by I<Seconds> or
10075 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10087 This example matches all values that are five minutes or more ahead of the
10088 server or one hour (or more) lagging behind.
10092 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10093 values. If a data-set consists of more than one data-source, all data-sources
10094 must match the specified ranges for a positive match.
10100 =item B<Min> I<Value>
10102 Sets the smallest value which still results in a match. If unset, behaves like
10105 =item B<Max> I<Value>
10107 Sets the largest value which still results in a match. If unset, behaves like
10110 =item B<Invert> B<true>|B<false>
10112 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10113 no-match is returned and vice versa. Please note that the B<Invert> setting
10114 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10115 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10117 =item B<DataSource> I<DSName> [I<DSName> ...]
10119 Select one or more of the data sources. If no data source is configured, all
10120 data sources will be checked. If the type handled by the match does not have a
10121 data source of the specified name(s), this will always result in no match
10122 (independent of the B<Invert> setting).
10124 =item B<Satisfy> B<Any>|B<All>
10126 Specifies how checking with several data sources is performed. If set to
10127 B<Any>, the match succeeds if one of the data sources is in the configured
10128 range. If set to B<All> the match only succeeds if all data sources are within
10129 the configured range. Default is B<All>.
10131 Usually B<All> is used for positive matches, B<Any> is used for negative
10132 matches. This means that with B<All> you usually check that all values are in a
10133 "good" range, while with B<Any> you check if any value is within a "bad" range
10134 (or outside the "good" range).
10138 Either B<Min> or B<Max>, but not both, may be unset.
10142 # Match all values smaller than or equal to 100. Matches only if all data
10143 # sources are below 100.
10149 # Match if the value of any data source is outside the range of 0 - 100.
10157 =item B<empty_counter>
10159 Matches all values with one or more data sources of type B<COUNTER> and where
10160 all counter values are zero. These counters usually I<never> increased since
10161 they started existing (and are therefore uninteresting), or got reset recently
10162 or overflowed and you had really, I<really> bad luck.
10164 Please keep in mind that ignoring such counters can result in confusing
10165 behavior: Counters which hardly ever increase will be zero for long periods of
10166 time. If the counter is reset for some reason (machine or service restarted,
10167 usually), the graph will be empty (NAN) for a long time. People may not
10172 Calculates a hash value of the host name and matches values according to that
10173 hash value. This makes it possible to divide all hosts into groups and match
10174 only values that are in a specific group. The intended use is in load
10175 balancing, where you want to handle only part of all data and leave the rest
10178 The hashing function used tries to distribute the hosts evenly. First, it
10179 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10182 for (i = 0; host[i] != 0; i++)
10183 hash_value = (hash_value * 251) + host[i];
10185 The constant 251 is a prime number which is supposed to make this hash value
10186 more random. The code then checks the group for this host according to the
10187 I<Total> and I<Match> arguments:
10189 if ((hash_value % Total) == Match)
10194 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10195 groups), then the least significant bit of the hash value will be the XOR of
10196 all least significant bits in the host name. One consequence is that when you
10197 have two hosts, "server0.example.com" and "server1.example.com", where the host
10198 name differs in one digit only and the digits differ by one, those hosts will
10199 never end up in the same group.
10205 =item B<Match> I<Match> I<Total>
10207 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10208 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10209 be smaller than I<Total>. I<Total> must be at least one, although only values
10210 greater than one really do make any sense.
10212 You can repeat this option to match multiple groups, for example:
10217 The above config will divide the data into seven groups and match groups three
10218 and five. One use would be to keep every value on two hosts so that if one
10219 fails the missing data can later be reconstructed from the second host.
10225 # Operate on the pre-cache chain, so that ignored values are not even in the
10230 # Divide all received hosts in seven groups and accept all hosts in
10234 # If matched: Return and continue.
10237 # If not matched: Return and stop.
10243 =head2 Available targets
10247 =item B<notification>
10249 Creates and dispatches a notification.
10255 =item B<Message> I<String>
10257 This required option sets the message of the notification. The following
10258 placeholders will be replaced by an appropriate value:
10266 =item B<%{plugin_instance}>
10270 =item B<%{type_instance}>
10272 These placeholders are replaced by the identifier field of the same name.
10274 =item B<%{ds:>I<name>B<}>
10276 These placeholders are replaced by a (hopefully) human readable representation
10277 of the current rate of this data source. If you changed the instance name
10278 (using the B<set> or B<replace> targets, see below), it may not be possible to
10279 convert counter values to rates.
10283 Please note that these placeholders are B<case sensitive>!
10285 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10287 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10294 <Target "notification">
10295 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10301 Replaces parts of the identifier using regular expressions.
10307 =item B<Host> I<Regex> I<Replacement>
10309 =item B<Plugin> I<Regex> I<Replacement>
10311 =item B<PluginInstance> I<Regex> I<Replacement>
10313 =item B<TypeInstance> I<Regex> I<Replacement>
10315 =item B<MetaData> I<String> I<Regex> I<Replacement>
10317 =item B<DeleteMetaData> I<String> I<Regex>
10319 Match the appropriate field with the given regular expression I<Regex>. If the
10320 regular expression matches, that part that matches is replaced with
10321 I<Replacement>. If multiple places of the input buffer match a given regular
10322 expression, only the first occurrence will be replaced.
10324 You can specify each option multiple times to use multiple regular expressions
10332 # Replace "example.net" with "example.com"
10333 Host "\\<example.net\\>" "example.com"
10335 # Strip "www." from hostnames
10336 Host "\\<www\\." ""
10341 Sets part of the identifier of a value to a given string.
10347 =item B<Host> I<String>
10349 =item B<Plugin> I<String>
10351 =item B<PluginInstance> I<String>
10353 =item B<TypeInstance> I<String>
10355 =item B<MetaData> I<String> I<String>
10357 Set the appropriate field to the given string. The strings for plugin instance,
10358 type instance, and meta data may be empty, the strings for host and plugin may
10359 not be empty. It's currently not possible to set the type of a value this way.
10361 The following placeholders will be replaced by an appropriate value:
10369 =item B<%{plugin_instance}>
10373 =item B<%{type_instance}>
10375 These placeholders are replaced by the identifier field of the same name.
10377 =item B<%{meta:>I<name>B<}>
10379 These placeholders are replaced by the meta data value with the given name.
10383 Please note that these placeholders are B<case sensitive>!
10385 =item B<DeleteMetaData> I<String>
10387 Delete the named meta data field.
10394 PluginInstance "coretemp"
10395 TypeInstance "core3"
10400 =head2 Backwards compatibility
10402 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10403 B<Chain> block, it will behave as it used to. This is equivalent to the
10404 following configuration:
10406 <Chain "PostCache">
10410 If you specify a B<PostCacheChain>, the B<write> target will not be added
10411 anywhere and you will have to make sure that it is called where appropriate. We
10412 suggest to add the above snippet as default target to your "PostCache" chain.
10416 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10431 B<Ignorelists> are a generic framework to either ignore some metrics or report
10432 specific metircs only. Plugins usually provide one or more options to specify
10433 the items (mounts points, devices, ...) and the boolean option
10438 =item B<Select> I<String>
10440 Selects the item I<String>. This option often has a plugin specific name, e.g.
10441 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10442 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10443 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10445 By default, this option is doing a case-sensitive full-string match. The
10446 following config will match C<foo>, but not C<Foo>:
10450 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10451 I<regular expression>. For example, so match all item starting with C<foo>, use
10452 could use the following syntax:
10456 The regular expression is I<not> anchored, i.e. the following config will match
10457 C<foobar>, C<barfoo> and C<AfooZ>:
10461 The B<Select> option may be repeated to select multiple items.
10463 =item B<IgnoreSelected> B<true>|B<false>
10465 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10466 collected. If set to B<false>, matching metrics are I<collected> and all other
10467 metrics are ignored.
10474 L<collectd-exec(5)>,
10475 L<collectd-perl(5)>,
10476 L<collectd-unixsock(5)>,
10489 Florian Forster E<lt>octo@collectd.orgE<gt>