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 =item B<Interval> I<Seconds>
246 Configures the interval in which to query the read plugins. Obviously smaller
247 values lead to a higher system load produced by collectd, while higher values
248 lead to more coarse statistics.
250 B<Warning:> You should set this once and then never touch it again. If you do,
251 I<you will have to delete all your RRD files> or know some serious RRDtool
252 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
254 =item B<MaxReadInterval> I<Seconds>
256 A read plugin doubles the interval between queries after each failed attempt
259 This options limits the maximum value of the interval. The default value is
262 =item B<Timeout> I<Iterations>
264 Consider a value list "missing" when no update has been read or received for
265 I<Iterations> iterations. By default, I<collectd> considers a value list
266 missing when no update has been received for twice the update interval. Since
267 this setting uses iterations, the maximum allowed time without update depends
268 on the I<Interval> information contained in each value list. This is used in
269 the I<Threshold> configuration to dispatch notifications about missing values,
270 see L<collectd-threshold(5)> for details.
272 =item B<ReadThreads> I<Num>
274 Number of threads to start for reading plugins. The default value is B<5>, but
275 you may want to increase this if you have more than five plugins that take a
276 long time to read. Mostly those are plugins that do network-IO. Setting this to
277 a value higher than the number of registered read callbacks is not recommended.
279 =item B<WriteThreads> I<Num>
281 Number of threads to start for dispatching value lists to write plugins. The
282 default value is B<5>, but you may want to increase this if you have more than
283 five plugins that may take relatively long to write to.
285 =item B<WriteQueueLimitHigh> I<HighNum>
287 =item B<WriteQueueLimitLow> I<LowNum>
289 Metrics are read by the I<read threads> and then put into a queue to be handled
290 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
291 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
292 running into memory issues in such a case, you can limit the size of this
295 By default, there is no limit and memory may grow indefinitely. This is most
296 likely not an issue for clients, i.e. instances that only handle the local
297 metrics. For servers it is recommended to set this to a non-zero value, though.
299 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
300 Each of them takes a numerical argument which is the number of metrics in the
301 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
302 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
303 I<will> be enqueued. If the number of metrics currently in the queue is between
304 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
305 proportional to the number of metrics in the queue (i.e. it increases linearly
306 until it reaches 100%.)
308 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
309 unset, the latter will default to half of B<WriteQueueLimitHigh>.
311 If you do not want to randomly drop values when the queue size is between
312 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
315 Enabling the B<CollectInternalStats> option is of great help to figure out the
316 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
318 =item B<Hostname> I<Name>
320 Sets the hostname that identifies a host. If you omit this setting, the
321 hostname will be determined using the L<gethostname(2)> system call.
323 =item B<FQDNLookup> B<true|false>
325 If B<Hostname> is determined automatically this setting controls whether or not
326 the daemon should try to figure out the "fully qualified domain name", FQDN.
327 This is done using a lookup of the name returned by C<gethostname>. This option
328 is enabled by default.
330 =item B<PreCacheChain> I<ChainName>
332 =item B<PostCacheChain> I<ChainName>
334 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
335 see L<FILTER CONFIGURATION> below on information on chains and how these
336 setting change the daemon's behavior.
340 =head1 PLUGIN OPTIONS
342 Some plugins may register own options. These options must be enclosed in a
343 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
344 require external configuration, too. The C<apache plugin>, for example,
345 required C<mod_status> to be configured in the webserver you're going to
346 collect data from. These plugins are listed below as well, even if they don't
347 require any configuration within collectd's configuration file.
349 A list of all plugins and a short summary for each plugin can be found in the
350 F<README> file shipped with the sourcecode and hopefully binary packets as
353 =head2 Plugin C<aggregation>
355 The I<Aggregation plugin> makes it possible to aggregate several values into
356 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
357 This can be put to a wide variety of uses, e.g. average and total CPU
358 statistics for your entire fleet.
360 The grouping is powerful but, as with many powerful tools, may be a bit
361 difficult to wrap your head around. The grouping will therefore be
362 demonstrated using an example: The average and sum of the CPU usage across
363 all CPUs of each host is to be calculated.
365 To select all the affected values for our example, set C<Plugin cpu> and
366 C<Type cpu>. The other values are left unspecified, meaning "all values". The
367 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
368 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
374 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
375 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
376 example, the intention is to have a new value for each host / type instance
377 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
378 It can be specified multiple times to group by more than one field.
381 GroupBy "TypeInstance"
383 We do neither specify nor group by I<plugin instance> (the CPU number), so all
384 metrics that differ in the CPU number only will be aggregated. Each
385 aggregation needs I<at least one> such field, otherwise no aggregation would
388 The full example configuration looks like this:
390 <Plugin "aggregation">
396 GroupBy "TypeInstance"
399 CalculateAverage true
403 There are a couple of limitations you should be aware of:
409 The I<Type> cannot be left unspecified, because it is not reasonable to add
410 apples to oranges. Also, the internal lookup structure won't work if you try
415 There must be at least one unspecified, ungrouped field. Otherwise nothing
420 As you can see in the example above, each aggregation has its own
421 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
422 blocks may match the same values, i.e. one value list can update multiple
423 aggregations. The following options are valid inside B<Aggregation> blocks:
427 =item B<Host> I<Host>
429 =item B<Plugin> I<Plugin>
431 =item B<PluginInstance> I<PluginInstance>
433 =item B<Type> I<Type>
435 =item B<TypeInstance> I<TypeInstance>
437 Selects the value lists to be added to this aggregation. B<Type> must be a
438 valid data set name, see L<types.db(5)> for details.
440 If the string starts with and ends with a slash (C</>), the string is
441 interpreted as a I<regular expression>. The regex flavor used are POSIX
442 extended regular expressions as described in L<regex(7)>. Example usage:
444 Host "/^db[0-9]\\.example\\.com$/"
446 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
448 Group valued by the specified field. The B<GroupBy> option may be repeated to
449 group by multiple fields.
451 =item B<SetHost> I<Host>
453 =item B<SetPlugin> I<Plugin>
455 =item B<SetPluginInstance> I<PluginInstance>
457 =item B<SetTypeInstance> I<TypeInstance>
459 Sets the appropriate part of the identifier to the provided string.
461 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
462 will be replaced with the aggregation function, e.g. "average". Not including
463 the placeholder will result in duplication warnings and/or messed up values if
464 more than one aggregation function are enabled.
466 The following example calculates the average usage of all "even" CPUs:
468 <Plugin "aggregation">
471 PluginInstance "/[0,2,4,6,8]$/"
475 SetPluginInstance "even-%{aggregation}"
478 GroupBy "TypeInstance"
480 CalculateAverage true
484 This will create the files:
490 foo.example.com/cpu-even-average/cpu-idle
494 foo.example.com/cpu-even-average/cpu-system
498 foo.example.com/cpu-even-average/cpu-user
506 =item B<CalculateNum> B<true>|B<false>
508 =item B<CalculateSum> B<true>|B<false>
510 =item B<CalculateAverage> B<true>|B<false>
512 =item B<CalculateMinimum> B<true>|B<false>
514 =item B<CalculateMaximum> B<true>|B<false>
516 =item B<CalculateStddev> B<true>|B<false>
518 Boolean options for enabling calculation of the number of value lists, their
519 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
520 are disabled by default.
524 =head2 Plugin C<amqp>
526 The I<AMQP plugin> can be used to communicate with other instances of
527 I<collectd> or third party applications using an AMQP message broker. Values
528 are sent to or received from the broker, which handles routing, queueing and
529 possibly filtering out messages.
534 # Send values to an AMQP broker
535 <Publish "some_name">
541 Exchange "amq.fanout"
542 # ExchangeType "fanout"
543 # RoutingKey "collectd"
545 # ConnectionRetryDelay 0
548 # GraphitePrefix "collectd."
549 # GraphiteEscapeChar "_"
550 # GraphiteSeparateInstances false
551 # GraphiteAlwaysAppendDS false
554 # Receive values from an AMQP broker
555 <Subscribe "some_name">
561 Exchange "amq.fanout"
562 # ExchangeType "fanout"
565 # QueueAutoDelete true
566 # RoutingKey "collectd.#"
567 # ConnectionRetryDelay 0
571 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
572 blocks, which configure sending and receiving of values respectively. The two
573 blocks are very similar, so unless otherwise noted, an option can be used in
574 either block. The name given in the blocks starting tag is only used for
575 reporting messages, but may be used to support I<flushing> of certain
576 I<Publish> blocks in the future.
580 =item B<Host> I<Host>
582 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
583 the underlying communications library, I<rabbitmq-c>, which is "localhost".
585 =item B<Port> I<Port>
587 Service name or port number on which the AMQP broker accepts connections. This
588 argument must be a string, even if the numeric form is used. Defaults to
591 =item B<VHost> I<VHost>
593 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
595 =item B<User> I<User>
597 =item B<Password> I<Password>
599 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
602 =item B<Exchange> I<Exchange>
604 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
605 By default, "amq.fanout" will be used.
607 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
608 the given exchange and the I<queue> is created, using the I<routing key> if
609 configured. See the B<Queue> and B<RoutingKey> options below.
611 =item B<ExchangeType> I<Type>
613 If given, the plugin will try to create the configured I<exchange> with this
614 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
615 be bound to this exchange.
617 =item B<Queue> I<Queue> (Subscribe only)
619 Configures the I<queue> name to subscribe to. If no queue name was configured
620 explicitly, a unique queue name will be created by the broker.
622 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
624 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
625 or transient (will disappear if the AMQP broker is restarted). Defaults to
628 This option should be used in conjunction with the I<Persistent> option on the
631 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
633 Defines if the I<queue> subscribed to will be deleted once the last consumer
634 unsubscribes. Defaults to "true".
636 =item B<RoutingKey> I<Key>
638 In I<Publish> blocks, this configures the routing key to set on all outgoing
639 messages. If not given, the routing key will be computed from the I<identifier>
640 of the value. The host, plugin, type and the two instances are concatenated
641 together using dots as the separator and all containing dots replaced with
642 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
643 possible to receive only specific values using a "topic" exchange.
645 In I<Subscribe> blocks, configures the I<routing key> used when creating a
646 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
647 used to filter messages when using a "topic" exchange. If you're only
648 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
651 =item B<Persistent> B<true>|B<false> (Publish only)
653 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
654 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
655 default), the I<transient> delivery mode will be used, i.e. messages may be
656 lost due to high load, overflowing queues or similar issues.
658 =item B<ConnectionRetryDelay> I<Delay>
660 When the connection to the AMQP broker is lost, defines the time in seconds to
661 wait before attempting to reconnect. Defaults to 0, which implies collectd will
662 attempt to reconnect at each read interval (in Subscribe mode) or each time
663 values are ready for submission (in Publish mode).
665 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
667 Selects the format in which messages are sent to the broker. If set to
668 B<Command> (the default), values are sent as C<PUTVAL> commands which are
669 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
670 case, the C<Content-Type> header field will be set to C<text/collectd>.
672 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
673 an easy and straight forward exchange format. The C<Content-Type> header field
674 will be set to C<application/json>.
676 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
677 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
680 A subscribing client I<should> use the C<Content-Type> header field to
681 determine how to decode the values. Currently, the I<AMQP plugin> itself can
682 only decode the B<Command> format.
684 =item B<StoreRates> B<true>|B<false> (Publish only)
686 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
687 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
688 default), no conversion is performed. Otherwise the conversion is performed
689 using the internal value cache.
691 Please note that currently this option is only used if the B<Format> option has
694 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
696 A prefix can be added in the metric name when outputting in the I<Graphite> format.
697 It's added before the I<Host> name.
698 Metric name will be "<prefix><host><postfix><plugin><type><name>"
700 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
702 A postfix can be added in the metric name when outputting in the I<Graphite> format.
703 It's added after the I<Host> name.
704 Metric name will be "<prefix><host><postfix><plugin><type><name>"
706 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
708 Specify a character to replace dots (.) in the host part of the metric name.
709 In I<Graphite> metric name, dots are used as separators between different
710 metric parts (host, plugin, type).
711 Default is "_" (I<Underscore>).
713 =item B<GraphiteSeparateInstances> B<true>|B<false>
715 If set to B<true>, the plugin instance and type instance will be in their own
716 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
717 default), the plugin and plugin instance (and likewise the type and type
718 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
720 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
722 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
723 identifier. If set to B<false> (the default), this is only done when there is
728 =head2 Plugin C<apache>
730 To configure the C<apache>-plugin you first need to configure the Apache
731 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
732 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
733 the following snipped to base your Apache config upon:
736 <IfModule mod_status.c>
737 <Location /mod_status>
738 SetHandler server-status
742 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
743 also supported. It introduces a new field, called C<BusyServers>, to count the
744 number of currently connected clients. This field is also supported.
746 The configuration of the I<Apache> plugin consists of one or more
747 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
748 as the instance name. For example:
752 URL "http://www1.example.com/mod_status?auto"
755 URL "http://www2.example.com/mod_status?auto"
759 The instance name will be used as the I<plugin instance>. To emulate the old
760 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
761 plugin to work correctly, each instance name must be unique. This is not
762 enforced by the plugin and it is your responsibility to ensure it.
764 The following options are accepted within each I<Instance> block:
768 =item B<URL> I<http://host/mod_status?auto>
770 Sets the URL of the C<mod_status> output. This needs to be the output generated
771 by C<ExtendedStatus on> and it needs to be the machine readable output
772 generated by appending the C<?auto> argument. This option is I<mandatory>.
774 =item B<User> I<Username>
776 Optional user name needed for authentication.
778 =item B<Password> I<Password>
780 Optional password needed for authentication.
782 =item B<VerifyPeer> B<true|false>
784 Enable or disable peer SSL certificate verification. See
785 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
787 =item B<VerifyHost> B<true|false>
789 Enable or disable peer host name verification. If enabled, the plugin checks
790 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
791 certificate matches the host name provided by the B<URL> option. If this
792 identity check fails, the connection is aborted. Obviously, only works when
793 connecting to a SSL enabled server. Enabled by default.
795 =item B<CACert> I<File>
797 File that holds one or more SSL certificates. If you want to use HTTPS you will
798 possibly need this option. What CA certificates come bundled with C<libcurl>
799 and are checked by default depends on the distribution you use.
801 =item B<SSLCiphers> I<list of ciphers>
803 Specifies which ciphers to use in the connection. The list of ciphers
804 must specify valid ciphers. See
805 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
807 =item B<Timeout> I<Milliseconds>
809 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
810 milliseconds. By default, the configured B<Interval> is used to set the
815 =head2 Plugin C<apcups>
819 =item B<Host> I<Hostname>
821 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
822 that IPv6 support has been disabled unless someone can confirm or decline that
823 B<apcupsd> can handle it.
825 =item B<Port> I<Port>
827 TCP-Port to connect to. Defaults to B<3551>.
829 =item B<ReportSeconds> B<true>|B<false>
831 If set to B<true>, the time reported in the C<timeleft> metric will be
832 converted to seconds. This is the recommended setting. If set to B<false>, the
833 default for backwards compatibility, the time will be reported in minutes.
835 =item B<PersistentConnection> B<true>|B<false>
837 The plugin is designed to keep the connection to I<apcupsd> open between reads.
838 If plugin poll interval is greater than 15 seconds (hardcoded socket close
839 timeout in I<apcupsd> NIS), then this option is B<false> by default.
841 You can instruct the plugin to close the connection after each read by setting
842 this option to B<false> or force keeping the connection by setting it to B<true>.
844 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
845 the plugin will try to detect this problem and switch to an open-read-close mode.
849 =head2 Plugin C<aquaero>
851 This plugin collects the value of the available sensors in an
852 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
853 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
854 connection for monitoring and configuration. The board can handle multiple
855 temperature sensors, fans, water pumps and water level sensors and adjust the
856 output settings such as fan voltage or power used by the water pump based on
857 the available inputs using a configurable controller included in the board.
858 This plugin collects all the available inputs as well as some of the output
859 values chosen by this controller. The plugin is based on the I<libaquaero5>
860 library provided by I<aquatools-ng>.
864 =item B<Device> I<DevicePath>
866 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
867 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
868 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
872 =head2 Plugin C<ascent>
874 This plugin collects information about an Ascent server, a free server for the
875 "World of Warcraft" game. This plugin gathers the information by fetching the
876 XML status page using C<libcurl> and parses it using C<libxml2>.
878 The configuration options are the same as for the C<apache> plugin above:
882 =item B<URL> I<http://localhost/ascent/status/>
884 Sets the URL of the XML status output.
886 =item B<User> I<Username>
888 Optional user name needed for authentication.
890 =item B<Password> I<Password>
892 Optional password needed for authentication.
894 =item B<VerifyPeer> B<true|false>
896 Enable or disable peer SSL certificate verification. See
897 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
899 =item B<VerifyHost> B<true|false>
901 Enable or disable peer host name verification. If enabled, the plugin checks
902 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
903 certificate matches the host name provided by the B<URL> option. If this
904 identity check fails, the connection is aborted. Obviously, only works when
905 connecting to a SSL enabled server. Enabled by default.
907 =item B<CACert> I<File>
909 File that holds one or more SSL certificates. If you want to use HTTPS you will
910 possibly need this option. What CA certificates come bundled with C<libcurl>
911 and are checked by default depends on the distribution you use.
913 =item B<Timeout> I<Milliseconds>
915 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
916 milliseconds. By default, the configured B<Interval> is used to set the
921 =head2 Plugin C<barometer>
923 This plugin reads absolute air pressure using digital barometer sensor on a I2C
924 bus. Supported sensors are:
928 =item I<MPL115A2> from Freescale,
929 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
932 =item I<MPL3115> from Freescale
933 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
936 =item I<BMP085> from Bosch Sensortec
940 The sensor type - one of the above - is detected automatically by the plugin
941 and indicated in the plugin_instance (you will see subdirectory
942 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
943 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
944 (only one sensor can be used by the plugin).
946 The plugin provides absolute barometric pressure, air pressure reduced to sea
947 level (several possible approximations) and as an auxiliary value also internal
948 sensor temperature. It uses (expects/provides) typical metric units - pressure
949 in [hPa], temperature in [C], altitude in [m].
951 It was developed and tested under Linux only. The only platform dependency is
952 the standard Linux i2c-dev interface (the particular bus driver has to
953 support the SM Bus command subset).
955 The reduction or normalization to mean sea level pressure requires (depending
956 on selected method/approximation) also altitude and reference to temperature
957 sensor(s). When multiple temperature sensors are configured the minumum of
958 their values is always used (expecting that the warmer ones are affected by
959 e.g. direct sun light at that moment).
967 TemperatureOffset 0.0
970 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
975 =item B<Device> I<device>
977 The only mandatory configuration parameter.
979 Device name of the I2C bus to which the sensor is connected. Note that
980 typically you need to have loaded the i2c-dev module.
981 Using i2c-tools you can check/list i2c buses available on your system by:
985 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
989 This way you should be able to verify that the pressure sensor (either type) is
990 connected and detected on address 0x60.
992 =item B<Oversampling> I<value>
994 Optional parameter controlling the oversampling/accuracy. Default value
995 is 1 providing fastest and least accurate reading.
997 For I<MPL115> this is the size of the averaging window. To filter out sensor
998 noise a simple averaging using floating window of this configurable size is
999 used. The plugin will use average of the last C<value> measurements (value of 1
1000 means no averaging). Minimal size is 1, maximal 1024.
1002 For I<MPL3115> this is the oversampling value. The actual oversampling is
1003 performed by the sensor and the higher value the higher accuracy and longer
1004 conversion time (although nothing to worry about in the collectd context).
1005 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1006 adjusted by the plugin to the closest supported one.
1008 For I<BMP085> 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. Any other value is adjusted by the plugin to
1012 the closest supported one.
1014 =item B<PressureOffset> I<offset>
1016 Optional parameter for MPL3115 only.
1018 You can further calibrate the sensor by supplying pressure and/or temperature
1019 offsets. This is added to the measured/caclulated value (i.e. if the measured
1020 value is too high then use negative offset).
1021 In hPa, default is 0.0.
1023 =item B<TemperatureOffset> I<offset>
1025 Optional parameter for MPL3115 only.
1027 You can further calibrate the sensor by supplying pressure and/or temperature
1028 offsets. This is added to the measured/caclulated value (i.e. if the measured
1029 value is too high then use negative offset).
1030 In C, default is 0.0.
1032 =item B<Normalization> I<method>
1034 Optional parameter, default value is 0.
1036 Normalization method - what approximation/model is used to compute the mean sea
1037 level pressure from the air absolute pressure.
1039 Supported values of the C<method> (integer between from 0 to 2) are:
1043 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1044 do not need to configure C<Altitude> or C<TemperatureSensor>.
1046 =item B<1> - international formula for conversion ,
1048 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1049 For this method you have to configure C<Altitude> but do not need
1050 C<TemperatureSensor> (uses fixed global temperature average instead).
1052 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1053 Meteorological Service).
1054 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1055 For this method you have to configure both C<Altitude> and
1056 C<TemperatureSensor>.
1061 =item B<Altitude> I<altitude>
1063 The altitude (in meters) of the location where you meassure the pressure.
1065 =item B<TemperatureSensor> I<reference>
1067 Temperature sensor(s) which should be used as a reference when normalizing the
1068 pressure using C<Normalization> method 2.
1069 When specified more sensors a minumum is found and used each time. The
1070 temperature reading directly from this pressure sensor/plugin is typically not
1071 suitable as the pressure sensor will be probably inside while we want outside
1072 temperature. The collectd reference name is something like
1073 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1074 (<type_instance> is usually omitted when there is just single value type). Or
1075 you can figure it out from the path of the output data files.
1079 =head2 Plugin C<battery>
1081 The I<battery plugin> reports the remaining capacity, power and voltage of
1086 =item B<ValuesPercentage> B<false>|B<true>
1088 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1089 capacity remaining". Otherwise the capacity is stored as reported by the
1090 battery, most likely in "Wh". This option does not work with all input methods,
1091 in particular when only C</proc/pmu> is available on an old Linux system.
1092 Defaults to B<false>.
1094 =item B<ReportDegraded> B<false>|B<true>
1096 Typical laptop batteries degrade over time, meaning the capacity decreases with
1097 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1098 "last full capacity" and used to determine that a battery is "fully charged".
1100 When this option is set to B<false>, the default, the I<battery plugin> will
1101 only report the remaining capacity. If the B<ValuesPercentage> option is
1102 enabled, the relative remaining capacity is calculated as the ratio of the
1103 "remaining capacity" and the "last full capacity". This is what most tools,
1104 such as the status bar of desktop environments, also do.
1106 When set to B<true>, the battery plugin will report three values: B<charged>
1107 (remaining capacity), B<discharged> (difference between "last full capacity"
1108 and "remaining capacity") and B<degraded> (difference between "design capacity"
1109 and "last full capacity").
1113 =head2 Plugin C<bind>
1115 Starting with BIND 9.5.0, the most widely used DNS server software provides
1116 extensive statistics about queries, responses and lots of other information.
1117 The bind plugin retrieves this information that's encoded in XML and provided
1118 via HTTP and submits the values to collectd.
1120 To use this plugin, you first need to tell BIND to make this information
1121 available. This is done with the C<statistics-channels> configuration option:
1123 statistics-channels {
1124 inet localhost port 8053;
1127 The configuration follows the grouping that can be seen when looking at the
1128 data with an XSLT compatible viewer, such as a modern web browser. It's
1129 probably a good idea to make yourself familiar with the provided values, so you
1130 can understand what the collected statistics actually mean.
1135 URL "http://localhost:8053/"
1150 Zone "127.in-addr.arpa/IN"
1154 The bind plugin accepts the following configuration options:
1160 URL from which to retrieve the XML data. If not specified,
1161 C<http://localhost:8053/> will be used.
1163 =item B<ParseTime> B<true>|B<false>
1165 When set to B<true>, the time provided by BIND will be parsed and used to
1166 dispatch the values. When set to B<false>, the local time source is queried.
1168 This setting is set to B<true> by default for backwards compatibility; setting
1169 this to B<false> is I<recommended> to avoid problems with timezones and
1172 =item B<OpCodes> B<true>|B<false>
1174 When enabled, statistics about the I<"OpCodes">, for example the number of
1175 C<QUERY> packets, are collected.
1179 =item B<QTypes> B<true>|B<false>
1181 When enabled, the number of I<incoming> queries by query types (for example
1182 C<A>, C<MX>, C<AAAA>) is collected.
1186 =item B<ServerStats> B<true>|B<false>
1188 Collect global server statistics, such as requests received over IPv4 and IPv6,
1189 successful queries, and failed updates.
1193 =item B<ZoneMaintStats> B<true>|B<false>
1195 Collect zone maintenance statistics, mostly information about notifications
1196 (zone updates) and zone transfers.
1200 =item B<ResolverStats> B<true>|B<false>
1202 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1203 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1204 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1205 default. Use the B<ResolverStats> option within a B<View "_default"> block
1206 instead for the same functionality.
1210 =item B<MemoryStats>
1212 Collect global memory statistics.
1216 =item B<Timeout> I<Milliseconds>
1218 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1219 milliseconds. By default, the configured B<Interval> is used to set the
1222 =item B<View> I<Name>
1224 Collect statistics about a specific I<"view">. BIND can behave different,
1225 mostly depending on the source IP-address of the request. These different
1226 configurations are called "views". If you don't use this feature, you most
1227 likely are only interested in the C<_default> view.
1229 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1230 information you want to collect about a view. If no B<View> block is
1231 configured, no detailed view statistics will be collected.
1235 =item B<QTypes> B<true>|B<false>
1237 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1238 C<MX>) is collected.
1242 =item B<ResolverStats> B<true>|B<false>
1244 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1245 (e.E<nbsp>g. queries over IPv4, lame servers).
1249 =item B<CacheRRSets> B<true>|B<false>
1251 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1252 type is collected. Negative entries (queries which resulted in an error, for
1253 example names that do not exist) are reported with a leading exclamation mark,
1258 =item B<Zone> I<Name>
1260 When given, collect detailed information about the given zone in the view. The
1261 information collected if very similar to the global B<ServerStats> information
1264 You can repeat this option to collect detailed information about multiple
1267 By default no detailed zone information is collected.
1273 =head2 Plugin C<ceph>
1275 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1276 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1278 A separate B<Daemon> block must be configured for each ceph daemon to be
1279 monitored. The following example will read daemon statistics from four
1280 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1283 LongRunAvgLatency false
1284 ConvertSpecialMetricTypes true
1286 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1289 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1292 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1295 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1299 The ceph plugin accepts the following configuration options:
1303 =item B<LongRunAvgLatency> B<true>|B<false>
1305 If enabled, latency values(sum,count pairs) are calculated as the long run
1306 average - average since the ceph daemon was started = (sum / count).
1307 When disabled, latency values are calculated as the average since the last
1308 collection = (sum_now - sum_last) / (count_now - count_last).
1312 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1314 If enabled, special metrics (metrics that differ in type from similar counters)
1315 are converted to the type of those similar counters. This currently only
1316 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1317 ceph schema reports this metric type as a sum,count pair while similar counters
1318 are treated as derive types. When converted, the sum is used as the counter
1319 value and is treated as a derive type.
1320 When disabled, all metrics are treated as the types received from the ceph schema.
1326 Each B<Daemon> block must have a string argument for the plugin instance name.
1327 A B<SocketPath> is also required for each B<Daemon> block:
1331 =item B<Daemon> I<DaemonName>
1333 Name to be used as the instance name for this daemon.
1335 =item B<SocketPath> I<SocketPath>
1337 Specifies the path to the UNIX admin socket of the ceph daemon.
1341 =head2 Plugin C<cgroups>
1343 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1344 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1345 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1349 =item B<CGroup> I<Directory>
1351 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1352 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1355 =item B<IgnoreSelected> B<true>|B<false>
1357 Invert the selection: If set to true, all cgroups I<except> the ones that
1358 match any one of the criteria are collected. By default only selected
1359 cgroups are collected if a selection is made. If no selection is configured
1360 at all, B<all> cgroups are selected.
1364 =head2 Plugin C<chrony>
1366 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1367 skew and per-peer stratum.
1369 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1372 Available configuration options for the C<chrony> plugin:
1376 =item B<Host> I<Hostname>
1378 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1380 =item B<Port> I<Port>
1382 UDP-Port to connect to. Defaults to B<323>.
1384 =item B<Timeout> I<Timeout>
1386 Connection timeout in seconds. Defaults to B<2>.
1390 =head2 Plugin C<conntrack>
1392 This plugin collects IP conntrack statistics.
1398 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1399 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1403 =head2 Plugin C<cpu>
1405 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1406 as Jiffies, using the C<cpu> type. Two aggregations are available:
1412 Sum, per-state, over all CPUs installed in the system; and
1416 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1420 The two aggregations can be combined, leading to I<collectd> only emitting a
1421 single "active" metric for the entire system. As soon as one of these
1422 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1423 rather than Jiffies. In addition, you can request individual, per-state,
1424 per-CPU metrics to be reported as percentage.
1426 The following configuration options are available:
1430 =item B<ReportByState> B<true>|B<false>
1432 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1434 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1437 =item B<ReportByCpu> B<true>|B<false>
1439 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1440 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1441 global sum of CPU states is emitted.
1443 =item B<ValuesPercentage> B<false>|B<true>
1445 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1446 are set to B<true>. In this case, by default, metrics will be reported as
1447 Jiffies. By setting this option to B<true>, you can request percentage values
1448 in the un-aggregated (per-CPU, per-state) mode as well.
1450 =item B<ReportNumCpu> B<false>|B<true>
1452 When set to B<true>, reports the number of available CPUs.
1453 Defaults to B<false>.
1457 =head2 Plugin C<cpufreq>
1459 This plugin doesn't have any options. It reads
1460 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1461 installed) to get the current CPU frequency. If this file does not exist make
1462 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1463 installed and an "cpu governor" (that's a kernel module) is loaded.
1465 =head2 Plugin C<cpusleep>
1467 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1468 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1469 BOOTTIME clock increments while device is suspended and MONOTONIC
1470 clock does not, the derivative of the difference between these clocks
1471 gives the relative amount of time the device has spent in suspend
1472 state. The recorded value is in milliseconds of sleep per seconds of
1475 =head2 Plugin C<csv>
1479 =item B<DataDir> I<Directory>
1481 Set the directory to store CSV-files under. Per default CSV-files are generated
1482 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1483 The special strings B<stdout> and B<stderr> can be used to write to the standard
1484 output and standard error channels, respectively. This, of course, only makes
1485 much sense when collectd is running in foreground- or non-daemon-mode.
1487 =item B<StoreRates> B<true|false>
1489 If set to B<true>, convert counter values to rates. If set to B<false> (the
1490 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1495 =head2 cURL Statistics
1497 All cURL-based plugins support collection of generic, request-based
1498 statistics. These are disabled by default and can be enabled selectively for
1499 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1500 the documentation of those plugins for specific information. This section
1501 describes the available metrics that can be configured for each plugin. All
1502 options are disabled by default.
1504 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1508 =item B<TotalTime> B<true|false>
1510 Total time of the transfer, including name resolving, TCP connect, etc.
1512 =item B<NamelookupTime> B<true|false>
1514 Time it took from the start until name resolving was completed.
1516 =item B<ConnectTime> B<true|false>
1518 Time it took from the start until the connect to the remote host (or proxy)
1521 =item B<AppconnectTime> B<true|false>
1523 Time it took from the start until the SSL/SSH connect/handshake to the remote
1526 =item B<PretransferTime> B<true|false>
1528 Time it took from the start until just before the transfer begins.
1530 =item B<StarttransferTime> B<true|false>
1532 Time it took from the start until the first byte was received.
1534 =item B<RedirectTime> B<true|false>
1536 Time it took for all redirection steps include name lookup, connect,
1537 pre-transfer and transfer before final transaction was started.
1539 =item B<RedirectCount> B<true|false>
1541 The total number of redirections that were actually followed.
1543 =item B<SizeUpload> B<true|false>
1545 The total amount of bytes that were uploaded.
1547 =item B<SizeDownload> B<true|false>
1549 The total amount of bytes that were downloaded.
1551 =item B<SpeedDownload> B<true|false>
1553 The average download speed that curl measured for the complete download.
1555 =item B<SpeedUpload> B<true|false>
1557 The average upload speed that curl measured for the complete upload.
1559 =item B<HeaderSize> B<true|false>
1561 The total size of all the headers received.
1563 =item B<RequestSize> B<true|false>
1565 The total size of the issued requests.
1567 =item B<ContentLengthDownload> B<true|false>
1569 The content-length of the download.
1571 =item B<ContentLengthUpload> B<true|false>
1573 The specified size of the upload.
1575 =item B<NumConnects> B<true|false>
1577 The number of new connections that were created to achieve the transfer.
1581 =head2 Plugin C<curl>
1583 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1584 and the match infrastructure (the same code used by the tail plugin) to use
1585 regular expressions with the received data.
1587 The following example will read the current value of AMD stock from Google's
1588 finance page and dispatch the value to collectd.
1591 <Page "stock_quotes">
1592 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1598 CACert "/path/to/ca.crt"
1599 Header "X-Custom-Header: foobar"
1602 MeasureResponseTime false
1603 MeasureResponseCode false
1606 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1607 DSType "GaugeAverage"
1608 # Note: `stock_value' is not a standard type.
1615 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1616 a web page and one or more "matches" to be performed on the returned data. The
1617 string argument to the B<Page> block is used as plugin instance.
1619 The following options are valid within B<Page> blocks:
1625 URL of the web site to retrieve. Since a regular expression will be used to
1626 extract information from this data, non-binary data is a big plus here ;)
1628 =item B<User> I<Name>
1630 Username to use if authorization is required to read the page.
1632 =item B<Password> I<Password>
1634 Password to use if authorization is required to read the page.
1636 =item B<Digest> B<true>|B<false>
1638 Enable HTTP digest authentication.
1640 =item B<VerifyPeer> B<true>|B<false>
1642 Enable or disable peer SSL certificate verification. See
1643 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1645 =item B<VerifyHost> B<true>|B<false>
1647 Enable or disable peer host name verification. If enabled, the plugin checks if
1648 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1649 matches the host name provided by the B<URL> option. If this identity check
1650 fails, the connection is aborted. Obviously, only works when connecting to a
1651 SSL enabled server. Enabled by default.
1653 =item B<CACert> I<file>
1655 File that holds one or more SSL certificates. If you want to use HTTPS you will
1656 possibly need this option. What CA certificates come bundled with C<libcurl>
1657 and are checked by default depends on the distribution you use.
1659 =item B<Header> I<Header>
1661 A HTTP header to add to the request. Multiple headers are added if this option
1662 is specified more than once.
1664 =item B<Post> I<Body>
1666 Specifies that the HTTP operation should be a POST instead of a GET. The
1667 complete data to be posted is given as the argument. This option will usually
1668 need to be accompanied by a B<Header> option to set an appropriate
1669 C<Content-Type> for the post body (e.g. to
1670 C<application/x-www-form-urlencoded>).
1672 =item B<MeasureResponseTime> B<true>|B<false>
1674 Measure response time for the request. If this setting is enabled, B<Match>
1675 blocks (see below) are optional. Disabled by default.
1677 Beware that requests will get aborted if they take too long to complete. Adjust
1678 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1681 This option is similar to enabling the B<TotalTime> statistic but it's
1682 measured by collectd instead of cURL.
1684 =item B<MeasureResponseCode> B<true>|B<false>
1686 Measure response code for the request. If this setting is enabled, B<Match>
1687 blocks (see below) are optional. Disabled by default.
1689 =item B<E<lt>StatisticsE<gt>>
1691 One B<Statistics> block can be used to specify cURL statistics to be collected
1692 for each request to the remote web site. See the section "cURL Statistics"
1693 above for details. If this setting is enabled, B<Match> blocks (see below) are
1696 =item B<E<lt>MatchE<gt>>
1698 One or more B<Match> blocks that define how to match information in the data
1699 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1700 used by the C<tail> plugin, so please see the documentation of the C<tail>
1701 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1702 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1705 =item B<Timeout> I<Milliseconds>
1707 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1708 milliseconds. By default, the configured B<Interval> is used to set the
1709 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1710 indefinitely. This legacy behaviour can be achieved by setting the value of
1713 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1714 network connection will stall one read thread. Adjust the B<ReadThreads> global
1715 setting accordingly to prevent this from blocking other plugins.
1719 =head2 Plugin C<curl_json>
1721 The B<curl_json plugin> collects values from JSON data to be parsed by
1722 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1723 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1724 unix socket. The former can be used, for example, to collect values
1725 from CouchDB documents (which are stored JSON notation), and the
1726 latter to collect values from a uWSGI stats socket.
1728 The following example will collect several values from the built-in
1729 C<_stats> runtime statistics module of I<CouchDB>
1730 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1733 <URL "http://localhost:5984/_stats">
1735 <Key "httpd/requests/count">
1736 Type "http_requests"
1739 <Key "httpd_request_methods/*/count">
1740 Type "http_request_methods"
1743 <Key "httpd_status_codes/*/count">
1744 Type "http_response_codes"
1749 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1752 <Sock "/var/run/uwsgi.stats.sock">
1754 <Key "workers/*/requests">
1755 Type "http_requests"
1758 <Key "workers/*/apps/*/requests">
1759 Type "http_requests"
1764 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1765 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1766 blocks defining a unix socket to read JSON from directly. Each of
1767 these blocks may have one or more B<Key> blocks.
1769 The B<Key> string argument must be in a path format. Each component is
1770 used to match the key from a JSON map or the index of an JSON
1771 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1772 values for all map keys or array indices will be collectd.
1774 The following options are valid within B<URL> blocks:
1778 =item B<Instance> I<Instance>
1780 Sets the plugin instance to I<Instance>.
1782 =item B<Interval> I<Interval>
1784 Sets the interval (in seconds) in which the values will be collected from this
1785 URL. By default the global B<Interval> setting will be used.
1787 =item B<User> I<Name>
1789 =item B<Password> I<Password>
1791 =item B<Digest> B<true>|B<false>
1793 =item B<VerifyPeer> B<true>|B<false>
1795 =item B<VerifyHost> B<true>|B<false>
1797 =item B<CACert> I<file>
1799 =item B<Header> I<Header>
1801 =item B<Post> I<Body>
1803 =item B<Timeout> I<Milliseconds>
1805 These options behave exactly equivalent to the appropriate options of the
1806 I<cURL> plugin. Please see there for a detailed description.
1808 =item B<E<lt>StatisticsE<gt>>
1810 One B<Statistics> block can be used to specify cURL statistics to be collected
1811 for each request to the remote URL. See the section "cURL Statistics" above
1816 The following options are valid within B<Key> blocks:
1820 =item B<Type> I<Type>
1822 Sets the type used to dispatch the values to the daemon. Detailed information
1823 about types and their configuration can be found in L<types.db(5)>. This
1824 option is mandatory.
1826 =item B<Instance> I<Instance>
1828 Type-instance to use. Defaults to the current map key or current string array element value.
1832 =head2 Plugin C<curl_xml>
1834 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1835 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1838 <URL "http://localhost/stats.xml">
1840 Instance "some_instance"
1845 CACert "/path/to/ca.crt"
1846 Header "X-Custom-Header: foobar"
1849 <XPath "table[@id=\"magic_level\"]/tr">
1851 #InstancePrefix "prefix-"
1852 InstanceFrom "td[1]"
1853 ValuesFrom "td[2]/span[@class=\"level\"]"
1858 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1859 URL to be fetched using libcurl. Within each B<URL> block there are
1860 options which specify the connection parameters, for example authentication
1861 information, and one or more B<XPath> blocks.
1863 Each B<XPath> block specifies how to get one type of information. The
1864 string argument must be a valid XPath expression which returns a list
1865 of "base elements". One value is dispatched for each "base element". The
1866 I<type instance> and values are looked up using further I<XPath> expressions
1867 that should be relative to the base element.
1869 Within the B<URL> block the following options are accepted:
1873 =item B<Host> I<Name>
1875 Use I<Name> as the host name when submitting values. Defaults to the global
1878 =item B<Instance> I<Instance>
1880 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1881 empty string (no plugin instance).
1883 =item B<Namespace> I<Prefix> I<URL>
1885 If an XPath expression references namespaces, they must be specified
1886 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1887 I<URL> is the "namespace name", an URI reference uniquely identifying the
1888 namespace. The option can be repeated to register multiple namespaces.
1892 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1893 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1895 =item B<User> I<User>
1897 =item B<Password> I<Password>
1899 =item B<Digest> B<true>|B<false>
1901 =item B<VerifyPeer> B<true>|B<false>
1903 =item B<VerifyHost> B<true>|B<false>
1905 =item B<CACert> I<CA Cert File>
1907 =item B<Header> I<Header>
1909 =item B<Post> I<Body>
1911 =item B<Timeout> I<Milliseconds>
1913 These options behave exactly equivalent to the appropriate options of the
1914 I<cURL plugin>. Please see there for a detailed description.
1916 =item B<E<lt>StatisticsE<gt>>
1918 One B<Statistics> block can be used to specify cURL statistics to be collected
1919 for each request to the remote URL. See the section "cURL Statistics" above
1922 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1924 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1925 B<XPath> block specifies how to get one type of information. The string
1926 argument must be a valid XPath expression which returns a list of "base
1927 elements". One value is dispatched for each "base element".
1929 Within the B<XPath> block the following options are accepted:
1933 =item B<Type> I<Type>
1935 Specifies the I<Type> used for submitting patches. This determines the number
1936 of values that are required / expected and whether the strings are parsed as
1937 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1938 This option is required.
1940 =item B<InstancePrefix> I<InstancePrefix>
1942 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1943 concatenated together without any separator.
1944 This option is optional.
1946 =item B<InstanceFrom> I<InstanceFrom>
1948 Specifies a XPath expression to use for determining the I<type instance>. The
1949 XPath expression must return exactly one element. The element's value is then
1950 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1952 This value is required. As a special exception, if the "base XPath expression"
1953 (the argument to the B<XPath> block) returns exactly one argument, then this
1954 option may be omitted.
1956 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1958 Specifies one or more XPath expression to use for reading the values. The
1959 number of XPath expressions must match the number of data sources in the
1960 I<type> specified with B<Type> (see above). Each XPath expression must return
1961 exactly one element. The element's value is then parsed as a number and used as
1962 value for the appropriate value in the value list dispatched to the daemon.
1968 =head2 Plugin C<dbi>
1970 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1971 connect to various databases, execute I<SQL> statements and read back the
1972 results. I<dbi> is an acronym for "database interface" in case you were
1973 wondering about the name. You can configure how each column is to be
1974 interpreted and the plugin will generate one or more data sets from each row
1975 returned according to these rules.
1977 Because the plugin is very generic, the configuration is a little more complex
1978 than those of other plugins. It usually looks something like this:
1981 <Query "out_of_stock">
1982 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1983 # Use with MySQL 5.0.0 or later
1987 InstancePrefix "out_of_stock"
1988 InstancesFrom "category"
1992 <Database "product_information">
1995 DriverOption "host" "localhost"
1996 DriverOption "username" "collectd"
1997 DriverOption "password" "aZo6daiw"
1998 DriverOption "dbname" "prod_info"
1999 SelectDB "prod_info"
2000 Query "out_of_stock"
2004 The configuration above defines one query with one result and one database. The
2005 query is then linked to the database with the B<Query> option I<within> the
2006 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2007 and you can also use the B<Include> statement to split up the configuration
2008 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2009 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2012 The following is a complete list of options:
2014 =head3 B<Query> blocks
2016 Query blocks define I<SQL> statements and how the returned data should be
2017 interpreted. They are identified by the name that is given in the opening line
2018 of the block. Thus the name needs to be unique. Other than that, the name is
2019 not used in collectd.
2021 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2022 define which column holds which value or instance information. You can use
2023 multiple B<Result> blocks to create multiple values from one returned row. This
2024 is especially useful, when queries take a long time and sending almost the same
2025 query again and again is not desirable.
2029 <Query "environment">
2030 Statement "select station, temperature, humidity from environment"
2033 # InstancePrefix "foo"
2034 InstancesFrom "station"
2035 ValuesFrom "temperature"
2039 InstancesFrom "station"
2040 ValuesFrom "humidity"
2044 The following options are accepted:
2048 =item B<Statement> I<SQL>
2050 Sets the statement that should be executed on the server. This is B<not>
2051 interpreted by collectd, but simply passed to the database server. Therefore,
2052 the SQL dialect that's used depends on the server collectd is connected to.
2054 The query has to return at least two columns, one for the instance and one
2055 value. You cannot omit the instance, even if the statement is guaranteed to
2056 always return exactly one line. In that case, you can usually specify something
2059 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2061 (That works with MySQL but may not be valid SQL according to the spec. If you
2062 use a more strict database server, you may have to select from a dummy table or
2065 Please note that some databases, for example B<Oracle>, will fail if you
2066 include a semicolon at the end of the statement.
2068 =item B<MinVersion> I<Version>
2070 =item B<MaxVersion> I<Value>
2072 Only use this query for the specified database version. You can use these
2073 options to provide multiple queries with the same name but with a slightly
2074 different syntax. The plugin will use only those queries, where the specified
2075 minimum and maximum versions fit the version of the database in use.
2077 The database version is determined by C<dbi_conn_get_engine_version>, see the
2078 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2079 for details. Basically, each part of the version is assumed to be in the range
2080 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2081 "40102", version "5.0.42" becomes "50042".
2083 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2084 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2085 happen. Don't to it! A valid example would be something along these lines:
2096 In the above example, there are three ranges that don't overlap. The last one
2097 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2098 before "4.0.0" are not specified.
2100 =item B<Type> I<Type>
2102 The B<type> that's used for each line returned. See L<types.db(5)> for more
2103 details on how types are defined. In short: A type is a predefined layout of
2104 data and the number of values and type of values has to match the type
2107 If you specify "temperature" here, you need exactly one gauge column. If you
2108 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2111 There must be exactly one B<Type> option inside each B<Result> block.
2113 =item B<InstancePrefix> I<prefix>
2115 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2116 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2117 all strings returned in the appropriate columns are concatenated together,
2118 separated by dashes I<("-")>.
2120 =item B<InstancesFrom> I<column0> [I<column1> ...]
2122 Specifies the columns whose values will be used to create the "type-instance"
2123 for each row. If you specify more than one column, the value of all columns
2124 will be joined together with dashes I<("-")> as separation characters.
2126 The plugin itself does not check whether or not all built instances are
2127 different. It's your responsibility to assure that each is unique. This is
2128 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2129 sure that only one row is returned in this case.
2131 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2134 =item B<ValuesFrom> I<column0> [I<column1> ...]
2136 Names the columns whose content is used as the actual data for the data sets
2137 that are dispatched to the daemon. How many such columns you need is determined
2138 by the B<Type> setting above. If you specify too many or not enough columns,
2139 the plugin will complain about that and no data will be submitted to the
2142 The actual data type in the columns is not that important. The plugin will
2143 automatically cast the values to the right type if it know how to do that. So
2144 it should be able to handle integer an floating point types, as well as strings
2145 (if they include a number at the beginning).
2147 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2149 =item B<MetadataFrom> [I<column0> I<column1> ...]
2151 Names the columns whose content is used as metadata for the data sets
2152 that are dispatched to the daemon.
2154 The actual data type in the columns is not that important. The plugin will
2155 automatically cast the values to the right type if it know how to do that. So
2156 it should be able to handle integer an floating point types, as well as strings
2157 (if they include a number at the beginning).
2161 =head3 B<Database> blocks
2163 Database blocks define a connection to a database and which queries should be
2164 sent to that database. Since the used "dbi" library can handle a wide variety
2165 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2166 documentationE<nbsp>- we stick as close to the terminology used there.
2168 Each database needs a "name" as string argument in the starting tag of the
2169 block. This name will be used as "PluginInstance" in the values submitted to
2170 the daemon. Other than that, that name is not used.
2174 =item B<Interval> I<Interval>
2176 Sets the interval (in seconds) in which the values will be collected from this
2177 database. By default the global B<Interval> setting will be used.
2179 =item B<Driver> I<Driver>
2181 Specifies the driver to use to connect to the database. In many cases those
2182 drivers are named after the database they can connect to, but this is not a
2183 technical necessity. These drivers are sometimes referred to as "DBD",
2184 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2185 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2186 project at L<http://libdbi-drivers.sourceforge.net/>.
2188 You need to give the driver name as expected by the "dbi" library here. You
2189 should be able to find that in the documentation for each driver. If you
2190 mistype the driver name, the plugin will dump a list of all known driver names
2193 =item B<DriverOption> I<Key> I<Value>
2195 Sets driver-specific options. What option a driver supports can be found in the
2196 documentation for each driver, somewhere at
2197 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2198 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2200 DBDs can register two types of options: String options and numeric options. The
2201 plugin will use the C<dbi_conn_set_option> function when the configuration
2202 provides a string and the C<dbi_conn_require_option_numeric> function when the
2203 configuration provides a number. So these two lines will actually result in
2204 different calls being used:
2206 DriverOption "Port" 1234 # numeric
2207 DriverOption "Port" "1234" # string
2209 Unfortunately, drivers are not too keen to report errors when an unknown option
2210 is passed to them, so invalid settings here may go unnoticed. This is not the
2211 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2212 the driver. If a driver complains about an option, the plugin will dump a
2213 complete list of all options understood by that driver to the log. There is no
2214 way to programatically find out if an option expects a string or a numeric
2215 argument, so you will have to refer to the appropriate DBD's documentation to
2216 find this out. Sorry.
2218 =item B<SelectDB> I<Database>
2220 In some cases, the database name you connect with is not the database name you
2221 want to use for querying data. If this option is set, the plugin will "select"
2222 (switch to) that database after the connection is established.
2224 =item B<Query> I<QueryName>
2226 Associates the query named I<QueryName> with this database connection. The
2227 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2228 blocks you want to refer to must be placed above the database block you want to
2231 =item B<Host> I<Hostname>
2233 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2234 values. Defaults to the global hostname setting.
2242 =item B<Device> I<Device>
2244 Select partitions based on the devicename.
2246 =item B<MountPoint> I<Directory>
2248 Select partitions based on the mountpoint.
2250 =item B<FSType> I<FSType>
2252 Select partitions based on the filesystem type.
2254 =item B<IgnoreSelected> B<true>|B<false>
2256 Invert the selection: If set to true, all partitions B<except> the ones that
2257 match any one of the criteria are collected. By default only selected
2258 partitions are collected if a selection is made. If no selection is configured
2259 at all, B<all> partitions are selected.
2261 =item B<ReportByDevice> B<true>|B<false>
2263 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2264 (the default), it will report a disk as "root", but with it I<true>, it will be
2265 "sda1" (or whichever).
2267 =item B<ReportInodes> B<true>|B<false>
2269 Enables or disables reporting of free, reserved and used inodes. Defaults to
2270 inode collection being disabled.
2272 Enable this option if inodes are a scarce resource for you, usually because
2273 many small files are stored on the disk. This is a usual scenario for mail
2274 transfer agents and web caches.
2276 =item B<ValuesAbsolute> B<true>|B<false>
2278 Enables or disables reporting of free and used disk space in 1K-blocks.
2279 Defaults to B<true>.
2281 =item B<ValuesPercentage> B<false>|B<true>
2283 Enables or disables reporting of free and used disk space in percentage.
2284 Defaults to B<false>.
2286 This is useful for deploying I<collectd> on the cloud, where machines with
2287 different disk size may exist. Then it is more practical to configure
2288 thresholds based on relative disk size.
2292 =head2 Plugin C<disk>
2294 The C<disk> plugin collects information about the usage of physical disks and
2295 logical disks (partitions). Values collected are the number of octets written
2296 to and read from a disk or partition, the number of read/write operations
2297 issued to the disk and a rather complex "time" it took for these commands to be
2300 Using the following two options you can ignore some disks or configure the
2301 collection only of specific disks.
2305 =item B<Disk> I<Name>
2307 Select the disk I<Name>. Whether it is collected or ignored depends on the
2308 B<IgnoreSelected> setting, see below. As with other plugins that use the
2309 daemon's ignorelist functionality, a string that starts and ends with a slash
2310 is interpreted as a regular expression. Examples:
2315 =item B<IgnoreSelected> B<true>|B<false>
2317 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2318 statements, are ignored or if all other disks are ignored. The behavior
2319 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2320 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2321 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2322 is set to B<true>, all disks are collected B<except> the ones matched.
2324 =item B<UseBSDName> B<true>|B<false>
2326 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2327 default major/minor numbers. Requires collectd to be built with Apple's
2330 =item B<UdevNameAttr> I<Attribute>
2332 Attempt to override disk instance name with the value of a specified udev
2333 attribute when built with B<libudev>. If the attribute is not defined for the
2334 given device, the default name is used. Example:
2336 UdevNameAttr "DM_NAME"
2340 =head2 Plugin C<dns>
2344 =item B<Interface> I<Interface>
2346 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2347 option sets the interface that should be used. If this option is not set, or
2348 set to "any", the plugin will try to get packets from B<all> interfaces. This
2349 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2351 =item B<IgnoreSource> I<IP-address>
2353 Ignore packets that originate from this address.
2355 =item B<SelectNumericQueryTypes> B<true>|B<false>
2357 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2361 =head2 Plugin C<email>
2365 =item B<SocketFile> I<Path>
2367 Sets the socket-file which is to be created.
2369 =item B<SocketGroup> I<Group>
2371 If running as root change the group of the UNIX-socket after it has been
2372 created. Defaults to B<collectd>.
2374 =item B<SocketPerms> I<Permissions>
2376 Change the file permissions of the UNIX-socket after it has been created. The
2377 permissions must be given as a numeric, octal value as you would pass to
2378 L<chmod(1)>. Defaults to B<0770>.
2380 =item B<MaxConns> I<Number>
2382 Sets the maximum number of connections that can be handled in parallel. Since
2383 this many threads will be started immediately setting this to a very high
2384 value will waste valuable resources. Defaults to B<5> and will be forced to be
2385 at most B<16384> to prevent typos and dumb mistakes.
2389 =head2 Plugin C<ethstat>
2391 The I<ethstat plugin> collects information about network interface cards (NICs)
2392 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2398 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2399 Map "multicast" "if_multicast"
2406 =item B<Interface> I<Name>
2408 Collect statistical information about interface I<Name>.
2410 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2412 By default, the plugin will submit values as type C<derive> and I<type
2413 instance> set to I<Name>, the name of the metric as reported by the driver. If
2414 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2415 I<TypeInstance> will be used.
2417 =item B<MappedOnly> B<true>|B<false>
2419 When set to B<true>, only metrics that can be mapped to a I<type> will be
2420 collected, all other metrics will be ignored. Defaults to B<false>.
2424 =head2 Plugin C<exec>
2426 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2427 contains valuable information on when the executable is executed and the
2428 output that is expected from it.
2432 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2434 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2436 Execute the executable I<Executable> as user I<User>. If the user name is
2437 followed by a colon and a group name, the effective group is set to that group.
2438 The real group and saved-set group will be set to the default group of that
2439 user. If no group is given the effective group ID will be the same as the real
2442 Please note that in order to change the user and/or group the daemon needs
2443 superuser privileges. If the daemon is run as an unprivileged user you must
2444 specify the same user/group here. If the daemon is run with superuser
2445 privileges, you must supply a non-root user here.
2447 The executable may be followed by optional arguments that are passed to the
2448 program. Please note that due to the configuration parsing numbers and boolean
2449 values may be changed. If you want to be absolutely sure that something is
2450 passed as-is please enclose it in quotes.
2452 The B<Exec> and B<NotificationExec> statements change the semantics of the
2453 programs executed, i.E<nbsp>e. the data passed to them and the response
2454 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2458 =head2 Plugin C<fhcount>
2460 The C<fhcount> plugin provides statistics about used, unused and total number of
2461 file handles on Linux.
2463 The I<fhcount plugin> provides the following configuration options:
2467 =item B<ValuesAbsolute> B<true>|B<false>
2469 Enables or disables reporting of file handles usage in absolute numbers,
2470 e.g. file handles used. Defaults to B<true>.
2472 =item B<ValuesPercentage> B<false>|B<true>
2474 Enables or disables reporting of file handles usage in percentages, e.g.
2475 percent of file handles used. Defaults to B<false>.
2479 =head2 Plugin C<filecount>
2481 The C<filecount> plugin counts the number of files in a certain directory (and
2482 its subdirectories) and their combined size. The configuration is very straight
2485 <Plugin "filecount">
2486 <Directory "/var/qmail/queue/mess">
2487 Instance "qmail-message"
2489 <Directory "/var/qmail/queue/todo">
2490 Instance "qmail-todo"
2492 <Directory "/var/lib/php5">
2493 Instance "php5-sessions"
2498 The example above counts the number of files in QMail's queue directories and
2499 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2500 QMail has not yet looked at, the "message" queue holds the messages that were
2501 classified into "local" and "remote".
2503 As you can see, the configuration consists of one or more C<Directory> blocks,
2504 each of which specifies a directory in which to count the files. Within those
2505 blocks, the following options are recognized:
2509 =item B<Instance> I<Instance>
2511 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2512 it's your responsibility, the plugin doesn't check for that. If not given, the
2513 instance is set to the directory name with all slashes replaced by underscores
2514 and all leading underscores removed.
2516 =item B<Name> I<Pattern>
2518 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2519 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2520 against the pattern, not the entire path. In case this makes it easier for you:
2521 This option has been named after the B<-name> parameter to L<find(1)>.
2523 =item B<MTime> I<Age>
2525 Count only files of a specific age: If I<Age> is greater than zero, only files
2526 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2527 a negative number, this is inversed. For example, if B<-60> is specified, only
2528 files that have been modified in the last minute will be counted.
2530 The number can also be followed by a "multiplier" to easily specify a larger
2531 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2532 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2533 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2534 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2535 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2538 =item B<Size> I<Size>
2540 Count only files of a specific size. When I<Size> is a positive number, only
2541 files that are at least this big are counted. If I<Size> is a negative number,
2542 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2543 I<Size> are counted.
2545 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2546 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2547 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2548 note that there are 1000 bytes in a kilobyte, not 1024.
2550 =item B<Recursive> I<true>|I<false>
2552 Controls whether or not to recurse into subdirectories. Enabled by default.
2554 =item B<IncludeHidden> I<true>|I<false>
2556 Controls whether or not to include "hidden" files and directories in the count.
2557 "Hidden" files and directories are those, whose name begins with a dot.
2558 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2562 =head2 Plugin C<GenericJMX>
2564 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2565 L<collectd-java(5)>.
2567 =head2 Plugin C<gmond>
2569 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2570 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2571 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2576 MCReceiveFrom "239.2.11.71" "8649"
2577 <Metric "swap_total">
2579 TypeInstance "total"
2582 <Metric "swap_free">
2589 The following metrics are built-in:
2595 load_one, load_five, load_fifteen
2599 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2603 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2615 Available configuration options:
2619 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2621 Sets sets the multicast group and UDP port to which to subscribe.
2623 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2625 =item E<lt>B<Metric> I<Name>E<gt>
2627 These blocks add a new metric conversion to the internal table. I<Name>, the
2628 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2632 =item B<Type> I<Type>
2634 Type to map this metric to. Required.
2636 =item B<TypeInstance> I<Instance>
2638 Type-instance to use. Optional.
2640 =item B<DataSource> I<Name>
2642 Data source to map this metric to. If the configured type has exactly one data
2643 source, this is optional. Otherwise the option is required.
2649 =head2 Plugin C<gps>
2651 The C<gps plugin> connects to gpsd on the host machine.
2652 The host, port, timeout and pause are configurable.
2654 This is useful if you run an NTP server using a GPS for source and you want to
2657 Mind your GPS must send $--GSA for having the data reported!
2659 The following elements are collected:
2665 Number of satellites used for fix (type instance "used") and in view (type
2666 instance "visible"). 0 means no GPS satellites are visible.
2668 =item B<dilution_of_precision>
2670 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2671 It should be between 0 and 3.
2672 Look at the documentation of your GPS to know more.
2680 # Connect to localhost on gpsd regular port:
2685 # PauseConnect of 5 sec. between connection attempts.
2689 Available configuration options:
2693 =item B<Host> I<Host>
2695 The host on which gpsd daemon runs. Defaults to B<localhost>.
2697 =item B<Port> I<Port>
2699 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2701 =item B<Timeout> I<Seconds>
2703 Timeout in seconds (default 0.015 sec).
2705 The GPS data stream is fetch by the plugin form the daemon.
2706 It waits for data to be available, if none arrives it times out
2707 and loop for another reading.
2708 Mind to put a low value gpsd expects value in the micro-seconds area
2709 (recommended is 500 us) since the waiting function is blocking.
2710 Value must be between 500 us and 5 sec., if outside that range the
2711 default value is applied.
2713 This only applies from gpsd release-2.95.
2715 =item B<PauseConnect> I<Seconds>
2717 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
2721 =head2 Plugin C<grpc>
2723 The I<grpc> plugin provides an RPC interface to submit values to or query
2724 values from collectd based on the open source gRPC framework. It exposes an
2725 end-point for dispatching values to the daemon.
2727 The B<gRPC> homepage can be found at L<https://grpc.io/>.
2731 =item B<Listen> I<Host> I<Port>
2733 The B<Listen> statement sets the network address to bind to. When multiple
2734 statements are specified, the daemon will bind to all of them. If none are
2735 specified, it defaults to B<0.0.0.0:50051>.
2737 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2739 Optionally, B<Listen> may be specified as a configuration block which
2740 supports the following options:
2744 =item B<EnableSSL> I<true>|I<false>
2746 Whether to enable SSL for incoming connections. Default: false.
2748 =item B<SSLRootCerts> I<Filename>
2750 =item B<SSLServerKey> I<Filename>
2752 =item B<SSLServerCert> I<Filename>
2754 Filenames specifying SSL certificate and key material to be used with SSL
2761 =head2 Plugin C<hddtemp>
2763 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2764 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2765 default values, see below. C<hddtemp> has to be running to work correctly. If
2766 C<hddtemp> is not running timeouts may appear which may interfere with other
2769 The B<hddtemp> homepage can be found at
2770 L<http://www.guzu.net/linux/hddtemp.php>.
2774 =item B<Host> I<Hostname>
2776 Hostname to connect to. Defaults to B<127.0.0.1>.
2778 =item B<Port> I<Port>
2780 TCP-Port to connect to. Defaults to B<7634>.
2784 =head2 Plugin C<interface>
2788 =item B<Interface> I<Interface>
2790 Select this interface. By default these interfaces will then be collected. For
2791 a more detailed description see B<IgnoreSelected> below.
2793 =item B<IgnoreSelected> I<true>|I<false>
2795 If no configuration if given, the B<interface>-plugin will collect data from
2796 all interfaces. This may not be practical, especially for loopback- and
2797 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2798 interfaces you're interested in. Sometimes, however, it's easier/preferred
2799 to collect all interfaces I<except> a few ones. This option enables you to
2800 do that: By setting B<IgnoreSelected> to I<true> the effect of
2801 B<Interface> is inverted: All selected interfaces are ignored and all
2802 other interfaces are collected.
2804 It is possible to use regular expressions to match interface names, if the
2805 name is surrounded by I</.../> and collectd was compiled with support for
2806 regexps. This is useful if there's a need to collect (or ignore) data
2807 for a group of interfaces that are similarly named, without the need to
2808 explicitly list all of them (especially useful if the list is dynamic).
2813 Interface "/^tun[0-9]+/"
2814 IgnoreSelected "true"
2816 This will ignore the loopback interface, all interfaces with names starting
2817 with I<veth> and all interfaces with names starting with I<tun> followed by
2820 =item B<ReportInactive> I<true>|I<false>
2822 When set to I<false>, only interfaces with non-zero traffic will be
2823 reported. Note that the check is done by looking into whether a
2824 package was sent at any time from boot and the corresponding counter
2825 is non-zero. So, if the interface has been sending data in the past
2826 since boot, but not during the reported time-interval, it will still
2829 The default value is I<true> and results in collection of the data
2830 from all interfaces that are selected by B<Interface> and
2831 B<IgnoreSelected> options.
2833 =item B<UniqueName> I<true>|I<false>
2835 Interface name is not unique on Solaris (KSTAT), interface name is unique
2836 only within a module/instance. Following tuple is considered unique:
2837 (ks_module, ks_instance, ks_name)
2838 If this option is set to true, interface name contains above three fields
2839 separated by an underscore. For more info on KSTAT, visit
2840 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
2842 This option is only available on Solaris.
2846 =head2 Plugin C<ipmi>
2850 =item B<Sensor> I<Sensor>
2852 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2854 =item B<IgnoreSelected> I<true>|I<false>
2856 If no configuration if given, the B<ipmi> plugin will collect data from all
2857 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2858 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2859 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2860 all other sensors are collected.
2862 =item B<NotifySensorAdd> I<true>|I<false>
2864 If a sensor appears after initialization time of a minute a notification
2867 =item B<NotifySensorRemove> I<true>|I<false>
2869 If a sensor disappears a notification is sent.
2871 =item B<NotifySensorNotPresent> I<true>|I<false>
2873 If you have for example dual power supply and one of them is (un)plugged then
2874 a notification is sent.
2878 =head2 Plugin C<iptables>
2882 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2884 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2886 Select the iptables/ip6tables filter rules to count packets and bytes from.
2888 If only I<Table> and I<Chain> are given, this plugin will collect the counters
2889 of all rules which have a comment-match. The comment is then used as
2892 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2893 the I<n>th rule will be collected. Again, the comment (or the number) will be
2894 used as the type-instance.
2896 If I<Name> is supplied, it will be used as the type-instance instead of the
2897 comment or the number.
2901 =head2 Plugin C<irq>
2907 Select this irq. By default these irqs will then be collected. For a more
2908 detailed description see B<IgnoreSelected> below.
2910 =item B<IgnoreSelected> I<true>|I<false>
2912 If no configuration if given, the B<irq>-plugin will collect data from all
2913 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2914 can use the B<Irq>-option to pick the interrupt you're interested in.
2915 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2916 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2917 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2918 and all other interrupts are collected.
2922 =head2 Plugin C<java>
2924 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2925 This section only discusses the syntax and semantic of the configuration
2926 options. For more in-depth information on the I<Java> plugin, please read
2927 L<collectd-java(5)>.
2932 JVMArg "-verbose:jni"
2933 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2934 LoadPlugin "org.collectd.java.Foobar"
2935 <Plugin "org.collectd.java.Foobar">
2936 # To be parsed by the plugin
2940 Available configuration options:
2944 =item B<JVMArg> I<Argument>
2946 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2947 exactly the way the arguments to the I<java> binary on the command line work.
2948 Execute C<javaE<nbsp>--help> for details.
2950 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2951 any other options! When another option is found, the JVM will be started and
2952 later options will have to be ignored!
2954 =item B<LoadPlugin> I<JavaClass>
2956 Instantiates a new I<JavaClass> object. The constructor of this object very
2957 likely then registers one or more callback methods with the server.
2959 See L<collectd-java(5)> for details.
2961 When the first such option is found, the virtual machine (JVM) is created. This
2962 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2963 B<LoadPlugin> options!
2965 =item B<Plugin> I<Name>
2967 The entire block is passed to the Java plugin as an
2968 I<org.collectd.api.OConfigItem> object.
2970 For this to work, the plugin has to register a configuration callback first,
2971 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2972 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2973 depends on the (Java) plugin registering the callback and is completely
2974 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2978 =head2 Plugin C<load>
2980 The I<Load plugin> collects the system load. These numbers give a rough overview
2981 over the utilization of a machine. The system load is defined as the number of
2982 runnable tasks in the run-queue and is provided by many operating systems as a
2983 one, five or fifteen minute average.
2985 The following configuration options are available:
2989 =item B<ReportRelative> B<false>|B<true>
2991 When enabled, system load divided by number of available CPU cores is reported
2992 for intervals 1 min, 5 min and 15 min. Defaults to false.
2997 =head2 Plugin C<logfile>
3001 =item B<LogLevel> B<debug|info|notice|warning|err>
3003 Sets the log-level. If, for example, set to B<notice>, then all events with
3004 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3006 Please note that B<debug> is only available if collectd has been compiled with
3009 =item B<File> I<File>
3011 Sets the file to write log messages to. The special strings B<stdout> and
3012 B<stderr> can be used to write to the standard output and standard error
3013 channels, respectively. This, of course, only makes much sense when I<collectd>
3014 is running in foreground- or non-daemon-mode.
3016 =item B<Timestamp> B<true>|B<false>
3018 Prefix all lines printed by the current time. Defaults to B<true>.
3020 =item B<PrintSeverity> B<true>|B<false>
3022 When enabled, all lines are prefixed by the severity of the log message, for
3023 example "warning". Defaults to B<false>.
3027 B<Note>: There is no need to notify the daemon after moving or removing the
3028 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3029 for each line it writes.
3031 =head2 Plugin C<log_logstash>
3033 The I<log logstash plugin> behaves like the logfile plugin but formats
3034 messages as JSON events for logstash to parse and input.
3038 =item B<LogLevel> B<debug|info|notice|warning|err>
3040 Sets the log-level. If, for example, set to B<notice>, then all events with
3041 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3043 Please note that B<debug> is only available if collectd has been compiled with
3046 =item B<File> I<File>
3048 Sets the file to write log messages to. The special strings B<stdout> and
3049 B<stderr> can be used to write to the standard output and standard error
3050 channels, respectively. This, of course, only makes much sense when I<collectd>
3051 is running in foreground- or non-daemon-mode.
3055 B<Note>: There is no need to notify the daemon after moving or removing the
3056 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3057 for each line it writes.
3059 =head2 Plugin C<lpar>
3061 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3062 virtualization technique for IBM POWER processors. It takes into account CPU
3063 time stolen from or donated to a partition, in addition to the usual user,
3064 system, I/O statistics.
3066 The following configuration options are available:
3070 =item B<CpuPoolStats> B<false>|B<true>
3072 When enabled, statistics about the processor pool are read, too. The partition
3073 needs to have pool authority in order to be able to acquire this information.
3076 =item B<ReportBySerial> B<false>|B<true>
3078 If enabled, the serial of the physical machine the partition is currently
3079 running on is reported as I<hostname> and the logical hostname of the machine
3080 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3081 used (just like other plugins) and the I<plugin instance> will be empty.
3086 =head2 Plugin C<lua>
3088 This plugin embeds a Lua interpreter into collectd and provides an interface
3089 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3092 =head2 Plugin C<mbmon>
3094 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3096 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3097 B<Host> and B<Port> options can be used to change these values, see below.
3098 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3099 timeouts may appear which may interfere with other statistics..
3101 C<mbmon> must be run with the -r option ("print TAG and Value format");
3102 Debian's F</etc/init.d/mbmon> script already does this, other people
3103 will need to ensure that this is the case.
3107 =item B<Host> I<Hostname>
3109 Hostname to connect to. Defaults to B<127.0.0.1>.
3111 =item B<Port> I<Port>
3113 TCP-Port to connect to. Defaults to B<411>.
3119 The C<md plugin> collects information from Linux Software-RAID devices (md).
3121 All reported values are of the type C<md_disks>. Reported type instances are
3122 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3123 I<missing> (physically absent) disks.
3127 =item B<Device> I<Device>
3129 Select md devices based on device name. The I<device name> is the basename of
3130 the device, i.e. the name of the block device without the leading C</dev/>.
3131 See B<IgnoreSelected> for more details.
3133 =item B<IgnoreSelected> B<true>|B<false>
3135 Invert device selection: If set to B<true>, all md devices B<except> those
3136 listed using B<Device> are collected. If B<false> (the default), only those
3137 listed are collected. If no configuration is given, the B<md> plugin will
3138 collect data from all md devices.
3142 =head2 Plugin C<memcachec>
3144 The C<memcachec plugin> connects to a memcached server, queries one or more
3145 given I<pages> and parses the returned data according to user specification.
3146 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3149 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3150 library. Please note that there is another library with a very similar name,
3151 libmemcache (notice the missing `d'), which is not applicable.
3153 Synopsis of the configuration:
3155 <Plugin "memcachec">
3156 <Page "plugin_instance">
3160 Regex "(\\d+) bytes sent"
3163 Instance "type_instance"
3168 The configuration options are:
3172 =item E<lt>B<Page> I<Name>E<gt>
3174 Each B<Page> block defines one I<page> to be queried from the memcached server.
3175 The block requires one string argument which is used as I<plugin instance>.
3177 =item B<Server> I<Address>
3179 Sets the server address to connect to when querying the page. Must be inside a
3184 When connected to the memcached server, asks for the page I<Key>.
3186 =item E<lt>B<Match>E<gt>
3188 Match blocks define which strings to look for and how matches substrings are
3189 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3193 =head2 Plugin C<memcached>
3195 The B<memcached plugin> connects to a memcached server and queries statistics
3196 about cache utilization, memory and bandwidth used.
3197 L<http://www.danga.com/memcached/>
3199 <Plugin "memcached">
3201 Host "memcache.example.com"
3206 The plugin configuration consists of one or more B<Instance> blocks which
3207 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3208 following options are allowed:
3212 =item B<Host> I<Hostname>
3214 Hostname to connect to. Defaults to B<127.0.0.1>.
3216 =item B<Port> I<Port>
3218 TCP-Port to connect to. Defaults to B<11211>.
3220 =item B<Socket> I<Path>
3222 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3223 setting is given, the B<Host> and B<Port> settings are ignored.
3227 =head2 Plugin C<mic>
3229 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3230 Intel's Many Integrated Core (MIC) systems.
3239 ShowTemperatures true
3242 IgnoreSelectedTemperature true
3247 IgnoreSelectedPower true
3250 The following options are valid inside the B<PluginE<nbsp>mic> block:
3254 =item B<ShowCPU> B<true>|B<false>
3256 If enabled (the default) a sum of the CPU usage across all cores is reported.
3258 =item B<ShowCPUCores> B<true>|B<false>
3260 If enabled (the default) per-core CPU usage is reported.
3262 =item B<ShowMemory> B<true>|B<false>
3264 If enabled (the default) the physical memory usage of the MIC system is
3267 =item B<ShowTemperatures> B<true>|B<false>
3269 If enabled (the default) various temperatures of the MIC system are reported.
3271 =item B<Temperature> I<Name>
3273 This option controls which temperatures are being reported. Whether matching
3274 temperatures are being ignored or I<only> matching temperatures are reported
3275 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3276 temperatures are reported.
3278 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3280 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3281 (the default) only temperatures matching a B<Temperature> option are reported
3282 or, if no B<Temperature> option is specified, all temperatures are reported. If
3283 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3286 Known temperature names are:
3320 =item B<ShowPower> B<true>|B<false>
3322 If enabled (the default) various temperatures of the MIC system are reported.
3324 =item B<Power> I<Name>
3326 This option controls which power readings are being reported. Whether matching
3327 power readings are being ignored or I<only> matching power readings are reported
3328 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3329 power readings are reported.
3331 =item B<IgnoreSelectedPower> B<false>|B<true>
3333 Controls the behavior of the B<Power> setting above. If set to B<false>
3334 (the default) only power readings matching a B<Power> option are reported
3335 or, if no B<Power> option is specified, all power readings are reported. If
3336 set to B<true>, matching power readings are I<ignored> and all other power readings
3339 Known power names are:
3345 Total power utilization averaged over Time Window 0 (uWatts).
3349 Total power utilization averaged over Time Window 0 (uWatts).
3353 Instantaneous power (uWatts).
3357 Max instantaneous power (uWatts).
3361 PCI-E connector power (uWatts).
3365 2x3 connector power (uWatts).
3369 2x4 connector power (uWatts).
3377 Uncore rail (uVolts).
3381 Memory subsystem rail (uVolts).
3387 =head2 Plugin C<memory>
3389 The I<memory plugin> provides the following configuration options:
3393 =item B<ValuesAbsolute> B<true>|B<false>
3395 Enables or disables reporting of physical memory usage in absolute numbers,
3396 i.e. bytes. Defaults to B<true>.
3398 =item B<ValuesPercentage> B<false>|B<true>
3400 Enables or disables reporting of physical memory usage in percentages, e.g.
3401 percent of physical memory used. Defaults to B<false>.
3403 This is useful for deploying I<collectd> in a heterogeneous environment in
3404 which the sizes of physical memory vary.
3408 =head2 Plugin C<modbus>
3410 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3411 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3412 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3413 values (two registers interpreted as IEEE floats in big endian notation).
3417 <Data "voltage-input-1">
3420 RegisterCmd ReadHolding
3425 <Data "voltage-input-2">
3428 RegisterCmd ReadHolding
3433 <Data "supply-temperature-1">
3436 RegisterCmd ReadHolding
3441 <Host "modbus.example.com">
3442 Address "192.168.0.42"
3447 Instance "power-supply"
3448 Collect "voltage-input-1"
3449 Collect "voltage-input-2"
3454 Device "/dev/ttyUSB0"
3459 Instance "temperature"
3460 Collect "supply-temperature-1"
3466 =item E<lt>B<Data> I<Name>E<gt> blocks
3468 Data blocks define a mapping between register numbers and the "types" used by
3471 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3475 =item B<RegisterBase> I<Number>
3477 Configures the base register to read from the device. If the option
3478 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3479 register will be read (the register number is increased by one).
3481 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3483 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3484 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3485 combined into one value. Defaults to B<Uint16>.
3487 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3489 Specifies register type to be collected from device. Works only with libmodbus
3490 2.9.2 or higher. Defaults to B<ReadHolding>.
3492 =item B<Type> I<Type>
3494 Specifies the "type" (data set) to use when dispatching the value to
3495 I<collectd>. Currently, only data sets with exactly one data source are
3498 =item B<Instance> I<Instance>
3500 Sets the type instance to use when dispatching the value to I<collectd>. If
3501 unset, an empty string (no type instance) is used.
3505 =item E<lt>B<Host> I<Name>E<gt> blocks
3507 Host blocks are used to specify to which hosts to connect and what data to read
3508 from their "slaves". The string argument I<Name> is used as hostname when
3509 dispatching the values to I<collectd>.
3511 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3515 =item B<Address> I<Hostname>
3517 For Modbus/TCP, specifies the node name (the actual network address) used to
3518 connect to the host. This may be an IP address or a hostname. Please note that
3519 the used I<libmodbus> library only supports IPv4 at the moment.
3521 =item B<Port> I<Service>
3523 for Modbus/TCP, specifies the port used to connect to the host. The port can
3524 either be given as a number or as a service name. Please note that the
3525 I<Service> argument must be a string, even if ports are given in their numerical
3526 form. Defaults to "502".
3528 =item B<Device> I<Devicenode>
3530 For Modbus/RTU, specifies the path to the serial device being used.
3532 =item B<Baudrate> I<Baudrate>
3534 For Modbus/RTU, specifies the baud rate of the serial device.
3535 Note, connections currently support only 8/N/1.
3537 =item B<Interval> I<Interval>
3539 Sets the interval (in seconds) in which the values will be collected from this
3540 host. By default the global B<Interval> setting will be used.
3542 =item E<lt>B<Slave> I<ID>E<gt>
3544 Over each connection, multiple Modbus devices may be reached. The slave ID
3545 is used to specify which device should be addressed. For each device you want
3546 to query, one B<Slave> block must be given.
3548 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3552 =item B<Instance> I<Instance>
3554 Specify the plugin instance to use when dispatching the values to I<collectd>.
3555 By default "slave_I<ID>" is used.
3557 =item B<Collect> I<DataName>
3559 Specifies which data to retrieve from the device. I<DataName> must be the same
3560 string as the I<Name> argument passed to a B<Data> block. You can specify this
3561 option multiple times to collect more than one value from a slave. At least one
3562 B<Collect> option is mandatory.
3570 =head2 Plugin C<mqtt>
3572 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
3573 values from MQTT (B<Subscribe> blocks).
3579 Host "mqtt.example.com"
3583 Host "mqtt.example.com"
3588 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
3589 configuring the sending and receiving direction respectively. The plugin will
3590 register a write callback named C<mqtt/I<name>> where I<name> is the string
3591 argument given to the B<Publish> block. Both types of blocks share many but not
3592 all of the following options. If an option is valid in only one of the blocks,
3593 it will be mentioned explicitly.
3599 =item B<Host> I<Hostname>
3601 Hostname of the MQTT broker to connect to.
3603 =item B<Port> I<Service>
3605 Port number or service name of the MQTT broker to connect to.
3607 =item B<User> I<UserName>
3609 Username used when authenticating to the MQTT broker.
3611 =item B<Password> I<Password>
3613 Password used when authenticating to the MQTT broker.
3615 =item B<ClientId> I<ClientId>
3617 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
3619 =item B<QoS> [B<0>-B<2>]
3621 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
3639 In B<Publish> blocks, this option determines the QoS flag set on outgoing
3640 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
3641 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
3642 on a message is larger than the maximum accepted QoS of a subscriber, the
3643 message's QoS will be downgraded.
3645 =item B<Prefix> I<Prefix> (Publish only)
3647 This plugin will use one topic per I<value list> which will looks like a path.
3648 I<Prefix> is used as the first path element and defaults to B<collectd>.
3650 An example topic name would be:
3652 collectd/cpu-0/cpu-user
3654 =item B<Retain> B<false>|B<true> (Publish only)
3656 Controls whether the MQTT broker will retain (keep a copy of) the last message
3657 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
3659 =item B<StoreRates> B<true>|B<false> (Publish only)
3661 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
3662 before sending. Defaults to B<true>.
3664 =item B<CleanSession> B<true>|B<false> (Subscribe only)
3666 Controls whether the MQTT "cleans" the session up after the subscriber
3667 disconnects or if it maintains the subscriber's subscriptions and all messages
3668 that arrive while the subscriber is disconnected. Defaults to B<true>.
3670 =item B<Topic> I<TopicName> (Subscribe only)
3672 Configures the topic(s) to subscribe to. You can use the single level C<+> and
3673 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
3674 the B<collectd> branch.
3676 =item B<CACert> I<file>
3678 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
3679 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
3680 port of the MQTT broker.
3681 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3683 =item B<CertificateFile> I<file>
3685 Path to the PEM-encoded certificate file to use as client certificate when
3686 connecting to the MQTT broker.
3687 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3689 =item B<CertificateKeyFile> I<file>
3691 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
3692 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3694 =item B<TLSProtocol> I<protocol>
3696 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
3697 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
3698 version is used which depends on the version of OpenSSL the Mosquitto library
3701 =item B<CipherSuite> I<ciphersuite>
3703 A string describing the ciphers available for use. See L<ciphers(1)> and the
3704 C<openssl ciphers> utility for more information. If unset, the default ciphers
3710 =head2 Plugin C<mysql>
3712 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3713 one or more databases when started and keeps the connection up as long as
3714 possible. When the connection is interrupted for whatever reason it will try
3715 to re-connect. The plugin will complain loudly in case anything goes wrong.
3717 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3718 and collects information about MySQL network traffic, executed statements,
3719 requests, the query cache and threads by evaluating the
3720 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3721 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3722 Status Variables> for an explanation of these values.
3724 Optionally, master and slave statistics may be collected in a MySQL
3725 replication setup. In that case, information about the synchronization state
3726 of the nodes are collected by evaluating the C<Position> return value of the
3727 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3728 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3729 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3730 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3731 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3743 SSLKey "/path/to/key.pem"
3744 SSLCert "/path/to/cert.pem"
3745 SSLCA "/path/to/ca.pem"
3746 SSLCAPath "/path/to/cas/"
3747 SSLCipher "DHE-RSA-AES256-SHA"
3753 Socket "/var/run/mysql/mysqld.sock"
3755 SlaveNotifications true
3761 Socket "/var/run/mysql/mysqld.sock"
3766 A B<Database> block defines one connection to a MySQL database. It accepts a
3767 single argument which specifies the name of the database. None of the other
3768 options are required. MySQL will use default values as documented in the
3769 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
3770 B<MySQL reference manual>.
3774 =item B<Alias> I<Alias>
3776 Alias to use as sender instead of hostname when reporting. This may be useful
3777 when having cryptic hostnames.
3779 =item B<Host> I<Hostname>
3781 Hostname of the database server. Defaults to B<localhost>.
3783 =item B<User> I<Username>
3785 Username to use when connecting to the database. The user does not have to be
3786 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3787 unless you want to collectd replication statistics (see B<MasterStats> and
3788 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3789 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3791 =item B<Password> I<Password>
3793 Password needed to log into the database.
3795 =item B<Database> I<Database>
3797 Select this database. Defaults to I<no database> which is a perfectly reasonable
3798 option for what this plugin does.
3800 =item B<Port> I<Port>
3802 TCP-port to connect to. The port must be specified in its numeric form, but it
3803 must be passed as a string nonetheless. For example:
3807 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3808 See the documentation for the C<mysql_real_connect> function for details.
3810 =item B<Socket> I<Socket>
3812 Specifies the path to the UNIX domain socket of the MySQL server. This option
3813 only has any effect, if B<Host> is set to B<localhost> (the default).
3814 Otherwise, use the B<Port> option above. See the documentation for the
3815 C<mysql_real_connect> function for details.
3817 =item B<InnodbStats> I<true|false>
3819 If enabled, metrics about the InnoDB storage engine are collected.
3820 Disabled by default.
3822 =item B<MasterStats> I<true|false>
3824 =item B<SlaveStats> I<true|false>
3826 Enable the collection of master / slave statistics in a replication setup. In
3827 order to be able to get access to these statistics, the user needs special
3828 privileges. See the B<User> documentation above. Defaults to B<false>.
3830 =item B<SlaveNotifications> I<true|false>
3832 If enabled, the plugin sends a notification if the replication slave I/O and /
3833 or SQL threads are not running. Defaults to B<false>.
3835 =item B<WsrepStats> I<true|false>
3837 Enable the collection of wsrep plugin statistics, used in Master-Master
3838 replication setups like in MySQL Galera/Percona XtraDB Cluster.
3839 User needs only privileges to execute 'SHOW GLOBAL STATUS'
3841 =item B<ConnectTimeout> I<Seconds>
3843 Sets the connect timeout for the MySQL client.
3845 =item B<SSLKey> I<Path>
3847 If provided, the X509 key in PEM format.
3849 =item B<SSLCert> I<Path>
3851 If provided, the X509 cert in PEM format.
3853 =item B<SSLCA> I<Path>
3855 If provided, the CA file in PEM format (check OpenSSL docs).
3857 =item B<SSLCAPath> I<Path>
3859 If provided, the CA directory (check OpenSSL docs).
3861 =item B<SSLCipher> I<String>
3863 If provided, the SSL cipher to use.
3867 =head2 Plugin C<netapp>
3869 The netapp plugin can collect various performance and capacity information
3870 from a NetApp filer using the NetApp API.
3872 Please note that NetApp has a wide line of products and a lot of different
3873 software versions for each of these products. This plugin was developed for a
3874 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3875 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3876 model and software version but it is very hard to test this.
3877 If you have used this plugin with other models and/or software version, feel
3878 free to send us a mail to tell us about the results, even if it's just a short
3881 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3882 basic authentication.
3884 B<Do not use a regular user for this!> Create a special collectd user with just
3885 the minimum of capabilities needed. The user only needs the "login-http-admin"
3886 capability as well as a few more depending on which data will be collected.
3887 Required capabilities are documented below.
3892 <Host "netapp1.example.com">
3916 IgnoreSelectedIO false
3918 IgnoreSelectedOps false
3919 GetLatency "volume0"
3920 IgnoreSelectedLatency false
3927 IgnoreSelectedCapacity false
3930 IgnoreSelectedSnapshot false
3958 The netapp plugin accepts the following configuration options:
3962 =item B<Host> I<Name>
3964 A host block defines one NetApp filer. It will appear in collectd with the name
3965 you specify here which does not have to be its real name nor its hostname (see
3966 the B<Address> option below).
3968 =item B<VFiler> I<Name>
3970 A B<VFiler> block may only be used inside a host block. It accepts all the
3971 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3972 will execute all NetApp API commands in the context of the specified
3973 VFiler(R). It will appear in collectd with the name you specify here which
3974 does not have to be its real name. The VFiler name may be specified using the
3975 B<VFilerName> option. If this is not specified, it will default to the name
3978 The VFiler block inherits all connection related settings from the surrounding
3979 B<Host> block (which appear before the B<VFiler> block) but they may be
3980 overwritten inside the B<VFiler> block.
3982 This feature is useful, for example, when using a VFiler as SnapVault target
3983 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3984 available in the host filer (vfiler0) but only in the respective VFiler
3987 =item B<Protocol> B<httpd>|B<http>
3989 The protocol collectd will use to query this host.
3997 Valid options: http, https
3999 =item B<Address> I<Address>
4001 The hostname or IP address of the host.
4007 Default: The "host" block's name.
4009 =item B<Port> I<Port>
4011 The TCP port to connect to on the host.
4017 Default: 80 for protocol "http", 443 for protocol "https"
4019 =item B<User> I<User>
4021 =item B<Password> I<Password>
4023 The username and password to use to login to the NetApp.
4029 =item B<VFilerName> I<Name>
4031 The name of the VFiler in which context to execute API commands. If not
4032 specified, the name provided to the B<VFiler> block will be used instead.
4038 Default: name of the B<VFiler> block
4040 B<Note:> This option may only be used inside B<VFiler> blocks.
4042 =item B<Interval> I<Interval>
4048 The following options decide what kind of data will be collected. You can
4049 either use them as a block and fine tune various parameters inside this block,
4050 use them as a single statement to just accept all default values, or omit it to
4051 not collect any data.
4053 The following options are valid inside all blocks:
4057 =item B<Interval> I<Seconds>
4059 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4060 host specific setting.
4064 =head3 The System block
4066 This will collect various performance data about the whole system.
4068 B<Note:> To get this data the collectd user needs the
4069 "api-perf-object-get-instances" capability.
4073 =item B<Interval> I<Seconds>
4075 Collect disk statistics every I<Seconds> seconds.
4077 =item B<GetCPULoad> B<true>|B<false>
4079 If you set this option to true the current CPU usage will be read. This will be
4080 the average usage between all CPUs in your NetApp without any information about
4083 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4084 returns in the "CPU" field.
4092 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4094 =item B<GetInterfaces> B<true>|B<false>
4096 If you set this option to true the current traffic of the network interfaces
4097 will be read. This will be the total traffic over all interfaces of your NetApp
4098 without any information about individual interfaces.
4100 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4101 in the "Net kB/s" field.
4111 Result: One value list of type "if_octects".
4113 =item B<GetDiskIO> B<true>|B<false>
4115 If you set this option to true the current IO throughput will be read. This
4116 will be the total IO of your NetApp without any information about individual
4117 disks, volumes or aggregates.
4119 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4120 in the "DiskE<nbsp>kB/s" field.
4128 Result: One value list of type "disk_octets".
4130 =item B<GetDiskOps> B<true>|B<false>
4132 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4133 iSCSI, etc. operations will be read. This will be the total number of
4134 operations on your NetApp without any information about individual volumes or
4137 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4138 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4146 Result: A variable number of value lists of type "disk_ops_complex". Each type
4147 of operation will result in one value list with the name of the operation as
4152 =head3 The WAFL block
4154 This will collect various performance data about the WAFL file system. At the
4155 moment this just means cache performance.
4157 B<Note:> To get this data the collectd user needs the
4158 "api-perf-object-get-instances" capability.
4160 B<Note:> The interface to get these values is classified as "Diagnostics" by
4161 NetApp. This means that it is not guaranteed to be stable even between minor
4166 =item B<Interval> I<Seconds>
4168 Collect disk statistics every I<Seconds> seconds.
4170 =item B<GetNameCache> B<true>|B<false>
4178 Result: One value list of type "cache_ratio" and type instance
4181 =item B<GetDirCache> B<true>|B<false>
4189 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4191 =item B<GetInodeCache> B<true>|B<false>
4199 Result: One value list of type "cache_ratio" and type instance
4202 =item B<GetBufferCache> B<true>|B<false>
4204 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4205 in the "Cache hit" field.
4213 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4217 =head3 The Disks block
4219 This will collect performance data about the individual disks in the NetApp.
4221 B<Note:> To get this data the collectd user needs the
4222 "api-perf-object-get-instances" capability.
4226 =item B<Interval> I<Seconds>
4228 Collect disk statistics every I<Seconds> seconds.
4230 =item B<GetBusy> B<true>|B<false>
4232 If you set this option to true the busy time of all disks will be calculated
4233 and the value of the busiest disk in the system will be written.
4235 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4236 in the "Disk util" field. Probably.
4244 Result: One value list of type "percent" and type instance "disk_busy".
4248 =head3 The VolumePerf block
4250 This will collect various performance data about the individual volumes.
4252 You can select which data to collect about which volume using the following
4253 options. They follow the standard ignorelist semantic.
4255 B<Note:> To get this data the collectd user needs the
4256 I<api-perf-object-get-instances> capability.
4260 =item B<Interval> I<Seconds>
4262 Collect volume performance data every I<Seconds> seconds.
4264 =item B<GetIO> I<Volume>
4266 =item B<GetOps> I<Volume>
4268 =item B<GetLatency> I<Volume>
4270 Select the given volume for IO, operations or latency statistics collection.
4271 The argument is the name of the volume without the C</vol/> prefix.
4273 Since the standard ignorelist functionality is used here, you can use a string
4274 starting and ending with a slash to specify regular expression matching: To
4275 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4278 GetIO "/^vol[027]$/"
4280 If no regular expression is specified, an exact match is required. Both,
4281 regular and exact matching are case sensitive.
4283 If no volume was specified at all for either of the three options, that data
4284 will be collected for all available volumes.
4286 =item B<IgnoreSelectedIO> B<true>|B<false>
4288 =item B<IgnoreSelectedOps> B<true>|B<false>
4290 =item B<IgnoreSelectedLatency> B<true>|B<false>
4292 When set to B<true>, the volumes selected for IO, operations or latency
4293 statistics collection will be ignored and the data will be collected for all
4296 When set to B<false>, data will only be collected for the specified volumes and
4297 all other volumes will be ignored.
4299 If no volumes have been specified with the above B<Get*> options, all volumes
4300 will be collected regardless of the B<IgnoreSelected*> option.
4302 Defaults to B<false>
4306 =head3 The VolumeUsage block
4308 This will collect capacity data about the individual volumes.
4310 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4315 =item B<Interval> I<Seconds>
4317 Collect volume usage statistics every I<Seconds> seconds.
4319 =item B<GetCapacity> I<VolumeName>
4321 The current capacity of the volume will be collected. This will result in two
4322 to four value lists, depending on the configuration of the volume. All data
4323 sources are of type "df_complex" with the name of the volume as
4326 There will be type_instances "used" and "free" for the number of used and
4327 available bytes on the volume. If the volume has some space reserved for
4328 snapshots, a type_instance "snap_reserved" will be available. If the volume
4329 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4330 number of bytes saved by the SIS feature.
4332 B<Note:> The current NetApp API has a bug that results in this value being
4333 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4334 number which works most of the time. If you see strange values here, bug
4335 NetApp support to fix this.
4337 Repeat this option to specify multiple volumes.
4339 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4341 Specify whether to collect only the volumes selected by the B<GetCapacity>
4342 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4343 B<false>. However, if no B<GetCapacity> option is specified at all, all
4344 capacities will be selected anyway.
4346 =item B<GetSnapshot> I<VolumeName>
4348 Select volumes from which to collect snapshot information.
4350 Usually, the space used for snapshots is included in the space reported as
4351 "used". If snapshot information is collected as well, the space used for
4352 snapshots is subtracted from the used space.
4354 To make things even more interesting, it is possible to reserve space to be
4355 used for snapshots. If the space required for snapshots is less than that
4356 reserved space, there is "reserved free" and "reserved used" space in addition
4357 to "free" and "used". If the space required for snapshots exceeds the reserved
4358 space, that part allocated in the normal space is subtracted from the "used"
4361 Repeat this option to specify multiple volumes.
4363 =item B<IgnoreSelectedSnapshot>
4365 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4366 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4367 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4368 capacities will be selected anyway.
4372 =head3 The Quota block
4374 This will collect (tree) quota statistics (used disk space and number of used
4375 files). This mechanism is useful to get usage information for single qtrees.
4376 In case the quotas are not used for any other purpose, an entry similar to the
4377 following in C</etc/quotas> would be sufficient:
4379 /vol/volA/some_qtree tree - - - - -
4381 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4385 =item B<Interval> I<Seconds>
4387 Collect SnapVault(R) statistics every I<Seconds> seconds.
4391 =head3 The SnapVault block
4393 This will collect statistics about the time and traffic of SnapVault(R)
4398 =item B<Interval> I<Seconds>
4400 Collect SnapVault(R) statistics every I<Seconds> seconds.
4404 =head2 Plugin C<netlink>
4406 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4407 statistics of various interface and routing aspects.
4411 =item B<Interface> I<Interface>
4413 =item B<VerboseInterface> I<Interface>
4415 Instruct the plugin to collect interface statistics. This is basically the same
4416 as the statistics provided by the C<interface> plugin (see above) but
4417 potentially much more detailed.
4419 When configuring with B<Interface> only the basic statistics will be collected,
4420 namely octets, packets, and errors. These statistics are collected by
4421 the C<interface> plugin, too, so using both at the same time is no benefit.
4423 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4424 so that no data needs to be collected twice if you use the C<interface> plugin.
4425 This includes dropped packets, received multicast packets, collisions and a
4426 whole zoo of differentiated RX and TX errors. You can try the following command
4427 to get an idea of what awaits you:
4431 If I<Interface> is B<All>, all interfaces will be selected.
4433 =item B<QDisc> I<Interface> [I<QDisc>]
4435 =item B<Class> I<Interface> [I<Class>]
4437 =item B<Filter> I<Interface> [I<Filter>]
4439 Collect the octets and packets that pass a certain qdisc, class or filter.
4441 QDiscs and classes are identified by their type and handle (or classid).
4442 Filters don't necessarily have a handle, therefore the parent's handle is used.
4443 The notation used in collectd differs from that used in tc(1) in that it
4444 doesn't skip the major or minor number if it's zero and doesn't print special
4445 ids by their name. So, for example, a qdisc may be identified by
4446 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4447 thus not displayed by tc(1).
4449 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4450 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4451 associated with that interface will be collected.
4453 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4454 used. This may lead to problems when more than one filter is attached to a
4455 qdisc or class. This isn't nice, but we don't know how this could be done any
4456 better. If you have a idea, please don't hesitate to tell us.
4458 As with the B<Interface> option you can specify B<All> as the interface,
4459 meaning all interfaces.
4461 Here are some examples to help you understand the above text more easily:
4464 VerboseInterface "All"
4465 QDisc "eth0" "pfifo_fast-1:0"
4467 Class "ppp0" "htb-1:10"
4468 Filter "ppp0" "u32-1:0"
4471 =item B<IgnoreSelected>
4473 The behavior is the same as with all other similar plugins: If nothing is
4474 selected at all, everything is collected. If some things are selected using the
4475 options described above, only these statistics are collected. If you set
4476 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4477 specified statistics will not be collected.
4481 =head2 Plugin C<network>
4483 The Network plugin sends data to a remote instance of collectd, receives data
4484 from a remote instance, or both at the same time. Data which has been received
4485 from the network is usually not transmitted again, but this can be activated, see
4486 the B<Forward> option below.
4488 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4489 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4491 Both, B<Server> and B<Listen> can be used as single option or as block. When
4492 used as block, given options are valid for this socket only. The following
4493 example will export the metrics twice: Once to an "internal" server (without
4494 encryption and signing) and one to an external server (with cryptographic
4498 # Export to an internal server
4499 # (demonstrates usage without additional options)
4500 Server "collectd.internal.tld"
4502 # Export to an external server
4503 # (demonstrates usage with signature options)
4504 <Server "collectd.external.tld">
4505 SecurityLevel "sign"
4506 Username "myhostname"
4513 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4515 The B<Server> statement/block sets the server to send datagrams to. The
4516 statement may occur multiple times to send each datagram to multiple
4519 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
4520 optional second argument specifies a port number or a service name. If not
4521 given, the default, B<25826>, is used.
4523 The following options are recognized within B<Server> blocks:
4527 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4529 Set the security you require for network communication. When the security level
4530 has been set to B<Encrypt>, data sent over the network will be encrypted using
4531 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4532 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4533 authentication code. When set to B<None>, data is sent without any security.
4535 This feature is only available if the I<network> plugin was linked with
4538 =item B<Username> I<Username>
4540 Sets the username to transmit. This is used by the server to lookup the
4541 password. See B<AuthFile> below. All security levels except B<None> require
4544 This feature is only available if the I<network> plugin was linked with
4547 =item B<Password> I<Password>
4549 Sets a password (shared secret) for this socket. All security levels except
4550 B<None> require this setting.
4552 This feature is only available if the I<network> plugin was linked with
4555 =item B<Interface> I<Interface name>
4557 Set the outgoing interface for IP packets. This applies at least
4558 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4559 undefined or a non-existent interface name is specified, the default
4560 behavior is to let the kernel choose the appropriate interface. Be warned
4561 that the manual selection of an interface for unicast traffic is only
4562 necessary in rare cases.
4564 =item B<ResolveInterval> I<Seconds>
4566 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4567 useful to force a regular DNS lookup to support a high availability setup. If
4568 not specified, re-resolves are never attempted.
4572 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4574 The B<Listen> statement sets the interfaces to bind to. When multiple
4575 statements are found the daemon will bind to multiple interfaces.
4577 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4578 the argument is a multicast address the daemon will join that multicast group.
4579 The optional second argument specifies a port number or a service name. If not
4580 given, the default, B<25826>, is used.
4582 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4586 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4588 Set the security you require for network communication. When the security level
4589 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4590 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4591 signed and encrypted data is accepted. When set to B<None>, all data will be
4592 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4593 decrypted if possible.
4595 This feature is only available if the I<network> plugin was linked with
4598 =item B<AuthFile> I<Filename>
4600 Sets a file in which usernames are mapped to passwords. These passwords are
4601 used to verify signatures and to decrypt encrypted network packets. If
4602 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4603 verified and encrypted packets are decrypted. Otherwise, signed data is
4604 accepted without checking the signature and encrypted data cannot be decrypted.
4605 For the other security levels this option is mandatory.
4607 The file format is very simple: Each line consists of a username followed by a
4608 colon and any number of spaces followed by the password. To demonstrate, an
4609 example file could look like this:
4614 Each time a packet is received, the modification time of the file is checked
4615 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4616 the file is being read, it is locked using L<fcntl(2)>.
4618 =item B<Interface> I<Interface name>
4620 Set the incoming interface for IP packets explicitly. This applies at least
4621 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4622 undefined or a non-existent interface name is specified, the default
4623 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4624 traffic gets only accepted, if it arrives on the given interface.
4628 =item B<TimeToLive> I<1-255>
4630 Set the time-to-live of sent packets. This applies to all, unicast and
4631 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4632 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4635 =item B<MaxPacketSize> I<1024-65535>
4637 Set the maximum size for datagrams received over the network. Packets larger
4638 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4639 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4642 On the server side, this limit should be set to the largest value used on
4643 I<any> client. Likewise, the value on the client must not be larger than the
4644 value on the server, or data will be lost.
4646 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4647 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4648 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4651 =item B<Forward> I<true|false>
4653 If set to I<true>, write packets that were received via the network plugin to
4654 the sending sockets. This should only be activated when the B<Listen>- and
4655 B<Server>-statements differ. Otherwise packets may be send multiple times to
4656 the same multicast group. While this results in more network traffic than
4657 necessary it's not a huge problem since the plugin has a duplicate detection,
4658 so the values will not loop.
4660 =item B<ReportStats> B<true>|B<false>
4662 The network plugin cannot only receive and send statistics, it can also create
4663 statistics about itself. Collected data included the number of received and
4664 sent octets and packets, the length of the receive queue and the number of
4665 values handled. When set to B<true>, the I<Network plugin> will make these
4666 statistics available. Defaults to B<false>.
4670 =head2 Plugin C<nginx>
4672 This plugin collects the number of connections and requests handled by the
4673 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4674 queries the page provided by the C<ngx_http_stub_status_module> module, which
4675 isn't compiled by default. Please refer to
4676 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4677 how to compile and configure nginx and this module.
4679 The following options are accepted by the C<nginx plugin>:
4683 =item B<URL> I<http://host/nginx_status>
4685 Sets the URL of the C<ngx_http_stub_status_module> output.
4687 =item B<User> I<Username>
4689 Optional user name needed for authentication.
4691 =item B<Password> I<Password>
4693 Optional password needed for authentication.
4695 =item B<VerifyPeer> B<true|false>
4697 Enable or disable peer SSL certificate verification. See
4698 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4700 =item B<VerifyHost> B<true|false>
4702 Enable or disable peer host name verification. If enabled, the plugin checks
4703 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4704 certificate matches the host name provided by the B<URL> option. If this
4705 identity check fails, the connection is aborted. Obviously, only works when
4706 connecting to a SSL enabled server. Enabled by default.
4708 =item B<CACert> I<File>
4710 File that holds one or more SSL certificates. If you want to use HTTPS you will
4711 possibly need this option. What CA certificates come bundled with C<libcurl>
4712 and are checked by default depends on the distribution you use.
4714 =item B<Timeout> I<Milliseconds>
4716 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4717 milliseconds. By default, the configured B<Interval> is used to set the
4722 =head2 Plugin C<notify_desktop>
4724 This plugin sends a desktop notification to a notification daemon, as defined
4725 in the Desktop Notification Specification. To actually display the
4726 notifications, B<notification-daemon> is required and B<collectd> has to be
4727 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4728 environment variables have to be set correctly) and the D-Bus message bus.
4730 The Desktop Notification Specification can be found at
4731 L<http://www.galago-project.org/specs/notification/>.
4735 =item B<OkayTimeout> I<timeout>
4737 =item B<WarningTimeout> I<timeout>
4739 =item B<FailureTimeout> I<timeout>
4741 Set the I<timeout>, in milliseconds, after which to expire the notification
4742 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4743 been specified, the displayed notification will not be closed at all - the
4744 user has to do so herself. These options default to 5000. If a negative number
4745 has been specified, the default is used as well.
4749 =head2 Plugin C<notify_email>
4751 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4752 configured email address.
4754 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4756 Available configuration options:
4760 =item B<From> I<Address>
4762 Email address from which the emails should appear to come from.
4764 Default: C<root@localhost>
4766 =item B<Recipient> I<Address>
4768 Configures the email address(es) to which the notifications should be mailed.
4769 May be repeated to send notifications to multiple addresses.
4771 At least one B<Recipient> must be present for the plugin to work correctly.
4773 =item B<SMTPServer> I<Hostname>
4775 Hostname of the SMTP server to connect to.
4777 Default: C<localhost>
4779 =item B<SMTPPort> I<Port>
4781 TCP port to connect to.
4785 =item B<SMTPUser> I<Username>
4787 Username for ASMTP authentication. Optional.
4789 =item B<SMTPPassword> I<Password>
4791 Password for ASMTP authentication. Optional.
4793 =item B<Subject> I<Subject>
4795 Subject-template to use when sending emails. There must be exactly two
4796 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4797 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4800 Default: C<Collectd notify: %s@%s>
4804 =head2 Plugin C<notify_nagios>
4806 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
4807 a I<passive service check result>.
4809 Available configuration options:
4813 =item B<CommandFile> I<Path>
4815 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
4819 =head2 Plugin C<ntpd>
4821 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
4824 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
4825 the wire - using B<mode 7> specific requests. This mode is deprecated with
4826 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
4827 correctly with them, the ntp daemon must be explicitly configured to
4828 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
4829 manual page for details.
4831 Available configuration options for the C<ntpd> plugin:
4835 =item B<Host> I<Hostname>
4837 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4839 =item B<Port> I<Port>
4841 UDP-Port to connect to. Defaults to B<123>.
4843 =item B<ReverseLookups> B<true>|B<false>
4845 Sets whether or not to perform reverse lookups on peers. Since the name or
4846 IP-address may be used in a filename it is recommended to disable reverse
4847 lookups. The default is to do reverse lookups to preserve backwards
4848 compatibility, though.
4850 =item B<IncludeUnitID> B<true>|B<false>
4852 When a peer is a refclock, include the unit ID in the I<type instance>.
4853 Defaults to B<false> for backward compatibility.
4855 If two refclock peers use the same driver and this is B<false>, the plugin will
4856 try to write simultaneous measurements from both to the same type instance.
4857 This will result in error messages in the log and only one set of measurements
4862 =head2 Plugin C<nut>
4866 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4868 Add a UPS to collect data from. The format is identical to the one accepted by
4873 =head2 Plugin C<olsrd>
4875 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4876 the Optimized Link State Routing daemon and reads information about the current
4877 state of the meshed network.
4879 The following configuration options are understood:
4883 =item B<Host> I<Host>
4885 Connect to I<Host>. Defaults to B<"localhost">.
4887 =item B<Port> I<Port>
4889 Specifies the port to connect to. This must be a string, even if you give the
4890 port as a number rather than a service name. Defaults to B<"2006">.
4892 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4894 Specifies what information to collect about links, i.E<nbsp>e. direct
4895 connections of the daemon queried. If set to B<No>, no information is
4896 collected. If set to B<Summary>, the number of links and the average of all
4897 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4898 If set to B<Detail> LQ and NLQ are collected per link.
4900 Defaults to B<Detail>.
4902 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4904 Specifies what information to collect about routes of the daemon queried. If
4905 set to B<No>, no information is collected. If set to B<Summary>, the number of
4906 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4907 metric and ETX are collected per route.
4909 Defaults to B<Summary>.
4911 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4913 Specifies what information to collect about the global topology. If set to
4914 B<No>, no information is collected. If set to B<Summary>, the number of links
4915 in the entire topology and the average I<link quality> (LQ) is calculated.
4916 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4918 Defaults to B<Summary>.
4922 =head2 Plugin C<onewire>
4924 B<EXPERIMENTAL!> See notes below.
4926 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4927 L<http://owfs.org/> to read sensors connected via the onewire bus.
4929 It can be used in two possible modes - standard or advanced.
4931 In the standard mode only temperature sensors (sensors with the family code
4932 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4933 other sensors you would like to have included, please send a sort request to
4934 the mailing list. You can select sensors to be read or to be ignored depending
4935 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4936 walked and all sensors are read.
4938 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4939 experimental, below.
4941 In the advanced mode you can configure any sensor to be read (only numerical
4942 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4943 In this mode you have to list all the sensors. Neither default bus walk nor
4944 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4945 the path automatically and should produce compatible structure with the "standard"
4946 mode (basically the path is expected as for example
4947 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4948 "F10FCA000800" and the rest after the slash is considered the type - here
4950 There are two advantages to this mode - you can access virtually any sensor
4951 (not just temperature), select whether to use cached or directly read values
4952 and it is slighlty faster. The downside is more complex configuration.
4954 The two modes are distinguished automatically by the format of the address.
4955 It is not possible to mix the two modes. Once a full path is detected in any
4956 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4957 (and as standard addresses will fail parsing they will be ignored).
4961 =item B<Device> I<Device>
4963 Sets the device to read the values from. This can either be a "real" hardware
4964 device, such as a serial port or an USB port, or the address of the
4965 L<owserver(1)> socket, usually B<localhost:4304>.
4967 Though the documentation claims to automatically recognize the given address
4968 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4969 with that version, the following configuration worked for us:
4972 Device "-s localhost:4304"
4975 This directive is B<required> and does not have a default value.
4977 =item B<Sensor> I<Sensor>
4979 In the standard mode selects sensors to collect or to ignore
4980 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4981 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4982 and B<not> include the leading C<10.> family byte and point.
4983 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4984 sensors (see above) are read.
4986 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4987 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4988 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4990 As there can be multiple devices on the bus you can list multiple sensor (use
4991 multiple B<Sensor> elements).
4993 =item B<IgnoreSelected> I<true>|I<false>
4995 If no configuration is given, the B<onewire> plugin will collect data from all
4996 sensors found. This may not be practical, especially if sensors are added and
4997 removed regularly. Sometimes, however, it's easier/preferred to collect only
4998 specific sensors or all sensors I<except> a few specified ones. This option
4999 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5000 B<Sensor> is inverted: All selected interfaces are ignored and all other
5001 interfaces are collected.
5003 Used only in the standard mode - see above.
5005 =item B<Interval> I<Seconds>
5007 Sets the interval in which all sensors should be read. If not specified, the
5008 global B<Interval> setting is used.
5012 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5013 work with big setups. It works with one sensor being attached to one
5014 controller, but as soon as you throw in a couple more senors and maybe a hub
5015 or two, reading all values will take more than ten seconds (the default
5016 interval). We will probably add some separate thread for reading the sensors
5017 and some cache or something like that, but it's not done yet. We will try to
5018 maintain backwards compatibility in the future, but we can't promise. So in
5019 short: If it works for you: Great! But keep in mind that the config I<might>
5020 change, though this is unlikely. Oh, and if you want to help improving this
5021 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5023 =head2 Plugin C<openldap>
5025 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5026 server correctly. The backend database C<monitor> needs to be loaded and
5027 working. See slapd-monitor(5) for the details.
5029 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5030 blocks. Each block requires one string argument as the instance name. For
5035 URL "ldap://localhost/"
5038 URL "ldaps://localhost/"
5042 The instance name will be used as the I<plugin instance>. To emulate the old
5043 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5044 plugin to work correctly, each instance name must be unique. This is not
5045 enforced by the plugin and it is your responsibility to ensure it is.
5047 The following options are accepted within each B<Instance> block:
5051 =item B<URL> I<ldap://host/binddn>
5053 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5056 =item B<BindDN> I<BindDN>
5058 Name in the form of an LDAP distinguished name intended to be used for
5059 authentication. Defaults to empty string to establish an anonymous authorization.
5061 =item B<Password> I<Password>
5063 Password for simple bind authentication. If this option is not set,
5064 unauthenticated bind operation is used.
5066 =item B<StartTLS> B<true|false>
5068 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5069 Disabled by default.
5071 =item B<VerifyHost> B<true|false>
5073 Enables or disables peer host name verification. If enabled, the plugin checks
5074 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5075 certificate matches the host name provided by the B<URL> option. If this
5076 identity check fails, the connection is aborted. Enabled by default.
5078 =item B<CACert> I<File>
5080 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5081 may possibly need this option. What CA certificates are checked by default
5082 depends on the distribution you use and can be changed with the usual ldap
5083 client configuration mechanisms. See ldap.conf(5) for the details.
5085 =item B<Timeout> I<Seconds>
5087 Sets the timeout value for ldap operations, in seconds. By default, the
5088 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5091 =item B<Version> I<Version>
5093 An integer which sets the LDAP protocol version number to use when connecting
5094 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5098 =head2 Plugin C<openvpn>
5100 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5101 traffic statistics about connected clients.
5103 To set up OpenVPN to write to the status file periodically, use the
5104 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
5105 you need to set the required format, too. This is done by setting
5106 B<--status-version> to B<2>.
5108 So, in a nutshell you need:
5110 openvpn $OTHER_OPTIONS \
5111 --status "/var/run/openvpn-status" 10 \
5118 =item B<StatusFile> I<File>
5120 Specifies the location of the status file.
5122 =item B<ImprovedNamingSchema> B<true>|B<false>
5124 When enabled, the filename of the status file will be used as plugin instance
5125 and the client's "common name" will be used as type instance. This is required
5126 when reading multiple status files. Enabling this option is recommended, but to
5127 maintain backwards compatibility this option is disabled by default.
5129 =item B<CollectCompression> B<true>|B<false>
5131 Sets whether or not statistics about the compression used by OpenVPN should be
5132 collected. This information is only available in I<single> mode. Enabled by
5135 =item B<CollectIndividualUsers> B<true>|B<false>
5137 Sets whether or not traffic information is collected for each connected client
5138 individually. If set to false, currently no traffic data is collected at all
5139 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5141 =item B<CollectUserCount> B<true>|B<false>
5143 When enabled, the number of currently connected clients or users is collected.
5144 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5145 can be configured independently from that option. Defaults to B<false>.
5149 =head2 Plugin C<oracle>
5151 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5152 Oracle® Database and lets you execute SQL statements there. It is very similar
5153 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5154 plugin's documentation above for details.
5157 <Query "out_of_stock">
5158 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5161 # InstancePrefix "foo"
5162 InstancesFrom "category"
5166 <Database "product_information">
5170 Query "out_of_stock"
5174 =head3 B<Query> blocks
5176 The Query blocks are handled identically to the Query blocks of the "dbi"
5177 plugin. Please see its documentation above for details on how to specify
5180 =head3 B<Database> blocks
5182 Database blocks define a connection to a database and which queries should be
5183 sent to that database. Each database needs a "name" as string argument in the
5184 starting tag of the block. This name will be used as "PluginInstance" in the
5185 values submitted to the daemon. Other than that, that name is not used.
5189 =item B<ConnectID> I<ID>
5191 Defines the "database alias" or "service name" to connect to. Usually, these
5192 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5194 =item B<Host> I<Host>
5196 Hostname to use when dispatching values for this database. Defaults to using
5197 the global hostname of the I<collectd> instance.
5199 =item B<Username> I<Username>
5201 Username used for authentication.
5203 =item B<Password> I<Password>
5205 Password used for authentication.
5207 =item B<Query> I<QueryName>
5209 Associates the query named I<QueryName> with this database connection. The
5210 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5211 blocks you want to refer to must be placed above the database block you want to
5216 =head2 Plugin C<perl>
5218 This plugin embeds a Perl-interpreter into collectd and provides an interface
5219 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
5221 =head2 Plugin C<pinba>
5223 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
5224 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
5225 PHP-based webpage has been delivered, the extension will send a UDP packet
5226 containing timing information, peak memory usage and so on. The plugin will
5227 wait for such packets, parse them and account the provided information, which
5228 is then dispatched to the daemon once per interval.
5235 # Overall statistics for the website.
5237 Server "www.example.com"
5239 # Statistics for www-a only
5241 Host "www-a.example.com"
5242 Server "www.example.com"
5244 # Statistics for www-b only
5246 Host "www-b.example.com"
5247 Server "www.example.com"
5251 The plugin provides the following configuration options:
5255 =item B<Address> I<Node>
5257 Configures the address used to open a listening socket. By default, plugin will
5258 bind to the I<any> address C<::0>.
5260 =item B<Port> I<Service>
5262 Configures the port (service) to bind to. By default the default Pinba port
5263 "30002" will be used. The option accepts service names in addition to port
5264 numbers and thus requires a I<string> argument.
5266 =item E<lt>B<View> I<Name>E<gt> block
5268 The packets sent by the Pinba extension include the hostname of the server, the
5269 server name (the name of the virtual host) and the script that was executed.
5270 Using B<View> blocks it is possible to separate the data into multiple groups
5271 to get more meaningful statistics. Each packet is added to all matching groups,
5272 so that a packet may be accounted for more than once.
5276 =item B<Host> I<Host>
5278 Matches the hostname of the system the webserver / script is running on. This
5279 will contain the result of the L<gethostname(2)> system call. If not
5280 configured, all hostnames will be accepted.
5282 =item B<Server> I<Server>
5284 Matches the name of the I<virtual host>, i.e. the contents of the
5285 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
5286 server names will be accepted.
5288 =item B<Script> I<Script>
5290 Matches the name of the I<script name>, i.e. the contents of the
5291 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
5292 script names will be accepted.
5298 =head2 Plugin C<ping>
5300 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
5301 configured hosts periodically and measures the network latency. Whenever the
5302 C<read> function of the plugin is called, it submits the average latency, the
5303 standard deviation and the drop rate for each host.
5305 Available configuration options:
5309 =item B<Host> I<IP-address>
5311 Host to ping periodically. This option may be repeated several times to ping
5314 =item B<Interval> I<Seconds>
5316 Sets the interval in which to send ICMP echo packets to the configured hosts.
5317 This is B<not> the interval in which statistics are queries from the plugin but
5318 the interval in which the hosts are "pinged". Therefore, the setting here
5319 should be smaller than or equal to the global B<Interval> setting. Fractional
5320 times, such as "1.24" are allowed.
5324 =item B<Timeout> I<Seconds>
5326 Time to wait for a response from the host to which an ICMP packet had been
5327 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
5328 to be down or the packet to be dropped. This setting must be smaller than the
5329 B<Interval> setting above for the plugin to work correctly. Fractional
5330 arguments are accepted.
5334 =item B<TTL> I<0-255>
5336 Sets the Time-To-Live of generated ICMP packets.
5338 =item B<Size> I<size>
5340 Sets the size of the data payload in ICMP packet to specified I<size> (it
5341 will be filled with regular ASCII pattern). If not set, default 56 byte
5342 long string is used so that the packet size of an ICMPv4 packet is exactly
5343 64 bytes, similar to the behaviour of normal ping(1) command.
5345 =item B<SourceAddress> I<host>
5347 Sets the source address to use. I<host> may either be a numerical network
5348 address or a network hostname.
5350 =item B<Device> I<name>
5352 Sets the outgoing network device to be used. I<name> has to specify an
5353 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
5356 =item B<MaxMissed> I<Packets>
5358 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
5359 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
5361 Default: B<-1> (disabled)
5365 =head2 Plugin C<postgresql>
5367 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
5368 keeps a persistent connection to all configured databases and tries to
5369 reconnect if the connection has been interrupted. A database is configured by
5370 specifying a B<Database> block as described below. The default statistics are
5371 collected from PostgreSQL's B<statistics collector> which thus has to be
5372 enabled for this plugin to work correctly. This should usually be the case by
5373 default. See the section "The Statistics Collector" of the B<PostgreSQL
5374 Documentation> for details.
5376 By specifying custom database queries using a B<Query> block as described
5377 below, you may collect any data that is available from some PostgreSQL
5378 database. This way, you are able to access statistics of external daemons
5379 which are available in a PostgreSQL database or use future or special
5380 statistics provided by PostgreSQL without the need to upgrade your collectd
5383 Starting with version 5.2, the C<postgresql> plugin supports writing data to
5384 PostgreSQL databases as well. This has been implemented in a generic way. You
5385 need to specify an SQL statement which will then be executed by collectd in
5386 order to write the data (see below for details). The benefit of that approach
5387 is that there is no fixed database layout. Rather, the layout may be optimized
5388 for the current setup.
5390 The B<PostgreSQL Documentation> manual can be found at
5391 L<http://www.postgresql.org/docs/manuals/>.
5395 Statement "SELECT magic FROM wizard WHERE host = $1;"
5399 InstancePrefix "magic"
5404 <Query rt36_tickets>
5405 Statement "SELECT COUNT(type) AS count, type \
5407 WHEN resolved = 'epoch' THEN 'open' \
5408 ELSE 'resolved' END AS type \
5409 FROM tickets) type \
5413 InstancePrefix "rt36_tickets"
5414 InstancesFrom "type"
5420 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
5430 KRBSrvName "kerberos_service_name"
5436 Service "service_name"
5437 Query backend # predefined
5448 The B<Query> block defines one database query which may later be used by a
5449 database definition. It accepts a single mandatory argument which specifies
5450 the name of the query. The names of all queries have to be unique (see the
5451 B<MinVersion> and B<MaxVersion> options below for an exception to this
5454 In each B<Query> block, there is one or more B<Result> blocks. Multiple
5455 B<Result> blocks may be used to extract multiple values from a single query.
5457 The following configuration options are available to define the query:
5461 =item B<Statement> I<sql query statement>
5463 Specify the I<sql query statement> which the plugin should execute. The string
5464 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
5465 first, second, etc. parameter. The value of the parameters is specified by the
5466 B<Param> configuration option - see below for details. To include a literal
5467 B<$> character followed by a number, surround it with single quotes (B<'>).
5469 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
5470 allowed. Note, however, that only a single command may be used. Semicolons are
5471 allowed as long as a single non-empty command has been specified only.
5473 The returned lines will be handled separately one after another.
5475 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
5477 Specify the parameters which should be passed to the SQL query. The parameters
5478 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
5479 they appear in the configuration file. The value of the parameter is
5480 determined depending on the value of the B<Param> option as follows:
5486 The configured hostname of the database connection. If a UNIX domain socket is
5487 used, the parameter expands to "localhost".
5491 The name of the database of the current connection.
5495 The name of the database plugin instance. See the B<Instance> option of the
5496 database specification below for details.
5500 The username used to connect to the database.
5504 The interval with which this database is queried (as specified by the database
5505 specific or global B<Interval> options).
5509 Please note that parameters are only supported by PostgreSQL's protocol
5510 version 3 and above which was introduced in version 7.4 of PostgreSQL.
5512 =item B<PluginInstanceFrom> I<column>
5514 Specify how to create the "PluginInstance" for reporting this query results.
5515 Only one column is supported. You may concatenate fields and string values in
5516 the query statement to get the required results.
5518 =item B<MinVersion> I<version>
5520 =item B<MaxVersion> I<version>
5522 Specify the minimum or maximum version of PostgreSQL that this query should be
5523 used with. Some statistics might only be available with certain versions of
5524 PostgreSQL. This allows you to specify multiple queries with the same name but
5525 which apply to different versions, thus allowing you to use the same
5526 configuration in a heterogeneous environment.
5528 The I<version> has to be specified as the concatenation of the major, minor
5529 and patch-level versions, each represented as two-decimal-digit numbers. For
5530 example, version 8.2.3 will become 80203.
5534 The B<Result> block defines how to handle the values returned from the query.
5535 It defines which column holds which value and how to dispatch that value to
5540 =item B<Type> I<type>
5542 The I<type> name to be used when dispatching the values. The type describes
5543 how to handle the data and where to store it. See L<types.db(5)> for more
5544 details on types and their configuration. The number and type of values (as
5545 selected by the B<ValuesFrom> option) has to match the type of the given name.
5547 This option is mandatory.
5549 =item B<InstancePrefix> I<prefix>
5551 =item B<InstancesFrom> I<column0> [I<column1> ...]
5553 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
5554 B<InstancePrefix> defines a static prefix that will be prepended to all type
5555 instances. B<InstancesFrom> defines the column names whose values will be used
5556 to create the type instance. Multiple values will be joined together using the
5557 hyphen (C<->) as separation character.
5559 The plugin itself does not check whether or not all built instances are
5560 different. It is your responsibility to assure that each is unique.
5562 Both options are optional. If none is specified, the type instance will be
5565 =item B<ValuesFrom> I<column0> [I<column1> ...]
5567 Names the columns whose content is used as the actual data for the data sets
5568 that are dispatched to the daemon. How many such columns you need is
5569 determined by the B<Type> setting as explained above. If you specify too many
5570 or not enough columns, the plugin will complain about that and no data will be
5571 submitted to the daemon.
5573 The actual data type, as seen by PostgreSQL, is not that important as long as
5574 it represents numbers. The plugin will automatically cast the values to the
5575 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
5576 L<strtod(3)> functions, so anything supported by those functions is supported
5577 by the plugin as well.
5579 This option is required inside a B<Result> block and may be specified multiple
5580 times. If multiple B<ValuesFrom> options are specified, the columns are read
5585 The following predefined queries are available (the definitions can be found
5586 in the F<postgresql_default.conf> file which, by default, is available at
5587 C<I<prefix>/share/collectd/>):
5593 This query collects the number of backends, i.E<nbsp>e. the number of
5596 =item B<transactions>
5598 This query collects the numbers of committed and rolled-back transactions of
5603 This query collects the numbers of various table modifications (i.E<nbsp>e.
5604 insertions, updates, deletions) of the user tables.
5606 =item B<query_plans>
5608 This query collects the numbers of various table scans and returned tuples of
5611 =item B<table_states>
5613 This query collects the numbers of live and dead rows in the user tables.
5617 This query collects disk block access counts for user tables.
5621 This query collects the on-disk size of the database in bytes.
5625 In addition, the following detailed queries are available by default. Please
5626 note that each of those queries collects information B<by table>, thus,
5627 potentially producing B<a lot> of data. For details see the description of the
5628 non-by_table queries above.
5632 =item B<queries_by_table>
5634 =item B<query_plans_by_table>
5636 =item B<table_states_by_table>
5638 =item B<disk_io_by_table>
5642 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5643 mandatory argument specifying the name of the writer. This will then be used
5644 in the B<Database> specification in order to activate the writer instance. The
5645 names of all writers have to be unique. The following options may be
5650 =item B<Statement> I<sql statement>
5652 This mandatory option specifies the SQL statement that will be executed for
5653 each submitted value. A single SQL statement is allowed only. Anything after
5654 the first semicolon will be ignored.
5656 Nine parameters will be passed to the statement and should be specified as
5657 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5658 values are made available through those parameters:
5664 The timestamp of the queried value as a floating point number.
5668 The hostname of the queried value.
5672 The plugin name of the queried value.
5676 The plugin instance of the queried value. This value may be B<NULL> if there
5677 is no plugin instance.
5681 The type of the queried value (cf. L<types.db(5)>).
5685 The type instance of the queried value. This value may be B<NULL> if there is
5690 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5691 sources of the submitted value-list).
5695 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5696 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5697 B<StoreRates> is enabled (which is the default, see below), all types will be
5702 An array of the submitted values. The dimensions of the value name and value
5707 In general, it is advisable to create and call a custom function in the
5708 PostgreSQL database for this purpose. Any procedural language supported by
5709 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5712 =item B<StoreRates> B<false>|B<true>
5714 If set to B<true> (the default), convert counter values to rates. If set to
5715 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5720 The B<Database> block defines one PostgreSQL database for which to collect
5721 statistics. It accepts a single mandatory argument which specifies the
5722 database name. None of the other options are required. PostgreSQL will use
5723 default values as documented in the section "CONNECTING TO A DATABASE" in the
5724 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5725 the user collectd is run as and special environment variables. See the manpage
5730 =item B<Interval> I<seconds>
5732 Specify the interval with which the database should be queried. The default is
5733 to use the global B<Interval> setting.
5735 =item B<CommitInterval> I<seconds>
5737 This option may be used for database connections which have "writers" assigned
5738 (see above). If specified, it causes a writer to put several updates into a
5739 single transaction. This transaction will last for the specified amount of
5740 time. By default, each update will be executed in a separate transaction. Each
5741 transaction generates a fair amount of overhead which can, thus, be reduced by
5742 activating this option. The draw-back is, that data covering the specified
5743 amount of time will be lost, for example, if a single statement within the
5744 transaction fails or if the database server crashes.
5746 =item B<Instance> I<name>
5748 Specify the plugin instance name that should be used instead of the database
5749 name (which is the default, if this option has not been specified). This
5750 allows to query multiple databases of the same name on the same host (e.g.
5751 when running multiple database server versions in parallel).
5752 The plugin instance name can also be set from the query result using
5753 the B<PluginInstanceFrom> option in B<Query> block.
5755 =item B<Host> I<hostname>
5757 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5758 value begins with a slash, it is interpreted as the directory name in which to
5759 look for the UNIX domain socket.
5761 This option is also used to determine the hostname that is associated with a
5762 collected data set. If it has been omitted or either begins with with a slash
5763 or equals B<localhost> it will be replaced with the global hostname definition
5764 of collectd. Any other value will be passed literally to collectd when
5765 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5767 =item B<Port> I<port>
5769 Specify the TCP port or the local UNIX domain socket file extension of the
5772 =item B<User> I<username>
5774 Specify the username to be used when connecting to the server.
5776 =item B<Password> I<password>
5778 Specify the password to be used when connecting to the server.
5780 =item B<ExpireDelay> I<delay>
5782 Skip expired values in query output.
5784 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5786 Specify whether to use an SSL connection when contacting the server. The
5787 following modes are supported:
5793 Do not use SSL at all.
5797 First, try to connect without using SSL. If that fails, try using SSL.
5799 =item I<prefer> (default)
5801 First, try to connect using SSL. If that fails, try without using SSL.
5809 =item B<Instance> I<name>
5811 Specify the plugin instance name that should be used instead of the database
5812 name (which is the default, if this option has not been specified). This
5813 allows to query multiple databases of the same name on the same host (e.g.
5814 when running multiple database server versions in parallel).
5816 =item B<KRBSrvName> I<kerberos_service_name>
5818 Specify the Kerberos service name to use when authenticating with Kerberos 5
5819 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5820 B<PostgreSQL Documentation> for details.
5822 =item B<Service> I<service_name>
5824 Specify the PostgreSQL service name to use for additional parameters. That
5825 service has to be defined in F<pg_service.conf> and holds additional
5826 connection parameters. See the section "The Connection Service File" in the
5827 B<PostgreSQL Documentation> for details.
5829 =item B<Query> I<query>
5831 Specifies a I<query> which should be executed in the context of the database
5832 connection. This may be any of the predefined or user-defined queries. If no
5833 such option is given, it defaults to "backends", "transactions", "queries",
5834 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5835 has been specified). Else, the specified queries are used only.
5837 =item B<Writer> I<writer>
5839 Assigns the specified I<writer> backend to the database connection. This
5840 causes all collected data to be send to the database using the settings
5841 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5842 below for details on how to selectively send data to certain plugins).
5844 Each writer will register a flush callback which may be used when having long
5845 transactions enabled (see the B<CommitInterval> option above). When issuing
5846 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5847 transaction will be committed right away. Two different kinds of flush
5848 callbacks are available with the C<postgresql> plugin:
5854 Flush all writer backends.
5856 =item B<postgresql->I<database>
5858 Flush all writers of the specified I<database> only.
5864 =head2 Plugin C<powerdns>
5866 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5867 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5868 values, many of which are probably meaningless to most users, but may be useful
5869 for some. So you may chose which values to collect, but if you don't, some
5870 reasonable defaults will be collected.
5873 <Server "server_name">
5875 Collect "udp-answers" "udp-queries"
5876 Socket "/var/run/pdns.controlsocket"
5878 <Recursor "recursor_name">
5880 Collect "cache-hits" "cache-misses"
5881 Socket "/var/run/pdns_recursor.controlsocket"
5883 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5888 =item B<Server> and B<Recursor> block
5890 The B<Server> block defines one authoritative server to query, the B<Recursor>
5891 does the same for an recursing server. The possible options in both blocks are
5892 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5897 =item B<Collect> I<Field>
5899 Using the B<Collect> statement you can select which values to collect. Here,
5900 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5901 C<dlg-only-drops>, C<answers10-100>.
5903 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5904 When querying the server a C<SHOW *> command is issued in any case, because
5905 that's the only way of getting multiple values out of the server at once.
5906 collectd then picks out the values you have selected. When querying the
5907 recursor, a command is generated to query exactly these values. So if you
5908 specify invalid fields when querying the recursor, a syntax error may be
5909 returned by the daemon and collectd may not collect any values at all.
5911 If no B<Collect> statement is given, the following B<Server> values will be
5918 =item packetcache-hit
5920 =item packetcache-miss
5922 =item packetcache-size
5924 =item query-cache-hit
5926 =item query-cache-miss
5928 =item recursing-answers
5930 =item recursing-questions
5942 The following B<Recursor> values will be collected by default:
5946 =item noerror-answers
5948 =item nxdomain-answers
5950 =item servfail-answers
5968 Please note that up to that point collectd doesn't know what values are
5969 available on the server and values that are added do not need a change of the
5970 mechanism so far. However, the values must be mapped to collectd's naming
5971 scheme, which is done using a lookup table that lists all known values. If
5972 values are added in the future and collectd does not know about them, you will
5973 get an error much like this:
5975 powerdns plugin: submit: Not found in lookup table: foobar = 42
5977 In this case please file a bug report with the collectd team.
5979 =item B<Socket> I<Path>
5981 Configures the path to the UNIX domain socket to be used when connecting to the
5982 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5983 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5984 will be used for the recursor.
5988 =item B<LocalSocket> I<Path>
5990 Querying the recursor is done using UDP. When using UDP over UNIX domain
5991 sockets, the client socket needs a name in the file system, too. You can set
5992 this local name to I<Path> using the B<LocalSocket> option. The default is
5993 C<I<prefix>/var/run/collectd-powerdns>.
5997 =head2 Plugin C<processes>
6001 =item B<Process> I<Name>
6003 Select more detailed statistics of processes matching this name. The statistics
6004 collected for these selected processes are size of the resident segment size
6005 (RSS), user- and system-time used, number of processes and number of threads,
6006 io data (where available) and minor and major pagefaults.
6008 Some platforms have a limit on the length of process names. I<Name> must stay
6011 =item B<ProcessMatch> I<name> I<regex>
6013 Similar to the B<Process> option this allows to select more detailed
6014 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6015 details). The statistics of all matching processes are summed up and
6016 dispatched to the daemon using the specified I<name> as an identifier. This
6017 allows to "group" several processes together. I<name> must not contain
6020 =item B<CollectContextSwitch> I<Boolean>
6022 Collect context switch of the process.
6026 =head2 Plugin C<protocols>
6028 Collects a lot of information about various network protocols, such as I<IP>,
6029 I<TCP>, I<UDP>, etc.
6031 Available configuration options:
6035 =item B<Value> I<Selector>
6037 Selects whether or not to select a specific value. The string being matched is
6038 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6039 plugin instance and I<ValueName> will be used as type instance. An example of
6040 the string being used would be C<Tcp:RetransSegs>.
6042 You can use regular expressions to match a large number of values with just one
6043 configuration option. To select all "extended" I<TCP> values, you could use the
6044 following statement:
6048 Whether only matched values are selected or all matched values are ignored
6049 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6050 If no value is configured at all, all values will be selected.
6052 =item B<IgnoreSelected> B<true>|B<false>
6054 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6055 matching values will be ignored.
6059 =head2 Plugin C<python>
6061 This plugin embeds a Python-interpreter into collectd and provides an interface
6062 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6064 =head2 Plugin C<routeros>
6066 The C<routeros> plugin connects to a device running I<RouterOS>, the
6067 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6068 I<librouteros> to connect and reads information about the interfaces and
6069 wireless connections of the device. The configuration supports querying
6074 Host "router0.example.com"
6077 CollectInterface true
6082 Host "router1.example.com"
6085 CollectInterface true
6086 CollectRegistrationTable true
6092 As you can see above, the configuration of the I<routeros> plugin consists of
6093 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6094 options are understood:
6098 =item B<Host> I<Host>
6100 Hostname or IP-address of the router to connect to.
6102 =item B<Port> I<Port>
6104 Port name or port number used when connecting. If left unspecified, the default
6105 will be chosen by I<librouteros>, currently "8728". This option expects a
6106 string argument, even when a numeric port number is given.
6108 =item B<User> I<User>
6110 Use the user name I<User> to authenticate. Defaults to "admin".
6112 =item B<Password> I<Password>
6114 Set the password used to authenticate.
6116 =item B<CollectInterface> B<true>|B<false>
6118 When set to B<true>, interface statistics will be collected for all interfaces
6119 present on the device. Defaults to B<false>.
6121 =item B<CollectRegistrationTable> B<true>|B<false>
6123 When set to B<true>, information about wireless LAN connections will be
6124 collected. Defaults to B<false>.
6126 =item B<CollectCPULoad> B<true>|B<false>
6128 When set to B<true>, information about the CPU usage will be collected. The
6129 number is a dimensionless value where zero indicates no CPU usage at all.
6130 Defaults to B<false>.
6132 =item B<CollectMemory> B<true>|B<false>
6134 When enabled, the amount of used and free memory will be collected. How used
6135 memory is calculated is unknown, for example whether or not caches are counted
6137 Defaults to B<false>.
6139 =item B<CollectDF> B<true>|B<false>
6141 When enabled, the amount of used and free disk space will be collected.
6142 Defaults to B<false>.
6144 =item B<CollectDisk> B<true>|B<false>
6146 When enabled, the number of sectors written and bad blocks will be collected.
6147 Defaults to B<false>.
6151 =head2 Plugin C<redis>
6153 The I<Redis plugin> connects to one or more Redis servers and gathers
6154 information about each server's state. For each server there is a I<Node> block
6155 which configures the connection parameters for this node.
6162 <Query "LLEN myqueue">
6169 The information shown in the synopsis above is the I<default configuration>
6170 which is used by the plugin if no configuration is present.
6174 =item B<Node> I<Nodename>
6176 The B<Node> block identifies a new Redis node, that is a new Redis instance
6177 running in an specified host and port. The name for node is a canonical
6178 identifier which is used as I<plugin instance>. It is limited to
6179 64E<nbsp>characters in length.
6181 =item B<Host> I<Hostname>
6183 The B<Host> option is the hostname or IP-address where the Redis instance is
6186 =item B<Port> I<Port>
6188 The B<Port> option is the TCP port on which the Redis instance accepts
6189 connections. Either a service name of a port number may be given. Please note
6190 that numerical port numbers must be given as a string, too.
6192 =item B<Password> I<Password>
6194 Use I<Password> to authenticate when connecting to I<Redis>.
6196 =item B<Timeout> I<Milliseconds>
6198 The B<Timeout> option set the socket timeout for node response. Since the Redis
6199 read function is blocking, you should keep this value as low as possible. Keep
6200 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
6201 than B<Interval> defined globally.
6203 =item B<Query> I<Querystring>
6205 The B<Query> block identifies a query to execute against the redis server.
6206 There may be an arbitrary number of queries to execute.
6208 =item B<Type> I<Collectd type>
6210 Within a query definition, a valid collectd type to use as when submitting
6211 the result of the query. When not supplied, will default to B<gauge>.
6213 =item B<Instance> I<Type instance>
6215 Within a query definition, an optional type instance to use when submitting
6216 the result of the query. When not supplied will default to the escaped
6217 command, up to 64 chars.
6221 =head2 Plugin C<rrdcached>
6223 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
6224 to store values to RRD files in an efficient manner. The combination of the
6225 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
6226 way the C<rrdtool> plugin works (see below). The added abstraction layer
6227 provides a number of benefits, though: Because the cache is not within
6228 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
6229 restarted. This results in much shorter (if any) gaps in graphs, especially
6230 under heavy load. Also, the C<rrdtool> command line utility is aware of the
6231 daemon so that it can flush values to disk automatically when needed. This
6232 allows to integrate automated flushing of values into graphing solutions much
6235 There are disadvantages, though: The daemon may reside on a different host, so
6236 it may not be possible for C<collectd> to create the appropriate RRD files
6237 anymore. And even if C<rrdcached> runs on the same host, it may run in a
6238 different base directory, so relative paths may do weird stuff if you're not
6241 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
6242 on the same host, communicating via a UNIX domain socket. The B<DataDir>
6243 setting should be set to an absolute path, so that a changed base directory
6244 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
6248 =item B<DaemonAddress> I<Address>
6250 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
6251 library. See L<rrdcached(1)> for details. Example:
6253 <Plugin "rrdcached">
6254 DaemonAddress "unix:/var/run/rrdcached.sock"
6257 =item B<DataDir> I<Directory>
6259 Set the base directory in which the RRD files reside. If this is a relative
6260 path, it is relative to the working base directory of the C<rrdcached> daemon!
6261 Use of an absolute path is recommended.
6263 =item B<CreateFiles> B<true>|B<false>
6265 Enables or disables the creation of RRD files. If the daemon is not running
6266 locally, or B<DataDir> is set to a relative path, this will not work as
6267 expected. Default is B<true>.
6269 =item B<CreateFilesAsync> B<false>|B<true>
6271 When enabled, new RRD files are enabled asynchronously, using a separate thread
6272 that runs in the background. This prevents writes to block, which is a problem
6273 especially when many hundreds of files need to be created at once. However,
6274 since the purpose of creating the files asynchronously is I<not> to block until
6275 the file is available, values before the file is available will be discarded.
6276 When disabled (the default) files are created synchronously, blocking for a
6277 short while, while the file is being written.
6279 =item B<StepSize> I<Seconds>
6281 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6282 this setting is unset and the stepsize is set to the interval in which the data
6283 is collected. Do not use this option unless you absolutely have to for some
6284 reason. Setting this option may cause problems with the C<snmp plugin>, the
6285 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6287 =item B<HeartBeat> I<Seconds>
6289 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6290 in which case the heartbeat is set to twice the B<StepSize> which should equal
6291 the interval in which data is collected. Do not set this option unless you have
6292 a very good reason to do so.
6294 =item B<RRARows> I<NumRows>
6296 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6297 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6298 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6299 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6300 week, one month, and one year.
6302 So for each timespan, it calculates how many PDPs need to be consolidated into
6303 one CDP by calculating:
6304 number of PDPs = timespan / (stepsize * rrarows)
6306 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6309 =item B<RRATimespan> I<Seconds>
6311 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6312 more then one RRA. If this option is never used, the built-in default of (3600,
6313 86400, 604800, 2678400, 31622400) is used.
6315 For more information on how RRA-sizes are calculated see B<RRARows> above.
6317 =item B<XFF> I<Factor>
6319 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6320 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6323 =item B<CollectStatistics> B<false>|B<true>
6325 When set to B<true>, various statistics about the I<rrdcached> daemon will be
6326 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
6328 Statistics are read via I<rrdcached>s socket using the STATS command.
6329 See L<rrdcached(1)> for details.
6333 =head2 Plugin C<rrdtool>
6335 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
6336 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
6337 using these settings. If you don't want to dive into the depths of RRDtool, you
6338 can safely ignore these settings.
6342 =item B<DataDir> I<Directory>
6344 Set the directory to store RRD files under. By default RRD files are generated
6345 beneath the daemon's working directory, i.e. the B<BaseDir>.
6347 =item B<CreateFilesAsync> B<false>|B<true>
6349 When enabled, new RRD files are enabled asynchronously, using a separate thread
6350 that runs in the background. This prevents writes to block, which is a problem
6351 especially when many hundreds of files need to be created at once. However,
6352 since the purpose of creating the files asynchronously is I<not> to block until
6353 the file is available, values before the file is available will be discarded.
6354 When disabled (the default) files are created synchronously, blocking for a
6355 short while, while the file is being written.
6357 =item B<StepSize> I<Seconds>
6359 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6360 this setting is unset and the stepsize is set to the interval in which the data
6361 is collected. Do not use this option unless you absolutely have to for some
6362 reason. Setting this option may cause problems with the C<snmp plugin>, the
6363 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6365 =item B<HeartBeat> I<Seconds>
6367 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6368 in which case the heartbeat is set to twice the B<StepSize> which should equal
6369 the interval in which data is collected. Do not set this option unless you have
6370 a very good reason to do so.
6372 =item B<RRARows> I<NumRows>
6374 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6375 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6376 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6377 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6378 week, one month, and one year.
6380 So for each timespan, it calculates how many PDPs need to be consolidated into
6381 one CDP by calculating:
6382 number of PDPs = timespan / (stepsize * rrarows)
6384 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6387 =item B<RRATimespan> I<Seconds>
6389 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6390 more then one RRA. If this option is never used, the built-in default of (3600,
6391 86400, 604800, 2678400, 31622400) is used.
6393 For more information on how RRA-sizes are calculated see B<RRARows> above.
6395 =item B<XFF> I<Factor>
6397 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6398 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6401 =item B<CacheFlush> I<Seconds>
6403 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
6404 it writes all values for a certain RRD-file if the oldest value is older than
6405 (or equal to) the number of seconds specified. If some RRD-file is not updated
6406 anymore for some reason (the computer was shut down, the network is broken,
6407 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
6408 entire cache is searched for entries older than B<CacheTimeout> seconds and
6409 written to disk every I<Seconds> seconds. Since this is kind of expensive and
6410 does nothing under normal circumstances, this value should not be too small.
6411 900 seconds might be a good value, though setting this to 7200 seconds doesn't
6412 normally do much harm either.
6414 =item B<CacheTimeout> I<Seconds>
6416 If this option is set to a value greater than zero, the C<rrdtool plugin> will
6417 save values in a cache, as described above. Writing multiple values at once
6418 reduces IO-operations and thus lessens the load produced by updating the files.
6419 The trade off is that the graphs kind of "drag behind" and that more memory is
6422 =item B<WritesPerSecond> I<Updates>
6424 When collecting many statistics with collectd and the C<rrdtool> plugin, you
6425 will run serious performance problems. The B<CacheFlush> setting and the
6426 internal update queue assert that collectd continues to work just fine even
6427 under heavy load, but the system may become very unresponsive and slow. This is
6428 a problem especially if you create graphs from the RRD files on the same
6429 machine, for example using the C<graph.cgi> script included in the
6430 C<contrib/collection3/> directory.
6432 This setting is designed for very large setups. Setting this option to a value
6433 between 25 and 80 updates per second, depending on your hardware, will leave
6434 the server responsive enough to draw graphs even while all the cached values
6435 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
6436 by the B<FLUSH> command, are B<not> effected by this limit. They are still
6437 written as fast as possible, so that web frontends have up to date data when
6440 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
6441 updates per second, writing all values to disk will take approximately
6442 56E<nbsp>minutes. Together with the flushing ability that's integrated into
6443 "collection3" you'll end up with a responsive and fast system, up to date
6444 graphs and basically a "backup" of your values every hour.
6446 =item B<RandomTimeout> I<Seconds>
6448 When set, the actual timeout for each value is chosen randomly between
6449 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
6450 intention is to avoid high load situations that appear when many values timeout
6451 at the same time. This is especially a problem shortly after the daemon starts,
6452 because all values were added to the internal cache at roughly the same time.
6456 =head2 Plugin C<sensors>
6458 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
6459 that all the needed modules have to be loaded and lm_sensors has to be
6460 configured (most likely by editing F</etc/sensors.conf>. Read
6461 L<sensors.conf(5)> for details.
6463 The B<lm_sensors> homepage can be found at
6464 L<http://secure.netroedge.com/~lm78/>.
6468 =item B<SensorConfigFile> I<File>
6470 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
6471 the library's default will be used.
6473 =item B<Sensor> I<chip-bus-address/type-feature>
6475 Selects the name of the sensor which you want to collect or ignore, depending
6476 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
6477 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
6478 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
6480 =item B<IgnoreSelected> I<true>|I<false>
6482 If no configuration if given, the B<sensors>-plugin will collect data from all
6483 sensors. This may not be practical, especially for uninteresting sensors.
6484 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
6485 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
6486 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
6487 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
6488 and all other sensors are collected.
6490 =item B<UseLabels> I<true>|I<false>
6492 Configures how sensor readings are reported. When set to I<true>, sensor
6493 readings are reported using their descriptive label (e.g. "VCore"). When set to
6494 I<false> (the default) the sensor name is used ("in0").
6498 =head2 Plugin C<sigrok>
6500 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
6501 supported by the L<sigrok|http://sigrok.org/> project.
6507 <Device "AC Voltage">
6512 <Device "Sound Level">
6513 Driver "cem-dt-885x"
6520 =item B<LogLevel> B<0-5>
6522 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
6523 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
6524 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
6525 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
6526 their level, are always submitted to I<collectd> at its INFO log level.
6528 =item E<lt>B<Device> I<Name>E<gt>
6530 A sigrok-supported device, uniquely identified by this section's options. The
6531 I<Name> is passed to I<collectd> as the I<plugin instance>.
6533 =item B<Driver> I<DriverName>
6535 The sigrok driver to use for this device.
6537 =item B<Conn> I<ConnectionSpec>
6539 If the device cannot be auto-discovered, or more than one might be discovered
6540 by the driver, I<ConnectionSpec> specifies the connection string to the device.
6541 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
6542 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
6543 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
6544 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
6546 =item B<SerialComm> I<SerialSpec>
6548 For serial devices with non-standard port settings, this option can be used
6549 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
6550 This should not be necessary; drivers know how to communicate with devices they
6553 =item B<MinimumInterval> I<Seconds>
6555 Specifies the minimum time between measurement dispatches to I<collectd>, in
6556 seconds. Since some I<sigrok> supported devices can acquire measurements many
6557 times per second, it may be necessary to throttle these. For example, the
6558 I<RRD plugin> cannot process writes more than once per second.
6560 The default B<MinimumInterval> is B<0>, meaning measurements received from the
6561 device are always dispatched to I<collectd>. When throttled, unused
6562 measurements are discarded.
6566 =head2 Plugin C<smart>
6568 The C<smart> plugin collects SMART information from physical
6569 disks. Values collectd include temperature, power cycle count, poweron
6570 time and bad sectors. Also, all SMART attributes are collected along
6571 with the normalized current value, the worst value, the threshold and
6572 a human readable value.
6574 Using the following two options you can ignore some disks or configure the
6575 collection only of specific disks.
6579 =item B<Disk> I<Name>
6581 Select the disk I<Name>. Whether it is collected or ignored depends on the
6582 B<IgnoreSelected> setting, see below. As with other plugins that use the
6583 daemon's ignorelist functionality, a string that starts and ends with a slash
6584 is interpreted as a regular expression. Examples:
6589 =item B<IgnoreSelected> B<true>|B<false>
6591 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
6592 statements, are ignored or if all other disks are ignored. The behavior
6593 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
6594 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
6595 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
6596 is set to B<true>, all disks are collected B<except> the ones matched.
6598 =item B<IgnoreSleepMode> B<true>|B<false>
6600 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
6601 This option disables the sleep mode check and allows the plugin to collect data
6602 from these disks anyway. This is useful in cases where libatasmart mistakenly
6603 reports disks as asleep because it has not been updated to incorporate support
6604 for newer idle states in the ATA spec.
6606 =item B<UseSerial> B<true>|B<false>
6608 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
6609 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
6610 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
6611 storing data. This ensures that the data for a given disk will be kept together
6612 even if the kernel name changes.
6616 =head2 Plugin C<snmp>
6618 Since the configuration of the C<snmp plugin> is a little more complicated than
6619 other plugins, its documentation has been moved to an own manpage,
6620 L<collectd-snmp(5)>. Please see there for details.
6622 =head2 Plugin C<statsd>
6624 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
6625 protocol and dispatches rates or other aggregates of these numbers
6628 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
6629 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
6630 C<objects> respectively.
6632 The following configuration options are valid:
6636 =item B<Host> I<Host>
6638 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
6639 "any" address, i.e. accept packets sent to any of the hosts addresses.
6641 =item B<Port> I<Port>
6643 UDP port to listen to. This can be either a service name or a port number.
6644 Defaults to C<8125>.
6646 =item B<DeleteCounters> B<false>|B<true>
6648 =item B<DeleteTimers> B<false>|B<true>
6650 =item B<DeleteGauges> B<false>|B<true>
6652 =item B<DeleteSets> B<false>|B<true>
6654 These options control what happens if metrics are not updated in an interval.
6655 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6656 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6657 are unchanged. If set to B<True>, the such metrics are not dispatched and
6658 removed from the internal cache.
6660 =item B<CounterSum> B<false>|B<true>
6662 When enabled, creates a C<count> metric which reports the change since the last
6663 read. This option primarily exists for compatibility with the I<statsd>
6664 implementation by Etsy.
6666 =item B<TimerPercentile> I<Percent>
6668 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6669 that I<Percent> of all reported timers are smaller than or equal to the
6670 computed latency. This is useful for cutting off the long tail latency, as it's
6671 often done in I<Service Level Agreements> (SLAs).
6673 Different percentiles can be calculated by setting this option several times.
6674 If none are specified, no percentiles are calculated / dispatched.
6676 =item B<TimerLower> B<false>|B<true>
6678 =item B<TimerUpper> B<false>|B<true>
6680 =item B<TimerSum> B<false>|B<true>
6682 =item B<TimerCount> B<false>|B<true>
6684 Calculate and dispatch various values out of I<Timer> metrics received during
6685 an interval. If set to B<False>, the default, these values aren't calculated /
6690 =head2 Plugin C<swap>
6692 The I<Swap plugin> collects information about used and available swap space. On
6693 I<Linux> and I<Solaris>, the following options are available:
6697 =item B<ReportByDevice> B<false>|B<true>
6699 Configures how to report physical swap devices. If set to B<false> (the
6700 default), the summary over all swap devices is reported only, i.e. the globally
6701 used and available space over all devices. If B<true> is configured, the used
6702 and available space of each device will be reported separately.
6704 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6705 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6707 =item B<ReportBytes> B<false>|B<true>
6709 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6710 I<swap I/O> is reported in pages. This option is available under Linux only.
6712 =item B<ValuesAbsolute> B<true>|B<false>
6714 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6715 available and used. Defaults to B<true>.
6717 =item B<ValuesPercentage> B<false>|B<true>
6719 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6720 available and free. Defaults to B<false>.
6722 This is useful for deploying I<collectd> in a heterogeneous environment, where
6723 swap sizes differ and you want to specify generic thresholds or similar.
6727 =head2 Plugin C<syslog>
6731 =item B<LogLevel> B<debug|info|notice|warning|err>
6733 Sets the log-level. If, for example, set to B<notice>, then all events with
6734 severity B<notice>, B<warning>, or B<err> will be submitted to the
6737 Please note that B<debug> is only available if collectd has been compiled with
6740 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6742 Controls which notifications should be sent to syslog. The default behaviour is
6743 not to send any. Less severe notifications always imply logging more severe
6744 notifications: Setting this to B<OKAY> means all notifications will be sent to
6745 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6746 notifications but will dismiss B<OKAY> notifications. Setting this option to
6747 B<FAILURE> will only send failures to syslog.
6751 =head2 Plugin C<table>
6753 The C<table plugin> provides generic means to parse tabular data and dispatch
6754 user specified values. Values are selected based on column numbers. For
6755 example, this plugin may be used to get values from the Linux L<proc(5)>
6756 filesystem or CSV (comma separated values) files.
6759 <Table "/proc/slabinfo">
6764 InstancePrefix "active_objs"
6770 InstancePrefix "objperslab"
6777 The configuration consists of one or more B<Table> blocks, each of which
6778 configures one file to parse. Within each B<Table> block, there are one or
6779 more B<Result> blocks, which configure which data to select and how to
6782 The following options are available inside a B<Table> block:
6786 =item B<Instance> I<instance>
6788 If specified, I<instance> is used as the plugin instance. So, in the above
6789 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6790 filename of the table is used instead, with all special characters replaced
6791 with an underscore (C<_>).
6793 =item B<Separator> I<string>
6795 Any character of I<string> is interpreted as a delimiter between the different
6796 columns of the table. A sequence of two or more contiguous delimiters in the
6797 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6798 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6799 of a table - see its documentation for more details. This option is mandatory.
6801 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6802 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6803 required because of collectd's config parsing.
6807 The following options are available inside a B<Result> block:
6811 =item B<Type> I<type>
6813 Sets the type used to dispatch the values to the daemon. Detailed information
6814 about types and their configuration can be found in L<types.db(5)>. This
6815 option is mandatory.
6817 =item B<InstancePrefix> I<prefix>
6819 If specified, prepend I<prefix> to the type instance. If omitted, only the
6820 B<InstancesFrom> option is considered for the type instance.
6822 =item B<InstancesFrom> I<column0> [I<column1> ...]
6824 If specified, the content of the given columns (identified by the column
6825 number starting at zero) will be used to create the type instance for each
6826 row. Multiple values (and the instance prefix) will be joined together with
6827 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6828 option is considered for the type instance.
6830 The plugin itself does not check whether or not all built instances are
6831 different. It’s your responsibility to assure that each is unique. This is
6832 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6833 sure that the table only contains one row.
6835 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6838 =item B<ValuesFrom> I<column0> [I<column1> ...]
6840 Specifies the columns (identified by the column numbers starting at zero)
6841 whose content is used as the actual data for the data sets that are dispatched
6842 to the daemon. How many such columns you need is determined by the B<Type>
6843 setting above. If you specify too many or not enough columns, the plugin will
6844 complain about that and no data will be submitted to the daemon. The plugin
6845 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6846 respectively, so anything supported by those functions is supported by the
6847 plugin as well. This option is mandatory.
6851 =head2 Plugin C<tail>
6853 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6854 each line and dispatches found values. What is matched can be configured by the
6855 user using (extended) regular expressions, as described in L<regex(7)>.
6858 <File "/var/log/exim4/mainlog">
6862 Regex "S=([1-9][0-9]*)"
6868 Regex "\\<R=local_user\\>"
6869 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6872 Instance "local_user"
6877 The config consists of one or more B<File> blocks, each of which configures one
6878 logfile to parse. Within each B<File> block, there are one or more B<Match>
6879 blocks, which configure a regular expression to search for.
6881 The B<Instance> option in the B<File> block may be used to set the plugin
6882 instance. So in the above example the plugin name C<tail-foo> would be used.
6883 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6884 next B<Instance> option. This way you can extract several plugin instances from
6885 one logfile, handy when parsing syslog and the like.
6887 The B<Interval> option allows you to define the length of time between reads. If
6888 this is not set, the default Interval will be used.
6890 Each B<Match> block has the following options to describe how the match should
6895 =item B<Regex> I<regex>
6897 Sets the regular expression to use for matching against a line. The first
6898 subexpression has to match something that can be turned into a number by
6899 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6900 below. Because B<extended> regular expressions are used, you do not need to use
6901 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6902 collectd's config parsing you need to escape backslashes, though. So if you
6903 want to match literal parentheses you need to do the following:
6905 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6907 =item B<ExcludeRegex> I<regex>
6909 Sets an optional regular expression to use for excluding lines from the match.
6910 An example which excludes all connections from localhost from the match:
6912 ExcludeRegex "127\\.0\\.0\\.1"
6914 =item B<DSType> I<Type>
6916 Sets how the values are cumulated. I<Type> is one of:
6920 =item B<GaugeAverage>
6922 Calculate the average.
6926 Use the smallest number only.
6930 Use the greatest number only.
6934 Use the last number found.
6940 =item B<AbsoluteSet>
6942 The matched number is a counter. Simply I<sets> the internal counter to this
6943 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6951 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6952 matched number may be negative, which will effectively subtract from the
6961 Increase the internal counter by one. These B<DSType> are the only ones that do
6962 not use the matched subexpression, but simply count the number of matched
6963 lines. Thus, you may use a regular expression without submatch in this case.
6967 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6968 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6969 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6970 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6971 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6974 =item B<Type> I<Type>
6976 Sets the type used to dispatch this value. Detailed information about types and
6977 their configuration can be found in L<types.db(5)>.
6979 =item B<Instance> I<TypeInstance>
6981 This optional setting sets the type instance to use.
6985 =head2 Plugin C<tail_csv>
6987 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6988 written by I<Snort>.
6993 <Metric "snort-dropped">
6998 <File "/var/log/snort/snort.stats">
6999 Instance "snort-eth0"
7001 Collect "snort-dropped"
7005 The configuration consists of one or more B<Metric> blocks that define an index
7006 into the line of the CSV file and how this value is mapped to I<collectd's>
7007 internal representation. These are followed by one or more B<Instance> blocks
7008 which configure which file to read, in which interval and which metrics to
7013 =item E<lt>B<Metric> I<Name>E<gt>
7015 The B<Metric> block configures a new metric to be extracted from the statistics
7016 file and how it is mapped on I<collectd's> data model. The string I<Name> is
7017 only used inside the B<Instance> blocks to refer to this block, so you can use
7018 one B<Metric> block for multiple CSV files.
7022 =item B<Type> I<Type>
7024 Configures which I<Type> to use when dispatching this metric. Types are defined
7025 in the L<types.db(5)> file, see the appropriate manual page for more
7026 information on specifying types. Only types with a single I<data source> are
7027 supported by the I<tail_csv plugin>. The information whether the value is an
7028 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
7029 I<Type's> definition.
7031 =item B<Instance> I<TypeInstance>
7033 If set, I<TypeInstance> is used to populate the type instance field of the
7034 created value lists. Otherwise, no type instance is used.
7036 =item B<ValueFrom> I<Index>
7038 Configure to read the value from the field with the zero-based index I<Index>.
7039 If the value is parsed as signed integer, unsigned integer or double depends on
7040 the B<Type> setting, see above.
7044 =item E<lt>B<File> I<Path>E<gt>
7046 Each B<File> block represents one CSV file to read. There must be at least one
7047 I<File> block but there can be multiple if you have multiple CSV files.
7051 =item B<Instance> I<PluginInstance>
7053 Sets the I<plugin instance> used when dispatching the values.
7055 =item B<Collect> I<Metric>
7057 Specifies which I<Metric> to collect. This option must be specified at least
7058 once, and you can use this option multiple times to specify more than one
7059 metric to be extracted from this statistic file.
7061 =item B<Interval> I<Seconds>
7063 Configures the interval in which to read values from this instance / file.
7064 Defaults to the plugin's default interval.
7066 =item B<TimeFrom> I<Index>
7068 Rather than using the local time when dispatching a value, read the timestamp
7069 from the field with the zero-based index I<Index>. The value is interpreted as
7070 seconds since epoch. The value is parsed as a double and may be factional.
7076 =head2 Plugin C<teamspeak2>
7078 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
7079 polls interesting global and virtual server data. The plugin can query only one
7080 physical server but unlimited virtual servers. You can use the following
7081 options to configure it:
7085 =item B<Host> I<hostname/ip>
7087 The hostname or ip which identifies the physical server.
7090 =item B<Port> I<port>
7092 The query port of the physical server. This needs to be a string.
7095 =item B<Server> I<port>
7097 This option has to be added once for every virtual server the plugin should
7098 query. If you want to query the virtual server on port 8767 this is what the
7099 option would look like:
7103 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
7104 use quotes around it! If no such statement is given only global information
7109 =head2 Plugin C<ted>
7111 The I<TED> plugin connects to a device of "The Energy Detective", a device to
7112 measure power consumption. These devices are usually connected to a serial
7113 (RS232) or USB port. The plugin opens a configured device and tries to read the
7114 current energy readings. For more information on TED, visit
7115 L<http://www.theenergydetective.com/>.
7117 Available configuration options:
7121 =item B<Device> I<Path>
7123 Path to the device on which TED is connected. collectd will need read and write
7124 permissions on that file.
7126 Default: B</dev/ttyUSB0>
7128 =item B<Retries> I<Num>
7130 Apparently reading from TED is not that reliable. You can therefore configure a
7131 number of retries here. You only configure the I<retries> here, to if you
7132 specify zero, one reading will be performed (but no retries if that fails); if
7133 you specify three, a maximum of four readings are performed. Negative values
7140 =head2 Plugin C<tcpconns>
7142 The C<tcpconns plugin> counts the number of currently established TCP
7143 connections based on the local port and/or the remote port. Since there may be
7144 a lot of connections the default if to count all connections with a local port,
7145 for which a listening socket is opened. You can use the following options to
7146 fine-tune the ports you are interested in:
7150 =item B<ListeningPorts> I<true>|I<false>
7152 If this option is set to I<true>, statistics for all local ports for which a
7153 listening socket exists are collected. The default depends on B<LocalPort> and
7154 B<RemotePort> (see below): If no port at all is specifically selected, the
7155 default is to collect listening ports. If specific ports (no matter if local or
7156 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
7157 the selected ports will be collected unless this option is set to I<true>
7160 =item B<LocalPort> I<Port>
7162 Count the connections to a specific local port. This can be used to see how
7163 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
7164 You have to specify the port in numeric form, so for the mailserver example
7165 you'd need to set B<25>.
7167 =item B<RemotePort> I<Port>
7169 Count the connections to a specific remote port. This is useful to see how
7170 much a remote service is used. This is most useful if you want to know how many
7171 connections a local service has opened to remote services, e.E<nbsp>g. how many
7172 connections a mail server or news server has to other mail or news servers, or
7173 how many connections a web proxy holds to web servers. You have to give the
7174 port in numeric form.
7176 =item B<AllPortsSummary> I<true>|I<false>
7178 If this option is set to I<true> a summary of statistics from all connections
7179 are collected. This option defaults to I<false>.
7183 =head2 Plugin C<thermal>
7187 =item B<ForceUseProcfs> I<true>|I<false>
7189 By default, the I<Thermal plugin> tries to read the statistics from the Linux
7190 C<sysfs> interface. If that is not available, the plugin falls back to the
7191 C<procfs> interface. By setting this option to I<true>, you can force the
7192 plugin to use the latter. This option defaults to I<false>.
7194 =item B<Device> I<Device>
7196 Selects the name of the thermal device that you want to collect or ignore,
7197 depending on the value of the B<IgnoreSelected> option. This option may be
7198 used multiple times to specify a list of devices.
7200 =item B<IgnoreSelected> I<true>|I<false>
7202 Invert the selection: If set to true, all devices B<except> the ones that
7203 match the device names specified by the B<Device> option are collected. By
7204 default only selected devices are collected if a selection is made. If no
7205 selection is configured at all, B<all> devices are selected.
7209 =head2 Plugin C<threshold>
7211 The I<Threshold plugin> checks values collected or received by I<collectd>
7212 against a configurable I<threshold> and issues I<notifications> if values are
7215 Documentation for this plugin is available in the L<collectd-threshold(5)>
7218 =head2 Plugin C<tokyotyrant>
7220 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
7221 couple metrics: number of records, and database size on disk.
7225 =item B<Host> I<Hostname/IP>
7227 The hostname or ip which identifies the server.
7228 Default: B<127.0.0.1>
7230 =item B<Port> I<Service/Port>
7232 The query port of the server. This needs to be a string, even if the port is
7233 given in its numeric form.
7238 =head2 Plugin C<turbostat>
7240 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
7241 Intel processors by using the new Model Specific Registers.
7245 =item B<CoreCstates> I<Bitmask(Integer)>
7247 Bitmask of the list of core C states supported by the processor.
7248 This option should only be used if the automated detection fails.
7249 Default value extracted from the cpu model and family.
7251 Currently supported C-states (by this plugin): 3, 6, 7
7253 Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states
7255 =item B<PackageCstates> I<Bitmask(Integer)>
7257 Bitmask of the list of pacages C states supported by the processor.
7258 This option should only be used if the automated detection fails.
7259 Default value extracted from the cpu model and family.
7261 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
7263 Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7
7265 =item B<SystemManagementInterrupt> I<true>|I<false>
7267 Boolean enabling the collection of the I/O System-Management Interrupt
7268 counter'. This option should only be used if the automated detection
7269 fails or if you want to disable this feature.
7271 =item B<DigitalTemperatureSensor> I<true>|I<false>
7273 Boolean enabling the collection of the temperature of each core.
7274 This option should only be used if the automated detectionfails or
7275 if you want to disable this feature.
7277 =item B<DigitalTemperatureSensor> I<true>|I<false>
7279 Boolean enabling the collection of the temperature of each package.
7280 This option should only be used if the automated detectionfails or
7281 if you want to disable this feature.
7283 =item B<TCCActivationTemp> I<Temperature>
7285 Thermal Control Circuit Activation Temperature of the installed
7286 CPU. This temperature is used when collecting the temperature of
7287 cores or packages. This option should only be used if the automated
7288 detection fails. Default value extracted from B<MSR_IA32_TEMPERATURE_TARGET>
7290 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
7292 Bitmask of the list of elements to be thermally monitored. This option
7293 should only be used if the automated detection fails or if you want to
7294 disable some collections. The different bits of this bitmask accepted
7299 =item 0 ('1'): Package
7303 =item 2 ('4'): Cores
7305 =item 3 ('8'): Embedded graphic device
7311 =head2 Plugin C<unixsock>
7315 =item B<SocketFile> I<Path>
7317 Sets the socket-file which is to be created.
7319 =item B<SocketGroup> I<Group>
7321 If running as root change the group of the UNIX-socket after it has been
7322 created. Defaults to B<collectd>.
7324 =item B<SocketPerms> I<Permissions>
7326 Change the file permissions of the UNIX-socket after it has been created. The
7327 permissions must be given as a numeric, octal value as you would pass to
7328 L<chmod(1)>. Defaults to B<0770>.
7330 =item B<DeleteSocket> B<false>|B<true>
7332 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
7333 with the given name already exists. If I<collectd> crashes a socket file may be
7334 left over, preventing the daemon from opening a new socket when restarted.
7335 Since this is potentially dangerous, this defaults to B<false>.
7339 =head2 Plugin C<uuid>
7341 This plugin, if loaded, causes the Hostname to be taken from the machine's
7342 UUID. The UUID is a universally unique designation for the machine, usually
7343 taken from the machine's BIOS. This is most useful if the machine is running in
7344 a virtual environment such as Xen, in which case the UUID is preserved across
7345 shutdowns and migration.
7347 The following methods are used to find the machine's UUID, in order:
7353 Check I</etc/uuid> (or I<UUIDFile>).
7357 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
7362 Check for UUID from C<dmidecode> / SMBIOS.
7366 Check for UUID from Xen hypervisor.
7370 If no UUID can be found then the hostname is not modified.
7374 =item B<UUIDFile> I<Path>
7376 Take the UUID from the given file (default I</etc/uuid>).
7380 =head2 Plugin C<varnish>
7382 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
7383 It collects a subset of the values displayed by L<varnishstat(1)>, and
7384 organizes them in categories which can be enabled or disabled. Currently only
7385 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
7386 meaning of each metric can be found in L<varnish-counters(7)>.
7391 <Instance "example">
7395 CollectConnections true
7396 CollectDirectorDNS false
7400 CollectObjects false
7402 CollectSession false
7412 CollectWorkers false
7416 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
7417 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
7418 will collectd statistics from the default "varnishd" instance (this should work
7419 fine in most cases).
7421 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
7425 =item B<CollectBackend> B<true>|B<false>
7427 Back-end connection statistics, such as successful, reused,
7428 and closed connections. True by default.
7430 =item B<CollectBan> B<true>|B<false>
7432 Statistics about ban operations, such as number of bans added, retired, and
7433 number of objects tested against ban operations. Only available with Varnish
7434 3.x and above. False by default.
7436 =item B<CollectCache> B<true>|B<false>
7438 Cache hits and misses. True by default.
7440 =item B<CollectConnections> B<true>|B<false>
7442 Number of client connections received, accepted and dropped. True by default.
7444 =item B<CollectDirectorDNS> B<true>|B<false>
7446 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
7449 =item B<CollectESI> B<true>|B<false>
7451 Edge Side Includes (ESI) parse statistics. False by default.
7453 =item B<CollectFetch> B<true>|B<false>
7455 Statistics about fetches (HTTP requests sent to the backend). False by default.
7457 =item B<CollectHCB> B<true>|B<false>
7459 Inserts and look-ups in the crit bit tree based hash. Look-ups are
7460 divided into locked and unlocked look-ups. False by default.
7462 =item B<CollectObjects> B<true>|B<false>
7464 Statistics on cached objects: number of objects expired, nuked (prematurely
7465 expired), saved, moved, etc. False by default.
7467 =item B<CollectPurge> B<true>|B<false>
7469 Statistics about purge operations, such as number of purges added, retired, and
7470 number of objects tested against purge operations. Only available with Varnish
7471 2.x. False by default.
7473 =item B<CollectSession> B<true>|B<false>
7475 Client session statistics. Number of past and current sessions, session herd and
7476 linger counters, etc. False by default. Note that if using Varnish 4.x, some
7477 metrics found in the Connections and Threads sections with previous versions of
7478 Varnish have been moved here.
7480 =item B<CollectSHM> B<true>|B<false>
7482 Statistics about the shared memory log, a memory region to store
7483 log messages which is flushed to disk when full. True by default.
7485 =item B<CollectSMA> B<true>|B<false>
7487 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
7488 component is Solaris specific. Only available with Varnish 2.x. False by
7491 =item B<CollectSMS> B<true>|B<false>
7493 synth (synthetic content) storage statistics. This storage
7494 component is used internally only. False by default.
7496 =item B<CollectSM> B<true>|B<false>
7498 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
7501 =item B<CollectStruct> B<true>|B<false>
7503 Current varnish internal state statistics. Number of current sessions, objects
7504 in cache store, open connections to backends (with Varnish 2.x), etc. False by
7507 =item B<CollectTotals> B<true>|B<false>
7509 Collects overview counters, such as the number of sessions created,
7510 the number of requests and bytes transferred. False by default.
7512 =item B<CollectUptime> B<true>|B<false>
7514 Varnish uptime. Only available with Varnish 3.x and above. False by default.
7516 =item B<CollectVCL> B<true>|B<false>
7518 Number of total (available + discarded) VCL (config files). False by default.
7520 =item B<CollectVSM> B<true>|B<false>
7522 Collect statistics about Varnish's shared memory usage (used by the logging and
7523 statistics subsystems). Only available with Varnish 4.x. False by default.
7525 =item B<CollectWorkers> B<true>|B<false>
7527 Collect statistics about worker threads. False by default.
7531 =head2 Plugin C<virt>
7533 This plugin allows CPU, disk and network load to be collected for virtualized
7534 guests on the machine. This means that these metrics can be collected for guest
7535 systems without installing any software on them - I<collectd> only runs on the
7536 host system. The statistics are collected through libvirt
7537 (L<http://libvirt.org/>).
7539 Only I<Connection> is required.
7543 =item B<Connection> I<uri>
7545 Connect to the hypervisor given by I<uri>. For example if using Xen use:
7547 Connection "xen:///"
7549 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
7551 =item B<RefreshInterval> I<seconds>
7553 Refresh the list of domains and devices every I<seconds>. The default is 60
7554 seconds. Setting this to be the same or smaller than the I<Interval> will cause
7555 the list of domains and devices to be refreshed on every iteration.
7557 Refreshing the devices in particular is quite a costly operation, so if your
7558 virtualization setup is static you might consider increasing this. If this
7559 option is set to 0, refreshing is disabled completely.
7561 =item B<Domain> I<name>
7563 =item B<BlockDevice> I<name:dev>
7565 =item B<InterfaceDevice> I<name:dev>
7567 =item B<IgnoreSelected> B<true>|B<false>
7569 Select which domains and devices are collected.
7571 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
7572 disk/network devices are collected.
7574 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
7575 domains and disk/network devices are ignored, while the rest are collected.
7577 The domain name and device names may use a regular expression, if the name is
7578 surrounded by I</.../> and collectd was compiled with support for regexps.
7580 The default is to collect statistics for all domains and all their devices.
7584 BlockDevice "/:hdb/"
7585 IgnoreSelected "true"
7587 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
7590 =item B<HostnameFormat> B<name|uuid|hostname|...>
7592 When the virt plugin logs data, it sets the hostname of the collected data
7593 according to this setting. The default is to use the guest name as provided by
7594 the hypervisor, which is equal to setting B<name>.
7596 B<uuid> means use the guest's UUID. This is useful if you want to track the
7597 same guest across migrations.
7599 B<hostname> means to use the global B<Hostname> setting, which is probably not
7600 useful on its own because all guests will appear to have the same name.
7602 You can also specify combinations of these fields. For example B<name uuid>
7603 means to concatenate the guest name and UUID (with a literal colon character
7604 between, thus I<"foo:1234-1234-1234-1234">).
7606 At the moment of writing (collectd-5.5), hostname string is limited to 62
7607 characters. In case when combination of fields exceeds 62 characters,
7608 hostname will be truncated without a warning.
7610 =item B<InterfaceFormat> B<name>|B<address>
7612 When the virt plugin logs interface data, it sets the name of the collected
7613 data according to this setting. The default is to use the path as provided by
7614 the hypervisor (the "dev" property of the target node), which is equal to
7617 B<address> means use the interface's mac address. This is useful since the
7618 interface path might change between reboots of a guest or across migrations.
7620 =item B<PluginInstanceFormat> B<name|uuid|none>
7622 When the virt plugin logs data, it sets the plugin_instance of the collected
7623 data according to this setting. The default is to not set the plugin_instance.
7625 B<name> means use the guest's name as provided by the hypervisor.
7626 B<uuid> means use the guest's UUID.
7628 You can also specify combinations of the B<name> and B<uuid> fields.
7629 For example B<name uuid> means to concatenate the guest name and UUID
7630 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
7634 =head2 Plugin C<vmem>
7636 The C<vmem> plugin collects information about the usage of virtual memory.
7637 Since the statistics provided by the Linux kernel are very detailed, they are
7638 collected very detailed. However, to get all the details, you have to switch
7639 them on manually. Most people just want an overview over, such as the number of
7640 pages read from swap space.
7644 =item B<Verbose> B<true>|B<false>
7646 Enables verbose collection of information. This will start collecting page
7647 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
7648 Part of these statistics are collected on a "per zone" basis.
7652 =head2 Plugin C<vserver>
7654 This plugin doesn't have any options. B<VServer> support is only available for
7655 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
7656 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
7657 need to apply the patches and compile your own kernel, which will then provide
7658 the F</proc/virtual> filesystem that is required by this plugin.
7660 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
7662 B<Note>: The traffic collected by this plugin accounts for the amount of
7663 traffic passing a socket which might be a lot less than the actual on-wire
7664 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
7665 collect on-wire traffic you could, for example, use the logging facilities of
7666 iptables to feed data for the guest IPs into the iptables plugin.
7668 =head2 Plugin C<write_graphite>
7670 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
7671 storage and graphing project. The plugin connects to I<Carbon>, the data layer
7672 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
7673 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
7674 of at most 1428 bytes to minimize the number of network packets.
7678 <Plugin write_graphite>
7688 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7689 blocks. Inside the B<Node> blocks, the following options are recognized:
7693 =item B<Host> I<Address>
7695 Hostname or address to connect to. Defaults to C<localhost>.
7697 =item B<Port> I<Service>
7699 Service name or port number to connect to. Defaults to C<2003>.
7701 =item B<Protocol> I<String>
7703 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
7705 =item B<ReconnectInterval> I<Seconds>
7707 When set to non-zero, forces the connection to the Graphite backend to be
7708 closed and re-opend periodically. This behavior is desirable in environments
7709 where the connection to the Graphite backend is done through load balancers,
7710 for example. When set to zero, the default, the connetion is kept open for as
7713 =item B<LogSendErrors> B<false>|B<true>
7715 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
7716 If set to B<false>, it will not log the errors. This is especially useful when
7717 using Protocol UDP since many times we want to use the "fire-and-forget"
7718 approach and logging errors fills syslog with unneeded messages.
7720 =item B<Prefix> I<String>
7722 When set, I<String> is added in front of the host name. Dots and whitespace are
7723 I<not> escaped in this string (see B<EscapeCharacter> below).
7725 =item B<Postfix> I<String>
7727 When set, I<String> is appended to the host name. Dots and whitespace are
7728 I<not> escaped in this string (see B<EscapeCharacter> below).
7730 =item B<EscapeCharacter> I<Char>
7732 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
7733 in the identifier. The B<EscapeCharacter> option determines which character
7734 dots, whitespace and control characters are replaced with. Defaults to
7737 =item B<StoreRates> B<false>|B<true>
7739 If set to B<true> (the default), convert counter values to rates. If set to
7740 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7743 =item B<SeparateInstances> B<false>|B<true>
7745 If set to B<true>, the plugin instance and type instance will be in their own
7746 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7747 default), the plugin and plugin instance (and likewise the type and type
7748 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7750 =item B<AlwaysAppendDS> B<false>|B<true>
7752 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7753 identifier. If set to B<false> (the default), this is only done when there is
7758 =head2 Plugin C<write_tsdb>
7760 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7761 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7762 state daemon that ingests metrics and stores them in HBase. The plugin uses
7763 I<TCP> over the "line based" protocol with a default port 4242. The data will
7764 be sent in blocks of at most 1428 bytes to minimize the number of network
7771 Host "tsd-1.my.domain"
7773 HostTags "status=production"
7777 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7778 blocks. Inside the B<Node> blocks, the following options are recognized:
7782 =item B<Host> I<Address>
7784 Hostname or address to connect to. Defaults to C<localhost>.
7786 =item B<Port> I<Service>
7788 Service name or port number to connect to. Defaults to C<4242>.
7791 =item B<HostTags> I<String>
7793 When set, I<HostTags> is added to the end of the metric. It is intended to be
7794 used for name=value pairs that the TSD will tag the metric with. Dots and
7795 whitespace are I<not> escaped in this string.
7797 =item B<StoreRates> B<false>|B<true>
7799 If set to B<true>, convert counter values to rates. If set to B<false>
7800 (the default) counter values are stored as is, as an increasing
7803 =item B<AlwaysAppendDS> B<false>|B<true>
7805 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7806 identifier. If set to B<false> (the default), this is only done when there is
7811 =head2 Plugin C<write_mongodb>
7813 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7818 <Plugin "write_mongodb">
7827 The plugin can send values to multiple instances of I<MongoDB> by specifying
7828 one B<Node> block for each instance. Within the B<Node> blocks, the following
7829 options are available:
7833 =item B<Host> I<Address>
7835 Hostname or address to connect to. Defaults to C<localhost>.
7837 =item B<Port> I<Service>
7839 Service name or port number to connect to. Defaults to C<27017>.
7841 =item B<Timeout> I<Milliseconds>
7843 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7844 Setting this option to zero means no timeout, which is the default.
7846 =item B<StoreRates> B<false>|B<true>
7848 If set to B<true> (the default), convert counter values to rates. If set to
7849 B<false> counter values are stored as is, i.e. as an increasing integer
7852 =item B<Database> I<Database>
7854 =item B<User> I<User>
7856 =item B<Password> I<Password>
7858 Sets the information used when authenticating to a I<MongoDB> database. The
7859 fields are optional (in which case no authentication is attempted), but if you
7860 want to use authentication all three fields must be set.
7864 =head2 Plugin C<write_http>
7866 This output plugin submits values to an HTTP server using POST requests and
7867 encoding metrics with JSON or using the C<PUTVAL> command described in
7868 L<collectd-unixsock(5)>.
7872 <Plugin "write_http">
7874 URL "http://example.com/post-collectd"
7881 The plugin can send values to multiple HTTP servers by specifying one
7882 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7883 block, the following options are available:
7889 URL to which the values are submitted to. Mandatory.
7891 =item B<User> I<Username>
7893 Optional user name needed for authentication.
7895 =item B<Password> I<Password>
7897 Optional password needed for authentication.
7899 =item B<VerifyPeer> B<true>|B<false>
7901 Enable or disable peer SSL certificate verification. See
7902 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7904 =item B<VerifyHost> B<true|false>
7906 Enable or disable peer host name verification. If enabled, the plugin checks if
7907 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7908 matches the host name provided by the B<URL> option. If this identity check
7909 fails, the connection is aborted. Obviously, only works when connecting to a
7910 SSL enabled server. Enabled by default.
7912 =item B<CACert> I<File>
7914 File that holds one or more SSL certificates. If you want to use HTTPS you will
7915 possibly need this option. What CA certificates come bundled with C<libcurl>
7916 and are checked by default depends on the distribution you use.
7918 =item B<CAPath> I<Directory>
7920 Directory holding one or more CA certificate files. You can use this if for
7921 some reason all the needed CA certificates aren't in the same file and can't be
7922 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7925 =item B<ClientKey> I<File>
7927 File that holds the private key in PEM format to be used for certificate-based
7930 =item B<ClientCert> I<File>
7932 File that holds the SSL certificate to be used for certificate-based
7935 =item B<ClientKeyPass> I<Password>
7937 Password required to load the private key in B<ClientKey>.
7939 =item B<Header> I<Header>
7941 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
7943 Header "X-Custom-Header: custom_value"
7945 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7947 Define which SSL protocol version must be used. By default C<libcurl> will
7948 attempt to figure out the remote SSL protocol version. See
7949 L<curl_easy_setopt(3)> for more details.
7951 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
7953 Format of the output to generate. If set to B<Command>, will create output that
7954 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7955 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
7956 , will create output in the KairosDB format.
7958 Defaults to B<Command>.
7960 =item B<Metrics> B<true>|B<false>
7962 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
7964 =item B<Notifications> B<false>|B<true>
7966 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
7968 =item B<StoreRates> B<true|false>
7970 If set to B<true>, convert counter values to rates. If set to B<false> (the
7971 default) counter values are stored as is, i.e. as an increasing integer number.
7973 =item B<BufferSize> I<Bytes>
7975 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7976 requests will be generated, but more metrics will be batched / metrics are
7977 cached for longer before being sent, introducing additional delay until they
7978 are available on the server side. I<Bytes> must be at least 1024 and cannot
7979 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7980 Defaults to C<4096>.
7982 =item B<LowSpeedLimit> I<Bytes per Second>
7984 Sets the minimal transfer rate in I<Bytes per Second> below which the
7985 connection with the HTTP server will be considered too slow and aborted. All
7986 the data submitted over this connection will probably be lost. Defaults to 0,
7987 which means no minimum transfer rate is enforced.
7989 =item B<Timeout> I<Timeout>
7991 Sets the maximum time in milliseconds given for HTTP POST operations to
7992 complete. When this limit is reached, the POST operation will be aborted, and
7993 all the data in the current send buffer will probably be lost. Defaults to 0,
7994 which means the connection never times out.
7996 =item B<LogHttpError> B<false>|B<true>
7998 Enables printing of HTTP error code to log. Turned off by default.
8000 The C<write_http> plugin regularly submits the collected values to the HTTP
8001 server. How frequently this happens depends on how much data you are collecting
8002 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
8003 slightly below this interval, which you can estimate by monitoring the network
8004 traffic between collectd and the HTTP server.
8008 =head2 Plugin C<write_kafka>
8010 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
8014 <Plugin "write_kafka">
8015 Property "metadata.broker.list" "broker1:9092,broker2:9092"
8021 The following options are understood by the I<write_kafka plugin>:
8025 =item E<lt>B<Topic> I<Name>E<gt>
8027 The plugin's configuration consists of one or more B<Topic> blocks. Each block
8028 is given a unique I<Name> and specifies one kafka producer.
8029 Inside the B<Topic> block, the following per-topic options are
8034 =item B<Property> I<String> I<String>
8036 Configure the named property for the current topic. Properties are
8037 forwarded to the kafka producer library B<librdkafka>.
8039 =item B<Key> I<String>
8041 Use the specified string as a partioning key for the topic. Kafka breaks
8042 topic into partitions and guarantees that for a given topology, the same
8043 consumer will be used for a specific key. The special (case insensitive)
8044 string B<Random> can be used to specify that an arbitrary partition should
8047 =item B<Format> B<Command>|B<JSON>|B<Graphite>
8049 Selects the format in which messages are sent to the broker. If set to
8050 B<Command> (the default), values are sent as C<PUTVAL> commands which are
8051 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
8053 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
8054 an easy and straight forward exchange format.
8056 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
8057 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
8059 =item B<StoreRates> B<true>|B<false>
8061 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
8062 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
8063 default), no conversion is performed. Otherwise the conversion is performed
8064 using the internal value cache.
8066 Please note that currently this option is only used if the B<Format> option has
8067 been set to B<JSON>.
8069 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
8071 A prefix can be added in the metric name when outputting in the I<Graphite>
8072 format. It's added before the I<Host> name.
8074 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>>
8076 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
8078 A postfix can be added in the metric name when outputting in the I<Graphite>
8079 format. It's added after the I<Host> name.
8081 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>>
8083 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
8085 Specify a character to replace dots (.) in the host part of the metric name.
8086 In I<Graphite> metric name, dots are used as separators between different
8087 metric parts (host, plugin, type).
8088 Default is C<_> (I<Underscore>).
8090 =item B<GraphiteSeparateInstances> B<false>|B<true>
8092 If set to B<true>, the plugin instance and type instance will be in their own
8093 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8094 default), the plugin and plugin instance (and likewise the type and type
8095 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8097 =item B<StoreRates> B<true>|B<false>
8099 If set to B<true> (the default), convert counter values to rates. If set to
8100 B<false> counter values are stored as is, i.e. as an increasing integer number.
8102 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
8103 converted values will have "rate" appended to the data source type, e.g.
8104 C<ds_type:derive:rate>.
8108 =item B<Property> I<String> I<String>
8110 Configure the kafka producer through properties, you almost always will
8111 want to set B<metadata.broker.list> to your Kafka broker list.
8115 =head2 Plugin C<write_redis>
8117 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
8121 <Plugin "write_redis">
8133 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
8134 the timestamp as the score. Retrieving a date range can then be done using the
8135 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
8136 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
8137 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
8138 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
8139 with the B<Database> parameter (default is C<0>). See
8140 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
8143 The information shown in the synopsis above is the I<default configuration>
8144 which is used by the plugin if no configuration is present.
8146 The plugin can send values to multiple instances of I<Redis> by specifying
8147 one B<Node> block for each instance. Within the B<Node> blocks, the following
8148 options are available:
8152 =item B<Node> I<Nodename>
8154 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
8155 instance running on a specified host and port. The node name is a
8156 canonical identifier which is used as I<plugin instance>. It is limited to
8157 51E<nbsp>characters in length.
8159 =item B<Host> I<Hostname>
8161 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
8164 =item B<Port> I<Port>
8166 The B<Port> option is the TCP port on which the Redis instance accepts
8167 connections. Either a service name of a port number may be given. Please note
8168 that numerical port numbers must be given as a string, too.
8170 =item B<Timeout> I<Milliseconds>
8172 The B<Timeout> option sets the socket connection timeout, in milliseconds.
8174 =item B<Prefix> I<Prefix>
8176 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
8177 containing all metrics. Defaults to C<collectd/>, so metrics will have names
8178 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
8179 is recommended but not required to include a trailing slash in I<Prefix>.
8181 =item B<Database> I<Index>
8183 This index selects the redis database to use for writing operations. Defaults
8186 =item B<MaxSetSize> I<Items>
8188 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
8189 hold. Negative values for I<Items> sets no limit, which is the default behavior.
8191 =item B<StoreRates> B<true>|B<false>
8193 If set to B<true> (the default), convert counter values to rates. If set to
8194 B<false> counter values are stored as is, i.e. as an increasing integer number.
8198 =head2 Plugin C<write_riemann>
8200 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
8201 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
8202 I<Riemann> using UDP packets.
8206 <Plugin "write_riemann">
8212 AlwaysAppendDS false
8216 Attribute "foo" "bar"
8219 The following options are understood by the I<write_riemann plugin>:
8223 =item E<lt>B<Node> I<Name>E<gt>
8225 The plugin's configuration consists of one or more B<Node> blocks. Each block
8226 is given a unique I<Name> and specifies one connection to an instance of
8227 I<Riemann>. Indise the B<Node> block, the following per-connection options are
8232 =item B<Host> I<Address>
8234 Hostname or address to connect to. Defaults to C<localhost>.
8236 =item B<Port> I<Service>
8238 Service name or port number to connect to. Defaults to C<5555>.
8240 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
8242 Specify the protocol to use when communicating with I<Riemann>. Defaults to
8245 =item B<TLSCertFile> I<Path>
8247 When using the B<TLS> protocol, path to a PEM certificate to present
8250 =item B<TLSCAFile> I<Path>
8252 When using the B<TLS> protocol, path to a PEM CA certificate to
8253 use to validate the remote hosts's identity.
8255 =item B<TLSKeyFile> I<Path>
8257 When using the B<TLS> protocol, path to a PEM private key associated
8258 with the certificate defined by B<TLSCertFile>.
8260 =item B<Batch> B<true>|B<false>
8262 If set to B<true> and B<Protocol> is set to B<TCP>,
8263 events will be batched in memory and flushed at
8264 regular intervals or when B<BatchMaxSize> is exceeded.
8266 Notifications are not batched and sent as soon as possible.
8268 When enabled, it can occur that events get processed by the Riemann server
8269 close to or after their expiration time. Tune the B<TTLFactor> and
8270 B<BatchMaxSize> settings according to the amount of values collected, if this
8275 =item B<BatchMaxSize> I<size>
8277 Maximum payload size for a riemann packet. Defaults to 8192
8279 =item B<BatchFlushTimeout> I<seconds>
8281 Maximum amount of seconds to wait in between to batch flushes.
8282 No timeout by default.
8284 =item B<StoreRates> B<true>|B<false>
8286 If set to B<true> (the default), convert counter values to rates. If set to
8287 B<false> counter values are stored as is, i.e. as an increasing integer number.
8289 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
8290 converted values will have "rate" appended to the data source type, e.g.
8291 C<ds_type:derive:rate>.
8293 =item B<AlwaysAppendDS> B<false>|B<true>
8295 If set to B<true>, append the name of the I<Data Source> (DS) to the
8296 "service", i.e. the field that, together with the "host" field, uniquely
8297 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
8298 only done when there is more than one DS.
8300 =item B<TTLFactor> I<Factor>
8302 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
8303 event is considered active. I<collectd> populates this field based on the
8304 metrics interval setting. This setting controls the factor with which the
8305 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
8306 know exactly what you're doing, you should only increase this setting from its
8309 =item B<Notifications> B<false>|B<true>
8311 If set to B<true>, create riemann events for notifications. This is B<true>
8312 by default. When processing thresholds from write_riemann, it might prove
8313 useful to avoid getting notification events.
8315 =item B<CheckThresholds> B<false>|B<true>
8317 If set to B<true>, attach state to events based on thresholds defined
8318 in the B<Threshold> plugin. Defaults to B<false>.
8320 =item B<EventServicePrefix> I<String>
8322 Add the given string as a prefix to the event service name.
8323 If B<EventServicePrefix> not set or set to an empty string (""),
8324 no prefix will be used.
8328 =item B<Tag> I<String>
8330 Add the given string as an additional tag to the metric being sent to
8333 =item B<Attribute> I<String> I<String>
8335 Consider the two given strings to be the key and value of an additional
8336 attribute for each metric being sent out to I<Riemann>.
8340 =head2 Plugin C<write_sensu>
8342 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
8343 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
8344 a local I<Sensu> client using a TCP socket.
8346 At the moment, the I<write_sensu plugin> does not send over a collectd_host
8347 parameter so it is not possible to use one collectd instance as a gateway for
8348 others. Each collectd host must pair with one I<Sensu> client.
8352 <Plugin "write_sensu">
8357 AlwaysAppendDS false
8358 MetricHandler "influx"
8359 MetricHandler "default"
8360 NotificationHandler "flapjack"
8361 NotificationHandler "howling_monkey"
8365 Attribute "foo" "bar"
8368 The following options are understood by the I<write_sensu plugin>:
8372 =item E<lt>B<Node> I<Name>E<gt>
8374 The plugin's configuration consists of one or more B<Node> blocks. Each block
8375 is given a unique I<Name> and specifies one connection to an instance of
8376 I<Sensu>. Inside the B<Node> block, the following per-connection options are
8381 =item B<Host> I<Address>
8383 Hostname or address to connect to. Defaults to C<localhost>.
8385 =item B<Port> I<Service>
8387 Service name or port number to connect to. Defaults to C<3030>.
8389 =item B<StoreRates> B<true>|B<false>
8391 If set to B<true> (the default), convert counter values to rates. If set to
8392 B<false> counter values are stored as is, i.e. as an increasing integer number.
8394 This will be reflected in the C<collectd_data_source_type> tag: If
8395 B<StoreRates> is enabled, converted values will have "rate" appended to the
8396 data source type, e.g. C<collectd_data_source_type:derive:rate>.
8398 =item B<AlwaysAppendDS> B<false>|B<true>
8400 If set the B<true>, append the name of the I<Data Source> (DS) to the
8401 "service", i.e. the field that, together with the "host" field, uniquely
8402 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
8403 only done when there is more than one DS.
8405 =item B<Notifications> B<false>|B<true>
8407 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
8408 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
8410 =item B<Metrics> B<false>|B<true>
8412 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
8413 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
8416 =item B<Separator> I<String>
8418 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
8420 =item B<MetricHandler> I<String>
8422 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
8423 several of them, one per line. Defaults to no handler.
8425 =item B<NotificationHandler> I<String>
8427 Add a handler that will be set when notifications are sent to I<Sensu>. You can
8428 add several of them, one per line. Defaults to no handler.
8430 =item B<EventServicePrefix> I<String>
8432 Add the given string as a prefix to the event service name.
8433 If B<EventServicePrefix> not set or set to an empty string (""),
8434 no prefix will be used.
8438 =item B<Tag> I<String>
8440 Add the given string as an additional tag to the metric being sent to
8443 =item B<Attribute> I<String> I<String>
8445 Consider the two given strings to be the key and value of an additional
8446 attribute for each metric being sent out to I<Sensu>.
8450 =head2 Plugin C<xencpu>
8452 This plugin collects metrics of hardware CPU load for machine running Xen
8453 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
8454 Result is reported using the C<percent> type, for each CPU (core).
8456 This plugin doesn't have any options (yet).
8458 =head2 Plugin C<zookeeper>
8460 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
8461 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
8466 <Plugin "zookeeper">
8473 =item B<Host> I<Address>
8475 Hostname or address to connect to. Defaults to C<localhost>.
8477 =item B<Port> I<Service>
8479 Service name or port number to connect to. Defaults to C<2181>.
8483 =head1 THRESHOLD CONFIGURATION
8485 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
8486 we mean that the values are not only stored or sent somewhere, but that they
8487 are judged and, if a problem is recognized, acted upon. The only action
8488 collectd takes itself is to generate and dispatch a "notification". Plugins can
8489 register to receive notifications and perform appropriate further actions.
8491 Since systems and what you expect them to do differ a lot, you can configure
8492 B<thresholds> for your values freely. This gives you a lot of flexibility but
8493 also a lot of responsibility.
8495 Every time a value is out of range a notification is dispatched. This means
8496 that the idle percentage of your CPU needs to be less then the configured
8497 threshold only once for a notification to be generated. There's no such thing
8498 as a moving average or similar - at least not now.
8500 Also, all values that match a threshold are considered to be relevant or
8501 "interesting". As a consequence collectd will issue a notification if they are
8502 not received for B<Timeout> iterations. The B<Timeout> configuration option is
8503 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
8504 "2" (the default) and some hosts sends it's CPU statistics to the server every
8505 60 seconds, a notification will be dispatched after about 120 seconds. It may
8506 take a little longer because the timeout is checked only once each B<Interval>
8509 When a value comes within range again or is received after it was missing, an
8510 "OKAY-notification" is dispatched.
8512 Here is a configuration example to get you started. Read below for more
8525 <Plugin "interface">
8542 WarningMin 100000000
8548 There are basically two types of configuration statements: The C<Host>,
8549 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
8550 configured. The C<Plugin> and C<Type> blocks may be specified further using the
8551 C<Instance> option. You can combine the block by nesting the blocks, though
8552 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
8553 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
8554 C<Type> may not contain other blocks. If multiple blocks apply to the same
8555 value the most specific block is used.
8557 The other statements specify the threshold to configure. They B<must> be
8558 included in a C<Type> block. Currently the following statements are recognized:
8562 =item B<FailureMax> I<Value>
8564 =item B<WarningMax> I<Value>
8566 Sets the upper bound of acceptable values. If unset defaults to positive
8567 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
8568 will be created. If the value is greater than B<WarningMax> but less than (or
8569 equal to) B<FailureMax> a B<WARNING> notification will be created.
8571 =item B<FailureMin> I<Value>
8573 =item B<WarningMin> I<Value>
8575 Sets the lower bound of acceptable values. If unset defaults to negative
8576 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
8577 be created. If the value is less than B<WarningMin> but greater than (or equal
8578 to) B<FailureMin> a B<WARNING> notification will be created.
8580 =item B<DataSource> I<DSName>
8582 Some data sets have more than one "data source". Interesting examples are the
8583 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
8584 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
8585 system load data set, C<load>, even has three data sources: C<shortterm>,
8586 C<midterm>, and C<longterm>.
8588 Normally, all data sources are checked against a configured threshold. If this
8589 is undesirable, or if you want to specify different limits for each data
8590 source, you can use the B<DataSource> option to have a threshold apply only to
8593 =item B<Invert> B<true>|B<false>
8595 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
8596 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
8597 B<WarningMax>) are not okay. Defaults to B<false>.
8599 =item B<Persist> B<true>|B<false>
8601 Sets how often notifications are generated. If set to B<true> one notification
8602 will be generated for each value that is out of the acceptable range. If set to
8603 B<false> (the default) then a notification is only generated if a value is out
8604 of range but the previous value was okay.
8606 This applies to missing values, too: If set to B<true> a notification about a
8607 missing value is generated once every B<Interval> seconds. If set to B<false>
8608 only one such notification is generated until the value appears again.
8610 =item B<Percentage> B<true>|B<false>
8612 If set to B<true>, the minimum and maximum values given are interpreted as
8613 percentage value, relative to the other data sources. This is helpful for
8614 example for the "df" type, where you may want to issue a warning when less than
8615 5E<nbsp>% of the total space is available. Defaults to B<false>.
8617 =item B<Hits> I<Number>
8619 Delay creating the notification until the threshold has been passed I<Number>
8620 times. When a notification has been generated, or when a subsequent value is
8621 inside the threshold, the counter is reset. If, for example, a value is
8622 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
8623 will be dispatched at most once every 30E<nbsp>seconds.
8625 This is useful when short bursts are not a problem. If, for example, 100% CPU
8626 usage for up to a minute is normal (and data is collected every
8627 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
8629 =item B<Hysteresis> I<Number>
8631 When set to non-zero, a hysteresis value is applied when checking minimum and
8632 maximum bounds. This is useful for values that increase slowly and fluctuate a
8633 bit while doing so. When these values come close to the threshold, they may
8634 "flap", i.e. switch between failure / warning case and okay case repeatedly.
8636 If, for example, the threshold is configures as
8641 then a I<Warning> notification is created when the value exceeds I<101> and the
8642 corresponding I<Okay> notification is only created once the value falls below
8643 I<99>, thus avoiding the "flapping".
8647 =head1 FILTER CONFIGURATION
8649 Starting with collectd 4.6 there is a powerful filtering infrastructure
8650 implemented in the daemon. The concept has mostly been copied from
8651 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
8652 terminology, so that users that are familiar with iptables feel right at home.
8656 The following are the terms used in the remainder of the filter configuration
8657 documentation. For an ASCII-art schema of the mechanism, see
8658 L<"General structure"> below.
8664 A I<match> is a criteria to select specific values. Examples are, of course, the
8665 name of the value or it's current value.
8667 Matches are implemented in plugins which you have to load prior to using the
8668 match. The name of such plugins starts with the "match_" prefix.
8672 A I<target> is some action that is to be performed with data. Such actions
8673 could, for example, be to change part of the value's identifier or to ignore
8674 the value completely.
8676 Some of these targets are built into the daemon, see L<"Built-in targets">
8677 below. Other targets are implemented in plugins which you have to load prior to
8678 using the target. The name of such plugins starts with the "target_" prefix.
8682 The combination of any number of matches and at least one target is called a
8683 I<rule>. The target actions will be performed for all values for which B<all>
8684 matches apply. If the rule does not have any matches associated with it, the
8685 target action will be performed for all values.
8689 A I<chain> is a list of rules and possibly default targets. The rules are tried
8690 in order and if one matches, the associated target will be called. If a value
8691 is handled by a rule, it depends on the target whether or not any subsequent
8692 rules are considered or if traversal of the chain is aborted, see
8693 L<"Flow control"> below. After all rules have been checked, the default targets
8698 =head2 General structure
8700 The following shows the resulting structure:
8707 +---------+ +---------+ +---------+ +---------+
8708 ! Rule !->! Match !->! Match !->! Target !
8709 +---------+ +---------+ +---------+ +---------+
8712 +---------+ +---------+ +---------+
8713 ! Rule !->! Target !->! Target !
8714 +---------+ +---------+ +---------+
8721 +---------+ +---------+ +---------+
8722 ! Rule !->! Match !->! Target !
8723 +---------+ +---------+ +---------+
8733 There are four ways to control which way a value takes through the filter
8740 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
8741 process the value with another chain. When the called chain finishes, usually
8742 the next target or rule after the jump is executed.
8746 The stop condition, signaled for example by the built-in target B<stop>, causes
8747 all processing of the value to be stopped immediately.
8751 Causes processing in the current chain to be aborted, but processing of the
8752 value generally will continue. This means that if the chain was called via
8753 B<Jump>, the next target or rule after the jump will be executed. If the chain
8754 was not called by another chain, control will be returned to the daemon and it
8755 may pass the value to another chain.
8759 Most targets will signal the B<continue> condition, meaning that processing
8760 should continue normally. There is no special built-in target for this
8767 The configuration reflects this structure directly:
8769 PostCacheChain "PostCache"
8771 <Rule "ignore_mysql_show">
8774 Type "^mysql_command$"
8775 TypeInstance "^show_"
8785 The above configuration example will ignore all values where the plugin field
8786 is "mysql", the type is "mysql_command" and the type instance begins with
8787 "show_". All other values will be sent to the C<rrdtool> write plugin via the
8788 default target of the chain. Since this chain is run after the value has been
8789 added to the cache, the MySQL C<show_*> command statistics will be available
8790 via the C<unixsock> plugin.
8792 =head2 List of configuration options
8796 =item B<PreCacheChain> I<ChainName>
8798 =item B<PostCacheChain> I<ChainName>
8800 Configure the name of the "pre-cache chain" and the "post-cache chain". The
8801 argument is the name of a I<chain> that should be executed before and/or after
8802 the values have been added to the cache.
8804 To understand the implications, it's important you know what is going on inside
8805 I<collectd>. The following diagram shows how values are passed from the
8806 read-plugins to the write-plugins:
8812 + - - - - V - - - - +
8813 : +---------------+ :
8816 : +-------+-------+ :
8819 : +-------+-------+ : +---------------+
8820 : ! Cache !--->! Value Cache !
8821 : ! insert ! : +---+---+-------+
8822 : +-------+-------+ : ! !
8823 : ! ,------------' !
8825 : +-------+---+---+ : +-------+-------+
8826 : ! Post-Cache +--->! Write-Plugins !
8827 : ! Chain ! : +---------------+
8828 : +---------------+ :
8831 + - - - - - - - - - +
8833 After the values are passed from the "read" plugins to the dispatch functions,
8834 the pre-cache chain is run first. The values are added to the internal cache
8835 afterwards. The post-cache chain is run after the values have been added to the
8836 cache. So why is it such a huge deal if chains are run before or after the
8837 values have been added to this cache?
8839 Targets that change the identifier of a value list should be executed before
8840 the values are added to the cache, so that the name in the cache matches the
8841 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
8842 this cache to receive a list of all available values. If you change the
8843 identifier after the value list has been added to the cache, this may easily
8844 lead to confusion, but it's not forbidden of course.
8846 The cache is also used to convert counter values to rates. These rates are, for
8847 example, used by the C<value> match (see below). If you use the rate stored in
8848 the cache B<before> the new value is added, you will use the old, B<previous>
8849 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
8850 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
8853 Last but not last, the B<stop> target makes a difference: If the pre-cache
8854 chain returns the stop condition, the value will not be added to the cache and
8855 the post-cache chain will not be run.
8857 =item B<Chain> I<Name>
8859 Adds a new chain with a certain name. This name can be used to refer to a
8860 specific chain, for example to jump to it.
8862 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
8864 =item B<Rule> [I<Name>]
8866 Adds a new rule to the current chain. The name of the rule is optional and
8867 currently has no meaning for the daemon.
8869 Within the B<Rule> block, there may be any number of B<Match> blocks and there
8870 must be at least one B<Target> block.
8872 =item B<Match> I<Name>
8874 Adds a match to a B<Rule> block. The name specifies what kind of match should
8875 be performed. Available matches depend on the plugins that have been loaded.
8877 The arguments inside the B<Match> block are passed to the plugin implementing
8878 the match, so which arguments are valid here depends on the plugin being used.
8879 If you do not need any to pass any arguments to a match, you can use the
8884 Which is equivalent to:
8889 =item B<Target> I<Name>
8891 Add a target to a rule or a default target to a chain. The name specifies what
8892 kind of target is to be added. Which targets are available depends on the
8893 plugins being loaded.
8895 The arguments inside the B<Target> block are passed to the plugin implementing
8896 the target, so which arguments are valid here depends on the plugin being used.
8897 If you do not need any to pass any arguments to a target, you can use the
8902 This is the same as writing:
8909 =head2 Built-in targets
8911 The following targets are built into the core daemon and therefore need no
8912 plugins to be loaded:
8918 Signals the "return" condition, see the L<"Flow control"> section above. This
8919 causes the current chain to stop processing the value and returns control to
8920 the calling chain. The calling chain will continue processing targets and rules
8921 just after the B<jump> target (see below). This is very similar to the
8922 B<RETURN> target of iptables, see L<iptables(8)>.
8924 This target does not have any options.
8932 Signals the "stop" condition, see the L<"Flow control"> section above. This
8933 causes processing of the value to be aborted immediately. This is similar to
8934 the B<DROP> target of iptables, see L<iptables(8)>.
8936 This target does not have any options.
8944 Sends the value to "write" plugins.
8950 =item B<Plugin> I<Name>
8952 Name of the write plugin to which the data should be sent. This option may be
8953 given multiple times to send the data to more than one write plugin. If the
8954 plugin supports multiple instances, the plugin's instance(s) must also be
8959 If no plugin is explicitly specified, the values will be sent to all available
8962 Single-instance plugin example:
8968 Multi-instance plugin example:
8970 <Plugin "write_graphite">
8980 Plugin "write_graphite/foo"
8985 Starts processing the rules of another chain, see L<"Flow control"> above. If
8986 the end of that chain is reached, or a stop condition is encountered,
8987 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
8988 next target or the next rule. This is similar to the B<-j> command line option
8989 of iptables, see L<iptables(8)>.
8995 =item B<Chain> I<Name>
8997 Jumps to the chain I<Name>. This argument is required and may appear only once.
9009 =head2 Available matches
9015 Matches a value using regular expressions.
9021 =item B<Host> I<Regex>
9023 =item B<Plugin> I<Regex>
9025 =item B<PluginInstance> I<Regex>
9027 =item B<Type> I<Regex>
9029 =item B<TypeInstance> I<Regex>
9031 Match values where the given regular expressions match the various fields of
9032 the identifier of a value. If multiple regular expressions are given, B<all>
9033 regexen must match for a value to match.
9035 =item B<Invert> B<false>|B<true>
9037 When set to B<true>, the result of the match is inverted, i.e. all value lists
9038 where all regular expressions apply are not matched, all other value lists are
9039 matched. Defaults to B<false>.
9046 Host "customer[0-9]+"
9052 Matches values that have a time which differs from the time on the server.
9054 This match is mainly intended for servers that receive values over the
9055 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
9056 is very sensitive to the timestamp used when updating the RRD files. In
9057 particular, the time must be ever increasing. If a misbehaving client sends one
9058 packet with a timestamp far in the future, all further packets with a correct
9059 time will be ignored because of that one packet. What's worse, such corrupted
9060 RRD files are hard to fix.
9062 This match lets one match all values B<outside> a specified time range
9063 (relative to the server's time), so you can use the B<stop> target (see below)
9064 to ignore the value, for example.
9070 =item B<Future> I<Seconds>
9072 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
9073 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
9076 =item B<Past> I<Seconds>
9078 Matches all values that are I<behind> of the server's time by I<Seconds> or
9079 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
9091 This example matches all values that are five minutes or more ahead of the
9092 server or one hour (or more) lagging behind.
9096 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
9097 values. If a data-set consists of more than one data-source, all data-sources
9098 must match the specified ranges for a positive match.
9104 =item B<Min> I<Value>
9106 Sets the smallest value which still results in a match. If unset, behaves like
9109 =item B<Max> I<Value>
9111 Sets the largest value which still results in a match. If unset, behaves like
9114 =item B<Invert> B<true>|B<false>
9116 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
9117 no-match is returned and vice versa. Please note that the B<Invert> setting
9118 only effects how B<Min> and B<Max> are applied to a specific value. Especially
9119 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
9121 =item B<DataSource> I<DSName> [I<DSName> ...]
9123 Select one or more of the data sources. If no data source is configured, all
9124 data sources will be checked. If the type handled by the match does not have a
9125 data source of the specified name(s), this will always result in no match
9126 (independent of the B<Invert> setting).
9128 =item B<Satisfy> B<Any>|B<All>
9130 Specifies how checking with several data sources is performed. If set to
9131 B<Any>, the match succeeds if one of the data sources is in the configured
9132 range. If set to B<All> the match only succeeds if all data sources are within
9133 the configured range. Default is B<All>.
9135 Usually B<All> is used for positive matches, B<Any> is used for negative
9136 matches. This means that with B<All> you usually check that all values are in a
9137 "good" range, while with B<Any> you check if any value is within a "bad" range
9138 (or outside the "good" range).
9142 Either B<Min> or B<Max>, but not both, may be unset.
9146 # Match all values smaller than or equal to 100. Matches only if all data
9147 # sources are below 100.
9153 # Match if the value of any data source is outside the range of 0 - 100.
9161 =item B<empty_counter>
9163 Matches all values with one or more data sources of type B<COUNTER> and where
9164 all counter values are zero. These counters usually I<never> increased since
9165 they started existing (and are therefore uninteresting), or got reset recently
9166 or overflowed and you had really, I<really> bad luck.
9168 Please keep in mind that ignoring such counters can result in confusing
9169 behavior: Counters which hardly ever increase will be zero for long periods of
9170 time. If the counter is reset for some reason (machine or service restarted,
9171 usually), the graph will be empty (NAN) for a long time. People may not
9176 Calculates a hash value of the host name and matches values according to that
9177 hash value. This makes it possible to divide all hosts into groups and match
9178 only values that are in a specific group. The intended use is in load
9179 balancing, where you want to handle only part of all data and leave the rest
9182 The hashing function used tries to distribute the hosts evenly. First, it
9183 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
9186 for (i = 0; host[i] != 0; i++)
9187 hash_value = (hash_value * 251) + host[i];
9189 The constant 251 is a prime number which is supposed to make this hash value
9190 more random. The code then checks the group for this host according to the
9191 I<Total> and I<Match> arguments:
9193 if ((hash_value % Total) == Match)
9198 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
9199 groups), then the least significant bit of the hash value will be the XOR of
9200 all least significant bits in the host name. One consequence is that when you
9201 have two hosts, "server0.example.com" and "server1.example.com", where the host
9202 name differs in one digit only and the digits differ by one, those hosts will
9203 never end up in the same group.
9209 =item B<Match> I<Match> I<Total>
9211 Divide the data into I<Total> groups and match all hosts in group I<Match> as
9212 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
9213 be smaller than I<Total>. I<Total> must be at least one, although only values
9214 greater than one really do make any sense.
9216 You can repeat this option to match multiple groups, for example:
9221 The above config will divide the data into seven groups and match groups three
9222 and five. One use would be to keep every value on two hosts so that if one
9223 fails the missing data can later be reconstructed from the second host.
9229 # Operate on the pre-cache chain, so that ignored values are not even in the
9234 # Divide all received hosts in seven groups and accept all hosts in
9238 # If matched: Return and continue.
9241 # If not matched: Return and stop.
9247 =head2 Available targets
9251 =item B<notification>
9253 Creates and dispatches a notification.
9259 =item B<Message> I<String>
9261 This required option sets the message of the notification. The following
9262 placeholders will be replaced by an appropriate value:
9270 =item B<%{plugin_instance}>
9274 =item B<%{type_instance}>
9276 These placeholders are replaced by the identifier field of the same name.
9278 =item B<%{ds:>I<name>B<}>
9280 These placeholders are replaced by a (hopefully) human readable representation
9281 of the current rate of this data source. If you changed the instance name
9282 (using the B<set> or B<replace> targets, see below), it may not be possible to
9283 convert counter values to rates.
9287 Please note that these placeholders are B<case sensitive>!
9289 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
9291 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
9298 <Target "notification">
9299 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
9305 Replaces parts of the identifier using regular expressions.
9311 =item B<Host> I<Regex> I<Replacement>
9313 =item B<Plugin> I<Regex> I<Replacement>
9315 =item B<PluginInstance> I<Regex> I<Replacement>
9317 =item B<TypeInstance> I<Regex> I<Replacement>
9319 Match the appropriate field with the given regular expression I<Regex>. If the
9320 regular expression matches, that part that matches is replaced with
9321 I<Replacement>. If multiple places of the input buffer match a given regular
9322 expression, only the first occurrence will be replaced.
9324 You can specify each option multiple times to use multiple regular expressions
9332 # Replace "example.net" with "example.com"
9333 Host "\\<example.net\\>" "example.com"
9335 # Strip "www." from hostnames
9341 Sets part of the identifier of a value to a given string.
9347 =item B<Host> I<String>
9349 =item B<Plugin> I<String>
9351 =item B<PluginInstance> I<String>
9353 =item B<TypeInstance> I<String>
9355 =item B<MetaDataSet> I<String> I<String>
9357 Set the appropriate field to the given string. The strings for plugin instance
9358 and type instance may be empty, the strings for host and plugin may not be
9359 empty. It's currently not possible to set the type of a value this way.
9366 PluginInstance "coretemp"
9367 TypeInstance "core3"
9372 =head2 Backwards compatibility
9374 If you use collectd with an old configuration, i.E<nbsp>e. one without a
9375 B<Chain> block, it will behave as it used to. This is equivalent to the
9376 following configuration:
9382 If you specify a B<PostCacheChain>, the B<write> target will not be added
9383 anywhere and you will have to make sure that it is called where appropriate. We
9384 suggest to add the above snippet as default target to your "PostCache" chain.
9388 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
9404 L<collectd-exec(5)>,
9405 L<collectd-perl(5)>,
9406 L<collectd-unixsock(5)>,
9419 Florian Forster E<lt>octo@collectd.orgE<gt>