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
560 # Receive values from an AMQP broker
561 <Subscribe "some_name">
567 Exchange "amq.fanout"
568 # ExchangeType "fanout"
571 # QueueAutoDelete true
572 # RoutingKey "collectd.#"
573 # ConnectionRetryDelay 0
577 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
578 blocks, which configure sending and receiving of values respectively. The two
579 blocks are very similar, so unless otherwise noted, an option can be used in
580 either block. The name given in the blocks starting tag is only used for
581 reporting messages, but may be used to support I<flushing> of certain
582 I<Publish> blocks in the future.
586 =item B<Host> I<Host>
588 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
589 the underlying communications library, I<rabbitmq-c>, which is "localhost".
591 =item B<Port> I<Port>
593 Service name or port number on which the AMQP broker accepts connections. This
594 argument must be a string, even if the numeric form is used. Defaults to
597 =item B<VHost> I<VHost>
599 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
601 =item B<User> I<User>
603 =item B<Password> I<Password>
605 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
608 =item B<Exchange> I<Exchange>
610 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
611 By default, "amq.fanout" will be used.
613 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
614 the given exchange and the I<queue> is created, using the I<routing key> if
615 configured. See the B<Queue> and B<RoutingKey> options below.
617 =item B<ExchangeType> I<Type>
619 If given, the plugin will try to create the configured I<exchange> with this
620 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
621 be bound to this exchange.
623 =item B<Queue> I<Queue> (Subscribe only)
625 Configures the I<queue> name to subscribe to. If no queue name was configured
626 explicitly, a unique queue name will be created by the broker.
628 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
630 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
631 or transient (will disappear if the AMQP broker is restarted). Defaults to
634 This option should be used in conjunction with the I<Persistent> option on the
637 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
639 Defines if the I<queue> subscribed to will be deleted once the last consumer
640 unsubscribes. Defaults to "true".
642 =item B<RoutingKey> I<Key>
644 In I<Publish> blocks, this configures the routing key to set on all outgoing
645 messages. If not given, the routing key will be computed from the I<identifier>
646 of the value. The host, plugin, type and the two instances are concatenated
647 together using dots as the separator and all containing dots replaced with
648 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
649 possible to receive only specific values using a "topic" exchange.
651 In I<Subscribe> blocks, configures the I<routing key> used when creating a
652 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
653 used to filter messages when using a "topic" exchange. If you're only
654 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
657 =item B<Persistent> B<true>|B<false> (Publish only)
659 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
660 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
661 default), the I<transient> delivery mode will be used, i.e. messages may be
662 lost due to high load, overflowing queues or similar issues.
664 =item B<ConnectionRetryDelay> I<Delay>
666 When the connection to the AMQP broker is lost, defines the time in seconds to
667 wait before attempting to reconnect. Defaults to 0, which implies collectd will
668 attempt to reconnect at each read interval (in Subscribe mode) or each time
669 values are ready for submission (in Publish mode).
671 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
673 Selects the format in which messages are sent to the broker. If set to
674 B<Command> (the default), values are sent as C<PUTVAL> commands which are
675 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
676 case, the C<Content-Type> header field will be set to C<text/collectd>.
678 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
679 an easy and straight forward exchange format. The C<Content-Type> header field
680 will be set to C<application/json>.
682 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
683 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
686 A subscribing client I<should> use the C<Content-Type> header field to
687 determine how to decode the values. Currently, the I<AMQP plugin> itself can
688 only decode the B<Command> format.
690 =item B<StoreRates> B<true>|B<false> (Publish only)
692 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
693 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
694 default), no conversion is performed. Otherwise the conversion is performed
695 using the internal value cache.
697 Please note that currently this option is only used if the B<Format> option has
700 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
702 A prefix can be added in the metric name when outputting in the I<Graphite> format.
703 It's added before the I<Host> name.
704 Metric name will be "<prefix><host><postfix><plugin><type><name>"
706 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
708 A postfix can be added in the metric name when outputting in the I<Graphite> format.
709 It's added after the I<Host> name.
710 Metric name will be "<prefix><host><postfix><plugin><type><name>"
712 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
714 Specify a character to replace dots (.) in the host part of the metric name.
715 In I<Graphite> metric name, dots are used as separators between different
716 metric parts (host, plugin, type).
717 Default is "_" (I<Underscore>).
719 =item B<GraphiteSeparateInstances> B<true>|B<false>
721 If set to B<true>, the plugin instance and type instance will be in their own
722 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
723 default), the plugin and plugin instance (and likewise the type and type
724 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
726 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
728 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
729 identifier. If set to B<false> (the default), this is only done when there is
734 =head2 Plugin C<apache>
736 To configure the C<apache>-plugin you first need to configure the Apache
737 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
738 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
739 the following snipped to base your Apache config upon:
742 <IfModule mod_status.c>
743 <Location /mod_status>
744 SetHandler server-status
748 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
749 also supported. It introduces a new field, called C<BusyServers>, to count the
750 number of currently connected clients. This field is also supported.
752 The configuration of the I<Apache> plugin consists of one or more
753 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
754 as the instance name. For example:
758 URL "http://www1.example.com/mod_status?auto"
761 URL "http://www2.example.com/mod_status?auto"
765 The instance name will be used as the I<plugin instance>. To emulate the old
766 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
767 plugin to work correctly, each instance name must be unique. This is not
768 enforced by the plugin and it is your responsibility to ensure it.
770 The following options are accepted within each I<Instance> block:
774 =item B<URL> I<http://host/mod_status?auto>
776 Sets the URL of the C<mod_status> output. This needs to be the output generated
777 by C<ExtendedStatus on> and it needs to be the machine readable output
778 generated by appending the C<?auto> argument. This option is I<mandatory>.
780 =item B<User> I<Username>
782 Optional user name needed for authentication.
784 =item B<Password> I<Password>
786 Optional password needed for authentication.
788 =item B<VerifyPeer> B<true|false>
790 Enable or disable peer SSL certificate verification. See
791 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
793 =item B<VerifyHost> B<true|false>
795 Enable or disable peer host name verification. If enabled, the plugin checks
796 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
797 certificate matches the host name provided by the B<URL> option. If this
798 identity check fails, the connection is aborted. Obviously, only works when
799 connecting to a SSL enabled server. Enabled by default.
801 =item B<CACert> I<File>
803 File that holds one or more SSL certificates. If you want to use HTTPS you will
804 possibly need this option. What CA certificates come bundled with C<libcurl>
805 and are checked by default depends on the distribution you use.
807 =item B<SSLCiphers> I<list of ciphers>
809 Specifies which ciphers to use in the connection. The list of ciphers
810 must specify valid ciphers. See
811 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
813 =item B<Timeout> I<Milliseconds>
815 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
816 milliseconds. By default, the configured B<Interval> is used to set the
821 =head2 Plugin C<apcups>
825 =item B<Host> I<Hostname>
827 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
828 that IPv6 support has been disabled unless someone can confirm or decline that
829 B<apcupsd> can handle it.
831 =item B<Port> I<Port>
833 TCP-Port to connect to. Defaults to B<3551>.
835 =item B<ReportSeconds> B<true>|B<false>
837 If set to B<true>, the time reported in the C<timeleft> metric will be
838 converted to seconds. This is the recommended setting. If set to B<false>, the
839 default for backwards compatibility, the time will be reported in minutes.
841 =item B<PersistentConnection> B<true>|B<false>
843 The plugin is designed to keep the connection to I<apcupsd> open between reads.
844 If plugin poll interval is greater than 15 seconds (hardcoded socket close
845 timeout in I<apcupsd> NIS), then this option is B<false> by default.
847 You can instruct the plugin to close the connection after each read by setting
848 this option to B<false> or force keeping the connection by setting it to B<true>.
850 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
851 the plugin will try to detect this problem and switch to an open-read-close mode.
855 =head2 Plugin C<aquaero>
857 This plugin collects the value of the available sensors in an
858 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
859 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
860 connection for monitoring and configuration. The board can handle multiple
861 temperature sensors, fans, water pumps and water level sensors and adjust the
862 output settings such as fan voltage or power used by the water pump based on
863 the available inputs using a configurable controller included in the board.
864 This plugin collects all the available inputs as well as some of the output
865 values chosen by this controller. The plugin is based on the I<libaquaero5>
866 library provided by I<aquatools-ng>.
870 =item B<Device> I<DevicePath>
872 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
873 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
874 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
878 =head2 Plugin C<ascent>
880 This plugin collects information about an Ascent server, a free server for the
881 "World of Warcraft" game. This plugin gathers the information by fetching the
882 XML status page using C<libcurl> and parses it using C<libxml2>.
884 The configuration options are the same as for the C<apache> plugin above:
888 =item B<URL> I<http://localhost/ascent/status/>
890 Sets the URL of the XML status output.
892 =item B<User> I<Username>
894 Optional user name needed for authentication.
896 =item B<Password> I<Password>
898 Optional password needed for authentication.
900 =item B<VerifyPeer> B<true|false>
902 Enable or disable peer SSL certificate verification. See
903 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
905 =item B<VerifyHost> B<true|false>
907 Enable or disable peer host name verification. If enabled, the plugin checks
908 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
909 certificate matches the host name provided by the B<URL> option. If this
910 identity check fails, the connection is aborted. Obviously, only works when
911 connecting to a SSL enabled server. Enabled by default.
913 =item B<CACert> I<File>
915 File that holds one or more SSL certificates. If you want to use HTTPS you will
916 possibly need this option. What CA certificates come bundled with C<libcurl>
917 and are checked by default depends on the distribution you use.
919 =item B<Timeout> I<Milliseconds>
921 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
922 milliseconds. By default, the configured B<Interval> is used to set the
927 =head2 Plugin C<barometer>
929 This plugin reads absolute air pressure using digital barometer sensor on a I2C
930 bus. Supported sensors are:
934 =item I<MPL115A2> from Freescale,
935 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
938 =item I<MPL3115> from Freescale
939 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
942 =item I<BMP085> from Bosch Sensortec
946 The sensor type - one of the above - is detected automatically by the plugin
947 and indicated in the plugin_instance (you will see subdirectory
948 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
949 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
950 (only one sensor can be used by the plugin).
952 The plugin provides absolute barometric pressure, air pressure reduced to sea
953 level (several possible approximations) and as an auxiliary value also internal
954 sensor temperature. It uses (expects/provides) typical metric units - pressure
955 in [hPa], temperature in [C], altitude in [m].
957 It was developed and tested under Linux only. The only platform dependency is
958 the standard Linux i2c-dev interface (the particular bus driver has to
959 support the SM Bus command subset).
961 The reduction or normalization to mean sea level pressure requires (depending
962 on selected method/approximation) also altitude and reference to temperature
963 sensor(s). When multiple temperature sensors are configured the minimum of
964 their values is always used (expecting that the warmer ones are affected by
965 e.g. direct sun light at that moment).
973 TemperatureOffset 0.0
976 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
981 =item B<Device> I<device>
983 The only mandatory configuration parameter.
985 Device name of the I2C bus to which the sensor is connected. Note that
986 typically you need to have loaded the i2c-dev module.
987 Using i2c-tools you can check/list i2c buses available on your system by:
991 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
995 This way you should be able to verify that the pressure sensor (either type) is
996 connected and detected on address 0x60.
998 =item B<Oversampling> I<value>
1000 Optional parameter controlling the oversampling/accuracy. Default value
1001 is 1 providing fastest and least accurate reading.
1003 For I<MPL115> this is the size of the averaging window. To filter out sensor
1004 noise a simple averaging using floating window of this configurable size is
1005 used. The plugin will use average of the last C<value> measurements (value of 1
1006 means no averaging). Minimal size is 1, maximal 1024.
1008 For I<MPL3115> this is the oversampling value. The actual oversampling is
1009 performed by the sensor and the higher value the higher accuracy and longer
1010 conversion time (although nothing to worry about in the collectd context).
1011 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1012 adjusted by the plugin to the closest supported one.
1014 For I<BMP085> this is the oversampling value. The actual oversampling is
1015 performed by the sensor and the higher value the higher accuracy and longer
1016 conversion time (although nothing to worry about in the collectd context).
1017 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1018 the closest supported one.
1020 =item B<PressureOffset> I<offset>
1022 Optional parameter for MPL3115 only.
1024 You can further calibrate the sensor by supplying pressure and/or temperature
1025 offsets. This is added to the measured/caclulated value (i.e. if the measured
1026 value is too high then use negative offset).
1027 In hPa, default is 0.0.
1029 =item B<TemperatureOffset> I<offset>
1031 Optional parameter for MPL3115 only.
1033 You can further calibrate the sensor by supplying pressure and/or temperature
1034 offsets. This is added to the measured/caclulated value (i.e. if the measured
1035 value is too high then use negative offset).
1036 In C, default is 0.0.
1038 =item B<Normalization> I<method>
1040 Optional parameter, default value is 0.
1042 Normalization method - what approximation/model is used to compute the mean sea
1043 level pressure from the air absolute pressure.
1045 Supported values of the C<method> (integer between from 0 to 2) are:
1049 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1050 do not need to configure C<Altitude> or C<TemperatureSensor>.
1052 =item B<1> - international formula for conversion ,
1054 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1055 For this method you have to configure C<Altitude> but do not need
1056 C<TemperatureSensor> (uses fixed global temperature average instead).
1058 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1059 Meteorological Service).
1060 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1061 For this method you have to configure both C<Altitude> and
1062 C<TemperatureSensor>.
1067 =item B<Altitude> I<altitude>
1069 The altitude (in meters) of the location where you meassure the pressure.
1071 =item B<TemperatureSensor> I<reference>
1073 Temperature sensor(s) which should be used as a reference when normalizing the
1074 pressure using C<Normalization> method 2.
1075 When specified more sensors a minimum is found and used each time. The
1076 temperature reading directly from this pressure sensor/plugin is typically not
1077 suitable as the pressure sensor will be probably inside while we want outside
1078 temperature. The collectd reference name is something like
1079 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1080 (<type_instance> is usually omitted when there is just single value type). Or
1081 you can figure it out from the path of the output data files.
1085 =head2 Plugin C<battery>
1087 The I<battery plugin> reports the remaining capacity, power and voltage of
1092 =item B<ValuesPercentage> B<false>|B<true>
1094 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1095 capacity remaining". Otherwise the capacity is stored as reported by the
1096 battery, most likely in "Wh". This option does not work with all input methods,
1097 in particular when only C</proc/pmu> is available on an old Linux system.
1098 Defaults to B<false>.
1100 =item B<ReportDegraded> B<false>|B<true>
1102 Typical laptop batteries degrade over time, meaning the capacity decreases with
1103 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1104 "last full capacity" and used to determine that a battery is "fully charged".
1106 When this option is set to B<false>, the default, the I<battery plugin> will
1107 only report the remaining capacity. If the B<ValuesPercentage> option is
1108 enabled, the relative remaining capacity is calculated as the ratio of the
1109 "remaining capacity" and the "last full capacity". This is what most tools,
1110 such as the status bar of desktop environments, also do.
1112 When set to B<true>, the battery plugin will report three values: B<charged>
1113 (remaining capacity), B<discharged> (difference between "last full capacity"
1114 and "remaining capacity") and B<degraded> (difference between "design capacity"
1115 and "last full capacity").
1119 =head2 Plugin C<bind>
1121 Starting with BIND 9.5.0, the most widely used DNS server software provides
1122 extensive statistics about queries, responses and lots of other information.
1123 The bind plugin retrieves this information that's encoded in XML and provided
1124 via HTTP and submits the values to collectd.
1126 To use this plugin, you first need to tell BIND to make this information
1127 available. This is done with the C<statistics-channels> configuration option:
1129 statistics-channels {
1130 inet localhost port 8053;
1133 The configuration follows the grouping that can be seen when looking at the
1134 data with an XSLT compatible viewer, such as a modern web browser. It's
1135 probably a good idea to make yourself familiar with the provided values, so you
1136 can understand what the collected statistics actually mean.
1141 URL "http://localhost:8053/"
1156 Zone "127.in-addr.arpa/IN"
1160 The bind plugin accepts the following configuration options:
1166 URL from which to retrieve the XML data. If not specified,
1167 C<http://localhost:8053/> will be used.
1169 =item B<ParseTime> B<true>|B<false>
1171 When set to B<true>, the time provided by BIND will be parsed and used to
1172 dispatch the values. When set to B<false>, the local time source is queried.
1174 This setting is set to B<true> by default for backwards compatibility; setting
1175 this to B<false> is I<recommended> to avoid problems with timezones and
1178 =item B<OpCodes> B<true>|B<false>
1180 When enabled, statistics about the I<"OpCodes">, for example the number of
1181 C<QUERY> packets, are collected.
1185 =item B<QTypes> B<true>|B<false>
1187 When enabled, the number of I<incoming> queries by query types (for example
1188 C<A>, C<MX>, C<AAAA>) is collected.
1192 =item B<ServerStats> B<true>|B<false>
1194 Collect global server statistics, such as requests received over IPv4 and IPv6,
1195 successful queries, and failed updates.
1199 =item B<ZoneMaintStats> B<true>|B<false>
1201 Collect zone maintenance statistics, mostly information about notifications
1202 (zone updates) and zone transfers.
1206 =item B<ResolverStats> B<true>|B<false>
1208 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1209 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1210 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1211 default. Use the B<ResolverStats> option within a B<View "_default"> block
1212 instead for the same functionality.
1216 =item B<MemoryStats>
1218 Collect global memory statistics.
1222 =item B<Timeout> I<Milliseconds>
1224 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1225 milliseconds. By default, the configured B<Interval> is used to set the
1228 =item B<View> I<Name>
1230 Collect statistics about a specific I<"view">. BIND can behave different,
1231 mostly depending on the source IP-address of the request. These different
1232 configurations are called "views". If you don't use this feature, you most
1233 likely are only interested in the C<_default> view.
1235 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1236 information you want to collect about a view. If no B<View> block is
1237 configured, no detailed view statistics will be collected.
1241 =item B<QTypes> B<true>|B<false>
1243 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1244 C<MX>) is collected.
1248 =item B<ResolverStats> B<true>|B<false>
1250 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1251 (e.E<nbsp>g. queries over IPv4, lame servers).
1255 =item B<CacheRRSets> B<true>|B<false>
1257 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1258 type is collected. Negative entries (queries which resulted in an error, for
1259 example names that do not exist) are reported with a leading exclamation mark,
1264 =item B<Zone> I<Name>
1266 When given, collect detailed information about the given zone in the view. The
1267 information collected if very similar to the global B<ServerStats> information
1270 You can repeat this option to collect detailed information about multiple
1273 By default no detailed zone information is collected.
1279 =head2 Plugin C<ceph>
1281 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1282 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1284 A separate B<Daemon> block must be configured for each ceph daemon to be
1285 monitored. The following example will read daemon statistics from four
1286 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1289 LongRunAvgLatency false
1290 ConvertSpecialMetricTypes true
1292 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1295 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1298 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1301 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1305 The ceph plugin accepts the following configuration options:
1309 =item B<LongRunAvgLatency> B<true>|B<false>
1311 If enabled, latency values(sum,count pairs) are calculated as the long run
1312 average - average since the ceph daemon was started = (sum / count).
1313 When disabled, latency values are calculated as the average since the last
1314 collection = (sum_now - sum_last) / (count_now - count_last).
1318 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1320 If enabled, special metrics (metrics that differ in type from similar counters)
1321 are converted to the type of those similar counters. This currently only
1322 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1323 ceph schema reports this metric type as a sum,count pair while similar counters
1324 are treated as derive types. When converted, the sum is used as the counter
1325 value and is treated as a derive type.
1326 When disabled, all metrics are treated as the types received from the ceph schema.
1332 Each B<Daemon> block must have a string argument for the plugin instance name.
1333 A B<SocketPath> is also required for each B<Daemon> block:
1337 =item B<Daemon> I<DaemonName>
1339 Name to be used as the instance name for this daemon.
1341 =item B<SocketPath> I<SocketPath>
1343 Specifies the path to the UNIX admin socket of the ceph daemon.
1347 =head2 Plugin C<cgroups>
1349 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1350 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1351 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1355 =item B<CGroup> I<Directory>
1357 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1358 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1361 See F</"IGNORELISTS"> for details.
1363 =item B<IgnoreSelected> B<true>|B<false>
1365 Invert the selection: If set to true, all cgroups I<except> the ones that
1366 match any one of the criteria are collected. By default only selected
1367 cgroups are collected if a selection is made. If no selection is configured
1368 at all, B<all> cgroups are selected.
1372 =head2 Plugin C<chrony>
1374 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1375 skew and per-peer stratum.
1377 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1380 Available configuration options for the C<chrony> plugin:
1384 =item B<Host> I<Hostname>
1386 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1388 =item B<Port> I<Port>
1390 UDP-Port to connect to. Defaults to B<323>.
1392 =item B<Timeout> I<Timeout>
1394 Connection timeout in seconds. Defaults to B<2>.
1398 =head2 Plugin C<conntrack>
1400 This plugin collects IP conntrack statistics.
1406 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1407 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1411 =head2 Plugin C<cpu>
1413 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1414 as Jiffies, using the C<cpu> type. Two aggregations are available:
1420 Sum, per-state, over all CPUs installed in the system; and
1424 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1428 The two aggregations can be combined, leading to I<collectd> only emitting a
1429 single "active" metric for the entire system. As soon as one of these
1430 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1431 rather than Jiffies. In addition, you can request individual, per-state,
1432 per-CPU metrics to be reported as percentage.
1434 The following configuration options are available:
1438 =item B<ReportByState> B<true>|B<false>
1440 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1442 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1445 =item B<ReportByCpu> B<true>|B<false>
1447 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1448 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1449 global sum of CPU states is emitted.
1451 =item B<ValuesPercentage> B<false>|B<true>
1453 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1454 are set to B<true>. In this case, by default, metrics will be reported as
1455 Jiffies. By setting this option to B<true>, you can request percentage values
1456 in the un-aggregated (per-CPU, per-state) mode as well.
1458 =item B<ReportNumCpu> B<false>|B<true>
1460 When set to B<true>, reports the number of available CPUs.
1461 Defaults to B<false>.
1465 =head2 Plugin C<cpufreq>
1467 This plugin doesn't have any options. It reads
1468 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1469 installed) to get the current CPU frequency. If this file does not exist make
1470 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1471 installed and an "cpu governor" (that's a kernel module) is loaded.
1473 =head2 Plugin C<cpusleep>
1475 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1476 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1477 BOOTTIME clock increments while device is suspended and MONOTONIC
1478 clock does not, the derivative of the difference between these clocks
1479 gives the relative amount of time the device has spent in suspend
1480 state. The recorded value is in milliseconds of sleep per seconds of
1483 =head2 Plugin C<csv>
1487 =item B<DataDir> I<Directory>
1489 Set the directory to store CSV-files under. Per default CSV-files are generated
1490 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1491 The special strings B<stdout> and B<stderr> can be used to write to the standard
1492 output and standard error channels, respectively. This, of course, only makes
1493 much sense when collectd is running in foreground- or non-daemon-mode.
1495 =item B<StoreRates> B<true|false>
1497 If set to B<true>, convert counter values to rates. If set to B<false> (the
1498 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1503 =head2 cURL Statistics
1505 All cURL-based plugins support collection of generic, request-based
1506 statistics. These are disabled by default and can be enabled selectively for
1507 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1508 the documentation of those plugins for specific information. This section
1509 describes the available metrics that can be configured for each plugin. All
1510 options are disabled by default.
1512 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1516 =item B<TotalTime> B<true|false>
1518 Total time of the transfer, including name resolving, TCP connect, etc.
1520 =item B<NamelookupTime> B<true|false>
1522 Time it took from the start until name resolving was completed.
1524 =item B<ConnectTime> B<true|false>
1526 Time it took from the start until the connect to the remote host (or proxy)
1529 =item B<AppconnectTime> B<true|false>
1531 Time it took from the start until the SSL/SSH connect/handshake to the remote
1534 =item B<PretransferTime> B<true|false>
1536 Time it took from the start until just before the transfer begins.
1538 =item B<StarttransferTime> B<true|false>
1540 Time it took from the start until the first byte was received.
1542 =item B<RedirectTime> B<true|false>
1544 Time it took for all redirection steps include name lookup, connect,
1545 pre-transfer and transfer before final transaction was started.
1547 =item B<RedirectCount> B<true|false>
1549 The total number of redirections that were actually followed.
1551 =item B<SizeUpload> B<true|false>
1553 The total amount of bytes that were uploaded.
1555 =item B<SizeDownload> B<true|false>
1557 The total amount of bytes that were downloaded.
1559 =item B<SpeedDownload> B<true|false>
1561 The average download speed that curl measured for the complete download.
1563 =item B<SpeedUpload> B<true|false>
1565 The average upload speed that curl measured for the complete upload.
1567 =item B<HeaderSize> B<true|false>
1569 The total size of all the headers received.
1571 =item B<RequestSize> B<true|false>
1573 The total size of the issued requests.
1575 =item B<ContentLengthDownload> B<true|false>
1577 The content-length of the download.
1579 =item B<ContentLengthUpload> B<true|false>
1581 The specified size of the upload.
1583 =item B<NumConnects> B<true|false>
1585 The number of new connections that were created to achieve the transfer.
1589 =head2 Plugin C<curl>
1591 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1592 and the match infrastructure (the same code used by the tail plugin) to use
1593 regular expressions with the received data.
1595 The following example will read the current value of AMD stock from Google's
1596 finance page and dispatch the value to collectd.
1599 <Page "stock_quotes">
1600 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1606 CACert "/path/to/ca.crt"
1607 Header "X-Custom-Header: foobar"
1610 MeasureResponseTime false
1611 MeasureResponseCode false
1614 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1615 DSType "GaugeAverage"
1616 # Note: `stock_value' is not a standard type.
1623 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1624 a web page and one or more "matches" to be performed on the returned data. The
1625 string argument to the B<Page> block is used as plugin instance.
1627 The following options are valid within B<Page> blocks:
1633 URL of the web site to retrieve. Since a regular expression will be used to
1634 extract information from this data, non-binary data is a big plus here ;)
1636 =item B<User> I<Name>
1638 Username to use if authorization is required to read the page.
1640 =item B<Password> I<Password>
1642 Password to use if authorization is required to read the page.
1644 =item B<Digest> B<true>|B<false>
1646 Enable HTTP digest authentication.
1648 =item B<VerifyPeer> B<true>|B<false>
1650 Enable or disable peer SSL certificate verification. See
1651 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1653 =item B<VerifyHost> B<true>|B<false>
1655 Enable or disable peer host name verification. If enabled, the plugin checks if
1656 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1657 matches the host name provided by the B<URL> option. If this identity check
1658 fails, the connection is aborted. Obviously, only works when connecting to a
1659 SSL enabled server. Enabled by default.
1661 =item B<CACert> I<file>
1663 File that holds one or more SSL certificates. If you want to use HTTPS you will
1664 possibly need this option. What CA certificates come bundled with C<libcurl>
1665 and are checked by default depends on the distribution you use.
1667 =item B<Header> I<Header>
1669 A HTTP header to add to the request. Multiple headers are added if this option
1670 is specified more than once.
1672 =item B<Post> I<Body>
1674 Specifies that the HTTP operation should be a POST instead of a GET. The
1675 complete data to be posted is given as the argument. This option will usually
1676 need to be accompanied by a B<Header> option to set an appropriate
1677 C<Content-Type> for the post body (e.g. to
1678 C<application/x-www-form-urlencoded>).
1680 =item B<MeasureResponseTime> B<true>|B<false>
1682 Measure response time for the request. If this setting is enabled, B<Match>
1683 blocks (see below) are optional. Disabled by default.
1685 Beware that requests will get aborted if they take too long to complete. Adjust
1686 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1689 This option is similar to enabling the B<TotalTime> statistic but it's
1690 measured by collectd instead of cURL.
1692 =item B<MeasureResponseCode> B<true>|B<false>
1694 Measure response code for the request. If this setting is enabled, B<Match>
1695 blocks (see below) are optional. Disabled by default.
1697 =item B<E<lt>StatisticsE<gt>>
1699 One B<Statistics> block can be used to specify cURL statistics to be collected
1700 for each request to the remote web site. See the section "cURL Statistics"
1701 above for details. If this setting is enabled, B<Match> blocks (see below) are
1704 =item B<E<lt>MatchE<gt>>
1706 One or more B<Match> blocks that define how to match information in the data
1707 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1708 used by the C<tail> plugin, so please see the documentation of the C<tail>
1709 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1710 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1713 =item B<Timeout> I<Milliseconds>
1715 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1716 milliseconds. By default, the configured B<Interval> is used to set the
1717 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1718 indefinitely. This legacy behaviour can be achieved by setting the value of
1721 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1722 network connection will stall one read thread. Adjust the B<ReadThreads> global
1723 setting accordingly to prevent this from blocking other plugins.
1727 =head2 Plugin C<curl_json>
1729 The B<curl_json plugin> collects values from JSON data to be parsed by
1730 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1731 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1732 unix socket. The former can be used, for example, to collect values
1733 from CouchDB documents (which are stored JSON notation), and the
1734 latter to collect values from a uWSGI stats socket.
1736 The following example will collect several values from the built-in
1737 C<_stats> runtime statistics module of I<CouchDB>
1738 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1741 <URL "http://localhost:5984/_stats">
1743 <Key "httpd/requests/count">
1744 Type "http_requests"
1747 <Key "httpd_request_methods/*/count">
1748 Type "http_request_methods"
1751 <Key "httpd_status_codes/*/count">
1752 Type "http_response_codes"
1757 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1760 <Sock "/var/run/uwsgi.stats.sock">
1762 <Key "workers/*/requests">
1763 Type "http_requests"
1766 <Key "workers/*/apps/*/requests">
1767 Type "http_requests"
1772 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1773 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1774 blocks defining a unix socket to read JSON from directly. Each of
1775 these blocks may have one or more B<Key> blocks.
1777 The B<Key> string argument must be in a path format. Each component is
1778 used to match the key from a JSON map or the index of an JSON
1779 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1780 values for all map keys or array indices will be collectd.
1782 The following options are valid within B<URL> blocks:
1786 =item B<Host> I<Name>
1788 Use I<Name> as the host name when submitting values. Defaults to the global
1791 =item B<Instance> I<Instance>
1793 Sets the plugin instance to I<Instance>.
1795 =item B<Interval> I<Interval>
1797 Sets the interval (in seconds) in which the values will be collected from this
1798 URL. By default the global B<Interval> setting will be used.
1800 =item B<User> I<Name>
1802 =item B<Password> I<Password>
1804 =item B<Digest> B<true>|B<false>
1806 =item B<VerifyPeer> B<true>|B<false>
1808 =item B<VerifyHost> B<true>|B<false>
1810 =item B<CACert> I<file>
1812 =item B<Header> I<Header>
1814 =item B<Post> I<Body>
1816 =item B<Timeout> I<Milliseconds>
1818 These options behave exactly equivalent to the appropriate options of the
1819 I<cURL> plugin. Please see there for a detailed description.
1821 =item B<E<lt>StatisticsE<gt>>
1823 One B<Statistics> block can be used to specify cURL statistics to be collected
1824 for each request to the remote URL. See the section "cURL Statistics" above
1829 The following options are valid within B<Key> blocks:
1833 =item B<Type> I<Type>
1835 Sets the type used to dispatch the values to the daemon. Detailed information
1836 about types and their configuration can be found in L<types.db(5)>. This
1837 option is mandatory.
1839 =item B<Instance> I<Instance>
1841 Type-instance to use. Defaults to the current map key or current string array element value.
1845 =head2 Plugin C<curl_xml>
1847 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1848 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1851 <URL "http://localhost/stats.xml">
1853 Instance "some_instance"
1858 CACert "/path/to/ca.crt"
1859 Header "X-Custom-Header: foobar"
1862 <XPath "table[@id=\"magic_level\"]/tr">
1864 #InstancePrefix "prefix-"
1865 InstanceFrom "td[1]"
1866 ValuesFrom "td[2]/span[@class=\"level\"]"
1871 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1872 URL to be fetched using libcurl. Within each B<URL> block there are
1873 options which specify the connection parameters, for example authentication
1874 information, and one or more B<XPath> blocks.
1876 Each B<XPath> block specifies how to get one type of information. The
1877 string argument must be a valid XPath expression which returns a list
1878 of "base elements". One value is dispatched for each "base element". The
1879 I<type instance> and values are looked up using further I<XPath> expressions
1880 that should be relative to the base element.
1882 Within the B<URL> block the following options are accepted:
1886 =item B<Host> I<Name>
1888 Use I<Name> as the host name when submitting values. Defaults to the global
1891 =item B<Instance> I<Instance>
1893 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1894 empty string (no plugin instance).
1896 =item B<Namespace> I<Prefix> I<URL>
1898 If an XPath expression references namespaces, they must be specified
1899 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1900 I<URL> is the "namespace name", an URI reference uniquely identifying the
1901 namespace. The option can be repeated to register multiple namespaces.
1905 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1906 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1908 =item B<User> I<User>
1910 =item B<Password> I<Password>
1912 =item B<Digest> B<true>|B<false>
1914 =item B<VerifyPeer> B<true>|B<false>
1916 =item B<VerifyHost> B<true>|B<false>
1918 =item B<CACert> I<CA Cert File>
1920 =item B<Header> I<Header>
1922 =item B<Post> I<Body>
1924 =item B<Timeout> I<Milliseconds>
1926 These options behave exactly equivalent to the appropriate options of the
1927 I<cURL plugin>. Please see there for a detailed description.
1929 =item B<E<lt>StatisticsE<gt>>
1931 One B<Statistics> block can be used to specify cURL statistics to be collected
1932 for each request to the remote URL. See the section "cURL Statistics" above
1935 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1937 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1938 B<XPath> block specifies how to get one type of information. The string
1939 argument must be a valid XPath expression which returns a list of "base
1940 elements". One value is dispatched for each "base element".
1942 Within the B<XPath> block the following options are accepted:
1946 =item B<Type> I<Type>
1948 Specifies the I<Type> used for submitting patches. This determines the number
1949 of values that are required / expected and whether the strings are parsed as
1950 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1951 This option is required.
1953 =item B<InstancePrefix> I<InstancePrefix>
1955 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1956 concatenated together without any separator.
1957 This option is optional.
1959 =item B<InstanceFrom> I<InstanceFrom>
1961 Specifies a XPath expression to use for determining the I<type instance>. The
1962 XPath expression must return exactly one element. The element's value is then
1963 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1965 This value is required. As a special exception, if the "base XPath expression"
1966 (the argument to the B<XPath> block) returns exactly one argument, then this
1967 option may be omitted.
1969 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1971 Specifies one or more XPath expression to use for reading the values. The
1972 number of XPath expressions must match the number of data sources in the
1973 I<type> specified with B<Type> (see above). Each XPath expression must return
1974 exactly one element. The element's value is then parsed as a number and used as
1975 value for the appropriate value in the value list dispatched to the daemon.
1981 =head2 Plugin C<dbi>
1983 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1984 connect to various databases, execute I<SQL> statements and read back the
1985 results. I<dbi> is an acronym for "database interface" in case you were
1986 wondering about the name. You can configure how each column is to be
1987 interpreted and the plugin will generate one or more data sets from each row
1988 returned according to these rules.
1990 Because the plugin is very generic, the configuration is a little more complex
1991 than those of other plugins. It usually looks something like this:
1994 <Query "out_of_stock">
1995 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1996 # Use with MySQL 5.0.0 or later
2000 InstancePrefix "out_of_stock"
2001 InstancesFrom "category"
2005 <Database "product_information">
2008 DriverOption "host" "localhost"
2009 DriverOption "username" "collectd"
2010 DriverOption "password" "aZo6daiw"
2011 DriverOption "dbname" "prod_info"
2012 SelectDB "prod_info"
2013 Query "out_of_stock"
2017 The configuration above defines one query with one result and one database. The
2018 query is then linked to the database with the B<Query> option I<within> the
2019 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2020 and you can also use the B<Include> statement to split up the configuration
2021 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2022 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2025 The following is a complete list of options:
2027 =head3 B<Query> blocks
2029 Query blocks define I<SQL> statements and how the returned data should be
2030 interpreted. They are identified by the name that is given in the opening line
2031 of the block. Thus the name needs to be unique. Other than that, the name is
2032 not used in collectd.
2034 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2035 define which column holds which value or instance information. You can use
2036 multiple B<Result> blocks to create multiple values from one returned row. This
2037 is especially useful, when queries take a long time and sending almost the same
2038 query again and again is not desirable.
2042 <Query "environment">
2043 Statement "select station, temperature, humidity from environment"
2046 # InstancePrefix "foo"
2047 InstancesFrom "station"
2048 ValuesFrom "temperature"
2052 InstancesFrom "station"
2053 ValuesFrom "humidity"
2057 The following options are accepted:
2061 =item B<Statement> I<SQL>
2063 Sets the statement that should be executed on the server. This is B<not>
2064 interpreted by collectd, but simply passed to the database server. Therefore,
2065 the SQL dialect that's used depends on the server collectd is connected to.
2067 The query has to return at least two columns, one for the instance and one
2068 value. You cannot omit the instance, even if the statement is guaranteed to
2069 always return exactly one line. In that case, you can usually specify something
2072 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2074 (That works with MySQL but may not be valid SQL according to the spec. If you
2075 use a more strict database server, you may have to select from a dummy table or
2078 Please note that some databases, for example B<Oracle>, will fail if you
2079 include a semicolon at the end of the statement.
2081 =item B<MinVersion> I<Version>
2083 =item B<MaxVersion> I<Value>
2085 Only use this query for the specified database version. You can use these
2086 options to provide multiple queries with the same name but with a slightly
2087 different syntax. The plugin will use only those queries, where the specified
2088 minimum and maximum versions fit the version of the database in use.
2090 The database version is determined by C<dbi_conn_get_engine_version>, see the
2091 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2092 for details. Basically, each part of the version is assumed to be in the range
2093 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2094 "40102", version "5.0.42" becomes "50042".
2096 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2097 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2098 happen. Don't to it! A valid example would be something along these lines:
2109 In the above example, there are three ranges that don't overlap. The last one
2110 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2111 before "4.0.0" are not specified.
2113 =item B<Type> I<Type>
2115 The B<type> that's used for each line returned. See L<types.db(5)> for more
2116 details on how types are defined. In short: A type is a predefined layout of
2117 data and the number of values and type of values has to match the type
2120 If you specify "temperature" here, you need exactly one gauge column. If you
2121 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2124 There must be exactly one B<Type> option inside each B<Result> block.
2126 =item B<InstancePrefix> I<prefix>
2128 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2129 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2130 all strings returned in the appropriate columns are concatenated together,
2131 separated by dashes I<("-")>.
2133 =item B<InstancesFrom> I<column0> [I<column1> ...]
2135 Specifies the columns whose values will be used to create the "type-instance"
2136 for each row. If you specify more than one column, the value of all columns
2137 will be joined together with dashes I<("-")> as separation characters.
2139 The plugin itself does not check whether or not all built instances are
2140 different. It's your responsibility to assure that each is unique. This is
2141 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2142 sure that only one row is returned in this case.
2144 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2147 =item B<ValuesFrom> I<column0> [I<column1> ...]
2149 Names the columns whose content is used as the actual data for the data sets
2150 that are dispatched to the daemon. How many such columns you need is determined
2151 by the B<Type> setting above. If you specify too many or not enough columns,
2152 the plugin will complain about that and no data will be submitted to the
2155 The actual data type in the columns is not that important. The plugin will
2156 automatically cast the values to the right type if it know how to do that. So
2157 it should be able to handle integer an floating point types, as well as strings
2158 (if they include a number at the beginning).
2160 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2162 =item B<MetadataFrom> [I<column0> I<column1> ...]
2164 Names the columns whose content is used as metadata for the data sets
2165 that are dispatched to the daemon.
2167 The actual data type in the columns is not that important. The plugin will
2168 automatically cast the values to the right type if it know how to do that. So
2169 it should be able to handle integer an floating point types, as well as strings
2170 (if they include a number at the beginning).
2174 =head3 B<Database> blocks
2176 Database blocks define a connection to a database and which queries should be
2177 sent to that database. Since the used "dbi" library can handle a wide variety
2178 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2179 documentationE<nbsp>- we stick as close to the terminology used there.
2181 Each database needs a "name" as string argument in the starting tag of the
2182 block. This name will be used as "PluginInstance" in the values submitted to
2183 the daemon. Other than that, that name is not used.
2187 =item B<Interval> I<Interval>
2189 Sets the interval (in seconds) in which the values will be collected from this
2190 database. By default the global B<Interval> setting will be used.
2192 =item B<Driver> I<Driver>
2194 Specifies the driver to use to connect to the database. In many cases those
2195 drivers are named after the database they can connect to, but this is not a
2196 technical necessity. These drivers are sometimes referred to as "DBD",
2197 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2198 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2199 project at L<http://libdbi-drivers.sourceforge.net/>.
2201 You need to give the driver name as expected by the "dbi" library here. You
2202 should be able to find that in the documentation for each driver. If you
2203 mistype the driver name, the plugin will dump a list of all known driver names
2206 =item B<DriverOption> I<Key> I<Value>
2208 Sets driver-specific options. What option a driver supports can be found in the
2209 documentation for each driver, somewhere at
2210 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2211 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2213 DBDs can register two types of options: String options and numeric options. The
2214 plugin will use the C<dbi_conn_set_option> function when the configuration
2215 provides a string and the C<dbi_conn_require_option_numeric> function when the
2216 configuration provides a number. So these two lines will actually result in
2217 different calls being used:
2219 DriverOption "Port" 1234 # numeric
2220 DriverOption "Port" "1234" # string
2222 Unfortunately, drivers are not too keen to report errors when an unknown option
2223 is passed to them, so invalid settings here may go unnoticed. This is not the
2224 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2225 the driver. If a driver complains about an option, the plugin will dump a
2226 complete list of all options understood by that driver to the log. There is no
2227 way to programmatically find out if an option expects a string or a numeric
2228 argument, so you will have to refer to the appropriate DBD's documentation to
2229 find this out. Sorry.
2231 =item B<SelectDB> I<Database>
2233 In some cases, the database name you connect with is not the database name you
2234 want to use for querying data. If this option is set, the plugin will "select"
2235 (switch to) that database after the connection is established.
2237 =item B<Query> I<QueryName>
2239 Associates the query named I<QueryName> with this database connection. The
2240 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2241 blocks you want to refer to must be placed above the database block you want to
2244 =item B<Host> I<Hostname>
2246 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2247 values. Defaults to the global hostname setting.
2255 =item B<Device> I<Device>
2257 Select partitions based on the devicename.
2259 See F</"IGNORELISTS"> for details.
2261 =item B<MountPoint> I<Directory>
2263 Select partitions based on the mountpoint.
2265 See F</"IGNORELISTS"> for details.
2267 =item B<FSType> I<FSType>
2269 Select partitions based on the filesystem type.
2271 See F</"IGNORELISTS"> for details.
2273 =item B<IgnoreSelected> B<true>|B<false>
2275 Invert the selection: If set to true, all partitions B<except> the ones that
2276 match any one of the criteria are collected. By default only selected
2277 partitions are collected if a selection is made. If no selection is configured
2278 at all, B<all> partitions are selected.
2280 =item B<ReportByDevice> B<true>|B<false>
2282 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2283 (the default), it will report a disk as "root", but with it I<true>, it will be
2284 "sda1" (or whichever).
2286 =item B<ReportInodes> B<true>|B<false>
2288 Enables or disables reporting of free, reserved and used inodes. Defaults to
2289 inode collection being disabled.
2291 Enable this option if inodes are a scarce resource for you, usually because
2292 many small files are stored on the disk. This is a usual scenario for mail
2293 transfer agents and web caches.
2295 =item B<ValuesAbsolute> B<true>|B<false>
2297 Enables or disables reporting of free and used disk space in 1K-blocks.
2298 Defaults to B<true>.
2300 =item B<ValuesPercentage> B<false>|B<true>
2302 Enables or disables reporting of free and used disk space in percentage.
2303 Defaults to B<false>.
2305 This is useful for deploying I<collectd> on the cloud, where machines with
2306 different disk size may exist. Then it is more practical to configure
2307 thresholds based on relative disk size.
2311 =head2 Plugin C<disk>
2313 The C<disk> plugin collects information about the usage of physical disks and
2314 logical disks (partitions). Values collected are the number of octets written
2315 to and read from a disk or partition, the number of read/write operations
2316 issued to the disk and a rather complex "time" it took for these commands to be
2319 Using the following two options you can ignore some disks or configure the
2320 collection only of specific disks.
2324 =item B<Disk> I<Name>
2326 Select the disk I<Name>. Whether it is collected or ignored depends on the
2327 B<IgnoreSelected> setting, see below. As with other plugins that use the
2328 daemon's ignorelist functionality, a string that starts and ends with a slash
2329 is interpreted as a regular expression. Examples:
2334 See F</"IGNORELISTS"> for details.
2336 =item B<IgnoreSelected> B<true>|B<false>
2338 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2339 statements, are ignored or if all other disks are ignored. The behavior
2340 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2341 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2342 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2343 is set to B<true>, all disks are collected B<except> the ones matched.
2345 =item B<UseBSDName> B<true>|B<false>
2347 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2348 default major/minor numbers. Requires collectd to be built with Apple's
2351 =item B<UdevNameAttr> I<Attribute>
2353 Attempt to override disk instance name with the value of a specified udev
2354 attribute when built with B<libudev>. If the attribute is not defined for the
2355 given device, the default name is used. Example:
2357 UdevNameAttr "DM_NAME"
2361 =head2 Plugin C<dns>
2365 =item B<Interface> I<Interface>
2367 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2368 option sets the interface that should be used. If this option is not set, or
2369 set to "any", the plugin will try to get packets from B<all> interfaces. This
2370 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2372 =item B<IgnoreSource> I<IP-address>
2374 Ignore packets that originate from this address.
2376 =item B<SelectNumericQueryTypes> B<true>|B<false>
2378 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2382 =head2 Plugin C<email>
2386 =item B<SocketFile> I<Path>
2388 Sets the socket-file which is to be created.
2390 =item B<SocketGroup> I<Group>
2392 If running as root change the group of the UNIX-socket after it has been
2393 created. Defaults to B<collectd>.
2395 =item B<SocketPerms> I<Permissions>
2397 Change the file permissions of the UNIX-socket after it has been created. The
2398 permissions must be given as a numeric, octal value as you would pass to
2399 L<chmod(1)>. Defaults to B<0770>.
2401 =item B<MaxConns> I<Number>
2403 Sets the maximum number of connections that can be handled in parallel. Since
2404 this many threads will be started immediately setting this to a very high
2405 value will waste valuable resources. Defaults to B<5> and will be forced to be
2406 at most B<16384> to prevent typos and dumb mistakes.
2410 =head2 Plugin C<ethstat>
2412 The I<ethstat plugin> collects information about network interface cards (NICs)
2413 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2419 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2420 Map "multicast" "if_multicast"
2427 =item B<Interface> I<Name>
2429 Collect statistical information about interface I<Name>.
2431 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2433 By default, the plugin will submit values as type C<derive> and I<type
2434 instance> set to I<Name>, the name of the metric as reported by the driver. If
2435 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2436 I<TypeInstance> will be used.
2438 =item B<MappedOnly> B<true>|B<false>
2440 When set to B<true>, only metrics that can be mapped to a I<type> will be
2441 collected, all other metrics will be ignored. Defaults to B<false>.
2445 =head2 Plugin C<exec>
2447 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2448 contains valuable information on when the executable is executed and the
2449 output that is expected from it.
2453 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2455 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2457 Execute the executable I<Executable> as user I<User>. If the user name is
2458 followed by a colon and a group name, the effective group is set to that group.
2459 The real group and saved-set group will be set to the default group of that
2460 user. If no group is given the effective group ID will be the same as the real
2463 Please note that in order to change the user and/or group the daemon needs
2464 superuser privileges. If the daemon is run as an unprivileged user you must
2465 specify the same user/group here. If the daemon is run with superuser
2466 privileges, you must supply a non-root user here.
2468 The executable may be followed by optional arguments that are passed to the
2469 program. Please note that due to the configuration parsing numbers and boolean
2470 values may be changed. If you want to be absolutely sure that something is
2471 passed as-is please enclose it in quotes.
2473 The B<Exec> and B<NotificationExec> statements change the semantics of the
2474 programs executed, i.E<nbsp>e. the data passed to them and the response
2475 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2479 =head2 Plugin C<fhcount>
2481 The C<fhcount> plugin provides statistics about used, unused and total number of
2482 file handles on Linux.
2484 The I<fhcount plugin> provides the following configuration options:
2488 =item B<ValuesAbsolute> B<true>|B<false>
2490 Enables or disables reporting of file handles usage in absolute numbers,
2491 e.g. file handles used. Defaults to B<true>.
2493 =item B<ValuesPercentage> B<false>|B<true>
2495 Enables or disables reporting of file handles usage in percentages, e.g.
2496 percent of file handles used. Defaults to B<false>.
2500 =head2 Plugin C<filecount>
2502 The C<filecount> plugin counts the number of files in a certain directory (and
2503 its subdirectories) and their combined size. The configuration is very straight
2506 <Plugin "filecount">
2507 <Directory "/var/qmail/queue/mess">
2508 Instance "qmail-message"
2510 <Directory "/var/qmail/queue/todo">
2511 Instance "qmail-todo"
2513 <Directory "/var/lib/php5">
2514 Instance "php5-sessions"
2519 The example above counts the number of files in QMail's queue directories and
2520 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2521 QMail has not yet looked at, the "message" queue holds the messages that were
2522 classified into "local" and "remote".
2524 As you can see, the configuration consists of one or more C<Directory> blocks,
2525 each of which specifies a directory in which to count the files. Within those
2526 blocks, the following options are recognized:
2530 =item B<Instance> I<Instance>
2532 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2533 it's your responsibility, the plugin doesn't check for that. If not given, the
2534 instance is set to the directory name with all slashes replaced by underscores
2535 and all leading underscores removed.
2537 =item B<Name> I<Pattern>
2539 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2540 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2541 against the pattern, not the entire path. In case this makes it easier for you:
2542 This option has been named after the B<-name> parameter to L<find(1)>.
2544 =item B<MTime> I<Age>
2546 Count only files of a specific age: If I<Age> is greater than zero, only files
2547 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2548 a negative number, this is inversed. For example, if B<-60> is specified, only
2549 files that have been modified in the last minute will be counted.
2551 The number can also be followed by a "multiplier" to easily specify a larger
2552 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2553 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2554 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2555 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2556 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2559 =item B<Size> I<Size>
2561 Count only files of a specific size. When I<Size> is a positive number, only
2562 files that are at least this big are counted. If I<Size> is a negative number,
2563 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2564 I<Size> are counted.
2566 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2567 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2568 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2569 note that there are 1000 bytes in a kilobyte, not 1024.
2571 =item B<Recursive> I<true>|I<false>
2573 Controls whether or not to recurse into subdirectories. Enabled by default.
2575 =item B<IncludeHidden> I<true>|I<false>
2577 Controls whether or not to include "hidden" files and directories in the count.
2578 "Hidden" files and directories are those, whose name begins with a dot.
2579 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2583 =head2 Plugin C<GenericJMX>
2585 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2586 L<collectd-java(5)>.
2588 =head2 Plugin C<gmond>
2590 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2591 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2592 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2597 MCReceiveFrom "239.2.11.71" "8649"
2598 <Metric "swap_total">
2600 TypeInstance "total"
2603 <Metric "swap_free">
2610 The following metrics are built-in:
2616 load_one, load_five, load_fifteen
2620 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2624 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2636 Available configuration options:
2640 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2642 Sets sets the multicast group and UDP port to which to subscribe.
2644 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2646 =item E<lt>B<Metric> I<Name>E<gt>
2648 These blocks add a new metric conversion to the internal table. I<Name>, the
2649 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2653 =item B<Type> I<Type>
2655 Type to map this metric to. Required.
2657 =item B<TypeInstance> I<Instance>
2659 Type-instance to use. Optional.
2661 =item B<DataSource> I<Name>
2663 Data source to map this metric to. If the configured type has exactly one data
2664 source, this is optional. Otherwise the option is required.
2670 =head2 Plugin C<gps>
2672 The C<gps plugin> connects to gpsd on the host machine.
2673 The host, port, timeout and pause are configurable.
2675 This is useful if you run an NTP server using a GPS for source and you want to
2678 Mind your GPS must send $--GSA for having the data reported!
2680 The following elements are collected:
2686 Number of satellites used for fix (type instance "used") and in view (type
2687 instance "visible"). 0 means no GPS satellites are visible.
2689 =item B<dilution_of_precision>
2691 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2692 It should be between 0 and 3.
2693 Look at the documentation of your GPS to know more.
2701 # Connect to localhost on gpsd regular port:
2706 # PauseConnect of 5 sec. between connection attempts.
2710 Available configuration options:
2714 =item B<Host> I<Host>
2716 The host on which gpsd daemon runs. Defaults to B<localhost>.
2718 =item B<Port> I<Port>
2720 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2722 =item B<Timeout> I<Seconds>
2724 Timeout in seconds (default 0.015 sec).
2726 The GPS data stream is fetch by the plugin form the daemon.
2727 It waits for data to be available, if none arrives it times out
2728 and loop for another reading.
2729 Mind to put a low value gpsd expects value in the micro-seconds area
2730 (recommended is 500 us) since the waiting function is blocking.
2731 Value must be between 500 us and 5 sec., if outside that range the
2732 default value is applied.
2734 This only applies from gpsd release-2.95.
2736 =item B<PauseConnect> I<Seconds>
2738 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
2742 =head2 Plugin C<grpc>
2744 The I<grpc> plugin provides an RPC interface to submit values to or query
2745 values from collectd based on the open source gRPC framework. It exposes an
2746 end-point for dispatching values to the daemon.
2748 The B<gRPC> homepage can be found at L<https://grpc.io/>.
2752 =item B<Server> I<Host> I<Port>
2754 The B<Server> statement sets the address of a server to which to send metrics
2755 via the C<DispatchValues> function.
2757 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2759 Optionally, B<Server> may be specified as a configuration block which supports
2760 the following options:
2764 =item B<EnableSSL> B<false>|B<true>
2766 Whether to require SSL for outgoing connections. Default: false.
2768 =item B<SSLCACertificateFile> I<Filename>
2770 =item B<SSLCertificateFile> I<Filename>
2772 =item B<SSLCertificateKeyFile> I<Filename>
2774 Filenames specifying SSL certificate and key material to be used with SSL
2779 =item B<Listen> I<Host> I<Port>
2781 The B<Listen> statement sets the network address to bind to. When multiple
2782 statements are specified, the daemon will bind to all of them. If none are
2783 specified, it defaults to B<0.0.0.0:50051>.
2785 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2787 Optionally, B<Listen> may be specified as a configuration block which
2788 supports the following options:
2792 =item B<EnableSSL> I<true>|I<false>
2794 Whether to enable SSL for incoming connections. Default: false.
2796 =item B<SSLCACertificateFile> I<Filename>
2798 =item B<SSLCertificateFile> I<Filename>
2800 =item B<SSLCertificateKeyFile> I<Filename>
2802 Filenames specifying SSL certificate and key material to be used with SSL
2809 =head2 Plugin C<hddtemp>
2811 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2812 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2813 default values, see below. C<hddtemp> has to be running to work correctly. If
2814 C<hddtemp> is not running timeouts may appear which may interfere with other
2817 The B<hddtemp> homepage can be found at
2818 L<http://www.guzu.net/linux/hddtemp.php>.
2822 =item B<Host> I<Hostname>
2824 Hostname to connect to. Defaults to B<127.0.0.1>.
2826 =item B<Port> I<Port>
2828 TCP-Port to connect to. Defaults to B<7634>.
2832 =head2 Plugin C<interface>
2836 =item B<Interface> I<Interface>
2838 Select this interface. By default these interfaces will then be collected. For
2839 a more detailed description see B<IgnoreSelected> below.
2841 See F</"IGNORELISTS"> for details.
2843 =item B<IgnoreSelected> I<true>|I<false>
2845 If no configuration if given, the B<interface>-plugin will collect data from
2846 all interfaces. This may not be practical, especially for loopback- and
2847 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2848 interfaces you're interested in. Sometimes, however, it's easier/preferred
2849 to collect all interfaces I<except> a few ones. This option enables you to
2850 do that: By setting B<IgnoreSelected> to I<true> the effect of
2851 B<Interface> is inverted: All selected interfaces are ignored and all
2852 other interfaces are collected.
2854 It is possible to use regular expressions to match interface names, if the
2855 name is surrounded by I</.../> and collectd was compiled with support for
2856 regexps. This is useful if there's a need to collect (or ignore) data
2857 for a group of interfaces that are similarly named, without the need to
2858 explicitly list all of them (especially useful if the list is dynamic).
2863 Interface "/^tun[0-9]+/"
2864 IgnoreSelected "true"
2866 This will ignore the loopback interface, all interfaces with names starting
2867 with I<veth> and all interfaces with names starting with I<tun> followed by
2870 =item B<ReportInactive> I<true>|I<false>
2872 When set to I<false>, only interfaces with non-zero traffic will be
2873 reported. Note that the check is done by looking into whether a
2874 package was sent at any time from boot and the corresponding counter
2875 is non-zero. So, if the interface has been sending data in the past
2876 since boot, but not during the reported time-interval, it will still
2879 The default value is I<true> and results in collection of the data
2880 from all interfaces that are selected by B<Interface> and
2881 B<IgnoreSelected> options.
2883 =item B<UniqueName> I<true>|I<false>
2885 Interface name is not unique on Solaris (KSTAT), interface name is unique
2886 only within a module/instance. Following tuple is considered unique:
2887 (ks_module, ks_instance, ks_name)
2888 If this option is set to true, interface name contains above three fields
2889 separated by an underscore. For more info on KSTAT, visit
2890 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
2892 This option is only available on Solaris.
2896 =head2 Plugin C<ipmi>
2900 =item B<Sensor> I<Sensor>
2902 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2904 See F</"IGNORELISTS"> for details.
2906 =item B<IgnoreSelected> I<true>|I<false>
2908 If no configuration if given, the B<ipmi> plugin will collect data from all
2909 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2910 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2911 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2912 all other sensors are collected.
2914 =item B<NotifySensorAdd> I<true>|I<false>
2916 If a sensor appears after initialization time of a minute a notification
2919 =item B<NotifySensorRemove> I<true>|I<false>
2921 If a sensor disappears a notification is sent.
2923 =item B<NotifySensorNotPresent> I<true>|I<false>
2925 If you have for example dual power supply and one of them is (un)plugged then
2926 a notification is sent.
2930 =head2 Plugin C<iptables>
2934 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2936 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2938 Select the iptables/ip6tables filter rules to count packets and bytes from.
2940 If only I<Table> and I<Chain> are given, this plugin will collect the counters
2941 of all rules which have a comment-match. The comment is then used as
2944 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2945 the I<n>th rule will be collected. Again, the comment (or the number) will be
2946 used as the type-instance.
2948 If I<Name> is supplied, it will be used as the type-instance instead of the
2949 comment or the number.
2953 =head2 Plugin C<irq>
2959 Select this irq. By default these irqs will then be collected. For a more
2960 detailed description see B<IgnoreSelected> below.
2962 See F</"IGNORELISTS"> for details.
2964 =item B<IgnoreSelected> I<true>|I<false>
2966 If no configuration if given, the B<irq>-plugin will collect data from all
2967 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2968 can use the B<Irq>-option to pick the interrupt you're interested in.
2969 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2970 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2971 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2972 and all other interrupts are collected.
2976 =head2 Plugin C<java>
2978 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2979 This section only discusses the syntax and semantic of the configuration
2980 options. For more in-depth information on the I<Java> plugin, please read
2981 L<collectd-java(5)>.
2986 JVMArg "-verbose:jni"
2987 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2988 LoadPlugin "org.collectd.java.Foobar"
2989 <Plugin "org.collectd.java.Foobar">
2990 # To be parsed by the plugin
2994 Available configuration options:
2998 =item B<JVMArg> I<Argument>
3000 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3001 exactly the way the arguments to the I<java> binary on the command line work.
3002 Execute C<javaE<nbsp>--help> for details.
3004 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3005 any other options! When another option is found, the JVM will be started and
3006 later options will have to be ignored!
3008 =item B<LoadPlugin> I<JavaClass>
3010 Instantiates a new I<JavaClass> object. The constructor of this object very
3011 likely then registers one or more callback methods with the server.
3013 See L<collectd-java(5)> for details.
3015 When the first such option is found, the virtual machine (JVM) is created. This
3016 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3017 B<LoadPlugin> options!
3019 =item B<Plugin> I<Name>
3021 The entire block is passed to the Java plugin as an
3022 I<org.collectd.api.OConfigItem> object.
3024 For this to work, the plugin has to register a configuration callback first,
3025 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3026 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3027 depends on the (Java) plugin registering the callback and is completely
3028 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3032 =head2 Plugin C<load>
3034 The I<Load plugin> collects the system load. These numbers give a rough overview
3035 over the utilization of a machine. The system load is defined as the number of
3036 runnable tasks in the run-queue and is provided by many operating systems as a
3037 one, five or fifteen minute average.
3039 The following configuration options are available:
3043 =item B<ReportRelative> B<false>|B<true>
3045 When enabled, system load divided by number of available CPU cores is reported
3046 for intervals 1 min, 5 min and 15 min. Defaults to false.
3051 =head2 Plugin C<logfile>
3055 =item B<LogLevel> B<debug|info|notice|warning|err>
3057 Sets the log-level. If, for example, set to B<notice>, then all events with
3058 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3060 Please note that B<debug> is only available if collectd has been compiled with
3063 =item B<File> I<File>
3065 Sets the file to write log messages to. The special strings B<stdout> and
3066 B<stderr> can be used to write to the standard output and standard error
3067 channels, respectively. This, of course, only makes much sense when I<collectd>
3068 is running in foreground- or non-daemon-mode.
3070 =item B<Timestamp> B<true>|B<false>
3072 Prefix all lines printed by the current time. Defaults to B<true>.
3074 =item B<PrintSeverity> B<true>|B<false>
3076 When enabled, all lines are prefixed by the severity of the log message, for
3077 example "warning". Defaults to B<false>.
3081 B<Note>: There is no need to notify the daemon after moving or removing the
3082 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3083 for each line it writes.
3085 =head2 Plugin C<log_logstash>
3087 The I<log logstash plugin> behaves like the logfile plugin but formats
3088 messages as JSON events for logstash to parse and input.
3092 =item B<LogLevel> B<debug|info|notice|warning|err>
3094 Sets the log-level. If, for example, set to B<notice>, then all events with
3095 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3097 Please note that B<debug> is only available if collectd has been compiled with
3100 =item B<File> I<File>
3102 Sets the file to write log messages to. The special strings B<stdout> and
3103 B<stderr> can be used to write to the standard output and standard error
3104 channels, respectively. This, of course, only makes much sense when I<collectd>
3105 is running in foreground- or non-daemon-mode.
3109 B<Note>: There is no need to notify the daemon after moving or removing the
3110 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3111 for each line it writes.
3113 =head2 Plugin C<lpar>
3115 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3116 virtualization technique for IBM POWER processors. It takes into account CPU
3117 time stolen from or donated to a partition, in addition to the usual user,
3118 system, I/O statistics.
3120 The following configuration options are available:
3124 =item B<CpuPoolStats> B<false>|B<true>
3126 When enabled, statistics about the processor pool are read, too. The partition
3127 needs to have pool authority in order to be able to acquire this information.
3130 =item B<ReportBySerial> B<false>|B<true>
3132 If enabled, the serial of the physical machine the partition is currently
3133 running on is reported as I<hostname> and the logical hostname of the machine
3134 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3135 used (just like other plugins) and the I<plugin instance> will be empty.
3140 =head2 Plugin C<lua>
3142 This plugin embeds a Lua interpreter into collectd and provides an interface
3143 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3146 =head2 Plugin C<mbmon>
3148 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3150 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3151 B<Host> and B<Port> options can be used to change these values, see below.
3152 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3153 timeouts may appear which may interfere with other statistics..
3155 C<mbmon> must be run with the -r option ("print TAG and Value format");
3156 Debian's F</etc/init.d/mbmon> script already does this, other people
3157 will need to ensure that this is the case.
3161 =item B<Host> I<Hostname>
3163 Hostname to connect to. Defaults to B<127.0.0.1>.
3165 =item B<Port> I<Port>
3167 TCP-Port to connect to. Defaults to B<411>.
3173 The C<md plugin> collects information from Linux Software-RAID devices (md).
3175 All reported values are of the type C<md_disks>. Reported type instances are
3176 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3177 I<missing> (physically absent) disks.
3181 =item B<Device> I<Device>
3183 Select md devices based on device name. The I<device name> is the basename of
3184 the device, i.e. the name of the block device without the leading C</dev/>.
3185 See B<IgnoreSelected> for more details.
3187 See F</"IGNORELISTS"> for details.
3189 =item B<IgnoreSelected> B<true>|B<false>
3191 Invert device selection: If set to B<true>, all md devices B<except> those
3192 listed using B<Device> are collected. If B<false> (the default), only those
3193 listed are collected. If no configuration is given, the B<md> plugin will
3194 collect data from all md devices.
3198 =head2 Plugin C<memcachec>
3200 The C<memcachec plugin> connects to a memcached server, queries one or more
3201 given I<pages> and parses the returned data according to user specification.
3202 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3205 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3206 library. Please note that there is another library with a very similar name,
3207 libmemcache (notice the missing `d'), which is not applicable.
3209 Synopsis of the configuration:
3211 <Plugin "memcachec">
3212 <Page "plugin_instance">
3216 Regex "(\\d+) bytes sent"
3219 Instance "type_instance"
3224 The configuration options are:
3228 =item E<lt>B<Page> I<Name>E<gt>
3230 Each B<Page> block defines one I<page> to be queried from the memcached server.
3231 The block requires one string argument which is used as I<plugin instance>.
3233 =item B<Server> I<Address>
3235 Sets the server address to connect to when querying the page. Must be inside a
3240 When connected to the memcached server, asks for the page I<Key>.
3242 =item E<lt>B<Match>E<gt>
3244 Match blocks define which strings to look for and how matches substrings are
3245 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3249 =head2 Plugin C<memcached>
3251 The B<memcached plugin> connects to a memcached server and queries statistics
3252 about cache utilization, memory and bandwidth used.
3253 L<http://www.danga.com/memcached/>
3255 <Plugin "memcached">
3257 Host "memcache.example.com"
3262 The plugin configuration consists of one or more B<Instance> blocks which
3263 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3264 following options are allowed:
3268 =item B<Host> I<Hostname>
3270 Hostname to connect to. Defaults to B<127.0.0.1>.
3272 =item B<Port> I<Port>
3274 TCP-Port to connect to. Defaults to B<11211>.
3276 =item B<Socket> I<Path>
3278 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3279 setting is given, the B<Host> and B<Port> settings are ignored.
3283 =head2 Plugin C<mic>
3285 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3286 Intel's Many Integrated Core (MIC) systems.
3295 ShowTemperatures true
3298 IgnoreSelectedTemperature true
3303 IgnoreSelectedPower true
3306 The following options are valid inside the B<PluginE<nbsp>mic> block:
3310 =item B<ShowCPU> B<true>|B<false>
3312 If enabled (the default) a sum of the CPU usage across all cores is reported.
3314 =item B<ShowCPUCores> B<true>|B<false>
3316 If enabled (the default) per-core CPU usage is reported.
3318 =item B<ShowMemory> B<true>|B<false>
3320 If enabled (the default) the physical memory usage of the MIC system is
3323 =item B<ShowTemperatures> B<true>|B<false>
3325 If enabled (the default) various temperatures of the MIC system are reported.
3327 =item B<Temperature> I<Name>
3329 This option controls which temperatures are being reported. Whether matching
3330 temperatures are being ignored or I<only> matching temperatures are reported
3331 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3332 temperatures are reported.
3334 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3336 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3337 (the default) only temperatures matching a B<Temperature> option are reported
3338 or, if no B<Temperature> option is specified, all temperatures are reported. If
3339 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3342 Known temperature names are:
3376 =item B<ShowPower> B<true>|B<false>
3378 If enabled (the default) various temperatures of the MIC system are reported.
3380 =item B<Power> I<Name>
3382 This option controls which power readings are being reported. Whether matching
3383 power readings are being ignored or I<only> matching power readings are reported
3384 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3385 power readings are reported.
3387 =item B<IgnoreSelectedPower> B<false>|B<true>
3389 Controls the behavior of the B<Power> setting above. If set to B<false>
3390 (the default) only power readings matching a B<Power> option are reported
3391 or, if no B<Power> option is specified, all power readings are reported. If
3392 set to B<true>, matching power readings are I<ignored> and all other power readings
3395 Known power names are:
3401 Total power utilization averaged over Time Window 0 (uWatts).
3405 Total power utilization averaged over Time Window 0 (uWatts).
3409 Instantaneous power (uWatts).
3413 Max instantaneous power (uWatts).
3417 PCI-E connector power (uWatts).
3421 2x3 connector power (uWatts).
3425 2x4 connector power (uWatts).
3433 Uncore rail (uVolts).
3437 Memory subsystem rail (uVolts).
3443 =head2 Plugin C<memory>
3445 The I<memory plugin> provides the following configuration options:
3449 =item B<ValuesAbsolute> B<true>|B<false>
3451 Enables or disables reporting of physical memory usage in absolute numbers,
3452 i.e. bytes. Defaults to B<true>.
3454 =item B<ValuesPercentage> B<false>|B<true>
3456 Enables or disables reporting of physical memory usage in percentages, e.g.
3457 percent of physical memory used. Defaults to B<false>.
3459 This is useful for deploying I<collectd> in a heterogeneous environment in
3460 which the sizes of physical memory vary.
3464 =head2 Plugin C<modbus>
3466 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3467 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3468 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3469 values (two registers interpreted as IEEE floats in big endian notation).
3473 <Data "voltage-input-1">
3476 RegisterCmd ReadHolding
3481 <Data "voltage-input-2">
3484 RegisterCmd ReadHolding
3489 <Data "supply-temperature-1">
3492 RegisterCmd ReadHolding
3497 <Host "modbus.example.com">
3498 Address "192.168.0.42"
3503 Instance "power-supply"
3504 Collect "voltage-input-1"
3505 Collect "voltage-input-2"
3510 Device "/dev/ttyUSB0"
3515 Instance "temperature"
3516 Collect "supply-temperature-1"
3522 =item E<lt>B<Data> I<Name>E<gt> blocks
3524 Data blocks define a mapping between register numbers and the "types" used by
3527 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3531 =item B<RegisterBase> I<Number>
3533 Configures the base register to read from the device. If the option
3534 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3535 register will be read (the register number is increased by one).
3537 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3539 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3540 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3541 combined into one value. Defaults to B<Uint16>.
3543 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3545 Specifies register type to be collected from device. Works only with libmodbus
3546 2.9.2 or higher. Defaults to B<ReadHolding>.
3548 =item B<Type> I<Type>
3550 Specifies the "type" (data set) to use when dispatching the value to
3551 I<collectd>. Currently, only data sets with exactly one data source are
3554 =item B<Instance> I<Instance>
3556 Sets the type instance to use when dispatching the value to I<collectd>. If
3557 unset, an empty string (no type instance) is used.
3561 =item E<lt>B<Host> I<Name>E<gt> blocks
3563 Host blocks are used to specify to which hosts to connect and what data to read
3564 from their "slaves". The string argument I<Name> is used as hostname when
3565 dispatching the values to I<collectd>.
3567 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3571 =item B<Address> I<Hostname>
3573 For Modbus/TCP, specifies the node name (the actual network address) used to
3574 connect to the host. This may be an IP address or a hostname. Please note that
3575 the used I<libmodbus> library only supports IPv4 at the moment.
3577 =item B<Port> I<Service>
3579 for Modbus/TCP, specifies the port used to connect to the host. The port can
3580 either be given as a number or as a service name. Please note that the
3581 I<Service> argument must be a string, even if ports are given in their numerical
3582 form. Defaults to "502".
3584 =item B<Device> I<Devicenode>
3586 For Modbus/RTU, specifies the path to the serial device being used.
3588 =item B<Baudrate> I<Baudrate>
3590 For Modbus/RTU, specifies the baud rate of the serial device.
3591 Note, connections currently support only 8/N/1.
3593 =item B<Interval> I<Interval>
3595 Sets the interval (in seconds) in which the values will be collected from this
3596 host. By default the global B<Interval> setting will be used.
3598 =item E<lt>B<Slave> I<ID>E<gt>
3600 Over each connection, multiple Modbus devices may be reached. The slave ID
3601 is used to specify which device should be addressed. For each device you want
3602 to query, one B<Slave> block must be given.
3604 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3608 =item B<Instance> I<Instance>
3610 Specify the plugin instance to use when dispatching the values to I<collectd>.
3611 By default "slave_I<ID>" is used.
3613 =item B<Collect> I<DataName>
3615 Specifies which data to retrieve from the device. I<DataName> must be the same
3616 string as the I<Name> argument passed to a B<Data> block. You can specify this
3617 option multiple times to collect more than one value from a slave. At least one
3618 B<Collect> option is mandatory.
3626 =head2 Plugin C<mqtt>
3628 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
3629 values from MQTT (B<Subscribe> blocks).
3635 Host "mqtt.example.com"
3639 Host "mqtt.example.com"
3644 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
3645 configuring the sending and receiving direction respectively. The plugin will
3646 register a write callback named C<mqtt/I<name>> where I<name> is the string
3647 argument given to the B<Publish> block. Both types of blocks share many but not
3648 all of the following options. If an option is valid in only one of the blocks,
3649 it will be mentioned explicitly.
3655 =item B<Host> I<Hostname>
3657 Hostname of the MQTT broker to connect to.
3659 =item B<Port> I<Service>
3661 Port number or service name of the MQTT broker to connect to.
3663 =item B<User> I<UserName>
3665 Username used when authenticating to the MQTT broker.
3667 =item B<Password> I<Password>
3669 Password used when authenticating to the MQTT broker.
3671 =item B<ClientId> I<ClientId>
3673 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
3675 =item B<QoS> [B<0>-B<2>]
3677 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
3695 In B<Publish> blocks, this option determines the QoS flag set on outgoing
3696 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
3697 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
3698 on a message is larger than the maximum accepted QoS of a subscriber, the
3699 message's QoS will be downgraded.
3701 =item B<Prefix> I<Prefix> (Publish only)
3703 This plugin will use one topic per I<value list> which will looks like a path.
3704 I<Prefix> is used as the first path element and defaults to B<collectd>.
3706 An example topic name would be:
3708 collectd/cpu-0/cpu-user
3710 =item B<Retain> B<false>|B<true> (Publish only)
3712 Controls whether the MQTT broker will retain (keep a copy of) the last message
3713 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
3715 =item B<StoreRates> B<true>|B<false> (Publish only)
3717 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
3718 before sending. Defaults to B<true>.
3720 =item B<CleanSession> B<true>|B<false> (Subscribe only)
3722 Controls whether the MQTT "cleans" the session up after the subscriber
3723 disconnects or if it maintains the subscriber's subscriptions and all messages
3724 that arrive while the subscriber is disconnected. Defaults to B<true>.
3726 =item B<Topic> I<TopicName> (Subscribe only)
3728 Configures the topic(s) to subscribe to. You can use the single level C<+> and
3729 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
3730 the B<collectd> branch.
3732 =item B<CACert> I<file>
3734 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
3735 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
3736 port of the MQTT broker.
3737 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3739 =item B<CertificateFile> I<file>
3741 Path to the PEM-encoded certificate file to use as client certificate when
3742 connecting to the MQTT broker.
3743 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3745 =item B<CertificateKeyFile> I<file>
3747 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
3748 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3750 =item B<TLSProtocol> I<protocol>
3752 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
3753 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
3754 version is used which depends on the version of OpenSSL the Mosquitto library
3757 =item B<CipherSuite> I<ciphersuite>
3759 A string describing the ciphers available for use. See L<ciphers(1)> and the
3760 C<openssl ciphers> utility for more information. If unset, the default ciphers
3766 =head2 Plugin C<mysql>
3768 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3769 one or more databases when started and keeps the connection up as long as
3770 possible. When the connection is interrupted for whatever reason it will try
3771 to re-connect. The plugin will complain loudly in case anything goes wrong.
3773 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3774 and collects information about MySQL network traffic, executed statements,
3775 requests, the query cache and threads by evaluating the
3776 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3777 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3778 Status Variables> for an explanation of these values.
3780 Optionally, master and slave statistics may be collected in a MySQL
3781 replication setup. In that case, information about the synchronization state
3782 of the nodes are collected by evaluating the C<Position> return value of the
3783 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3784 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3785 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3786 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3787 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3799 SSLKey "/path/to/key.pem"
3800 SSLCert "/path/to/cert.pem"
3801 SSLCA "/path/to/ca.pem"
3802 SSLCAPath "/path/to/cas/"
3803 SSLCipher "DHE-RSA-AES256-SHA"
3809 Socket "/var/run/mysql/mysqld.sock"
3811 SlaveNotifications true
3817 Socket "/var/run/mysql/mysqld.sock"
3822 A B<Database> block defines one connection to a MySQL database. It accepts a
3823 single argument which specifies the name of the database. None of the other
3824 options are required. MySQL will use default values as documented in the
3825 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
3826 B<MySQL reference manual>.
3830 =item B<Alias> I<Alias>
3832 Alias to use as sender instead of hostname when reporting. This may be useful
3833 when having cryptic hostnames.
3835 =item B<Host> I<Hostname>
3837 Hostname of the database server. Defaults to B<localhost>.
3839 =item B<User> I<Username>
3841 Username to use when connecting to the database. The user does not have to be
3842 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3843 unless you want to collectd replication statistics (see B<MasterStats> and
3844 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3845 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3847 =item B<Password> I<Password>
3849 Password needed to log into the database.
3851 =item B<Database> I<Database>
3853 Select this database. Defaults to I<no database> which is a perfectly reasonable
3854 option for what this plugin does.
3856 =item B<Port> I<Port>
3858 TCP-port to connect to. The port must be specified in its numeric form, but it
3859 must be passed as a string nonetheless. For example:
3863 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3864 See the documentation for the C<mysql_real_connect> function for details.
3866 =item B<Socket> I<Socket>
3868 Specifies the path to the UNIX domain socket of the MySQL server. This option
3869 only has any effect, if B<Host> is set to B<localhost> (the default).
3870 Otherwise, use the B<Port> option above. See the documentation for the
3871 C<mysql_real_connect> function for details.
3873 =item B<InnodbStats> I<true|false>
3875 If enabled, metrics about the InnoDB storage engine are collected.
3876 Disabled by default.
3878 =item B<MasterStats> I<true|false>
3880 =item B<SlaveStats> I<true|false>
3882 Enable the collection of master / slave statistics in a replication setup. In
3883 order to be able to get access to these statistics, the user needs special
3884 privileges. See the B<User> documentation above. Defaults to B<false>.
3886 =item B<SlaveNotifications> I<true|false>
3888 If enabled, the plugin sends a notification if the replication slave I/O and /
3889 or SQL threads are not running. Defaults to B<false>.
3891 =item B<WsrepStats> I<true|false>
3893 Enable the collection of wsrep plugin statistics, used in Master-Master
3894 replication setups like in MySQL Galera/Percona XtraDB Cluster.
3895 User needs only privileges to execute 'SHOW GLOBAL STATUS'
3897 =item B<ConnectTimeout> I<Seconds>
3899 Sets the connect timeout for the MySQL client.
3901 =item B<SSLKey> I<Path>
3903 If provided, the X509 key in PEM format.
3905 =item B<SSLCert> I<Path>
3907 If provided, the X509 cert in PEM format.
3909 =item B<SSLCA> I<Path>
3911 If provided, the CA file in PEM format (check OpenSSL docs).
3913 =item B<SSLCAPath> I<Path>
3915 If provided, the CA directory (check OpenSSL docs).
3917 =item B<SSLCipher> I<String>
3919 If provided, the SSL cipher to use.
3923 =head2 Plugin C<netapp>
3925 The netapp plugin can collect various performance and capacity information
3926 from a NetApp filer using the NetApp API.
3928 Please note that NetApp has a wide line of products and a lot of different
3929 software versions for each of these products. This plugin was developed for a
3930 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3931 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3932 model and software version but it is very hard to test this.
3933 If you have used this plugin with other models and/or software version, feel
3934 free to send us a mail to tell us about the results, even if it's just a short
3937 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3938 basic authentication.
3940 B<Do not use a regular user for this!> Create a special collectd user with just
3941 the minimum of capabilities needed. The user only needs the "login-http-admin"
3942 capability as well as a few more depending on which data will be collected.
3943 Required capabilities are documented below.
3948 <Host "netapp1.example.com">
3972 IgnoreSelectedIO false
3974 IgnoreSelectedOps false
3975 GetLatency "volume0"
3976 IgnoreSelectedLatency false
3983 IgnoreSelectedCapacity false
3986 IgnoreSelectedSnapshot false
4014 The netapp plugin accepts the following configuration options:
4018 =item B<Host> I<Name>
4020 A host block defines one NetApp filer. It will appear in collectd with the name
4021 you specify here which does not have to be its real name nor its hostname (see
4022 the B<Address> option below).
4024 =item B<VFiler> I<Name>
4026 A B<VFiler> block may only be used inside a host block. It accepts all the
4027 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4028 will execute all NetApp API commands in the context of the specified
4029 VFiler(R). It will appear in collectd with the name you specify here which
4030 does not have to be its real name. The VFiler name may be specified using the
4031 B<VFilerName> option. If this is not specified, it will default to the name
4034 The VFiler block inherits all connection related settings from the surrounding
4035 B<Host> block (which appear before the B<VFiler> block) but they may be
4036 overwritten inside the B<VFiler> block.
4038 This feature is useful, for example, when using a VFiler as SnapVault target
4039 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4040 available in the host filer (vfiler0) but only in the respective VFiler
4043 =item B<Protocol> B<httpd>|B<http>
4045 The protocol collectd will use to query this host.
4053 Valid options: http, https
4055 =item B<Address> I<Address>
4057 The hostname or IP address of the host.
4063 Default: The "host" block's name.
4065 =item B<Port> I<Port>
4067 The TCP port to connect to on the host.
4073 Default: 80 for protocol "http", 443 for protocol "https"
4075 =item B<User> I<User>
4077 =item B<Password> I<Password>
4079 The username and password to use to login to the NetApp.
4085 =item B<VFilerName> I<Name>
4087 The name of the VFiler in which context to execute API commands. If not
4088 specified, the name provided to the B<VFiler> block will be used instead.
4094 Default: name of the B<VFiler> block
4096 B<Note:> This option may only be used inside B<VFiler> blocks.
4098 =item B<Interval> I<Interval>
4104 The following options decide what kind of data will be collected. You can
4105 either use them as a block and fine tune various parameters inside this block,
4106 use them as a single statement to just accept all default values, or omit it to
4107 not collect any data.
4109 The following options are valid inside all blocks:
4113 =item B<Interval> I<Seconds>
4115 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4116 host specific setting.
4120 =head3 The System block
4122 This will collect various performance data about the whole system.
4124 B<Note:> To get this data the collectd user needs the
4125 "api-perf-object-get-instances" capability.
4129 =item B<Interval> I<Seconds>
4131 Collect disk statistics every I<Seconds> seconds.
4133 =item B<GetCPULoad> B<true>|B<false>
4135 If you set this option to true the current CPU usage will be read. This will be
4136 the average usage between all CPUs in your NetApp without any information about
4139 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4140 returns in the "CPU" field.
4148 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4150 =item B<GetInterfaces> B<true>|B<false>
4152 If you set this option to true the current traffic of the network interfaces
4153 will be read. This will be the total traffic over all interfaces of your NetApp
4154 without any information about individual interfaces.
4156 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4157 in the "Net kB/s" field.
4167 Result: One value list of type "if_octects".
4169 =item B<GetDiskIO> B<true>|B<false>
4171 If you set this option to true the current IO throughput will be read. This
4172 will be the total IO of your NetApp without any information about individual
4173 disks, volumes or aggregates.
4175 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4176 in the "DiskE<nbsp>kB/s" field.
4184 Result: One value list of type "disk_octets".
4186 =item B<GetDiskOps> B<true>|B<false>
4188 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4189 iSCSI, etc. operations will be read. This will be the total number of
4190 operations on your NetApp without any information about individual volumes or
4193 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4194 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4202 Result: A variable number of value lists of type "disk_ops_complex". Each type
4203 of operation will result in one value list with the name of the operation as
4208 =head3 The WAFL block
4210 This will collect various performance data about the WAFL file system. At the
4211 moment this just means cache performance.
4213 B<Note:> To get this data the collectd user needs the
4214 "api-perf-object-get-instances" capability.
4216 B<Note:> The interface to get these values is classified as "Diagnostics" by
4217 NetApp. This means that it is not guaranteed to be stable even between minor
4222 =item B<Interval> I<Seconds>
4224 Collect disk statistics every I<Seconds> seconds.
4226 =item B<GetNameCache> B<true>|B<false>
4234 Result: One value list of type "cache_ratio" and type instance
4237 =item B<GetDirCache> B<true>|B<false>
4245 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4247 =item B<GetInodeCache> B<true>|B<false>
4255 Result: One value list of type "cache_ratio" and type instance
4258 =item B<GetBufferCache> B<true>|B<false>
4260 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4261 in the "Cache hit" field.
4269 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4273 =head3 The Disks block
4275 This will collect performance data about the individual disks in the NetApp.
4277 B<Note:> To get this data the collectd user needs the
4278 "api-perf-object-get-instances" capability.
4282 =item B<Interval> I<Seconds>
4284 Collect disk statistics every I<Seconds> seconds.
4286 =item B<GetBusy> B<true>|B<false>
4288 If you set this option to true the busy time of all disks will be calculated
4289 and the value of the busiest disk in the system will be written.
4291 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4292 in the "Disk util" field. Probably.
4300 Result: One value list of type "percent" and type instance "disk_busy".
4304 =head3 The VolumePerf block
4306 This will collect various performance data about the individual volumes.
4308 You can select which data to collect about which volume using the following
4309 options. They follow the standard ignorelist semantic.
4311 B<Note:> To get this data the collectd user needs the
4312 I<api-perf-object-get-instances> capability.
4316 =item B<Interval> I<Seconds>
4318 Collect volume performance data every I<Seconds> seconds.
4320 =item B<GetIO> I<Volume>
4322 =item B<GetOps> I<Volume>
4324 =item B<GetLatency> I<Volume>
4326 Select the given volume for IO, operations or latency statistics collection.
4327 The argument is the name of the volume without the C</vol/> prefix.
4329 Since the standard ignorelist functionality is used here, you can use a string
4330 starting and ending with a slash to specify regular expression matching: To
4331 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4334 GetIO "/^vol[027]$/"
4336 If no regular expression is specified, an exact match is required. Both,
4337 regular and exact matching are case sensitive.
4339 If no volume was specified at all for either of the three options, that data
4340 will be collected for all available volumes.
4342 See F</"IGNORELISTS"> for details.
4344 =item B<IgnoreSelectedIO> B<true>|B<false>
4346 =item B<IgnoreSelectedOps> B<true>|B<false>
4348 =item B<IgnoreSelectedLatency> B<true>|B<false>
4350 When set to B<true>, the volumes selected for IO, operations or latency
4351 statistics collection will be ignored and the data will be collected for all
4354 When set to B<false>, data will only be collected for the specified volumes and
4355 all other volumes will be ignored.
4357 If no volumes have been specified with the above B<Get*> options, all volumes
4358 will be collected regardless of the B<IgnoreSelected*> option.
4360 Defaults to B<false>
4364 =head3 The VolumeUsage block
4366 This will collect capacity data about the individual volumes.
4368 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4373 =item B<Interval> I<Seconds>
4375 Collect volume usage statistics every I<Seconds> seconds.
4377 =item B<GetCapacity> I<VolumeName>
4379 The current capacity of the volume will be collected. This will result in two
4380 to four value lists, depending on the configuration of the volume. All data
4381 sources are of type "df_complex" with the name of the volume as
4384 There will be type_instances "used" and "free" for the number of used and
4385 available bytes on the volume. If the volume has some space reserved for
4386 snapshots, a type_instance "snap_reserved" will be available. If the volume
4387 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4388 number of bytes saved by the SIS feature.
4390 B<Note:> The current NetApp API has a bug that results in this value being
4391 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4392 number which works most of the time. If you see strange values here, bug
4393 NetApp support to fix this.
4395 Repeat this option to specify multiple volumes.
4397 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4399 Specify whether to collect only the volumes selected by the B<GetCapacity>
4400 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4401 B<false>. However, if no B<GetCapacity> option is specified at all, all
4402 capacities will be selected anyway.
4404 =item B<GetSnapshot> I<VolumeName>
4406 Select volumes from which to collect snapshot information.
4408 Usually, the space used for snapshots is included in the space reported as
4409 "used". If snapshot information is collected as well, the space used for
4410 snapshots is subtracted from the used space.
4412 To make things even more interesting, it is possible to reserve space to be
4413 used for snapshots. If the space required for snapshots is less than that
4414 reserved space, there is "reserved free" and "reserved used" space in addition
4415 to "free" and "used". If the space required for snapshots exceeds the reserved
4416 space, that part allocated in the normal space is subtracted from the "used"
4419 Repeat this option to specify multiple volumes.
4421 =item B<IgnoreSelectedSnapshot>
4423 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4424 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4425 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4426 capacities will be selected anyway.
4430 =head3 The Quota block
4432 This will collect (tree) quota statistics (used disk space and number of used
4433 files). This mechanism is useful to get usage information for single qtrees.
4434 In case the quotas are not used for any other purpose, an entry similar to the
4435 following in C</etc/quotas> would be sufficient:
4437 /vol/volA/some_qtree tree - - - - -
4439 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4443 =item B<Interval> I<Seconds>
4445 Collect SnapVault(R) statistics every I<Seconds> seconds.
4449 =head3 The SnapVault block
4451 This will collect statistics about the time and traffic of SnapVault(R)
4456 =item B<Interval> I<Seconds>
4458 Collect SnapVault(R) statistics every I<Seconds> seconds.
4462 =head2 Plugin C<netlink>
4464 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4465 statistics of various interface and routing aspects.
4469 =item B<Interface> I<Interface>
4471 =item B<VerboseInterface> I<Interface>
4473 Instruct the plugin to collect interface statistics. This is basically the same
4474 as the statistics provided by the C<interface> plugin (see above) but
4475 potentially much more detailed.
4477 When configuring with B<Interface> only the basic statistics will be collected,
4478 namely octets, packets, and errors. These statistics are collected by
4479 the C<interface> plugin, too, so using both at the same time is no benefit.
4481 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4482 so that no data needs to be collected twice if you use the C<interface> plugin.
4483 This includes dropped packets, received multicast packets, collisions and a
4484 whole zoo of differentiated RX and TX errors. You can try the following command
4485 to get an idea of what awaits you:
4489 If I<Interface> is B<All>, all interfaces will be selected.
4491 =item B<QDisc> I<Interface> [I<QDisc>]
4493 =item B<Class> I<Interface> [I<Class>]
4495 =item B<Filter> I<Interface> [I<Filter>]
4497 Collect the octets and packets that pass a certain qdisc, class or filter.
4499 QDiscs and classes are identified by their type and handle (or classid).
4500 Filters don't necessarily have a handle, therefore the parent's handle is used.
4501 The notation used in collectd differs from that used in tc(1) in that it
4502 doesn't skip the major or minor number if it's zero and doesn't print special
4503 ids by their name. So, for example, a qdisc may be identified by
4504 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4505 thus not displayed by tc(1).
4507 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4508 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4509 associated with that interface will be collected.
4511 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4512 used. This may lead to problems when more than one filter is attached to a
4513 qdisc or class. This isn't nice, but we don't know how this could be done any
4514 better. If you have a idea, please don't hesitate to tell us.
4516 As with the B<Interface> option you can specify B<All> as the interface,
4517 meaning all interfaces.
4519 Here are some examples to help you understand the above text more easily:
4522 VerboseInterface "All"
4523 QDisc "eth0" "pfifo_fast-1:0"
4525 Class "ppp0" "htb-1:10"
4526 Filter "ppp0" "u32-1:0"
4529 See F</"IGNORELISTS"> for details.
4531 =item B<IgnoreSelected>
4533 The behavior is the same as with all other similar plugins: If nothing is
4534 selected at all, everything is collected. If some things are selected using the
4535 options described above, only these statistics are collected. If you set
4536 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4537 specified statistics will not be collected.
4541 =head2 Plugin C<network>
4543 The Network plugin sends data to a remote instance of collectd, receives data
4544 from a remote instance, or both at the same time. Data which has been received
4545 from the network is usually not transmitted again, but this can be activated, see
4546 the B<Forward> option below.
4548 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4549 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4551 Both, B<Server> and B<Listen> can be used as single option or as block. When
4552 used as block, given options are valid for this socket only. The following
4553 example will export the metrics twice: Once to an "internal" server (without
4554 encryption and signing) and one to an external server (with cryptographic
4558 # Export to an internal server
4559 # (demonstrates usage without additional options)
4560 Server "collectd.internal.tld"
4562 # Export to an external server
4563 # (demonstrates usage with signature options)
4564 <Server "collectd.external.tld">
4565 SecurityLevel "sign"
4566 Username "myhostname"
4573 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4575 The B<Server> statement/block sets the server to send datagrams to. The
4576 statement may occur multiple times to send each datagram to multiple
4579 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
4580 optional second argument specifies a port number or a service name. If not
4581 given, the default, B<25826>, is used.
4583 The following options are recognized within B<Server> blocks:
4587 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4589 Set the security you require for network communication. When the security level
4590 has been set to B<Encrypt>, data sent over the network will be encrypted using
4591 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4592 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4593 authentication code. When set to B<None>, data is sent without any security.
4595 This feature is only available if the I<network> plugin was linked with
4598 =item B<Username> I<Username>
4600 Sets the username to transmit. This is used by the server to lookup the
4601 password. See B<AuthFile> below. All security levels except B<None> require
4604 This feature is only available if the I<network> plugin was linked with
4607 =item B<Password> I<Password>
4609 Sets a password (shared secret) for this socket. All security levels except
4610 B<None> require this setting.
4612 This feature is only available if the I<network> plugin was linked with
4615 =item B<Interface> I<Interface name>
4617 Set the outgoing interface for IP packets. This applies at least
4618 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4619 undefined or a non-existent interface name is specified, the default
4620 behavior is to let the kernel choose the appropriate interface. Be warned
4621 that the manual selection of an interface for unicast traffic is only
4622 necessary in rare cases.
4624 =item B<ResolveInterval> I<Seconds>
4626 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4627 useful to force a regular DNS lookup to support a high availability setup. If
4628 not specified, re-resolves are never attempted.
4632 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4634 The B<Listen> statement sets the interfaces to bind to. When multiple
4635 statements are found the daemon will bind to multiple interfaces.
4637 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4638 the argument is a multicast address the daemon will join that multicast group.
4639 The optional second argument specifies a port number or a service name. If not
4640 given, the default, B<25826>, is used.
4642 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4646 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4648 Set the security you require for network communication. When the security level
4649 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4650 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4651 signed and encrypted data is accepted. When set to B<None>, all data will be
4652 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4653 decrypted if possible.
4655 This feature is only available if the I<network> plugin was linked with
4658 =item B<AuthFile> I<Filename>
4660 Sets a file in which usernames are mapped to passwords. These passwords are
4661 used to verify signatures and to decrypt encrypted network packets. If
4662 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4663 verified and encrypted packets are decrypted. Otherwise, signed data is
4664 accepted without checking the signature and encrypted data cannot be decrypted.
4665 For the other security levels this option is mandatory.
4667 The file format is very simple: Each line consists of a username followed by a
4668 colon and any number of spaces followed by the password. To demonstrate, an
4669 example file could look like this:
4674 Each time a packet is received, the modification time of the file is checked
4675 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4676 the file is being read, it is locked using L<fcntl(2)>.
4678 =item B<Interface> I<Interface name>
4680 Set the incoming interface for IP packets explicitly. This applies at least
4681 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4682 undefined or a non-existent interface name is specified, the default
4683 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4684 traffic gets only accepted, if it arrives on the given interface.
4688 =item B<TimeToLive> I<1-255>
4690 Set the time-to-live of sent packets. This applies to all, unicast and
4691 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4692 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4695 =item B<MaxPacketSize> I<1024-65535>
4697 Set the maximum size for datagrams received over the network. Packets larger
4698 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4699 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4702 On the server side, this limit should be set to the largest value used on
4703 I<any> client. Likewise, the value on the client must not be larger than the
4704 value on the server, or data will be lost.
4706 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4707 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4708 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4711 =item B<Forward> I<true|false>
4713 If set to I<true>, write packets that were received via the network plugin to
4714 the sending sockets. This should only be activated when the B<Listen>- and
4715 B<Server>-statements differ. Otherwise packets may be send multiple times to
4716 the same multicast group. While this results in more network traffic than
4717 necessary it's not a huge problem since the plugin has a duplicate detection,
4718 so the values will not loop.
4720 =item B<ReportStats> B<true>|B<false>
4722 The network plugin cannot only receive and send statistics, it can also create
4723 statistics about itself. Collectd data included the number of received and
4724 sent octets and packets, the length of the receive queue and the number of
4725 values handled. When set to B<true>, the I<Network plugin> will make these
4726 statistics available. Defaults to B<false>.
4730 =head2 Plugin C<nginx>
4732 This plugin collects the number of connections and requests handled by the
4733 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4734 queries the page provided by the C<ngx_http_stub_status_module> module, which
4735 isn't compiled by default. Please refer to
4736 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4737 how to compile and configure nginx and this module.
4739 The following options are accepted by the C<nginx plugin>:
4743 =item B<URL> I<http://host/nginx_status>
4745 Sets the URL of the C<ngx_http_stub_status_module> output.
4747 =item B<User> I<Username>
4749 Optional user name needed for authentication.
4751 =item B<Password> I<Password>
4753 Optional password needed for authentication.
4755 =item B<VerifyPeer> B<true|false>
4757 Enable or disable peer SSL certificate verification. See
4758 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4760 =item B<VerifyHost> B<true|false>
4762 Enable or disable peer host name verification. If enabled, the plugin checks
4763 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4764 certificate matches the host name provided by the B<URL> option. If this
4765 identity check fails, the connection is aborted. Obviously, only works when
4766 connecting to a SSL enabled server. Enabled by default.
4768 =item B<CACert> I<File>
4770 File that holds one or more SSL certificates. If you want to use HTTPS you will
4771 possibly need this option. What CA certificates come bundled with C<libcurl>
4772 and are checked by default depends on the distribution you use.
4774 =item B<Timeout> I<Milliseconds>
4776 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4777 milliseconds. By default, the configured B<Interval> is used to set the
4782 =head2 Plugin C<notify_desktop>
4784 This plugin sends a desktop notification to a notification daemon, as defined
4785 in the Desktop Notification Specification. To actually display the
4786 notifications, B<notification-daemon> is required and B<collectd> has to be
4787 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4788 environment variables have to be set correctly) and the D-Bus message bus.
4790 The Desktop Notification Specification can be found at
4791 L<http://www.galago-project.org/specs/notification/>.
4795 =item B<OkayTimeout> I<timeout>
4797 =item B<WarningTimeout> I<timeout>
4799 =item B<FailureTimeout> I<timeout>
4801 Set the I<timeout>, in milliseconds, after which to expire the notification
4802 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4803 been specified, the displayed notification will not be closed at all - the
4804 user has to do so herself. These options default to 5000. If a negative number
4805 has been specified, the default is used as well.
4809 =head2 Plugin C<notify_email>
4811 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4812 configured email address.
4814 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4816 Available configuration options:
4820 =item B<From> I<Address>
4822 Email address from which the emails should appear to come from.
4824 Default: C<root@localhost>
4826 =item B<Recipient> I<Address>
4828 Configures the email address(es) to which the notifications should be mailed.
4829 May be repeated to send notifications to multiple addresses.
4831 At least one B<Recipient> must be present for the plugin to work correctly.
4833 =item B<SMTPServer> I<Hostname>
4835 Hostname of the SMTP server to connect to.
4837 Default: C<localhost>
4839 =item B<SMTPPort> I<Port>
4841 TCP port to connect to.
4845 =item B<SMTPUser> I<Username>
4847 Username for ASMTP authentication. Optional.
4849 =item B<SMTPPassword> I<Password>
4851 Password for ASMTP authentication. Optional.
4853 =item B<Subject> I<Subject>
4855 Subject-template to use when sending emails. There must be exactly two
4856 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4857 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4860 Default: C<Collectd notify: %s@%s>
4864 =head2 Plugin C<notify_nagios>
4866 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
4867 a I<passive service check result>.
4869 Available configuration options:
4873 =item B<CommandFile> I<Path>
4875 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
4879 =head2 Plugin C<ntpd>
4881 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
4884 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
4885 the wire - using B<mode 7> specific requests. This mode is deprecated with
4886 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
4887 correctly with them, the ntp daemon must be explicitly configured to
4888 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
4889 manual page for details.
4891 Available configuration options for the C<ntpd> plugin:
4895 =item B<Host> I<Hostname>
4897 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4899 =item B<Port> I<Port>
4901 UDP-Port to connect to. Defaults to B<123>.
4903 =item B<ReverseLookups> B<true>|B<false>
4905 Sets whether or not to perform reverse lookups on peers. Since the name or
4906 IP-address may be used in a filename it is recommended to disable reverse
4907 lookups. The default is to do reverse lookups to preserve backwards
4908 compatibility, though.
4910 =item B<IncludeUnitID> B<true>|B<false>
4912 When a peer is a refclock, include the unit ID in the I<type instance>.
4913 Defaults to B<false> for backward compatibility.
4915 If two refclock peers use the same driver and this is B<false>, the plugin will
4916 try to write simultaneous measurements from both to the same type instance.
4917 This will result in error messages in the log and only one set of measurements
4922 =head2 Plugin C<nut>
4926 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4928 Add a UPS to collect data from. The format is identical to the one accepted by
4933 =head2 Plugin C<olsrd>
4935 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4936 the Optimized Link State Routing daemon and reads information about the current
4937 state of the meshed network.
4939 The following configuration options are understood:
4943 =item B<Host> I<Host>
4945 Connect to I<Host>. Defaults to B<"localhost">.
4947 =item B<Port> I<Port>
4949 Specifies the port to connect to. This must be a string, even if you give the
4950 port as a number rather than a service name. Defaults to B<"2006">.
4952 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4954 Specifies what information to collect about links, i.E<nbsp>e. direct
4955 connections of the daemon queried. If set to B<No>, no information is
4956 collected. If set to B<Summary>, the number of links and the average of all
4957 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4958 If set to B<Detail> LQ and NLQ are collected per link.
4960 Defaults to B<Detail>.
4962 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4964 Specifies what information to collect about routes of the daemon queried. If
4965 set to B<No>, no information is collected. If set to B<Summary>, the number of
4966 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4967 metric and ETX are collected per route.
4969 Defaults to B<Summary>.
4971 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4973 Specifies what information to collect about the global topology. If set to
4974 B<No>, no information is collected. If set to B<Summary>, the number of links
4975 in the entire topology and the average I<link quality> (LQ) is calculated.
4976 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4978 Defaults to B<Summary>.
4982 =head2 Plugin C<onewire>
4984 B<EXPERIMENTAL!> See notes below.
4986 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4987 L<http://owfs.org/> to read sensors connected via the onewire bus.
4989 It can be used in two possible modes - standard or advanced.
4991 In the standard mode only temperature sensors (sensors with the family code
4992 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4993 other sensors you would like to have included, please send a sort request to
4994 the mailing list. You can select sensors to be read or to be ignored depending
4995 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4996 walked and all sensors are read.
4998 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4999 experimental, below.
5001 In the advanced mode you can configure any sensor to be read (only numerical
5002 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5003 In this mode you have to list all the sensors. Neither default bus walk nor
5004 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5005 the path automatically and should produce compatible structure with the "standard"
5006 mode (basically the path is expected as for example
5007 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5008 "F10FCA000800" and the rest after the slash is considered the type - here
5010 There are two advantages to this mode - you can access virtually any sensor
5011 (not just temperature), select whether to use cached or directly read values
5012 and it is slighlty faster. The downside is more complex configuration.
5014 The two modes are distinguished automatically by the format of the address.
5015 It is not possible to mix the two modes. Once a full path is detected in any
5016 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5017 (and as standard addresses will fail parsing they will be ignored).
5021 =item B<Device> I<Device>
5023 Sets the device to read the values from. This can either be a "real" hardware
5024 device, such as a serial port or an USB port, or the address of the
5025 L<owserver(1)> socket, usually B<localhost:4304>.
5027 Though the documentation claims to automatically recognize the given address
5028 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5029 with that version, the following configuration worked for us:
5032 Device "-s localhost:4304"
5035 This directive is B<required> and does not have a default value.
5037 =item B<Sensor> I<Sensor>
5039 In the standard mode selects sensors to collect or to ignore
5040 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5041 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5042 and B<not> include the leading C<10.> family byte and point.
5043 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5044 sensors (see above) are read.
5046 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5047 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5048 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5050 As there can be multiple devices on the bus you can list multiple sensor (use
5051 multiple B<Sensor> elements).
5053 See F</"IGNORELISTS"> for details.
5055 =item B<IgnoreSelected> I<true>|I<false>
5057 If no configuration is given, the B<onewire> plugin will collect data from all
5058 sensors found. This may not be practical, especially if sensors are added and
5059 removed regularly. Sometimes, however, it's easier/preferred to collect only
5060 specific sensors or all sensors I<except> a few specified ones. This option
5061 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5062 B<Sensor> is inverted: All selected interfaces are ignored and all other
5063 interfaces are collected.
5065 Used only in the standard mode - see above.
5067 =item B<Interval> I<Seconds>
5069 Sets the interval in which all sensors should be read. If not specified, the
5070 global B<Interval> setting is used.
5074 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5075 work with big setups. It works with one sensor being attached to one
5076 controller, but as soon as you throw in a couple more senors and maybe a hub
5077 or two, reading all values will take more than ten seconds (the default
5078 interval). We will probably add some separate thread for reading the sensors
5079 and some cache or something like that, but it's not done yet. We will try to
5080 maintain backwards compatibility in the future, but we can't promise. So in
5081 short: If it works for you: Great! But keep in mind that the config I<might>
5082 change, though this is unlikely. Oh, and if you want to help improving this
5083 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5085 =head2 Plugin C<openldap>
5087 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5088 server correctly. The backend database C<monitor> needs to be loaded and
5089 working. See slapd-monitor(5) for the details.
5091 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5092 blocks. Each block requires one string argument as the instance name. For
5097 URL "ldap://localhost/"
5100 URL "ldaps://localhost/"
5104 The instance name will be used as the I<plugin instance>. To emulate the old
5105 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5106 plugin to work correctly, each instance name must be unique. This is not
5107 enforced by the plugin and it is your responsibility to ensure it is.
5109 The following options are accepted within each B<Instance> block:
5113 =item B<URL> I<ldap://host/binddn>
5115 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5118 =item B<BindDN> I<BindDN>
5120 Name in the form of an LDAP distinguished name intended to be used for
5121 authentication. Defaults to empty string to establish an anonymous authorization.
5123 =item B<Password> I<Password>
5125 Password for simple bind authentication. If this option is not set,
5126 unauthenticated bind operation is used.
5128 =item B<StartTLS> B<true|false>
5130 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5131 Disabled by default.
5133 =item B<VerifyHost> B<true|false>
5135 Enables or disables peer host name verification. If enabled, the plugin checks
5136 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5137 certificate matches the host name provided by the B<URL> option. If this
5138 identity check fails, the connection is aborted. Enabled by default.
5140 =item B<CACert> I<File>
5142 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5143 may possibly need this option. What CA certificates are checked by default
5144 depends on the distribution you use and can be changed with the usual ldap
5145 client configuration mechanisms. See ldap.conf(5) for the details.
5147 =item B<Timeout> I<Seconds>
5149 Sets the timeout value for ldap operations, in seconds. By default, the
5150 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5153 =item B<Version> I<Version>
5155 An integer which sets the LDAP protocol version number to use when connecting
5156 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5160 =head2 Plugin C<openvpn>
5162 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5163 traffic statistics about connected clients.
5165 To set up OpenVPN to write to the status file periodically, use the
5166 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
5167 you need to set the required format, too. This is done by setting
5168 B<--status-version> to B<2>.
5170 So, in a nutshell you need:
5172 openvpn $OTHER_OPTIONS \
5173 --status "/var/run/openvpn-status" 10 \
5180 =item B<StatusFile> I<File>
5182 Specifies the location of the status file.
5184 =item B<ImprovedNamingSchema> B<true>|B<false>
5186 When enabled, the filename of the status file will be used as plugin instance
5187 and the client's "common name" will be used as type instance. This is required
5188 when reading multiple status files. Enabling this option is recommended, but to
5189 maintain backwards compatibility this option is disabled by default.
5191 =item B<CollectCompression> B<true>|B<false>
5193 Sets whether or not statistics about the compression used by OpenVPN should be
5194 collected. This information is only available in I<single> mode. Enabled by
5197 =item B<CollectIndividualUsers> B<true>|B<false>
5199 Sets whether or not traffic information is collected for each connected client
5200 individually. If set to false, currently no traffic data is collected at all
5201 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5203 =item B<CollectUserCount> B<true>|B<false>
5205 When enabled, the number of currently connected clients or users is collected.
5206 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5207 can be configured independently from that option. Defaults to B<false>.
5211 =head2 Plugin C<oracle>
5213 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5214 Oracle® Database and lets you execute SQL statements there. It is very similar
5215 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5216 plugin's documentation above for details.
5219 <Query "out_of_stock">
5220 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5223 # InstancePrefix "foo"
5224 InstancesFrom "category"
5228 <Database "product_information">
5232 Query "out_of_stock"
5236 =head3 B<Query> blocks
5238 The Query blocks are handled identically to the Query blocks of the "dbi"
5239 plugin. Please see its documentation above for details on how to specify
5242 =head3 B<Database> blocks
5244 Database blocks define a connection to a database and which queries should be
5245 sent to that database. Each database needs a "name" as string argument in the
5246 starting tag of the block. This name will be used as "PluginInstance" in the
5247 values submitted to the daemon. Other than that, that name is not used.
5251 =item B<ConnectID> I<ID>
5253 Defines the "database alias" or "service name" to connect to. Usually, these
5254 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5256 =item B<Host> I<Host>
5258 Hostname to use when dispatching values for this database. Defaults to using
5259 the global hostname of the I<collectd> instance.
5261 =item B<Username> I<Username>
5263 Username used for authentication.
5265 =item B<Password> I<Password>
5267 Password used for authentication.
5269 =item B<Query> I<QueryName>
5271 Associates the query named I<QueryName> with this database connection. The
5272 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5273 blocks you want to refer to must be placed above the database block you want to
5278 =head2 Plugin C<perl>
5280 This plugin embeds a Perl-interpreter into collectd and provides an interface
5281 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
5283 =head2 Plugin C<pinba>
5285 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
5286 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
5287 PHP-based webpage has been delivered, the extension will send a UDP packet
5288 containing timing information, peak memory usage and so on. The plugin will
5289 wait for such packets, parse them and account the provided information, which
5290 is then dispatched to the daemon once per interval.
5297 # Overall statistics for the website.
5299 Server "www.example.com"
5301 # Statistics for www-a only
5303 Host "www-a.example.com"
5304 Server "www.example.com"
5306 # Statistics for www-b only
5308 Host "www-b.example.com"
5309 Server "www.example.com"
5313 The plugin provides the following configuration options:
5317 =item B<Address> I<Node>
5319 Configures the address used to open a listening socket. By default, plugin will
5320 bind to the I<any> address C<::0>.
5322 =item B<Port> I<Service>
5324 Configures the port (service) to bind to. By default the default Pinba port
5325 "30002" will be used. The option accepts service names in addition to port
5326 numbers and thus requires a I<string> argument.
5328 =item E<lt>B<View> I<Name>E<gt> block
5330 The packets sent by the Pinba extension include the hostname of the server, the
5331 server name (the name of the virtual host) and the script that was executed.
5332 Using B<View> blocks it is possible to separate the data into multiple groups
5333 to get more meaningful statistics. Each packet is added to all matching groups,
5334 so that a packet may be accounted for more than once.
5338 =item B<Host> I<Host>
5340 Matches the hostname of the system the webserver / script is running on. This
5341 will contain the result of the L<gethostname(2)> system call. If not
5342 configured, all hostnames will be accepted.
5344 =item B<Server> I<Server>
5346 Matches the name of the I<virtual host>, i.e. the contents of the
5347 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
5348 server names will be accepted.
5350 =item B<Script> I<Script>
5352 Matches the name of the I<script name>, i.e. the contents of the
5353 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
5354 script names will be accepted.
5360 =head2 Plugin C<ping>
5362 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
5363 configured hosts periodically and measures the network latency. Whenever the
5364 C<read> function of the plugin is called, it submits the average latency, the
5365 standard deviation and the drop rate for each host.
5367 Available configuration options:
5371 =item B<Host> I<IP-address>
5373 Host to ping periodically. This option may be repeated several times to ping
5376 =item B<Interval> I<Seconds>
5378 Sets the interval in which to send ICMP echo packets to the configured hosts.
5379 This is B<not> the interval in which metrics are read from the plugin but the
5380 interval in which the hosts are "pinged". Therefore, the setting here should be
5381 smaller than or equal to the global B<Interval> setting. Fractional times, such
5382 as "1.24" are allowed.
5386 =item B<Timeout> I<Seconds>
5388 Time to wait for a response from the host to which an ICMP packet had been
5389 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
5390 to be down or the packet to be dropped. This setting must be smaller than the
5391 B<Interval> setting above for the plugin to work correctly. Fractional
5392 arguments are accepted.
5396 =item B<TTL> I<0-255>
5398 Sets the Time-To-Live of generated ICMP packets.
5400 =item B<Size> I<size>
5402 Sets the size of the data payload in ICMP packet to specified I<size> (it
5403 will be filled with regular ASCII pattern). If not set, default 56 byte
5404 long string is used so that the packet size of an ICMPv4 packet is exactly
5405 64 bytes, similar to the behaviour of normal ping(1) command.
5407 =item B<SourceAddress> I<host>
5409 Sets the source address to use. I<host> may either be a numerical network
5410 address or a network hostname.
5412 =item B<Device> I<name>
5414 Sets the outgoing network device to be used. I<name> has to specify an
5415 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
5418 =item B<MaxMissed> I<Packets>
5420 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
5421 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
5423 Default: B<-1> (disabled)
5427 =head2 Plugin C<postgresql>
5429 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
5430 keeps a persistent connection to all configured databases and tries to
5431 reconnect if the connection has been interrupted. A database is configured by
5432 specifying a B<Database> block as described below. The default statistics are
5433 collected from PostgreSQL's B<statistics collector> which thus has to be
5434 enabled for this plugin to work correctly. This should usually be the case by
5435 default. See the section "The Statistics Collector" of the B<PostgreSQL
5436 Documentation> for details.
5438 By specifying custom database queries using a B<Query> block as described
5439 below, you may collect any data that is available from some PostgreSQL
5440 database. This way, you are able to access statistics of external daemons
5441 which are available in a PostgreSQL database or use future or special
5442 statistics provided by PostgreSQL without the need to upgrade your collectd
5445 Starting with version 5.2, the C<postgresql> plugin supports writing data to
5446 PostgreSQL databases as well. This has been implemented in a generic way. You
5447 need to specify an SQL statement which will then be executed by collectd in
5448 order to write the data (see below for details). The benefit of that approach
5449 is that there is no fixed database layout. Rather, the layout may be optimized
5450 for the current setup.
5452 The B<PostgreSQL Documentation> manual can be found at
5453 L<http://www.postgresql.org/docs/manuals/>.
5457 Statement "SELECT magic FROM wizard WHERE host = $1;"
5461 InstancePrefix "magic"
5466 <Query rt36_tickets>
5467 Statement "SELECT COUNT(type) AS count, type \
5469 WHEN resolved = 'epoch' THEN 'open' \
5470 ELSE 'resolved' END AS type \
5471 FROM tickets) type \
5475 InstancePrefix "rt36_tickets"
5476 InstancesFrom "type"
5482 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
5492 KRBSrvName "kerberos_service_name"
5498 Service "service_name"
5499 Query backend # predefined
5510 The B<Query> block defines one database query which may later be used by a
5511 database definition. It accepts a single mandatory argument which specifies
5512 the name of the query. The names of all queries have to be unique (see the
5513 B<MinVersion> and B<MaxVersion> options below for an exception to this
5516 In each B<Query> block, there is one or more B<Result> blocks. Multiple
5517 B<Result> blocks may be used to extract multiple values from a single query.
5519 The following configuration options are available to define the query:
5523 =item B<Statement> I<sql query statement>
5525 Specify the I<sql query statement> which the plugin should execute. The string
5526 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
5527 first, second, etc. parameter. The value of the parameters is specified by the
5528 B<Param> configuration option - see below for details. To include a literal
5529 B<$> character followed by a number, surround it with single quotes (B<'>).
5531 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
5532 allowed. Note, however, that only a single command may be used. Semicolons are
5533 allowed as long as a single non-empty command has been specified only.
5535 The returned lines will be handled separately one after another.
5537 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
5539 Specify the parameters which should be passed to the SQL query. The parameters
5540 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
5541 they appear in the configuration file. The value of the parameter is
5542 determined depending on the value of the B<Param> option as follows:
5548 The configured hostname of the database connection. If a UNIX domain socket is
5549 used, the parameter expands to "localhost".
5553 The name of the database of the current connection.
5557 The name of the database plugin instance. See the B<Instance> option of the
5558 database specification below for details.
5562 The username used to connect to the database.
5566 The interval with which this database is queried (as specified by the database
5567 specific or global B<Interval> options).
5571 Please note that parameters are only supported by PostgreSQL's protocol
5572 version 3 and above which was introduced in version 7.4 of PostgreSQL.
5574 =item B<PluginInstanceFrom> I<column>
5576 Specify how to create the "PluginInstance" for reporting this query results.
5577 Only one column is supported. You may concatenate fields and string values in
5578 the query statement to get the required results.
5580 =item B<MinVersion> I<version>
5582 =item B<MaxVersion> I<version>
5584 Specify the minimum or maximum version of PostgreSQL that this query should be
5585 used with. Some statistics might only be available with certain versions of
5586 PostgreSQL. This allows you to specify multiple queries with the same name but
5587 which apply to different versions, thus allowing you to use the same
5588 configuration in a heterogeneous environment.
5590 The I<version> has to be specified as the concatenation of the major, minor
5591 and patch-level versions, each represented as two-decimal-digit numbers. For
5592 example, version 8.2.3 will become 80203.
5596 The B<Result> block defines how to handle the values returned from the query.
5597 It defines which column holds which value and how to dispatch that value to
5602 =item B<Type> I<type>
5604 The I<type> name to be used when dispatching the values. The type describes
5605 how to handle the data and where to store it. See L<types.db(5)> for more
5606 details on types and their configuration. The number and type of values (as
5607 selected by the B<ValuesFrom> option) has to match the type of the given name.
5609 This option is mandatory.
5611 =item B<InstancePrefix> I<prefix>
5613 =item B<InstancesFrom> I<column0> [I<column1> ...]
5615 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
5616 B<InstancePrefix> defines a static prefix that will be prepended to all type
5617 instances. B<InstancesFrom> defines the column names whose values will be used
5618 to create the type instance. Multiple values will be joined together using the
5619 hyphen (C<->) as separation character.
5621 The plugin itself does not check whether or not all built instances are
5622 different. It is your responsibility to assure that each is unique.
5624 Both options are optional. If none is specified, the type instance will be
5627 =item B<ValuesFrom> I<column0> [I<column1> ...]
5629 Names the columns whose content is used as the actual data for the data sets
5630 that are dispatched to the daemon. How many such columns you need is
5631 determined by the B<Type> setting as explained above. If you specify too many
5632 or not enough columns, the plugin will complain about that and no data will be
5633 submitted to the daemon.
5635 The actual data type, as seen by PostgreSQL, is not that important as long as
5636 it represents numbers. The plugin will automatically cast the values to the
5637 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
5638 L<strtod(3)> functions, so anything supported by those functions is supported
5639 by the plugin as well.
5641 This option is required inside a B<Result> block and may be specified multiple
5642 times. If multiple B<ValuesFrom> options are specified, the columns are read
5647 The following predefined queries are available (the definitions can be found
5648 in the F<postgresql_default.conf> file which, by default, is available at
5649 C<I<prefix>/share/collectd/>):
5655 This query collects the number of backends, i.E<nbsp>e. the number of
5658 =item B<transactions>
5660 This query collects the numbers of committed and rolled-back transactions of
5665 This query collects the numbers of various table modifications (i.E<nbsp>e.
5666 insertions, updates, deletions) of the user tables.
5668 =item B<query_plans>
5670 This query collects the numbers of various table scans and returned tuples of
5673 =item B<table_states>
5675 This query collects the numbers of live and dead rows in the user tables.
5679 This query collects disk block access counts for user tables.
5683 This query collects the on-disk size of the database in bytes.
5687 In addition, the following detailed queries are available by default. Please
5688 note that each of those queries collects information B<by table>, thus,
5689 potentially producing B<a lot> of data. For details see the description of the
5690 non-by_table queries above.
5694 =item B<queries_by_table>
5696 =item B<query_plans_by_table>
5698 =item B<table_states_by_table>
5700 =item B<disk_io_by_table>
5704 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5705 mandatory argument specifying the name of the writer. This will then be used
5706 in the B<Database> specification in order to activate the writer instance. The
5707 names of all writers have to be unique. The following options may be
5712 =item B<Statement> I<sql statement>
5714 This mandatory option specifies the SQL statement that will be executed for
5715 each submitted value. A single SQL statement is allowed only. Anything after
5716 the first semicolon will be ignored.
5718 Nine parameters will be passed to the statement and should be specified as
5719 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5720 values are made available through those parameters:
5726 The timestamp of the queried value as a floating point number.
5730 The hostname of the queried value.
5734 The plugin name of the queried value.
5738 The plugin instance of the queried value. This value may be B<NULL> if there
5739 is no plugin instance.
5743 The type of the queried value (cf. L<types.db(5)>).
5747 The type instance of the queried value. This value may be B<NULL> if there is
5752 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5753 sources of the submitted value-list).
5757 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5758 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5759 B<StoreRates> is enabled (which is the default, see below), all types will be
5764 An array of the submitted values. The dimensions of the value name and value
5769 In general, it is advisable to create and call a custom function in the
5770 PostgreSQL database for this purpose. Any procedural language supported by
5771 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5774 =item B<StoreRates> B<false>|B<true>
5776 If set to B<true> (the default), convert counter values to rates. If set to
5777 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5782 The B<Database> block defines one PostgreSQL database for which to collect
5783 statistics. It accepts a single mandatory argument which specifies the
5784 database name. None of the other options are required. PostgreSQL will use
5785 default values as documented in the section "CONNECTING TO A DATABASE" in the
5786 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5787 the user collectd is run as and special environment variables. See the manpage
5792 =item B<Interval> I<seconds>
5794 Specify the interval with which the database should be queried. The default is
5795 to use the global B<Interval> setting.
5797 =item B<CommitInterval> I<seconds>
5799 This option may be used for database connections which have "writers" assigned
5800 (see above). If specified, it causes a writer to put several updates into a
5801 single transaction. This transaction will last for the specified amount of
5802 time. By default, each update will be executed in a separate transaction. Each
5803 transaction generates a fair amount of overhead which can, thus, be reduced by
5804 activating this option. The draw-back is, that data covering the specified
5805 amount of time will be lost, for example, if a single statement within the
5806 transaction fails or if the database server crashes.
5808 =item B<Instance> I<name>
5810 Specify the plugin instance name that should be used instead of the database
5811 name (which is the default, if this option has not been specified). This
5812 allows one to query multiple databases of the same name on the same host (e.g.
5813 when running multiple database server versions in parallel).
5814 The plugin instance name can also be set from the query result using
5815 the B<PluginInstanceFrom> option in B<Query> block.
5817 =item B<Host> I<hostname>
5819 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5820 value begins with a slash, it is interpreted as the directory name in which to
5821 look for the UNIX domain socket.
5823 This option is also used to determine the hostname that is associated with a
5824 collected data set. If it has been omitted or either begins with with a slash
5825 or equals B<localhost> it will be replaced with the global hostname definition
5826 of collectd. Any other value will be passed literally to collectd when
5827 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5829 =item B<Port> I<port>
5831 Specify the TCP port or the local UNIX domain socket file extension of the
5834 =item B<User> I<username>
5836 Specify the username to be used when connecting to the server.
5838 =item B<Password> I<password>
5840 Specify the password to be used when connecting to the server.
5842 =item B<ExpireDelay> I<delay>
5844 Skip expired values in query output.
5846 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5848 Specify whether to use an SSL connection when contacting the server. The
5849 following modes are supported:
5855 Do not use SSL at all.
5859 First, try to connect without using SSL. If that fails, try using SSL.
5861 =item I<prefer> (default)
5863 First, try to connect using SSL. If that fails, try without using SSL.
5871 =item B<Instance> I<name>
5873 Specify the plugin instance name that should be used instead of the database
5874 name (which is the default, if this option has not been specified). This
5875 allows one to query multiple databases of the same name on the same host (e.g.
5876 when running multiple database server versions in parallel).
5878 =item B<KRBSrvName> I<kerberos_service_name>
5880 Specify the Kerberos service name to use when authenticating with Kerberos 5
5881 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5882 B<PostgreSQL Documentation> for details.
5884 =item B<Service> I<service_name>
5886 Specify the PostgreSQL service name to use for additional parameters. That
5887 service has to be defined in F<pg_service.conf> and holds additional
5888 connection parameters. See the section "The Connection Service File" in the
5889 B<PostgreSQL Documentation> for details.
5891 =item B<Query> I<query>
5893 Specifies a I<query> which should be executed in the context of the database
5894 connection. This may be any of the predefined or user-defined queries. If no
5895 such option is given, it defaults to "backends", "transactions", "queries",
5896 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5897 has been specified). Else, the specified queries are used only.
5899 =item B<Writer> I<writer>
5901 Assigns the specified I<writer> backend to the database connection. This
5902 causes all collected data to be send to the database using the settings
5903 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5904 below for details on how to selectively send data to certain plugins).
5906 Each writer will register a flush callback which may be used when having long
5907 transactions enabled (see the B<CommitInterval> option above). When issuing
5908 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5909 transaction will be committed right away. Two different kinds of flush
5910 callbacks are available with the C<postgresql> plugin:
5916 Flush all writer backends.
5918 =item B<postgresql->I<database>
5920 Flush all writers of the specified I<database> only.
5926 =head2 Plugin C<powerdns>
5928 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5929 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5930 values, many of which are probably meaningless to most users, but may be useful
5931 for some. So you may chose which values to collect, but if you don't, some
5932 reasonable defaults will be collected.
5935 <Server "server_name">
5937 Collect "udp-answers" "udp-queries"
5938 Socket "/var/run/pdns.controlsocket"
5940 <Recursor "recursor_name">
5942 Collect "cache-hits" "cache-misses"
5943 Socket "/var/run/pdns_recursor.controlsocket"
5945 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5950 =item B<Server> and B<Recursor> block
5952 The B<Server> block defines one authoritative server to query, the B<Recursor>
5953 does the same for an recursing server. The possible options in both blocks are
5954 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5959 =item B<Collect> I<Field>
5961 Using the B<Collect> statement you can select which values to collect. Here,
5962 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5963 C<dlg-only-drops>, C<answers10-100>.
5965 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5966 When querying the server a C<SHOW *> command is issued in any case, because
5967 that's the only way of getting multiple values out of the server at once.
5968 collectd then picks out the values you have selected. When querying the
5969 recursor, a command is generated to query exactly these values. So if you
5970 specify invalid fields when querying the recursor, a syntax error may be
5971 returned by the daemon and collectd may not collect any values at all.
5973 If no B<Collect> statement is given, the following B<Server> values will be
5980 =item packetcache-hit
5982 =item packetcache-miss
5984 =item packetcache-size
5986 =item query-cache-hit
5988 =item query-cache-miss
5990 =item recursing-answers
5992 =item recursing-questions
6004 The following B<Recursor> values will be collected by default:
6008 =item noerror-answers
6010 =item nxdomain-answers
6012 =item servfail-answers
6030 Please note that up to that point collectd doesn't know what values are
6031 available on the server and values that are added do not need a change of the
6032 mechanism so far. However, the values must be mapped to collectd's naming
6033 scheme, which is done using a lookup table that lists all known values. If
6034 values are added in the future and collectd does not know about them, you will
6035 get an error much like this:
6037 powerdns plugin: submit: Not found in lookup table: foobar = 42
6039 In this case please file a bug report with the collectd team.
6041 =item B<Socket> I<Path>
6043 Configures the path to the UNIX domain socket to be used when connecting to the
6044 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6045 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6046 will be used for the recursor.
6050 =item B<LocalSocket> I<Path>
6052 Querying the recursor is done using UDP. When using UDP over UNIX domain
6053 sockets, the client socket needs a name in the file system, too. You can set
6054 this local name to I<Path> using the B<LocalSocket> option. The default is
6055 C<I<prefix>/var/run/collectd-powerdns>.
6059 =head2 Plugin C<processes>
6063 =item B<Process> I<Name>
6065 Select more detailed statistics of processes matching this name. The statistics
6066 collected for these selected processes are size of the resident segment size
6067 (RSS), user- and system-time used, number of processes and number of threads,
6068 io data (where available) and minor and major pagefaults.
6070 Some platforms have a limit on the length of process names. I<Name> must stay
6073 =item B<ProcessMatch> I<name> I<regex>
6075 Similar to the B<Process> option this allows one to select more detailed
6076 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6077 details). The statistics of all matching processes are summed up and
6078 dispatched to the daemon using the specified I<name> as an identifier. This
6079 allows one to "group" several processes together. I<name> must not contain
6082 =item B<CollectContextSwitch> I<Boolean>
6084 Collect context switch of the process.
6088 =head2 Plugin C<protocols>
6090 Collects a lot of information about various network protocols, such as I<IP>,
6091 I<TCP>, I<UDP>, etc.
6093 Available configuration options:
6097 =item B<Value> I<Selector>
6099 Selects whether or not to select a specific value. The string being matched is
6100 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6101 plugin instance and I<ValueName> will be used as type instance. An example of
6102 the string being used would be C<Tcp:RetransSegs>.
6104 You can use regular expressions to match a large number of values with just one
6105 configuration option. To select all "extended" I<TCP> values, you could use the
6106 following statement:
6110 Whether only matched values are selected or all matched values are ignored
6111 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6112 If no value is configured at all, all values will be selected.
6114 See F</"IGNORELISTS"> for details.
6116 =item B<IgnoreSelected> B<true>|B<false>
6118 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6119 matching values will be ignored.
6123 =head2 Plugin C<python>
6125 This plugin embeds a Python-interpreter into collectd and provides an interface
6126 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6128 =head2 Plugin C<routeros>
6130 The C<routeros> plugin connects to a device running I<RouterOS>, the
6131 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6132 I<librouteros> to connect and reads information about the interfaces and
6133 wireless connections of the device. The configuration supports querying
6138 Host "router0.example.com"
6141 CollectInterface true
6146 Host "router1.example.com"
6149 CollectInterface true
6150 CollectRegistrationTable true
6156 As you can see above, the configuration of the I<routeros> plugin consists of
6157 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6158 options are understood:
6162 =item B<Host> I<Host>
6164 Hostname or IP-address of the router to connect to.
6166 =item B<Port> I<Port>
6168 Port name or port number used when connecting. If left unspecified, the default
6169 will be chosen by I<librouteros>, currently "8728". This option expects a
6170 string argument, even when a numeric port number is given.
6172 =item B<User> I<User>
6174 Use the user name I<User> to authenticate. Defaults to "admin".
6176 =item B<Password> I<Password>
6178 Set the password used to authenticate.
6180 =item B<CollectInterface> B<true>|B<false>
6182 When set to B<true>, interface statistics will be collected for all interfaces
6183 present on the device. Defaults to B<false>.
6185 =item B<CollectRegistrationTable> B<true>|B<false>
6187 When set to B<true>, information about wireless LAN connections will be
6188 collected. Defaults to B<false>.
6190 =item B<CollectCPULoad> B<true>|B<false>
6192 When set to B<true>, information about the CPU usage will be collected. The
6193 number is a dimensionless value where zero indicates no CPU usage at all.
6194 Defaults to B<false>.
6196 =item B<CollectMemory> B<true>|B<false>
6198 When enabled, the amount of used and free memory will be collected. How used
6199 memory is calculated is unknown, for example whether or not caches are counted
6201 Defaults to B<false>.
6203 =item B<CollectDF> B<true>|B<false>
6205 When enabled, the amount of used and free disk space will be collected.
6206 Defaults to B<false>.
6208 =item B<CollectDisk> B<true>|B<false>
6210 When enabled, the number of sectors written and bad blocks will be collected.
6211 Defaults to B<false>.
6215 =head2 Plugin C<redis>
6217 The I<Redis plugin> connects to one or more Redis servers and gathers
6218 information about each server's state. For each server there is a I<Node> block
6219 which configures the connection parameters for this node.
6226 <Query "LLEN myqueue">
6233 The information shown in the synopsis above is the I<default configuration>
6234 which is used by the plugin if no configuration is present.
6238 =item B<Node> I<Nodename>
6240 The B<Node> block identifies a new Redis node, that is a new Redis instance
6241 running in an specified host and port. The name for node is a canonical
6242 identifier which is used as I<plugin instance>. It is limited to
6243 64E<nbsp>characters in length.
6245 =item B<Host> I<Hostname>
6247 The B<Host> option is the hostname or IP-address where the Redis instance is
6250 =item B<Port> I<Port>
6252 The B<Port> option is the TCP port on which the Redis instance accepts
6253 connections. Either a service name of a port number may be given. Please note
6254 that numerical port numbers must be given as a string, too.
6256 =item B<Password> I<Password>
6258 Use I<Password> to authenticate when connecting to I<Redis>.
6260 =item B<Timeout> I<Milliseconds>
6262 The B<Timeout> option set the socket timeout for node response. Since the Redis
6263 read function is blocking, you should keep this value as low as possible. Keep
6264 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
6265 than B<Interval> defined globally.
6267 =item B<Query> I<Querystring>
6269 The B<Query> block identifies a query to execute against the redis server.
6270 There may be an arbitrary number of queries to execute.
6272 =item B<Type> I<Collectd type>
6274 Within a query definition, a valid collectd type to use as when submitting
6275 the result of the query. When not supplied, will default to B<gauge>.
6277 =item B<Instance> I<Type instance>
6279 Within a query definition, an optional type instance to use when submitting
6280 the result of the query. When not supplied will default to the escaped
6281 command, up to 64 chars.
6285 =head2 Plugin C<rrdcached>
6287 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
6288 to store values to RRD files in an efficient manner. The combination of the
6289 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
6290 way the C<rrdtool> plugin works (see below). The added abstraction layer
6291 provides a number of benefits, though: Because the cache is not within
6292 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
6293 restarted. This results in much shorter (if any) gaps in graphs, especially
6294 under heavy load. Also, the C<rrdtool> command line utility is aware of the
6295 daemon so that it can flush values to disk automatically when needed. This
6296 allows one to integrate automated flushing of values into graphing solutions
6299 There are disadvantages, though: The daemon may reside on a different host, so
6300 it may not be possible for C<collectd> to create the appropriate RRD files
6301 anymore. And even if C<rrdcached> runs on the same host, it may run in a
6302 different base directory, so relative paths may do weird stuff if you're not
6305 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
6306 on the same host, communicating via a UNIX domain socket. The B<DataDir>
6307 setting should be set to an absolute path, so that a changed base directory
6308 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
6312 =item B<DaemonAddress> I<Address>
6314 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
6315 library. See L<rrdcached(1)> for details. Example:
6317 <Plugin "rrdcached">
6318 DaemonAddress "unix:/var/run/rrdcached.sock"
6321 =item B<DataDir> I<Directory>
6323 Set the base directory in which the RRD files reside. If this is a relative
6324 path, it is relative to the working base directory of the C<rrdcached> daemon!
6325 Use of an absolute path is recommended.
6327 =item B<CreateFiles> B<true>|B<false>
6329 Enables or disables the creation of RRD files. If the daemon is not running
6330 locally, or B<DataDir> is set to a relative path, this will not work as
6331 expected. Default is B<true>.
6333 =item B<CreateFilesAsync> B<false>|B<true>
6335 When enabled, new RRD files are enabled asynchronously, using a separate thread
6336 that runs in the background. This prevents writes to block, which is a problem
6337 especially when many hundreds of files need to be created at once. However,
6338 since the purpose of creating the files asynchronously is I<not> to block until
6339 the file is available, values before the file is available will be discarded.
6340 When disabled (the default) files are created synchronously, blocking for a
6341 short while, while the file is being written.
6343 =item B<StepSize> I<Seconds>
6345 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6346 this setting is unset and the stepsize is set to the interval in which the data
6347 is collected. Do not use this option unless you absolutely have to for some
6348 reason. Setting this option may cause problems with the C<snmp plugin>, the
6349 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6351 =item B<HeartBeat> I<Seconds>
6353 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6354 in which case the heartbeat is set to twice the B<StepSize> which should equal
6355 the interval in which data is collected. Do not set this option unless you have
6356 a very good reason to do so.
6358 =item B<RRARows> I<NumRows>
6360 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6361 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6362 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6363 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6364 week, one month, and one year.
6366 So for each timespan, it calculates how many PDPs need to be consolidated into
6367 one CDP by calculating:
6368 number of PDPs = timespan / (stepsize * rrarows)
6370 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6373 =item B<RRATimespan> I<Seconds>
6375 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6376 more then one RRA. If this option is never used, the built-in default of (3600,
6377 86400, 604800, 2678400, 31622400) is used.
6379 For more information on how RRA-sizes are calculated see B<RRARows> above.
6381 =item B<XFF> I<Factor>
6383 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6384 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6387 =item B<CollectStatistics> B<false>|B<true>
6389 When set to B<true>, various statistics about the I<rrdcached> daemon will be
6390 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
6392 Statistics are read via I<rrdcached>s socket using the STATS command.
6393 See L<rrdcached(1)> for details.
6397 =head2 Plugin C<rrdtool>
6399 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
6400 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
6401 using these settings. If you don't want to dive into the depths of RRDtool, you
6402 can safely ignore these settings.
6406 =item B<DataDir> I<Directory>
6408 Set the directory to store RRD files under. By default RRD files are generated
6409 beneath the daemon's working directory, i.e. the B<BaseDir>.
6411 =item B<CreateFilesAsync> B<false>|B<true>
6413 When enabled, new RRD files are enabled asynchronously, using a separate thread
6414 that runs in the background. This prevents writes to block, which is a problem
6415 especially when many hundreds of files need to be created at once. However,
6416 since the purpose of creating the files asynchronously is I<not> to block until
6417 the file is available, values before the file is available will be discarded.
6418 When disabled (the default) files are created synchronously, blocking for a
6419 short while, while the file is being written.
6421 =item B<StepSize> I<Seconds>
6423 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6424 this setting is unset and the stepsize is set to the interval in which the data
6425 is collected. Do not use this option unless you absolutely have to for some
6426 reason. Setting this option may cause problems with the C<snmp plugin>, the
6427 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6429 =item B<HeartBeat> I<Seconds>
6431 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6432 in which case the heartbeat is set to twice the B<StepSize> which should equal
6433 the interval in which data is collected. Do not set this option unless you have
6434 a very good reason to do so.
6436 =item B<RRARows> I<NumRows>
6438 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6439 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6440 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6441 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6442 week, one month, and one year.
6444 So for each timespan, it calculates how many PDPs need to be consolidated into
6445 one CDP by calculating:
6446 number of PDPs = timespan / (stepsize * rrarows)
6448 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6451 =item B<RRATimespan> I<Seconds>
6453 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6454 more then one RRA. If this option is never used, the built-in default of (3600,
6455 86400, 604800, 2678400, 31622400) is used.
6457 For more information on how RRA-sizes are calculated see B<RRARows> above.
6459 =item B<XFF> I<Factor>
6461 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6462 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6465 =item B<CacheFlush> I<Seconds>
6467 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
6468 it writes all values for a certain RRD-file if the oldest value is older than
6469 (or equal to) the number of seconds specified by B<CacheTimeout>.
6470 That check happens on new values arriwal. If some RRD-file is not updated
6471 anymore for some reason (the computer was shut down, the network is broken,
6472 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
6473 every I<Seconds> seconds the entire cache is searched for entries older than
6474 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
6475 disk. Since entire cache scan is kind of expensive and does nothing under normal
6476 circumstances, this value should not be too small. 900 seconds might be a good
6477 value, though setting this to 7200 seconds doesn't normally do much harm either.
6479 Default value for this option is 10x of B<CacheTimeout>.
6480 If value of B<CacheFlush> less than value of B<CacheTimeout> then default value
6483 =item B<CacheTimeout> I<Seconds>
6485 If this option is set to a value greater than zero, the C<rrdtool plugin> will
6486 save values in a cache, as described above. Writing multiple values at once
6487 reduces IO-operations and thus lessens the load produced by updating the files.
6488 The trade off is that the graphs kind of "drag behind" and that more memory is
6491 =item B<WritesPerSecond> I<Updates>
6493 When collecting many statistics with collectd and the C<rrdtool> plugin, you
6494 will run serious performance problems. The B<CacheFlush> setting and the
6495 internal update queue assert that collectd continues to work just fine even
6496 under heavy load, but the system may become very unresponsive and slow. This is
6497 a problem especially if you create graphs from the RRD files on the same
6498 machine, for example using the C<graph.cgi> script included in the
6499 C<contrib/collection3/> directory.
6501 This setting is designed for very large setups. Setting this option to a value
6502 between 25 and 80 updates per second, depending on your hardware, will leave
6503 the server responsive enough to draw graphs even while all the cached values
6504 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
6505 by the B<FLUSH> command, are B<not> effected by this limit. They are still
6506 written as fast as possible, so that web frontends have up to date data when
6509 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
6510 updates per second, writing all values to disk will take approximately
6511 56E<nbsp>minutes. Together with the flushing ability that's integrated into
6512 "collection3" you'll end up with a responsive and fast system, up to date
6513 graphs and basically a "backup" of your values every hour.
6515 =item B<RandomTimeout> I<Seconds>
6517 When set, the actual timeout for each value is chosen randomly between
6518 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
6519 intention is to avoid high load situations that appear when many values timeout
6520 at the same time. This is especially a problem shortly after the daemon starts,
6521 because all values were added to the internal cache at roughly the same time.
6525 =head2 Plugin C<sensors>
6527 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
6528 that all the needed modules have to be loaded and lm_sensors has to be
6529 configured (most likely by editing F</etc/sensors.conf>. Read
6530 L<sensors.conf(5)> for details.
6532 The B<lm_sensors> homepage can be found at
6533 L<http://secure.netroedge.com/~lm78/>.
6537 =item B<SensorConfigFile> I<File>
6539 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
6540 the library's default will be used.
6542 =item B<Sensor> I<chip-bus-address/type-feature>
6544 Selects the name of the sensor which you want to collect or ignore, depending
6545 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
6546 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
6547 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
6549 See F</"IGNORELISTS"> for details.
6551 =item B<IgnoreSelected> I<true>|I<false>
6553 If no configuration if given, the B<sensors>-plugin will collect data from all
6554 sensors. This may not be practical, especially for uninteresting sensors.
6555 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
6556 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
6557 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
6558 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
6559 and all other sensors are collected.
6561 =item B<UseLabels> I<true>|I<false>
6563 Configures how sensor readings are reported. When set to I<true>, sensor
6564 readings are reported using their descriptive label (e.g. "VCore"). When set to
6565 I<false> (the default) the sensor name is used ("in0").
6569 =head2 Plugin C<sigrok>
6571 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
6572 supported by the L<sigrok|http://sigrok.org/> project.
6578 <Device "AC Voltage">
6583 <Device "Sound Level">
6584 Driver "cem-dt-885x"
6591 =item B<LogLevel> B<0-5>
6593 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
6594 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
6595 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
6596 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
6597 their level, are always submitted to I<collectd> at its INFO log level.
6599 =item E<lt>B<Device> I<Name>E<gt>
6601 A sigrok-supported device, uniquely identified by this section's options. The
6602 I<Name> is passed to I<collectd> as the I<plugin instance>.
6604 =item B<Driver> I<DriverName>
6606 The sigrok driver to use for this device.
6608 =item B<Conn> I<ConnectionSpec>
6610 If the device cannot be auto-discovered, or more than one might be discovered
6611 by the driver, I<ConnectionSpec> specifies the connection string to the device.
6612 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
6613 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
6614 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
6615 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
6617 =item B<SerialComm> I<SerialSpec>
6619 For serial devices with non-standard port settings, this option can be used
6620 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
6621 This should not be necessary; drivers know how to communicate with devices they
6624 =item B<MinimumInterval> I<Seconds>
6626 Specifies the minimum time between measurement dispatches to I<collectd>, in
6627 seconds. Since some I<sigrok> supported devices can acquire measurements many
6628 times per second, it may be necessary to throttle these. For example, the
6629 I<RRD plugin> cannot process writes more than once per second.
6631 The default B<MinimumInterval> is B<0>, meaning measurements received from the
6632 device are always dispatched to I<collectd>. When throttled, unused
6633 measurements are discarded.
6637 =head2 Plugin C<smart>
6639 The C<smart> plugin collects SMART information from physical
6640 disks. Values collectd include temperature, power cycle count, poweron
6641 time and bad sectors. Also, all SMART attributes are collected along
6642 with the normalized current value, the worst value, the threshold and
6643 a human readable value.
6645 Using the following two options you can ignore some disks or configure the
6646 collection only of specific disks.
6650 =item B<Disk> I<Name>
6652 Select the disk I<Name>. Whether it is collected or ignored depends on the
6653 B<IgnoreSelected> setting, see below. As with other plugins that use the
6654 daemon's ignorelist functionality, a string that starts and ends with a slash
6655 is interpreted as a regular expression. Examples:
6660 See F</"IGNORELISTS"> for details.
6662 =item B<IgnoreSelected> B<true>|B<false>
6664 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
6665 statements, are ignored or if all other disks are ignored. The behavior
6666 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
6667 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
6668 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
6669 is set to B<true>, all disks are collected B<except> the ones matched.
6671 =item B<IgnoreSleepMode> B<true>|B<false>
6673 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
6674 This option disables the sleep mode check and allows the plugin to collect data
6675 from these disks anyway. This is useful in cases where libatasmart mistakenly
6676 reports disks as asleep because it has not been updated to incorporate support
6677 for newer idle states in the ATA spec.
6679 =item B<UseSerial> B<true>|B<false>
6681 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
6682 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
6683 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
6684 storing data. This ensures that the data for a given disk will be kept together
6685 even if the kernel name changes.
6689 =head2 Plugin C<snmp>
6691 Since the configuration of the C<snmp plugin> is a little more complicated than
6692 other plugins, its documentation has been moved to an own manpage,
6693 L<collectd-snmp(5)>. Please see there for details.
6695 =head2 Plugin C<statsd>
6697 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
6698 protocol and dispatches rates or other aggregates of these numbers
6701 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
6702 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
6703 C<objects> respectively.
6705 The following configuration options are valid:
6709 =item B<Host> I<Host>
6711 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
6712 "any" address, i.e. accept packets sent to any of the hosts addresses.
6714 =item B<Port> I<Port>
6716 UDP port to listen to. This can be either a service name or a port number.
6717 Defaults to C<8125>.
6719 =item B<DeleteCounters> B<false>|B<true>
6721 =item B<DeleteTimers> B<false>|B<true>
6723 =item B<DeleteGauges> B<false>|B<true>
6725 =item B<DeleteSets> B<false>|B<true>
6727 These options control what happens if metrics are not updated in an interval.
6728 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6729 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6730 are unchanged. If set to B<True>, the such metrics are not dispatched and
6731 removed from the internal cache.
6733 =item B<CounterSum> B<false>|B<true>
6735 When enabled, creates a C<count> metric which reports the change since the last
6736 read. This option primarily exists for compatibility with the I<statsd>
6737 implementation by Etsy.
6739 =item B<TimerPercentile> I<Percent>
6741 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6742 that I<Percent> of all reported timers are smaller than or equal to the
6743 computed latency. This is useful for cutting off the long tail latency, as it's
6744 often done in I<Service Level Agreements> (SLAs).
6746 Different percentiles can be calculated by setting this option several times.
6747 If none are specified, no percentiles are calculated / dispatched.
6749 =item B<TimerLower> B<false>|B<true>
6751 =item B<TimerUpper> B<false>|B<true>
6753 =item B<TimerSum> B<false>|B<true>
6755 =item B<TimerCount> B<false>|B<true>
6757 Calculate and dispatch various values out of I<Timer> metrics received during
6758 an interval. If set to B<False>, the default, these values aren't calculated /
6763 =head2 Plugin C<swap>
6765 The I<Swap plugin> collects information about used and available swap space. On
6766 I<Linux> and I<Solaris>, the following options are available:
6770 =item B<ReportByDevice> B<false>|B<true>
6772 Configures how to report physical swap devices. If set to B<false> (the
6773 default), the summary over all swap devices is reported only, i.e. the globally
6774 used and available space over all devices. If B<true> is configured, the used
6775 and available space of each device will be reported separately.
6777 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6778 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6780 =item B<ReportBytes> B<false>|B<true>
6782 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6783 I<swap I/O> is reported in pages. This option is available under Linux only.
6785 =item B<ValuesAbsolute> B<true>|B<false>
6787 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6788 available and used. Defaults to B<true>.
6790 =item B<ValuesPercentage> B<false>|B<true>
6792 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6793 available and free. Defaults to B<false>.
6795 This is useful for deploying I<collectd> in a heterogeneous environment, where
6796 swap sizes differ and you want to specify generic thresholds or similar.
6800 =head2 Plugin C<syslog>
6804 =item B<LogLevel> B<debug|info|notice|warning|err>
6806 Sets the log-level. If, for example, set to B<notice>, then all events with
6807 severity B<notice>, B<warning>, or B<err> will be submitted to the
6810 Please note that B<debug> is only available if collectd has been compiled with
6813 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6815 Controls which notifications should be sent to syslog. The default behaviour is
6816 not to send any. Less severe notifications always imply logging more severe
6817 notifications: Setting this to B<OKAY> means all notifications will be sent to
6818 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6819 notifications but will dismiss B<OKAY> notifications. Setting this option to
6820 B<FAILURE> will only send failures to syslog.
6824 =head2 Plugin C<table>
6826 The C<table plugin> provides generic means to parse tabular data and dispatch
6827 user specified values. Values are selected based on column numbers. For
6828 example, this plugin may be used to get values from the Linux L<proc(5)>
6829 filesystem or CSV (comma separated values) files.
6832 <Table "/proc/slabinfo">
6837 InstancePrefix "active_objs"
6843 InstancePrefix "objperslab"
6850 The configuration consists of one or more B<Table> blocks, each of which
6851 configures one file to parse. Within each B<Table> block, there are one or
6852 more B<Result> blocks, which configure which data to select and how to
6855 The following options are available inside a B<Table> block:
6859 =item B<Instance> I<instance>
6861 If specified, I<instance> is used as the plugin instance. So, in the above
6862 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6863 filename of the table is used instead, with all special characters replaced
6864 with an underscore (C<_>).
6866 =item B<Separator> I<string>
6868 Any character of I<string> is interpreted as a delimiter between the different
6869 columns of the table. A sequence of two or more contiguous delimiters in the
6870 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6871 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6872 of a table - see its documentation for more details. This option is mandatory.
6874 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6875 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6876 required because of collectd's config parsing.
6880 The following options are available inside a B<Result> block:
6884 =item B<Type> I<type>
6886 Sets the type used to dispatch the values to the daemon. Detailed information
6887 about types and their configuration can be found in L<types.db(5)>. This
6888 option is mandatory.
6890 =item B<InstancePrefix> I<prefix>
6892 If specified, prepend I<prefix> to the type instance. If omitted, only the
6893 B<InstancesFrom> option is considered for the type instance.
6895 =item B<InstancesFrom> I<column0> [I<column1> ...]
6897 If specified, the content of the given columns (identified by the column
6898 number starting at zero) will be used to create the type instance for each
6899 row. Multiple values (and the instance prefix) will be joined together with
6900 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6901 option is considered for the type instance.
6903 The plugin itself does not check whether or not all built instances are
6904 different. It’s your responsibility to assure that each is unique. This is
6905 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6906 sure that the table only contains one row.
6908 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6911 =item B<ValuesFrom> I<column0> [I<column1> ...]
6913 Specifies the columns (identified by the column numbers starting at zero)
6914 whose content is used as the actual data for the data sets that are dispatched
6915 to the daemon. How many such columns you need is determined by the B<Type>
6916 setting above. If you specify too many or not enough columns, the plugin will
6917 complain about that and no data will be submitted to the daemon. The plugin
6918 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6919 respectively, so anything supported by those functions is supported by the
6920 plugin as well. This option is mandatory.
6924 =head2 Plugin C<tail>
6926 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6927 each line and dispatches found values. What is matched can be configured by the
6928 user using (extended) regular expressions, as described in L<regex(7)>.
6931 <File "/var/log/exim4/mainlog">
6935 Regex "S=([1-9][0-9]*)"
6941 Regex "\\<R=local_user\\>"
6942 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6945 Instance "local_user"
6950 The config consists of one or more B<File> blocks, each of which configures one
6951 logfile to parse. Within each B<File> block, there are one or more B<Match>
6952 blocks, which configure a regular expression to search for.
6954 The B<Instance> option in the B<File> block may be used to set the plugin
6955 instance. So in the above example the plugin name C<tail-foo> would be used.
6956 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6957 next B<Instance> option. This way you can extract several plugin instances from
6958 one logfile, handy when parsing syslog and the like.
6960 The B<Interval> option allows you to define the length of time between reads. If
6961 this is not set, the default Interval will be used.
6963 Each B<Match> block has the following options to describe how the match should
6968 =item B<Regex> I<regex>
6970 Sets the regular expression to use for matching against a line. The first
6971 subexpression has to match something that can be turned into a number by
6972 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6973 below. Because B<extended> regular expressions are used, you do not need to use
6974 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6975 collectd's config parsing you need to escape backslashes, though. So if you
6976 want to match literal parentheses you need to do the following:
6978 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6980 =item B<ExcludeRegex> I<regex>
6982 Sets an optional regular expression to use for excluding lines from the match.
6983 An example which excludes all connections from localhost from the match:
6985 ExcludeRegex "127\\.0\\.0\\.1"
6987 =item B<DSType> I<Type>
6989 Sets how the values are cumulated. I<Type> is one of:
6993 =item B<GaugeAverage>
6995 Calculate the average.
6999 Use the smallest number only.
7003 Use the greatest number only.
7007 Use the last number found.
7013 =item B<AbsoluteSet>
7015 The matched number is a counter. Simply I<sets> the internal counter to this
7016 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
7024 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
7025 matched number may be negative, which will effectively subtract from the
7034 Increase the internal counter by one. These B<DSType> are the only ones that do
7035 not use the matched subexpression, but simply count the number of matched
7036 lines. Thus, you may use a regular expression without submatch in this case.
7040 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
7041 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
7042 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
7043 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
7044 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
7047 =item B<Type> I<Type>
7049 Sets the type used to dispatch this value. Detailed information about types and
7050 their configuration can be found in L<types.db(5)>.
7052 =item B<Instance> I<TypeInstance>
7054 This optional setting sets the type instance to use.
7058 =head2 Plugin C<tail_csv>
7060 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
7061 written by I<Snort>.
7066 <Metric "snort-dropped">
7071 <File "/var/log/snort/snort.stats">
7072 Instance "snort-eth0"
7074 Collect "snort-dropped"
7078 The configuration consists of one or more B<Metric> blocks that define an index
7079 into the line of the CSV file and how this value is mapped to I<collectd's>
7080 internal representation. These are followed by one or more B<Instance> blocks
7081 which configure which file to read, in which interval and which metrics to
7086 =item E<lt>B<Metric> I<Name>E<gt>
7088 The B<Metric> block configures a new metric to be extracted from the statistics
7089 file and how it is mapped on I<collectd's> data model. The string I<Name> is
7090 only used inside the B<Instance> blocks to refer to this block, so you can use
7091 one B<Metric> block for multiple CSV files.
7095 =item B<Type> I<Type>
7097 Configures which I<Type> to use when dispatching this metric. Types are defined
7098 in the L<types.db(5)> file, see the appropriate manual page for more
7099 information on specifying types. Only types with a single I<data source> are
7100 supported by the I<tail_csv plugin>. The information whether the value is an
7101 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
7102 I<Type's> definition.
7104 =item B<Instance> I<TypeInstance>
7106 If set, I<TypeInstance> is used to populate the type instance field of the
7107 created value lists. Otherwise, no type instance is used.
7109 =item B<ValueFrom> I<Index>
7111 Configure to read the value from the field with the zero-based index I<Index>.
7112 If the value is parsed as signed integer, unsigned integer or double depends on
7113 the B<Type> setting, see above.
7117 =item E<lt>B<File> I<Path>E<gt>
7119 Each B<File> block represents one CSV file to read. There must be at least one
7120 I<File> block but there can be multiple if you have multiple CSV files.
7124 =item B<Instance> I<PluginInstance>
7126 Sets the I<plugin instance> used when dispatching the values.
7128 =item B<Collect> I<Metric>
7130 Specifies which I<Metric> to collect. This option must be specified at least
7131 once, and you can use this option multiple times to specify more than one
7132 metric to be extracted from this statistic file.
7134 =item B<Interval> I<Seconds>
7136 Configures the interval in which to read values from this instance / file.
7137 Defaults to the plugin's default interval.
7139 =item B<TimeFrom> I<Index>
7141 Rather than using the local time when dispatching a value, read the timestamp
7142 from the field with the zero-based index I<Index>. The value is interpreted as
7143 seconds since epoch. The value is parsed as a double and may be factional.
7149 =head2 Plugin C<teamspeak2>
7151 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
7152 polls interesting global and virtual server data. The plugin can query only one
7153 physical server but unlimited virtual servers. You can use the following
7154 options to configure it:
7158 =item B<Host> I<hostname/ip>
7160 The hostname or ip which identifies the physical server.
7163 =item B<Port> I<port>
7165 The query port of the physical server. This needs to be a string.
7168 =item B<Server> I<port>
7170 This option has to be added once for every virtual server the plugin should
7171 query. If you want to query the virtual server on port 8767 this is what the
7172 option would look like:
7176 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
7177 use quotes around it! If no such statement is given only global information
7182 =head2 Plugin C<ted>
7184 The I<TED> plugin connects to a device of "The Energy Detective", a device to
7185 measure power consumption. These devices are usually connected to a serial
7186 (RS232) or USB port. The plugin opens a configured device and tries to read the
7187 current energy readings. For more information on TED, visit
7188 L<http://www.theenergydetective.com/>.
7190 Available configuration options:
7194 =item B<Device> I<Path>
7196 Path to the device on which TED is connected. collectd will need read and write
7197 permissions on that file.
7199 Default: B</dev/ttyUSB0>
7201 =item B<Retries> I<Num>
7203 Apparently reading from TED is not that reliable. You can therefore configure a
7204 number of retries here. You only configure the I<retries> here, to if you
7205 specify zero, one reading will be performed (but no retries if that fails); if
7206 you specify three, a maximum of four readings are performed. Negative values
7213 =head2 Plugin C<tcpconns>
7215 The C<tcpconns plugin> counts the number of currently established TCP
7216 connections based on the local port and/or the remote port. Since there may be
7217 a lot of connections the default if to count all connections with a local port,
7218 for which a listening socket is opened. You can use the following options to
7219 fine-tune the ports you are interested in:
7223 =item B<ListeningPorts> I<true>|I<false>
7225 If this option is set to I<true>, statistics for all local ports for which a
7226 listening socket exists are collected. The default depends on B<LocalPort> and
7227 B<RemotePort> (see below): If no port at all is specifically selected, the
7228 default is to collect listening ports. If specific ports (no matter if local or
7229 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
7230 the selected ports will be collected unless this option is set to I<true>
7233 =item B<LocalPort> I<Port>
7235 Count the connections to a specific local port. This can be used to see how
7236 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
7237 You have to specify the port in numeric form, so for the mailserver example
7238 you'd need to set B<25>.
7240 =item B<RemotePort> I<Port>
7242 Count the connections to a specific remote port. This is useful to see how
7243 much a remote service is used. This is most useful if you want to know how many
7244 connections a local service has opened to remote services, e.E<nbsp>g. how many
7245 connections a mail server or news server has to other mail or news servers, or
7246 how many connections a web proxy holds to web servers. You have to give the
7247 port in numeric form.
7249 =item B<AllPortsSummary> I<true>|I<false>
7251 If this option is set to I<true> a summary of statistics from all connections
7252 are collected. This option defaults to I<false>.
7256 =head2 Plugin C<thermal>
7260 =item B<ForceUseProcfs> I<true>|I<false>
7262 By default, the I<Thermal plugin> tries to read the statistics from the Linux
7263 C<sysfs> interface. If that is not available, the plugin falls back to the
7264 C<procfs> interface. By setting this option to I<true>, you can force the
7265 plugin to use the latter. This option defaults to I<false>.
7267 =item B<Device> I<Device>
7269 Selects the name of the thermal device that you want to collect or ignore,
7270 depending on the value of the B<IgnoreSelected> option. This option may be
7271 used multiple times to specify a list of devices.
7273 See F</"IGNORELISTS"> for details.
7275 =item B<IgnoreSelected> I<true>|I<false>
7277 Invert the selection: If set to true, all devices B<except> the ones that
7278 match the device names specified by the B<Device> option are collected. By
7279 default only selected devices are collected if a selection is made. If no
7280 selection is configured at all, B<all> devices are selected.
7284 =head2 Plugin C<threshold>
7286 The I<Threshold plugin> checks values collected or received by I<collectd>
7287 against a configurable I<threshold> and issues I<notifications> if values are
7290 Documentation for this plugin is available in the L<collectd-threshold(5)>
7293 =head2 Plugin C<tokyotyrant>
7295 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
7296 couple metrics: number of records, and database size on disk.
7300 =item B<Host> I<Hostname/IP>
7302 The hostname or ip which identifies the server.
7303 Default: B<127.0.0.1>
7305 =item B<Port> I<Service/Port>
7307 The query port of the server. This needs to be a string, even if the port is
7308 given in its numeric form.
7313 =head2 Plugin C<turbostat>
7315 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
7316 Intel processors by using the new Model Specific Registers.
7320 =item B<CoreCstates> I<Bitmask(Integer)>
7322 Bitmask of the list of core C states supported by the processor.
7323 This option should only be used if the automated detection fails.
7324 Default value extracted from the cpu model and family.
7326 Currently supported C-states (by this plugin): 3, 6, 7
7328 Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states
7330 =item B<PackageCstates> I<Bitmask(Integer)>
7332 Bitmask of the list of pacages C states supported by the processor.
7333 This option should only be used if the automated detection fails.
7334 Default value extracted from the cpu model and family.
7336 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
7338 Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7
7340 =item B<SystemManagementInterrupt> I<true>|I<false>
7342 Boolean enabling the collection of the I/O System-Management Interrupt
7343 counter'. This option should only be used if the automated detection
7344 fails or if you want to disable this feature.
7346 =item B<DigitalTemperatureSensor> I<true>|I<false>
7348 Boolean enabling the collection of the temperature of each core.
7349 This option should only be used if the automated detectionfails or
7350 if you want to disable this feature.
7352 =item B<DigitalTemperatureSensor> I<true>|I<false>
7354 Boolean enabling the collection of the temperature of each package.
7355 This option should only be used if the automated detectionfails or
7356 if you want to disable this feature.
7358 =item B<TCCActivationTemp> I<Temperature>
7360 Thermal Control Circuit Activation Temperature of the installed
7361 CPU. This temperature is used when collecting the temperature of
7362 cores or packages. This option should only be used if the automated
7363 detection fails. Default value extracted from B<MSR_IA32_TEMPERATURE_TARGET>
7365 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
7367 Bitmask of the list of elements to be thermally monitored. This option
7368 should only be used if the automated detection fails or if you want to
7369 disable some collections. The different bits of this bitmask accepted
7374 =item 0 ('1'): Package
7378 =item 2 ('4'): Cores
7380 =item 3 ('8'): Embedded graphic device
7386 =head2 Plugin C<unixsock>
7390 =item B<SocketFile> I<Path>
7392 Sets the socket-file which is to be created.
7394 =item B<SocketGroup> I<Group>
7396 If running as root change the group of the UNIX-socket after it has been
7397 created. Defaults to B<collectd>.
7399 =item B<SocketPerms> I<Permissions>
7401 Change the file permissions of the UNIX-socket after it has been created. The
7402 permissions must be given as a numeric, octal value as you would pass to
7403 L<chmod(1)>. Defaults to B<0770>.
7405 =item B<DeleteSocket> B<false>|B<true>
7407 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
7408 with the given name already exists. If I<collectd> crashes a socket file may be
7409 left over, preventing the daemon from opening a new socket when restarted.
7410 Since this is potentially dangerous, this defaults to B<false>.
7414 =head2 Plugin C<uuid>
7416 This plugin, if loaded, causes the Hostname to be taken from the machine's
7417 UUID. The UUID is a universally unique designation for the machine, usually
7418 taken from the machine's BIOS. This is most useful if the machine is running in
7419 a virtual environment such as Xen, in which case the UUID is preserved across
7420 shutdowns and migration.
7422 The following methods are used to find the machine's UUID, in order:
7428 Check I</etc/uuid> (or I<UUIDFile>).
7432 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
7437 Check for UUID from C<dmidecode> / SMBIOS.
7441 Check for UUID from Xen hypervisor.
7445 If no UUID can be found then the hostname is not modified.
7449 =item B<UUIDFile> I<Path>
7451 Take the UUID from the given file (default I</etc/uuid>).
7455 =head2 Plugin C<varnish>
7457 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
7458 It collects a subset of the values displayed by L<varnishstat(1)>, and
7459 organizes them in categories which can be enabled or disabled. Currently only
7460 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
7461 meaning of each metric can be found in L<varnish-counters(7)>.
7466 <Instance "example">
7470 CollectConnections true
7471 CollectDirectorDNS false
7475 CollectObjects false
7477 CollectSession false
7487 CollectWorkers false
7491 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
7492 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
7493 will collectd statistics from the default "varnishd" instance (this should work
7494 fine in most cases).
7496 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
7500 =item B<CollectBackend> B<true>|B<false>
7502 Back-end connection statistics, such as successful, reused,
7503 and closed connections. True by default.
7505 =item B<CollectBan> B<true>|B<false>
7507 Statistics about ban operations, such as number of bans added, retired, and
7508 number of objects tested against ban operations. Only available with Varnish
7509 3.x and above. False by default.
7511 =item B<CollectCache> B<true>|B<false>
7513 Cache hits and misses. True by default.
7515 =item B<CollectConnections> B<true>|B<false>
7517 Number of client connections received, accepted and dropped. True by default.
7519 =item B<CollectDirectorDNS> B<true>|B<false>
7521 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
7524 =item B<CollectESI> B<true>|B<false>
7526 Edge Side Includes (ESI) parse statistics. False by default.
7528 =item B<CollectFetch> B<true>|B<false>
7530 Statistics about fetches (HTTP requests sent to the backend). False by default.
7532 =item B<CollectHCB> B<true>|B<false>
7534 Inserts and look-ups in the crit bit tree based hash. Look-ups are
7535 divided into locked and unlocked look-ups. False by default.
7537 =item B<CollectObjects> B<true>|B<false>
7539 Statistics on cached objects: number of objects expired, nuked (prematurely
7540 expired), saved, moved, etc. False by default.
7542 =item B<CollectPurge> B<true>|B<false>
7544 Statistics about purge operations, such as number of purges added, retired, and
7545 number of objects tested against purge operations. Only available with Varnish
7546 2.x. False by default.
7548 =item B<CollectSession> B<true>|B<false>
7550 Client session statistics. Number of past and current sessions, session herd and
7551 linger counters, etc. False by default. Note that if using Varnish 4.x, some
7552 metrics found in the Connections and Threads sections with previous versions of
7553 Varnish have been moved here.
7555 =item B<CollectSHM> B<true>|B<false>
7557 Statistics about the shared memory log, a memory region to store
7558 log messages which is flushed to disk when full. True by default.
7560 =item B<CollectSMA> B<true>|B<false>
7562 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
7563 component is Solaris specific. Only available with Varnish 2.x. False by
7566 =item B<CollectSMS> B<true>|B<false>
7568 synth (synthetic content) storage statistics. This storage
7569 component is used internally only. False by default.
7571 =item B<CollectSM> B<true>|B<false>
7573 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
7576 =item B<CollectStruct> B<true>|B<false>
7578 Current varnish internal state statistics. Number of current sessions, objects
7579 in cache store, open connections to backends (with Varnish 2.x), etc. False by
7582 =item B<CollectTotals> B<true>|B<false>
7584 Collects overview counters, such as the number of sessions created,
7585 the number of requests and bytes transferred. False by default.
7587 =item B<CollectUptime> B<true>|B<false>
7589 Varnish uptime. Only available with Varnish 3.x and above. False by default.
7591 =item B<CollectVCL> B<true>|B<false>
7593 Number of total (available + discarded) VCL (config files). False by default.
7595 =item B<CollectVSM> B<true>|B<false>
7597 Collect statistics about Varnish's shared memory usage (used by the logging and
7598 statistics subsystems). Only available with Varnish 4.x. False by default.
7600 =item B<CollectWorkers> B<true>|B<false>
7602 Collect statistics about worker threads. False by default.
7606 =head2 Plugin C<virt>
7608 This plugin allows CPU, disk and network load to be collected for virtualized
7609 guests on the machine. This means that these metrics can be collected for guest
7610 systems without installing any software on them - I<collectd> only runs on the
7611 host system. The statistics are collected through libvirt
7612 (L<http://libvirt.org/>).
7614 Only I<Connection> is required.
7618 =item B<Connection> I<uri>
7620 Connect to the hypervisor given by I<uri>. For example if using Xen use:
7622 Connection "xen:///"
7624 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
7626 =item B<RefreshInterval> I<seconds>
7628 Refresh the list of domains and devices every I<seconds>. The default is 60
7629 seconds. Setting this to be the same or smaller than the I<Interval> will cause
7630 the list of domains and devices to be refreshed on every iteration.
7632 Refreshing the devices in particular is quite a costly operation, so if your
7633 virtualization setup is static you might consider increasing this. If this
7634 option is set to 0, refreshing is disabled completely.
7636 =item B<Domain> I<name>
7638 =item B<BlockDevice> I<name:dev>
7640 =item B<InterfaceDevice> I<name:dev>
7642 =item B<IgnoreSelected> B<true>|B<false>
7644 Select which domains and devices are collected.
7646 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
7647 disk/network devices are collected.
7649 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
7650 domains and disk/network devices are ignored, while the rest are collected.
7652 The domain name and device names may use a regular expression, if the name is
7653 surrounded by I</.../> and collectd was compiled with support for regexps.
7655 The default is to collect statistics for all domains and all their devices.
7659 BlockDevice "/:hdb/"
7660 IgnoreSelected "true"
7662 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
7665 =item B<HostnameFormat> B<name|uuid|hostname|...>
7667 When the virt plugin logs data, it sets the hostname of the collected data
7668 according to this setting. The default is to use the guest name as provided by
7669 the hypervisor, which is equal to setting B<name>.
7671 B<uuid> means use the guest's UUID. This is useful if you want to track the
7672 same guest across migrations.
7674 B<hostname> means to use the global B<Hostname> setting, which is probably not
7675 useful on its own because all guests will appear to have the same name.
7677 You can also specify combinations of these fields. For example B<name uuid>
7678 means to concatenate the guest name and UUID (with a literal colon character
7679 between, thus I<"foo:1234-1234-1234-1234">).
7681 At the moment of writing (collectd-5.5), hostname string is limited to 62
7682 characters. In case when combination of fields exceeds 62 characters,
7683 hostname will be truncated without a warning.
7685 =item B<InterfaceFormat> B<name>|B<address>
7687 When the virt plugin logs interface data, it sets the name of the collected
7688 data according to this setting. The default is to use the path as provided by
7689 the hypervisor (the "dev" property of the target node), which is equal to
7692 B<address> means use the interface's mac address. This is useful since the
7693 interface path might change between reboots of a guest or across migrations.
7695 =item B<PluginInstanceFormat> B<name|uuid|none>
7697 When the virt plugin logs data, it sets the plugin_instance of the collected
7698 data according to this setting. The default is to not set the plugin_instance.
7700 B<name> means use the guest's name as provided by the hypervisor.
7701 B<uuid> means use the guest's UUID.
7703 You can also specify combinations of the B<name> and B<uuid> fields.
7704 For example B<name uuid> means to concatenate the guest name and UUID
7705 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
7709 =head2 Plugin C<vmem>
7711 The C<vmem> plugin collects information about the usage of virtual memory.
7712 Since the statistics provided by the Linux kernel are very detailed, they are
7713 collected very detailed. However, to get all the details, you have to switch
7714 them on manually. Most people just want an overview over, such as the number of
7715 pages read from swap space.
7719 =item B<Verbose> B<true>|B<false>
7721 Enables verbose collection of information. This will start collecting page
7722 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
7723 Part of these statistics are collected on a "per zone" basis.
7727 =head2 Plugin C<vserver>
7729 This plugin doesn't have any options. B<VServer> support is only available for
7730 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
7731 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
7732 need to apply the patches and compile your own kernel, which will then provide
7733 the F</proc/virtual> filesystem that is required by this plugin.
7735 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
7737 B<Note>: The traffic collected by this plugin accounts for the amount of
7738 traffic passing a socket which might be a lot less than the actual on-wire
7739 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
7740 collect on-wire traffic you could, for example, use the logging facilities of
7741 iptables to feed data for the guest IPs into the iptables plugin.
7743 =head2 Plugin C<write_graphite>
7745 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
7746 storage and graphing project. The plugin connects to I<Carbon>, the data layer
7747 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
7748 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
7749 of at most 1428 bytes to minimize the number of network packets.
7753 <Plugin write_graphite>
7763 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7764 blocks. Inside the B<Node> blocks, the following options are recognized:
7768 =item B<Host> I<Address>
7770 Hostname or address to connect to. Defaults to C<localhost>.
7772 =item B<Port> I<Service>
7774 Service name or port number to connect to. Defaults to C<2003>.
7776 =item B<Protocol> I<String>
7778 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
7780 =item B<ReconnectInterval> I<Seconds>
7782 When set to non-zero, forces the connection to the Graphite backend to be
7783 closed and re-opend periodically. This behavior is desirable in environments
7784 where the connection to the Graphite backend is done through load balancers,
7785 for example. When set to zero, the default, the connetion is kept open for as
7788 =item B<LogSendErrors> B<false>|B<true>
7790 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
7791 If set to B<false>, it will not log the errors. This is especially useful when
7792 using Protocol UDP since many times we want to use the "fire-and-forget"
7793 approach and logging errors fills syslog with unneeded messages.
7795 =item B<Prefix> I<String>
7797 When set, I<String> is added in front of the host name. Dots and whitespace are
7798 I<not> escaped in this string (see B<EscapeCharacter> below).
7800 =item B<Postfix> I<String>
7802 When set, I<String> is appended to the host name. Dots and whitespace are
7803 I<not> escaped in this string (see B<EscapeCharacter> below).
7805 =item B<EscapeCharacter> I<Char>
7807 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
7808 in the identifier. The B<EscapeCharacter> option determines which character
7809 dots, whitespace and control characters are replaced with. Defaults to
7812 =item B<StoreRates> B<false>|B<true>
7814 If set to B<true> (the default), convert counter values to rates. If set to
7815 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7818 =item B<SeparateInstances> B<false>|B<true>
7820 If set to B<true>, the plugin instance and type instance will be in their own
7821 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7822 default), the plugin and plugin instance (and likewise the type and type
7823 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7825 =item B<AlwaysAppendDS> B<false>|B<true>
7827 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7828 identifier. If set to B<false> (the default), this is only done when there is
7833 =head2 Plugin C<write_tsdb>
7835 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7836 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7837 state daemon that ingests metrics and stores them in HBase. The plugin uses
7838 I<TCP> over the "line based" protocol with a default port 4242. The data will
7839 be sent in blocks of at most 1428 bytes to minimize the number of network
7846 Host "tsd-1.my.domain"
7848 HostTags "status=production"
7852 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7853 blocks. Inside the B<Node> blocks, the following options are recognized:
7857 =item B<Host> I<Address>
7859 Hostname or address to connect to. Defaults to C<localhost>.
7861 =item B<Port> I<Service>
7863 Service name or port number to connect to. Defaults to C<4242>.
7866 =item B<HostTags> I<String>
7868 When set, I<HostTags> is added to the end of the metric. It is intended to be
7869 used for name=value pairs that the TSD will tag the metric with. Dots and
7870 whitespace are I<not> escaped in this string.
7872 =item B<StoreRates> B<false>|B<true>
7874 If set to B<true>, convert counter values to rates. If set to B<false>
7875 (the default) counter values are stored as is, as an increasing
7878 =item B<AlwaysAppendDS> B<false>|B<true>
7880 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7881 identifier. If set to B<false> (the default), this is only done when there is
7886 =head2 Plugin C<write_mongodb>
7888 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7893 <Plugin "write_mongodb">
7902 The plugin can send values to multiple instances of I<MongoDB> by specifying
7903 one B<Node> block for each instance. Within the B<Node> blocks, the following
7904 options are available:
7908 =item B<Host> I<Address>
7910 Hostname or address to connect to. Defaults to C<localhost>.
7912 =item B<Port> I<Service>
7914 Service name or port number to connect to. Defaults to C<27017>.
7916 =item B<Timeout> I<Milliseconds>
7918 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7919 Setting this option to zero means no timeout, which is the default.
7921 =item B<StoreRates> B<false>|B<true>
7923 If set to B<true> (the default), convert counter values to rates. If set to
7924 B<false> counter values are stored as is, i.e. as an increasing integer
7927 =item B<Database> I<Database>
7929 =item B<User> I<User>
7931 =item B<Password> I<Password>
7933 Sets the information used when authenticating to a I<MongoDB> database. The
7934 fields are optional (in which case no authentication is attempted), but if you
7935 want to use authentication all three fields must be set.
7939 =head2 Plugin C<write_http>
7941 This output plugin submits values to an HTTP server using POST requests and
7942 encoding metrics with JSON or using the C<PUTVAL> command described in
7943 L<collectd-unixsock(5)>.
7947 <Plugin "write_http">
7949 URL "http://example.com/post-collectd"
7956 The plugin can send values to multiple HTTP servers by specifying one
7957 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7958 block, the following options are available:
7964 URL to which the values are submitted to. Mandatory.
7966 =item B<User> I<Username>
7968 Optional user name needed for authentication.
7970 =item B<Password> I<Password>
7972 Optional password needed for authentication.
7974 =item B<VerifyPeer> B<true>|B<false>
7976 Enable or disable peer SSL certificate verification. See
7977 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7979 =item B<VerifyHost> B<true|false>
7981 Enable or disable peer host name verification. If enabled, the plugin checks if
7982 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7983 matches the host name provided by the B<URL> option. If this identity check
7984 fails, the connection is aborted. Obviously, only works when connecting to a
7985 SSL enabled server. Enabled by default.
7987 =item B<CACert> I<File>
7989 File that holds one or more SSL certificates. If you want to use HTTPS you will
7990 possibly need this option. What CA certificates come bundled with C<libcurl>
7991 and are checked by default depends on the distribution you use.
7993 =item B<CAPath> I<Directory>
7995 Directory holding one or more CA certificate files. You can use this if for
7996 some reason all the needed CA certificates aren't in the same file and can't be
7997 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
8000 =item B<ClientKey> I<File>
8002 File that holds the private key in PEM format to be used for certificate-based
8005 =item B<ClientCert> I<File>
8007 File that holds the SSL certificate to be used for certificate-based
8010 =item B<ClientKeyPass> I<Password>
8012 Password required to load the private key in B<ClientKey>.
8014 =item B<Header> I<Header>
8016 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
8018 Header "X-Custom-Header: custom_value"
8020 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
8022 Define which SSL protocol version must be used. By default C<libcurl> will
8023 attempt to figure out the remote SSL protocol version. See
8024 L<curl_easy_setopt(3)> for more details.
8026 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
8028 Format of the output to generate. If set to B<Command>, will create output that
8029 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
8030 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
8031 , will create output in the KairosDB format.
8033 Defaults to B<Command>.
8035 =item B<Metrics> B<true>|B<false>
8037 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
8039 =item B<Notifications> B<false>|B<true>
8041 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
8043 =item B<StoreRates> B<true|false>
8045 If set to B<true>, convert counter values to rates. If set to B<false> (the
8046 default) counter values are stored as is, i.e. as an increasing integer number.
8048 =item B<BufferSize> I<Bytes>
8050 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
8051 requests will be generated, but more metrics will be batched / metrics are
8052 cached for longer before being sent, introducing additional delay until they
8053 are available on the server side. I<Bytes> must be at least 1024 and cannot
8054 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
8055 Defaults to C<4096>.
8057 =item B<LowSpeedLimit> I<Bytes per Second>
8059 Sets the minimal transfer rate in I<Bytes per Second> below which the
8060 connection with the HTTP server will be considered too slow and aborted. All
8061 the data submitted over this connection will probably be lost. Defaults to 0,
8062 which means no minimum transfer rate is enforced.
8064 =item B<Timeout> I<Timeout>
8066 Sets the maximum time in milliseconds given for HTTP POST operations to
8067 complete. When this limit is reached, the POST operation will be aborted, and
8068 all the data in the current send buffer will probably be lost. Defaults to 0,
8069 which means the connection never times out.
8071 =item B<LogHttpError> B<false>|B<true>
8073 Enables printing of HTTP error code to log. Turned off by default.
8075 The C<write_http> plugin regularly submits the collected values to the HTTP
8076 server. How frequently this happens depends on how much data you are collecting
8077 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
8078 slightly below this interval, which you can estimate by monitoring the network
8079 traffic between collectd and the HTTP server.
8083 =head2 Plugin C<write_kafka>
8085 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
8089 <Plugin "write_kafka">
8090 Property "metadata.broker.list" "broker1:9092,broker2:9092"
8096 The following options are understood by the I<write_kafka plugin>:
8100 =item E<lt>B<Topic> I<Name>E<gt>
8102 The plugin's configuration consists of one or more B<Topic> blocks. Each block
8103 is given a unique I<Name> and specifies one kafka producer.
8104 Inside the B<Topic> block, the following per-topic options are
8109 =item B<Property> I<String> I<String>
8111 Configure the named property for the current topic. Properties are
8112 forwarded to the kafka producer library B<librdkafka>.
8114 =item B<Key> I<String>
8116 Use the specified string as a partitioning key for the topic. Kafka breaks
8117 topic into partitions and guarantees that for a given topology, the same
8118 consumer will be used for a specific key. The special (case insensitive)
8119 string B<Random> can be used to specify that an arbitrary partition should
8122 =item B<Format> B<Command>|B<JSON>|B<Graphite>
8124 Selects the format in which messages are sent to the broker. If set to
8125 B<Command> (the default), values are sent as C<PUTVAL> commands which are
8126 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
8128 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
8129 an easy and straight forward exchange format.
8131 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
8132 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
8134 =item B<StoreRates> B<true>|B<false>
8136 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
8137 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
8138 default), no conversion is performed. Otherwise the conversion is performed
8139 using the internal value cache.
8141 Please note that currently this option is only used if the B<Format> option has
8142 been set to B<JSON>.
8144 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
8146 A prefix can be added in the metric name when outputting in the I<Graphite>
8147 format. It's added before the I<Host> name.
8149 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>>
8151 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
8153 A postfix can be added in the metric name when outputting in the I<Graphite>
8154 format. It's added after the I<Host> name.
8156 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>>
8158 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
8160 Specify a character to replace dots (.) in the host part of the metric name.
8161 In I<Graphite> metric name, dots are used as separators between different
8162 metric parts (host, plugin, type).
8163 Default is C<_> (I<Underscore>).
8165 =item B<GraphiteSeparateInstances> B<false>|B<true>
8167 If set to B<true>, the plugin instance and type instance will be in their own
8168 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8169 default), the plugin and plugin instance (and likewise the type and type
8170 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8172 =item B<StoreRates> B<true>|B<false>
8174 If set to B<true> (the default), convert counter values to rates. If set to
8175 B<false> counter values are stored as is, i.e. as an increasing integer number.
8177 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
8178 converted values will have "rate" appended to the data source type, e.g.
8179 C<ds_type:derive:rate>.
8183 =item B<Property> I<String> I<String>
8185 Configure the kafka producer through properties, you almost always will
8186 want to set B<metadata.broker.list> to your Kafka broker list.
8190 =head2 Plugin C<write_redis>
8192 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
8196 <Plugin "write_redis">
8208 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
8209 the timestamp as the score. Retrieving a date range can then be done using the
8210 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
8211 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
8212 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
8213 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
8214 with the B<Database> parameter (default is C<0>). See
8215 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
8218 The information shown in the synopsis above is the I<default configuration>
8219 which is used by the plugin if no configuration is present.
8221 The plugin can send values to multiple instances of I<Redis> by specifying
8222 one B<Node> block for each instance. Within the B<Node> blocks, the following
8223 options are available:
8227 =item B<Node> I<Nodename>
8229 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
8230 instance running on a specified host and port. The node name is a
8231 canonical identifier which is used as I<plugin instance>. It is limited to
8232 51E<nbsp>characters in length.
8234 =item B<Host> I<Hostname>
8236 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
8239 =item B<Port> I<Port>
8241 The B<Port> option is the TCP port on which the Redis instance accepts
8242 connections. Either a service name of a port number may be given. Please note
8243 that numerical port numbers must be given as a string, too.
8245 =item B<Timeout> I<Milliseconds>
8247 The B<Timeout> option sets the socket connection timeout, in milliseconds.
8249 =item B<Prefix> I<Prefix>
8251 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
8252 containing all metrics. Defaults to C<collectd/>, so metrics will have names
8253 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
8254 is recommended but not required to include a trailing slash in I<Prefix>.
8256 =item B<Database> I<Index>
8258 This index selects the redis database to use for writing operations. Defaults
8261 =item B<MaxSetSize> I<Items>
8263 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
8264 hold. Negative values for I<Items> sets no limit, which is the default behavior.
8266 =item B<StoreRates> B<true>|B<false>
8268 If set to B<true> (the default), convert counter values to rates. If set to
8269 B<false> counter values are stored as is, i.e. as an increasing integer number.
8273 =head2 Plugin C<write_riemann>
8275 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
8276 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
8277 I<Riemann> using UDP packets.
8281 <Plugin "write_riemann">
8287 AlwaysAppendDS false
8291 Attribute "foo" "bar"
8294 The following options are understood by the I<write_riemann plugin>:
8298 =item E<lt>B<Node> I<Name>E<gt>
8300 The plugin's configuration consists of one or more B<Node> blocks. Each block
8301 is given a unique I<Name> and specifies one connection to an instance of
8302 I<Riemann>. Indise the B<Node> block, the following per-connection options are
8307 =item B<Host> I<Address>
8309 Hostname or address to connect to. Defaults to C<localhost>.
8311 =item B<Port> I<Service>
8313 Service name or port number to connect to. Defaults to C<5555>.
8315 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
8317 Specify the protocol to use when communicating with I<Riemann>. Defaults to
8320 =item B<TLSCertFile> I<Path>
8322 When using the B<TLS> protocol, path to a PEM certificate to present
8325 =item B<TLSCAFile> I<Path>
8327 When using the B<TLS> protocol, path to a PEM CA certificate to
8328 use to validate the remote hosts's identity.
8330 =item B<TLSKeyFile> I<Path>
8332 When using the B<TLS> protocol, path to a PEM private key associated
8333 with the certificate defined by B<TLSCertFile>.
8335 =item B<Batch> B<true>|B<false>
8337 If set to B<true> and B<Protocol> is set to B<TCP>,
8338 events will be batched in memory and flushed at
8339 regular intervals or when B<BatchMaxSize> is exceeded.
8341 Notifications are not batched and sent as soon as possible.
8343 When enabled, it can occur that events get processed by the Riemann server
8344 close to or after their expiration time. Tune the B<TTLFactor> and
8345 B<BatchMaxSize> settings according to the amount of values collected, if this
8350 =item B<BatchMaxSize> I<size>
8352 Maximum payload size for a riemann packet. Defaults to 8192
8354 =item B<BatchFlushTimeout> I<seconds>
8356 Maximum amount of seconds to wait in between to batch flushes.
8357 No timeout by default.
8359 =item B<StoreRates> B<true>|B<false>
8361 If set to B<true> (the default), convert counter values to rates. If set to
8362 B<false> counter values are stored as is, i.e. as an increasing integer number.
8364 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
8365 converted values will have "rate" appended to the data source type, e.g.
8366 C<ds_type:derive:rate>.
8368 =item B<AlwaysAppendDS> B<false>|B<true>
8370 If set to B<true>, append the name of the I<Data Source> (DS) to the
8371 "service", i.e. the field that, together with the "host" field, uniquely
8372 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
8373 only done when there is more than one DS.
8375 =item B<TTLFactor> I<Factor>
8377 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
8378 event is considered active. I<collectd> populates this field based on the
8379 metrics interval setting. This setting controls the factor with which the
8380 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
8381 know exactly what you're doing, you should only increase this setting from its
8384 =item B<Notifications> B<false>|B<true>
8386 If set to B<true>, create riemann events for notifications. This is B<true>
8387 by default. When processing thresholds from write_riemann, it might prove
8388 useful to avoid getting notification events.
8390 =item B<CheckThresholds> B<false>|B<true>
8392 If set to B<true>, attach state to events based on thresholds defined
8393 in the B<Threshold> plugin. Defaults to B<false>.
8395 =item B<EventServicePrefix> I<String>
8397 Add the given string as a prefix to the event service name.
8398 If B<EventServicePrefix> not set or set to an empty string (""),
8399 no prefix will be used.
8403 =item B<Tag> I<String>
8405 Add the given string as an additional tag to the metric being sent to
8408 =item B<Attribute> I<String> I<String>
8410 Consider the two given strings to be the key and value of an additional
8411 attribute for each metric being sent out to I<Riemann>.
8415 =head2 Plugin C<write_sensu>
8417 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
8418 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
8419 a local I<Sensu> client using a TCP socket.
8421 At the moment, the I<write_sensu plugin> does not send over a collectd_host
8422 parameter so it is not possible to use one collectd instance as a gateway for
8423 others. Each collectd host must pair with one I<Sensu> client.
8427 <Plugin "write_sensu">
8432 AlwaysAppendDS false
8433 MetricHandler "influx"
8434 MetricHandler "default"
8435 NotificationHandler "flapjack"
8436 NotificationHandler "howling_monkey"
8440 Attribute "foo" "bar"
8443 The following options are understood by the I<write_sensu plugin>:
8447 =item E<lt>B<Node> I<Name>E<gt>
8449 The plugin's configuration consists of one or more B<Node> blocks. Each block
8450 is given a unique I<Name> and specifies one connection to an instance of
8451 I<Sensu>. Inside the B<Node> block, the following per-connection options are
8456 =item B<Host> I<Address>
8458 Hostname or address to connect to. Defaults to C<localhost>.
8460 =item B<Port> I<Service>
8462 Service name or port number to connect to. Defaults to C<3030>.
8464 =item B<StoreRates> B<true>|B<false>
8466 If set to B<true> (the default), convert counter values to rates. If set to
8467 B<false> counter values are stored as is, i.e. as an increasing integer number.
8469 This will be reflected in the C<collectd_data_source_type> tag: If
8470 B<StoreRates> is enabled, converted values will have "rate" appended to the
8471 data source type, e.g. C<collectd_data_source_type:derive:rate>.
8473 =item B<AlwaysAppendDS> B<false>|B<true>
8475 If set the B<true>, append the name of the I<Data Source> (DS) to the
8476 "service", i.e. the field that, together with the "host" field, uniquely
8477 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
8478 only done when there is more than one DS.
8480 =item B<Notifications> B<false>|B<true>
8482 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
8483 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
8485 =item B<Metrics> B<false>|B<true>
8487 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
8488 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
8491 =item B<Separator> I<String>
8493 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
8495 =item B<MetricHandler> I<String>
8497 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
8498 several of them, one per line. Defaults to no handler.
8500 =item B<NotificationHandler> I<String>
8502 Add a handler that will be set when notifications are sent to I<Sensu>. You can
8503 add several of them, one per line. Defaults to no handler.
8505 =item B<EventServicePrefix> I<String>
8507 Add the given string as a prefix to the event service name.
8508 If B<EventServicePrefix> not set or set to an empty string (""),
8509 no prefix will be used.
8513 =item B<Tag> I<String>
8515 Add the given string as an additional tag to the metric being sent to
8518 =item B<Attribute> I<String> I<String>
8520 Consider the two given strings to be the key and value of an additional
8521 attribute for each metric being sent out to I<Sensu>.
8525 =head2 Plugin C<xencpu>
8527 This plugin collects metrics of hardware CPU load for machine running Xen
8528 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
8529 Result is reported using the C<percent> type, for each CPU (core).
8531 This plugin doesn't have any options (yet).
8533 =head2 Plugin C<zookeeper>
8535 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
8536 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
8541 <Plugin "zookeeper">
8548 =item B<Host> I<Address>
8550 Hostname or address to connect to. Defaults to C<localhost>.
8552 =item B<Port> I<Service>
8554 Service name or port number to connect to. Defaults to C<2181>.
8558 =head1 THRESHOLD CONFIGURATION
8560 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
8561 we mean that the values are not only stored or sent somewhere, but that they
8562 are judged and, if a problem is recognized, acted upon. The only action
8563 collectd takes itself is to generate and dispatch a "notification". Plugins can
8564 register to receive notifications and perform appropriate further actions.
8566 Since systems and what you expect them to do differ a lot, you can configure
8567 B<thresholds> for your values freely. This gives you a lot of flexibility but
8568 also a lot of responsibility.
8570 Every time a value is out of range a notification is dispatched. This means
8571 that the idle percentage of your CPU needs to be less then the configured
8572 threshold only once for a notification to be generated. There's no such thing
8573 as a moving average or similar - at least not now.
8575 Also, all values that match a threshold are considered to be relevant or
8576 "interesting". As a consequence collectd will issue a notification if they are
8577 not received for B<Timeout> iterations. The B<Timeout> configuration option is
8578 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
8579 "2" (the default) and some hosts sends it's CPU statistics to the server every
8580 60 seconds, a notification will be dispatched after about 120 seconds. It may
8581 take a little longer because the timeout is checked only once each B<Interval>
8584 When a value comes within range again or is received after it was missing, an
8585 "OKAY-notification" is dispatched.
8587 Here is a configuration example to get you started. Read below for more
8600 <Plugin "interface">
8617 WarningMin 100000000
8623 There are basically two types of configuration statements: The C<Host>,
8624 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
8625 configured. The C<Plugin> and C<Type> blocks may be specified further using the
8626 C<Instance> option. You can combine the block by nesting the blocks, though
8627 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
8628 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
8629 C<Type> may not contain other blocks. If multiple blocks apply to the same
8630 value the most specific block is used.
8632 The other statements specify the threshold to configure. They B<must> be
8633 included in a C<Type> block. Currently the following statements are recognized:
8637 =item B<FailureMax> I<Value>
8639 =item B<WarningMax> I<Value>
8641 Sets the upper bound of acceptable values. If unset defaults to positive
8642 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
8643 will be created. If the value is greater than B<WarningMax> but less than (or
8644 equal to) B<FailureMax> a B<WARNING> notification will be created.
8646 =item B<FailureMin> I<Value>
8648 =item B<WarningMin> I<Value>
8650 Sets the lower bound of acceptable values. If unset defaults to negative
8651 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
8652 be created. If the value is less than B<WarningMin> but greater than (or equal
8653 to) B<FailureMin> a B<WARNING> notification will be created.
8655 =item B<DataSource> I<DSName>
8657 Some data sets have more than one "data source". Interesting examples are the
8658 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
8659 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
8660 system load data set, C<load>, even has three data sources: C<shortterm>,
8661 C<midterm>, and C<longterm>.
8663 Normally, all data sources are checked against a configured threshold. If this
8664 is undesirable, or if you want to specify different limits for each data
8665 source, you can use the B<DataSource> option to have a threshold apply only to
8668 =item B<Invert> B<true>|B<false>
8670 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
8671 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
8672 B<WarningMax>) are not okay. Defaults to B<false>.
8674 =item B<Persist> B<true>|B<false>
8676 Sets how often notifications are generated. If set to B<true> one notification
8677 will be generated for each value that is out of the acceptable range. If set to
8678 B<false> (the default) then a notification is only generated if a value is out
8679 of range but the previous value was okay.
8681 This applies to missing values, too: If set to B<true> a notification about a
8682 missing value is generated once every B<Interval> seconds. If set to B<false>
8683 only one such notification is generated until the value appears again.
8685 =item B<Percentage> B<true>|B<false>
8687 If set to B<true>, the minimum and maximum values given are interpreted as
8688 percentage value, relative to the other data sources. This is helpful for
8689 example for the "df" type, where you may want to issue a warning when less than
8690 5E<nbsp>% of the total space is available. Defaults to B<false>.
8692 =item B<Hits> I<Number>
8694 Delay creating the notification until the threshold has been passed I<Number>
8695 times. When a notification has been generated, or when a subsequent value is
8696 inside the threshold, the counter is reset. If, for example, a value is
8697 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
8698 will be dispatched at most once every 30E<nbsp>seconds.
8700 This is useful when short bursts are not a problem. If, for example, 100% CPU
8701 usage for up to a minute is normal (and data is collected every
8702 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
8704 =item B<Hysteresis> I<Number>
8706 When set to non-zero, a hysteresis value is applied when checking minimum and
8707 maximum bounds. This is useful for values that increase slowly and fluctuate a
8708 bit while doing so. When these values come close to the threshold, they may
8709 "flap", i.e. switch between failure / warning case and okay case repeatedly.
8711 If, for example, the threshold is configures as
8716 then a I<Warning> notification is created when the value exceeds I<101> and the
8717 corresponding I<Okay> notification is only created once the value falls below
8718 I<99>, thus avoiding the "flapping".
8722 =head1 FILTER CONFIGURATION
8724 Starting with collectd 4.6 there is a powerful filtering infrastructure
8725 implemented in the daemon. The concept has mostly been copied from
8726 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
8727 terminology, so that users that are familiar with iptables feel right at home.
8731 The following are the terms used in the remainder of the filter configuration
8732 documentation. For an ASCII-art schema of the mechanism, see
8733 L<"General structure"> below.
8739 A I<match> is a criteria to select specific values. Examples are, of course, the
8740 name of the value or it's current value.
8742 Matches are implemented in plugins which you have to load prior to using the
8743 match. The name of such plugins starts with the "match_" prefix.
8747 A I<target> is some action that is to be performed with data. Such actions
8748 could, for example, be to change part of the value's identifier or to ignore
8749 the value completely.
8751 Some of these targets are built into the daemon, see L<"Built-in targets">
8752 below. Other targets are implemented in plugins which you have to load prior to
8753 using the target. The name of such plugins starts with the "target_" prefix.
8757 The combination of any number of matches and at least one target is called a
8758 I<rule>. The target actions will be performed for all values for which B<all>
8759 matches apply. If the rule does not have any matches associated with it, the
8760 target action will be performed for all values.
8764 A I<chain> is a list of rules and possibly default targets. The rules are tried
8765 in order and if one matches, the associated target will be called. If a value
8766 is handled by a rule, it depends on the target whether or not any subsequent
8767 rules are considered or if traversal of the chain is aborted, see
8768 L<"Flow control"> below. After all rules have been checked, the default targets
8773 =head2 General structure
8775 The following shows the resulting structure:
8782 +---------+ +---------+ +---------+ +---------+
8783 ! Rule !->! Match !->! Match !->! Target !
8784 +---------+ +---------+ +---------+ +---------+
8787 +---------+ +---------+ +---------+
8788 ! Rule !->! Target !->! Target !
8789 +---------+ +---------+ +---------+
8796 +---------+ +---------+ +---------+
8797 ! Rule !->! Match !->! Target !
8798 +---------+ +---------+ +---------+
8808 There are four ways to control which way a value takes through the filter
8815 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
8816 process the value with another chain. When the called chain finishes, usually
8817 the next target or rule after the jump is executed.
8821 The stop condition, signaled for example by the built-in target B<stop>, causes
8822 all processing of the value to be stopped immediately.
8826 Causes processing in the current chain to be aborted, but processing of the
8827 value generally will continue. This means that if the chain was called via
8828 B<Jump>, the next target or rule after the jump will be executed. If the chain
8829 was not called by another chain, control will be returned to the daemon and it
8830 may pass the value to another chain.
8834 Most targets will signal the B<continue> condition, meaning that processing
8835 should continue normally. There is no special built-in target for this
8842 The configuration reflects this structure directly:
8844 PostCacheChain "PostCache"
8846 <Rule "ignore_mysql_show">
8849 Type "^mysql_command$"
8850 TypeInstance "^show_"
8860 The above configuration example will ignore all values where the plugin field
8861 is "mysql", the type is "mysql_command" and the type instance begins with
8862 "show_". All other values will be sent to the C<rrdtool> write plugin via the
8863 default target of the chain. Since this chain is run after the value has been
8864 added to the cache, the MySQL C<show_*> command statistics will be available
8865 via the C<unixsock> plugin.
8867 =head2 List of configuration options
8871 =item B<PreCacheChain> I<ChainName>
8873 =item B<PostCacheChain> I<ChainName>
8875 Configure the name of the "pre-cache chain" and the "post-cache chain". The
8876 argument is the name of a I<chain> that should be executed before and/or after
8877 the values have been added to the cache.
8879 To understand the implications, it's important you know what is going on inside
8880 I<collectd>. The following diagram shows how values are passed from the
8881 read-plugins to the write-plugins:
8887 + - - - - V - - - - +
8888 : +---------------+ :
8891 : +-------+-------+ :
8894 : +-------+-------+ : +---------------+
8895 : ! Cache !--->! Value Cache !
8896 : ! insert ! : +---+---+-------+
8897 : +-------+-------+ : ! !
8898 : ! ,------------' !
8900 : +-------+---+---+ : +-------+-------+
8901 : ! Post-Cache +--->! Write-Plugins !
8902 : ! Chain ! : +---------------+
8903 : +---------------+ :
8906 + - - - - - - - - - +
8908 After the values are passed from the "read" plugins to the dispatch functions,
8909 the pre-cache chain is run first. The values are added to the internal cache
8910 afterwards. The post-cache chain is run after the values have been added to the
8911 cache. So why is it such a huge deal if chains are run before or after the
8912 values have been added to this cache?
8914 Targets that change the identifier of a value list should be executed before
8915 the values are added to the cache, so that the name in the cache matches the
8916 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
8917 this cache to receive a list of all available values. If you change the
8918 identifier after the value list has been added to the cache, this may easily
8919 lead to confusion, but it's not forbidden of course.
8921 The cache is also used to convert counter values to rates. These rates are, for
8922 example, used by the C<value> match (see below). If you use the rate stored in
8923 the cache B<before> the new value is added, you will use the old, B<previous>
8924 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
8925 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
8928 Last but not last, the B<stop> target makes a difference: If the pre-cache
8929 chain returns the stop condition, the value will not be added to the cache and
8930 the post-cache chain will not be run.
8932 =item B<Chain> I<Name>
8934 Adds a new chain with a certain name. This name can be used to refer to a
8935 specific chain, for example to jump to it.
8937 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
8939 =item B<Rule> [I<Name>]
8941 Adds a new rule to the current chain. The name of the rule is optional and
8942 currently has no meaning for the daemon.
8944 Within the B<Rule> block, there may be any number of B<Match> blocks and there
8945 must be at least one B<Target> block.
8947 =item B<Match> I<Name>
8949 Adds a match to a B<Rule> block. The name specifies what kind of match should
8950 be performed. Available matches depend on the plugins that have been loaded.
8952 The arguments inside the B<Match> block are passed to the plugin implementing
8953 the match, so which arguments are valid here depends on the plugin being used.
8954 If you do not need any to pass any arguments to a match, you can use the
8959 Which is equivalent to:
8964 =item B<Target> I<Name>
8966 Add a target to a rule or a default target to a chain. The name specifies what
8967 kind of target is to be added. Which targets are available depends on the
8968 plugins being loaded.
8970 The arguments inside the B<Target> block are passed to the plugin implementing
8971 the target, so which arguments are valid here depends on the plugin being used.
8972 If you do not need any to pass any arguments to a target, you can use the
8977 This is the same as writing:
8984 =head2 Built-in targets
8986 The following targets are built into the core daemon and therefore need no
8987 plugins to be loaded:
8993 Signals the "return" condition, see the L<"Flow control"> section above. This
8994 causes the current chain to stop processing the value and returns control to
8995 the calling chain. The calling chain will continue processing targets and rules
8996 just after the B<jump> target (see below). This is very similar to the
8997 B<RETURN> target of iptables, see L<iptables(8)>.
8999 This target does not have any options.
9007 Signals the "stop" condition, see the L<"Flow control"> section above. This
9008 causes processing of the value to be aborted immediately. This is similar to
9009 the B<DROP> target of iptables, see L<iptables(8)>.
9011 This target does not have any options.
9019 Sends the value to "write" plugins.
9025 =item B<Plugin> I<Name>
9027 Name of the write plugin to which the data should be sent. This option may be
9028 given multiple times to send the data to more than one write plugin. If the
9029 plugin supports multiple instances, the plugin's instance(s) must also be
9034 If no plugin is explicitly specified, the values will be sent to all available
9037 Single-instance plugin example:
9043 Multi-instance plugin example:
9045 <Plugin "write_graphite">
9055 Plugin "write_graphite/foo"
9060 Starts processing the rules of another chain, see L<"Flow control"> above. If
9061 the end of that chain is reached, or a stop condition is encountered,
9062 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
9063 next target or the next rule. This is similar to the B<-j> command line option
9064 of iptables, see L<iptables(8)>.
9070 =item B<Chain> I<Name>
9072 Jumps to the chain I<Name>. This argument is required and may appear only once.
9084 =head2 Available matches
9090 Matches a value using regular expressions.
9096 =item B<Host> I<Regex>
9098 =item B<Plugin> I<Regex>
9100 =item B<PluginInstance> I<Regex>
9102 =item B<Type> I<Regex>
9104 =item B<TypeInstance> I<Regex>
9106 Match values where the given regular expressions match the various fields of
9107 the identifier of a value. If multiple regular expressions are given, B<all>
9108 regexen must match for a value to match.
9110 =item B<Invert> B<false>|B<true>
9112 When set to B<true>, the result of the match is inverted, i.e. all value lists
9113 where all regular expressions apply are not matched, all other value lists are
9114 matched. Defaults to B<false>.
9121 Host "customer[0-9]+"
9127 Matches values that have a time which differs from the time on the server.
9129 This match is mainly intended for servers that receive values over the
9130 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
9131 is very sensitive to the timestamp used when updating the RRD files. In
9132 particular, the time must be ever increasing. If a misbehaving client sends one
9133 packet with a timestamp far in the future, all further packets with a correct
9134 time will be ignored because of that one packet. What's worse, such corrupted
9135 RRD files are hard to fix.
9137 This match lets one match all values B<outside> a specified time range
9138 (relative to the server's time), so you can use the B<stop> target (see below)
9139 to ignore the value, for example.
9145 =item B<Future> I<Seconds>
9147 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
9148 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
9151 =item B<Past> I<Seconds>
9153 Matches all values that are I<behind> of the server's time by I<Seconds> or
9154 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
9166 This example matches all values that are five minutes or more ahead of the
9167 server or one hour (or more) lagging behind.
9171 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
9172 values. If a data-set consists of more than one data-source, all data-sources
9173 must match the specified ranges for a positive match.
9179 =item B<Min> I<Value>
9181 Sets the smallest value which still results in a match. If unset, behaves like
9184 =item B<Max> I<Value>
9186 Sets the largest value which still results in a match. If unset, behaves like
9189 =item B<Invert> B<true>|B<false>
9191 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
9192 no-match is returned and vice versa. Please note that the B<Invert> setting
9193 only effects how B<Min> and B<Max> are applied to a specific value. Especially
9194 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
9196 =item B<DataSource> I<DSName> [I<DSName> ...]
9198 Select one or more of the data sources. If no data source is configured, all
9199 data sources will be checked. If the type handled by the match does not have a
9200 data source of the specified name(s), this will always result in no match
9201 (independent of the B<Invert> setting).
9203 =item B<Satisfy> B<Any>|B<All>
9205 Specifies how checking with several data sources is performed. If set to
9206 B<Any>, the match succeeds if one of the data sources is in the configured
9207 range. If set to B<All> the match only succeeds if all data sources are within
9208 the configured range. Default is B<All>.
9210 Usually B<All> is used for positive matches, B<Any> is used for negative
9211 matches. This means that with B<All> you usually check that all values are in a
9212 "good" range, while with B<Any> you check if any value is within a "bad" range
9213 (or outside the "good" range).
9217 Either B<Min> or B<Max>, but not both, may be unset.
9221 # Match all values smaller than or equal to 100. Matches only if all data
9222 # sources are below 100.
9228 # Match if the value of any data source is outside the range of 0 - 100.
9236 =item B<empty_counter>
9238 Matches all values with one or more data sources of type B<COUNTER> and where
9239 all counter values are zero. These counters usually I<never> increased since
9240 they started existing (and are therefore uninteresting), or got reset recently
9241 or overflowed and you had really, I<really> bad luck.
9243 Please keep in mind that ignoring such counters can result in confusing
9244 behavior: Counters which hardly ever increase will be zero for long periods of
9245 time. If the counter is reset for some reason (machine or service restarted,
9246 usually), the graph will be empty (NAN) for a long time. People may not
9251 Calculates a hash value of the host name and matches values according to that
9252 hash value. This makes it possible to divide all hosts into groups and match
9253 only values that are in a specific group. The intended use is in load
9254 balancing, where you want to handle only part of all data and leave the rest
9257 The hashing function used tries to distribute the hosts evenly. First, it
9258 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
9261 for (i = 0; host[i] != 0; i++)
9262 hash_value = (hash_value * 251) + host[i];
9264 The constant 251 is a prime number which is supposed to make this hash value
9265 more random. The code then checks the group for this host according to the
9266 I<Total> and I<Match> arguments:
9268 if ((hash_value % Total) == Match)
9273 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
9274 groups), then the least significant bit of the hash value will be the XOR of
9275 all least significant bits in the host name. One consequence is that when you
9276 have two hosts, "server0.example.com" and "server1.example.com", where the host
9277 name differs in one digit only and the digits differ by one, those hosts will
9278 never end up in the same group.
9284 =item B<Match> I<Match> I<Total>
9286 Divide the data into I<Total> groups and match all hosts in group I<Match> as
9287 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
9288 be smaller than I<Total>. I<Total> must be at least one, although only values
9289 greater than one really do make any sense.
9291 You can repeat this option to match multiple groups, for example:
9296 The above config will divide the data into seven groups and match groups three
9297 and five. One use would be to keep every value on two hosts so that if one
9298 fails the missing data can later be reconstructed from the second host.
9304 # Operate on the pre-cache chain, so that ignored values are not even in the
9309 # Divide all received hosts in seven groups and accept all hosts in
9313 # If matched: Return and continue.
9316 # If not matched: Return and stop.
9322 =head2 Available targets
9326 =item B<notification>
9328 Creates and dispatches a notification.
9334 =item B<Message> I<String>
9336 This required option sets the message of the notification. The following
9337 placeholders will be replaced by an appropriate value:
9345 =item B<%{plugin_instance}>
9349 =item B<%{type_instance}>
9351 These placeholders are replaced by the identifier field of the same name.
9353 =item B<%{ds:>I<name>B<}>
9355 These placeholders are replaced by a (hopefully) human readable representation
9356 of the current rate of this data source. If you changed the instance name
9357 (using the B<set> or B<replace> targets, see below), it may not be possible to
9358 convert counter values to rates.
9362 Please note that these placeholders are B<case sensitive>!
9364 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
9366 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
9373 <Target "notification">
9374 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
9380 Replaces parts of the identifier using regular expressions.
9386 =item B<Host> I<Regex> I<Replacement>
9388 =item B<Plugin> I<Regex> I<Replacement>
9390 =item B<PluginInstance> I<Regex> I<Replacement>
9392 =item B<TypeInstance> I<Regex> I<Replacement>
9394 Match the appropriate field with the given regular expression I<Regex>. If the
9395 regular expression matches, that part that matches is replaced with
9396 I<Replacement>. If multiple places of the input buffer match a given regular
9397 expression, only the first occurrence will be replaced.
9399 You can specify each option multiple times to use multiple regular expressions
9407 # Replace "example.net" with "example.com"
9408 Host "\\<example.net\\>" "example.com"
9410 # Strip "www." from hostnames
9416 Sets part of the identifier of a value to a given string.
9422 =item B<Host> I<String>
9424 =item B<Plugin> I<String>
9426 =item B<PluginInstance> I<String>
9428 =item B<TypeInstance> I<String>
9430 =item B<MetaData> I<String> I<String>
9432 Set the appropriate field to the given string. The strings for plugin instance
9433 and type instance may be empty, the strings for host and plugin may not be
9434 empty. It's currently not possible to set the type of a value this way.
9441 PluginInstance "coretemp"
9442 TypeInstance "core3"
9447 =head2 Backwards compatibility
9449 If you use collectd with an old configuration, i.E<nbsp>e. one without a
9450 B<Chain> block, it will behave as it used to. This is equivalent to the
9451 following configuration:
9457 If you specify a B<PostCacheChain>, the B<write> target will not be added
9458 anywhere and you will have to make sure that it is called where appropriate. We
9459 suggest to add the above snippet as default target to your "PostCache" chain.
9463 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
9478 B<Ignorelists> are a generic framework to either ignore some metrics or report
9479 specific metircs only. Plugins usually provide one or more options to specify
9480 the items (mounts points, devices, ...) and the boolean option
9485 =item B<Select> I<String>
9487 Selects the item I<String>. This option often has a plugin specific name, e.g.
9488 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
9489 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
9490 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
9492 By default, this option is doing a case-sensitive full-string match. The
9493 following config will match C<foo>, but not C<Foo>:
9497 If I<String> starts and ends with C</> (a slash), the string is compiled as a
9498 I<regular expression>. For example, so match all item starting with C<foo>, use
9499 could use the following syntax:
9503 The regular expression is I<not> anchored, i.e. the following config will match
9504 C<foobar>, C<barfoo> and C<AfooZ>:
9508 The B<Select> option may be repeated to select multiple items.
9510 =item B<IgnoreSelected> B<true>|B<false>
9512 If set to B<true>, matching metrics are I<ignored> and all other metrics are
9513 collected. If set to B<false>, matching metrics are I<collected> and all other
9514 metrics are ignored.
9521 L<collectd-exec(5)>,
9522 L<collectd-perl(5)>,
9523 L<collectd-unixsock(5)>,
9536 Florian Forster E<lt>octo@collectd.orgE<gt>