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<Host> I<Name>
1780 Use I<Name> as the host name when submitting values. Defaults to the global
1783 =item B<Instance> I<Instance>
1785 Sets the plugin instance to I<Instance>.
1787 =item B<Interval> I<Interval>
1789 Sets the interval (in seconds) in which the values will be collected from this
1790 URL. By default the global B<Interval> setting will be used.
1792 =item B<User> I<Name>
1794 =item B<Password> I<Password>
1796 =item B<Digest> B<true>|B<false>
1798 =item B<VerifyPeer> B<true>|B<false>
1800 =item B<VerifyHost> B<true>|B<false>
1802 =item B<CACert> I<file>
1804 =item B<Header> I<Header>
1806 =item B<Post> I<Body>
1808 =item B<Timeout> I<Milliseconds>
1810 These options behave exactly equivalent to the appropriate options of the
1811 I<cURL> plugin. Please see there for a detailed description.
1813 =item B<E<lt>StatisticsE<gt>>
1815 One B<Statistics> block can be used to specify cURL statistics to be collected
1816 for each request to the remote URL. See the section "cURL Statistics" above
1821 The following options are valid within B<Key> blocks:
1825 =item B<Type> I<Type>
1827 Sets the type used to dispatch the values to the daemon. Detailed information
1828 about types and their configuration can be found in L<types.db(5)>. This
1829 option is mandatory.
1831 =item B<Instance> I<Instance>
1833 Type-instance to use. Defaults to the current map key or current string array element value.
1837 =head2 Plugin C<curl_xml>
1839 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1840 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1843 <URL "http://localhost/stats.xml">
1845 Instance "some_instance"
1850 CACert "/path/to/ca.crt"
1851 Header "X-Custom-Header: foobar"
1854 <XPath "table[@id=\"magic_level\"]/tr">
1856 #InstancePrefix "prefix-"
1857 InstanceFrom "td[1]"
1858 ValuesFrom "td[2]/span[@class=\"level\"]"
1863 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1864 URL to be fetched using libcurl. Within each B<URL> block there are
1865 options which specify the connection parameters, for example authentication
1866 information, and one or more B<XPath> blocks.
1868 Each B<XPath> block specifies how to get one type of information. The
1869 string argument must be a valid XPath expression which returns a list
1870 of "base elements". One value is dispatched for each "base element". The
1871 I<type instance> and values are looked up using further I<XPath> expressions
1872 that should be relative to the base element.
1874 Within the B<URL> block the following options are accepted:
1878 =item B<Host> I<Name>
1880 Use I<Name> as the host name when submitting values. Defaults to the global
1883 =item B<Instance> I<Instance>
1885 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1886 empty string (no plugin instance).
1888 =item B<Namespace> I<Prefix> I<URL>
1890 If an XPath expression references namespaces, they must be specified
1891 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1892 I<URL> is the "namespace name", an URI reference uniquely identifying the
1893 namespace. The option can be repeated to register multiple namespaces.
1897 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1898 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1900 =item B<User> I<User>
1902 =item B<Password> I<Password>
1904 =item B<Digest> B<true>|B<false>
1906 =item B<VerifyPeer> B<true>|B<false>
1908 =item B<VerifyHost> B<true>|B<false>
1910 =item B<CACert> I<CA Cert File>
1912 =item B<Header> I<Header>
1914 =item B<Post> I<Body>
1916 =item B<Timeout> I<Milliseconds>
1918 These options behave exactly equivalent to the appropriate options of the
1919 I<cURL plugin>. Please see there for a detailed description.
1921 =item B<E<lt>StatisticsE<gt>>
1923 One B<Statistics> block can be used to specify cURL statistics to be collected
1924 for each request to the remote URL. See the section "cURL Statistics" above
1927 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1929 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1930 B<XPath> block specifies how to get one type of information. The string
1931 argument must be a valid XPath expression which returns a list of "base
1932 elements". One value is dispatched for each "base element".
1934 Within the B<XPath> block the following options are accepted:
1938 =item B<Type> I<Type>
1940 Specifies the I<Type> used for submitting patches. This determines the number
1941 of values that are required / expected and whether the strings are parsed as
1942 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1943 This option is required.
1945 =item B<InstancePrefix> I<InstancePrefix>
1947 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1948 concatenated together without any separator.
1949 This option is optional.
1951 =item B<InstanceFrom> I<InstanceFrom>
1953 Specifies a XPath expression to use for determining the I<type instance>. The
1954 XPath expression must return exactly one element. The element's value is then
1955 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1957 This value is required. As a special exception, if the "base XPath expression"
1958 (the argument to the B<XPath> block) returns exactly one argument, then this
1959 option may be omitted.
1961 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1963 Specifies one or more XPath expression to use for reading the values. The
1964 number of XPath expressions must match the number of data sources in the
1965 I<type> specified with B<Type> (see above). Each XPath expression must return
1966 exactly one element. The element's value is then parsed as a number and used as
1967 value for the appropriate value in the value list dispatched to the daemon.
1973 =head2 Plugin C<dbi>
1975 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1976 connect to various databases, execute I<SQL> statements and read back the
1977 results. I<dbi> is an acronym for "database interface" in case you were
1978 wondering about the name. You can configure how each column is to be
1979 interpreted and the plugin will generate one or more data sets from each row
1980 returned according to these rules.
1982 Because the plugin is very generic, the configuration is a little more complex
1983 than those of other plugins. It usually looks something like this:
1986 <Query "out_of_stock">
1987 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1988 # Use with MySQL 5.0.0 or later
1992 InstancePrefix "out_of_stock"
1993 InstancesFrom "category"
1997 <Database "product_information">
2000 DriverOption "host" "localhost"
2001 DriverOption "username" "collectd"
2002 DriverOption "password" "aZo6daiw"
2003 DriverOption "dbname" "prod_info"
2004 SelectDB "prod_info"
2005 Query "out_of_stock"
2009 The configuration above defines one query with one result and one database. The
2010 query is then linked to the database with the B<Query> option I<within> the
2011 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2012 and you can also use the B<Include> statement to split up the configuration
2013 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2014 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2017 The following is a complete list of options:
2019 =head3 B<Query> blocks
2021 Query blocks define I<SQL> statements and how the returned data should be
2022 interpreted. They are identified by the name that is given in the opening line
2023 of the block. Thus the name needs to be unique. Other than that, the name is
2024 not used in collectd.
2026 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2027 define which column holds which value or instance information. You can use
2028 multiple B<Result> blocks to create multiple values from one returned row. This
2029 is especially useful, when queries take a long time and sending almost the same
2030 query again and again is not desirable.
2034 <Query "environment">
2035 Statement "select station, temperature, humidity from environment"
2038 # InstancePrefix "foo"
2039 InstancesFrom "station"
2040 ValuesFrom "temperature"
2044 InstancesFrom "station"
2045 ValuesFrom "humidity"
2049 The following options are accepted:
2053 =item B<Statement> I<SQL>
2055 Sets the statement that should be executed on the server. This is B<not>
2056 interpreted by collectd, but simply passed to the database server. Therefore,
2057 the SQL dialect that's used depends on the server collectd is connected to.
2059 The query has to return at least two columns, one for the instance and one
2060 value. You cannot omit the instance, even if the statement is guaranteed to
2061 always return exactly one line. In that case, you can usually specify something
2064 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2066 (That works with MySQL but may not be valid SQL according to the spec. If you
2067 use a more strict database server, you may have to select from a dummy table or
2070 Please note that some databases, for example B<Oracle>, will fail if you
2071 include a semicolon at the end of the statement.
2073 =item B<MinVersion> I<Version>
2075 =item B<MaxVersion> I<Value>
2077 Only use this query for the specified database version. You can use these
2078 options to provide multiple queries with the same name but with a slightly
2079 different syntax. The plugin will use only those queries, where the specified
2080 minimum and maximum versions fit the version of the database in use.
2082 The database version is determined by C<dbi_conn_get_engine_version>, see the
2083 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2084 for details. Basically, each part of the version is assumed to be in the range
2085 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2086 "40102", version "5.0.42" becomes "50042".
2088 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2089 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2090 happen. Don't to it! A valid example would be something along these lines:
2101 In the above example, there are three ranges that don't overlap. The last one
2102 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2103 before "4.0.0" are not specified.
2105 =item B<Type> I<Type>
2107 The B<type> that's used for each line returned. See L<types.db(5)> for more
2108 details on how types are defined. In short: A type is a predefined layout of
2109 data and the number of values and type of values has to match the type
2112 If you specify "temperature" here, you need exactly one gauge column. If you
2113 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2116 There must be exactly one B<Type> option inside each B<Result> block.
2118 =item B<InstancePrefix> I<prefix>
2120 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2121 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2122 all strings returned in the appropriate columns are concatenated together,
2123 separated by dashes I<("-")>.
2125 =item B<InstancesFrom> I<column0> [I<column1> ...]
2127 Specifies the columns whose values will be used to create the "type-instance"
2128 for each row. If you specify more than one column, the value of all columns
2129 will be joined together with dashes I<("-")> as separation characters.
2131 The plugin itself does not check whether or not all built instances are
2132 different. It's your responsibility to assure that each is unique. This is
2133 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2134 sure that only one row is returned in this case.
2136 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2139 =item B<ValuesFrom> I<column0> [I<column1> ...]
2141 Names the columns whose content is used as the actual data for the data sets
2142 that are dispatched to the daemon. How many such columns you need is determined
2143 by the B<Type> setting above. If you specify too many or not enough columns,
2144 the plugin will complain about that and no data will be submitted to the
2147 The actual data type in the columns is not that important. The plugin will
2148 automatically cast the values to the right type if it know how to do that. So
2149 it should be able to handle integer an floating point types, as well as strings
2150 (if they include a number at the beginning).
2152 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2154 =item B<MetadataFrom> [I<column0> I<column1> ...]
2156 Names the columns whose content is used as metadata for the data sets
2157 that are dispatched to the daemon.
2159 The actual data type in the columns is not that important. The plugin will
2160 automatically cast the values to the right type if it know how to do that. So
2161 it should be able to handle integer an floating point types, as well as strings
2162 (if they include a number at the beginning).
2166 =head3 B<Database> blocks
2168 Database blocks define a connection to a database and which queries should be
2169 sent to that database. Since the used "dbi" library can handle a wide variety
2170 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2171 documentationE<nbsp>- we stick as close to the terminology used there.
2173 Each database needs a "name" as string argument in the starting tag of the
2174 block. This name will be used as "PluginInstance" in the values submitted to
2175 the daemon. Other than that, that name is not used.
2179 =item B<Interval> I<Interval>
2181 Sets the interval (in seconds) in which the values will be collected from this
2182 database. By default the global B<Interval> setting will be used.
2184 =item B<Driver> I<Driver>
2186 Specifies the driver to use to connect to the database. In many cases those
2187 drivers are named after the database they can connect to, but this is not a
2188 technical necessity. These drivers are sometimes referred to as "DBD",
2189 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2190 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2191 project at L<http://libdbi-drivers.sourceforge.net/>.
2193 You need to give the driver name as expected by the "dbi" library here. You
2194 should be able to find that in the documentation for each driver. If you
2195 mistype the driver name, the plugin will dump a list of all known driver names
2198 =item B<DriverOption> I<Key> I<Value>
2200 Sets driver-specific options. What option a driver supports can be found in the
2201 documentation for each driver, somewhere at
2202 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2203 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2205 DBDs can register two types of options: String options and numeric options. The
2206 plugin will use the C<dbi_conn_set_option> function when the configuration
2207 provides a string and the C<dbi_conn_require_option_numeric> function when the
2208 configuration provides a number. So these two lines will actually result in
2209 different calls being used:
2211 DriverOption "Port" 1234 # numeric
2212 DriverOption "Port" "1234" # string
2214 Unfortunately, drivers are not too keen to report errors when an unknown option
2215 is passed to them, so invalid settings here may go unnoticed. This is not the
2216 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2217 the driver. If a driver complains about an option, the plugin will dump a
2218 complete list of all options understood by that driver to the log. There is no
2219 way to programatically find out if an option expects a string or a numeric
2220 argument, so you will have to refer to the appropriate DBD's documentation to
2221 find this out. Sorry.
2223 =item B<SelectDB> I<Database>
2225 In some cases, the database name you connect with is not the database name you
2226 want to use for querying data. If this option is set, the plugin will "select"
2227 (switch to) that database after the connection is established.
2229 =item B<Query> I<QueryName>
2231 Associates the query named I<QueryName> with this database connection. The
2232 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2233 blocks you want to refer to must be placed above the database block you want to
2236 =item B<Host> I<Hostname>
2238 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2239 values. Defaults to the global hostname setting.
2247 =item B<Device> I<Device>
2249 Select partitions based on the devicename.
2251 =item B<MountPoint> I<Directory>
2253 Select partitions based on the mountpoint.
2255 =item B<FSType> I<FSType>
2257 Select partitions based on the filesystem type.
2259 =item B<IgnoreSelected> B<true>|B<false>
2261 Invert the selection: If set to true, all partitions B<except> the ones that
2262 match any one of the criteria are collected. By default only selected
2263 partitions are collected if a selection is made. If no selection is configured
2264 at all, B<all> partitions are selected.
2266 =item B<ReportByDevice> B<true>|B<false>
2268 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2269 (the default), it will report a disk as "root", but with it I<true>, it will be
2270 "sda1" (or whichever).
2272 =item B<ReportInodes> B<true>|B<false>
2274 Enables or disables reporting of free, reserved and used inodes. Defaults to
2275 inode collection being disabled.
2277 Enable this option if inodes are a scarce resource for you, usually because
2278 many small files are stored on the disk. This is a usual scenario for mail
2279 transfer agents and web caches.
2281 =item B<ValuesAbsolute> B<true>|B<false>
2283 Enables or disables reporting of free and used disk space in 1K-blocks.
2284 Defaults to B<true>.
2286 =item B<ValuesPercentage> B<false>|B<true>
2288 Enables or disables reporting of free and used disk space in percentage.
2289 Defaults to B<false>.
2291 This is useful for deploying I<collectd> on the cloud, where machines with
2292 different disk size may exist. Then it is more practical to configure
2293 thresholds based on relative disk size.
2297 =head2 Plugin C<disk>
2299 The C<disk> plugin collects information about the usage of physical disks and
2300 logical disks (partitions). Values collected are the number of octets written
2301 to and read from a disk or partition, the number of read/write operations
2302 issued to the disk and a rather complex "time" it took for these commands to be
2305 Using the following two options you can ignore some disks or configure the
2306 collection only of specific disks.
2310 =item B<Disk> I<Name>
2312 Select the disk I<Name>. Whether it is collected or ignored depends on the
2313 B<IgnoreSelected> setting, see below. As with other plugins that use the
2314 daemon's ignorelist functionality, a string that starts and ends with a slash
2315 is interpreted as a regular expression. Examples:
2320 =item B<IgnoreSelected> B<true>|B<false>
2322 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2323 statements, are ignored or if all other disks are ignored. The behavior
2324 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2325 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2326 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2327 is set to B<true>, all disks are collected B<except> the ones matched.
2329 =item B<UseBSDName> B<true>|B<false>
2331 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2332 default major/minor numbers. Requires collectd to be built with Apple's
2335 =item B<UdevNameAttr> I<Attribute>
2337 Attempt to override disk instance name with the value of a specified udev
2338 attribute when built with B<libudev>. If the attribute is not defined for the
2339 given device, the default name is used. Example:
2341 UdevNameAttr "DM_NAME"
2345 =head2 Plugin C<dns>
2349 =item B<Interface> I<Interface>
2351 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2352 option sets the interface that should be used. If this option is not set, or
2353 set to "any", the plugin will try to get packets from B<all> interfaces. This
2354 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2356 =item B<IgnoreSource> I<IP-address>
2358 Ignore packets that originate from this address.
2360 =item B<SelectNumericQueryTypes> B<true>|B<false>
2362 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2366 =head2 Plugin C<email>
2370 =item B<SocketFile> I<Path>
2372 Sets the socket-file which is to be created.
2374 =item B<SocketGroup> I<Group>
2376 If running as root change the group of the UNIX-socket after it has been
2377 created. Defaults to B<collectd>.
2379 =item B<SocketPerms> I<Permissions>
2381 Change the file permissions of the UNIX-socket after it has been created. The
2382 permissions must be given as a numeric, octal value as you would pass to
2383 L<chmod(1)>. Defaults to B<0770>.
2385 =item B<MaxConns> I<Number>
2387 Sets the maximum number of connections that can be handled in parallel. Since
2388 this many threads will be started immediately setting this to a very high
2389 value will waste valuable resources. Defaults to B<5> and will be forced to be
2390 at most B<16384> to prevent typos and dumb mistakes.
2394 =head2 Plugin C<ethstat>
2396 The I<ethstat plugin> collects information about network interface cards (NICs)
2397 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2403 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2404 Map "multicast" "if_multicast"
2411 =item B<Interface> I<Name>
2413 Collect statistical information about interface I<Name>.
2415 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2417 By default, the plugin will submit values as type C<derive> and I<type
2418 instance> set to I<Name>, the name of the metric as reported by the driver. If
2419 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2420 I<TypeInstance> will be used.
2422 =item B<MappedOnly> B<true>|B<false>
2424 When set to B<true>, only metrics that can be mapped to a I<type> will be
2425 collected, all other metrics will be ignored. Defaults to B<false>.
2429 =head2 Plugin C<exec>
2431 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2432 contains valuable information on when the executable is executed and the
2433 output that is expected from it.
2437 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2439 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2441 Execute the executable I<Executable> as user I<User>. If the user name is
2442 followed by a colon and a group name, the effective group is set to that group.
2443 The real group and saved-set group will be set to the default group of that
2444 user. If no group is given the effective group ID will be the same as the real
2447 Please note that in order to change the user and/or group the daemon needs
2448 superuser privileges. If the daemon is run as an unprivileged user you must
2449 specify the same user/group here. If the daemon is run with superuser
2450 privileges, you must supply a non-root user here.
2452 The executable may be followed by optional arguments that are passed to the
2453 program. Please note that due to the configuration parsing numbers and boolean
2454 values may be changed. If you want to be absolutely sure that something is
2455 passed as-is please enclose it in quotes.
2457 The B<Exec> and B<NotificationExec> statements change the semantics of the
2458 programs executed, i.E<nbsp>e. the data passed to them and the response
2459 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2463 =head2 Plugin C<fhcount>
2465 The C<fhcount> plugin provides statistics about used, unused and total number of
2466 file handles on Linux.
2468 The I<fhcount plugin> provides the following configuration options:
2472 =item B<ValuesAbsolute> B<true>|B<false>
2474 Enables or disables reporting of file handles usage in absolute numbers,
2475 e.g. file handles used. Defaults to B<true>.
2477 =item B<ValuesPercentage> B<false>|B<true>
2479 Enables or disables reporting of file handles usage in percentages, e.g.
2480 percent of file handles used. Defaults to B<false>.
2484 =head2 Plugin C<filecount>
2486 The C<filecount> plugin counts the number of files in a certain directory (and
2487 its subdirectories) and their combined size. The configuration is very straight
2490 <Plugin "filecount">
2491 <Directory "/var/qmail/queue/mess">
2492 Instance "qmail-message"
2494 <Directory "/var/qmail/queue/todo">
2495 Instance "qmail-todo"
2497 <Directory "/var/lib/php5">
2498 Instance "php5-sessions"
2503 The example above counts the number of files in QMail's queue directories and
2504 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2505 QMail has not yet looked at, the "message" queue holds the messages that were
2506 classified into "local" and "remote".
2508 As you can see, the configuration consists of one or more C<Directory> blocks,
2509 each of which specifies a directory in which to count the files. Within those
2510 blocks, the following options are recognized:
2514 =item B<Instance> I<Instance>
2516 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2517 it's your responsibility, the plugin doesn't check for that. If not given, the
2518 instance is set to the directory name with all slashes replaced by underscores
2519 and all leading underscores removed.
2521 =item B<Name> I<Pattern>
2523 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2524 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2525 against the pattern, not the entire path. In case this makes it easier for you:
2526 This option has been named after the B<-name> parameter to L<find(1)>.
2528 =item B<MTime> I<Age>
2530 Count only files of a specific age: If I<Age> is greater than zero, only files
2531 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2532 a negative number, this is inversed. For example, if B<-60> is specified, only
2533 files that have been modified in the last minute will be counted.
2535 The number can also be followed by a "multiplier" to easily specify a larger
2536 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2537 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2538 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2539 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2540 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2543 =item B<Size> I<Size>
2545 Count only files of a specific size. When I<Size> is a positive number, only
2546 files that are at least this big are counted. If I<Size> is a negative number,
2547 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2548 I<Size> are counted.
2550 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2551 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2552 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2553 note that there are 1000 bytes in a kilobyte, not 1024.
2555 =item B<Recursive> I<true>|I<false>
2557 Controls whether or not to recurse into subdirectories. Enabled by default.
2559 =item B<IncludeHidden> I<true>|I<false>
2561 Controls whether or not to include "hidden" files and directories in the count.
2562 "Hidden" files and directories are those, whose name begins with a dot.
2563 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2567 =head2 Plugin C<GenericJMX>
2569 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2570 L<collectd-java(5)>.
2572 =head2 Plugin C<gmond>
2574 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2575 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2576 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2581 MCReceiveFrom "239.2.11.71" "8649"
2582 <Metric "swap_total">
2584 TypeInstance "total"
2587 <Metric "swap_free">
2594 The following metrics are built-in:
2600 load_one, load_five, load_fifteen
2604 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2608 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2620 Available configuration options:
2624 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2626 Sets sets the multicast group and UDP port to which to subscribe.
2628 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2630 =item E<lt>B<Metric> I<Name>E<gt>
2632 These blocks add a new metric conversion to the internal table. I<Name>, the
2633 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2637 =item B<Type> I<Type>
2639 Type to map this metric to. Required.
2641 =item B<TypeInstance> I<Instance>
2643 Type-instance to use. Optional.
2645 =item B<DataSource> I<Name>
2647 Data source to map this metric to. If the configured type has exactly one data
2648 source, this is optional. Otherwise the option is required.
2654 =head2 Plugin C<gps>
2656 The C<gps plugin> connects to gpsd on the host machine.
2657 The host, port, timeout and pause are configurable.
2659 This is useful if you run an NTP server using a GPS for source and you want to
2662 Mind your GPS must send $--GSA for having the data reported!
2664 The following elements are collected:
2670 Number of satellites used for fix (type instance "used") and in view (type
2671 instance "visible"). 0 means no GPS satellites are visible.
2673 =item B<dilution_of_precision>
2675 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2676 It should be between 0 and 3.
2677 Look at the documentation of your GPS to know more.
2685 # Connect to localhost on gpsd regular port:
2690 # PauseConnect of 5 sec. between connection attempts.
2694 Available configuration options:
2698 =item B<Host> I<Host>
2700 The host on which gpsd daemon runs. Defaults to B<localhost>.
2702 =item B<Port> I<Port>
2704 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2706 =item B<Timeout> I<Seconds>
2708 Timeout in seconds (default 0.015 sec).
2710 The GPS data stream is fetch by the plugin form the daemon.
2711 It waits for data to be available, if none arrives it times out
2712 and loop for another reading.
2713 Mind to put a low value gpsd expects value in the micro-seconds area
2714 (recommended is 500 us) since the waiting function is blocking.
2715 Value must be between 500 us and 5 sec., if outside that range the
2716 default value is applied.
2718 This only applies from gpsd release-2.95.
2720 =item B<PauseConnect> I<Seconds>
2722 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
2726 =head2 Plugin C<grpc>
2728 The I<grpc> plugin provides an RPC interface to submit values to or query
2729 values from collectd based on the open source gRPC framework. It exposes an
2730 end-point for dispatching values to the daemon.
2732 The B<gRPC> homepage can be found at L<https://grpc.io/>.
2736 =item B<Server> I<Host> I<Port>
2738 The B<Server> statement sets the address of a server to which to send metrics
2739 via the C<DispatchValues> function.
2741 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2743 Optionally, B<Server> may be specified as a configuration block which supports
2744 the following options:
2748 =item B<EnableSSL> B<false>|B<true>
2750 Whether to require SSL for outgoing connections. Default: false.
2752 =item B<SSLCACertificateFile> I<Filename>
2754 =item B<SSLCertificateFile> I<Filename>
2756 =item B<SSLCertificateKeyFile> I<Filename>
2758 Filenames specifying SSL certificate and key material to be used with SSL
2763 =item B<Listen> I<Host> I<Port>
2765 The B<Listen> statement sets the network address to bind to. When multiple
2766 statements are specified, the daemon will bind to all of them. If none are
2767 specified, it defaults to B<0.0.0.0:50051>.
2769 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2771 Optionally, B<Listen> may be specified as a configuration block which
2772 supports the following options:
2776 =item B<EnableSSL> I<true>|I<false>
2778 Whether to enable SSL for incoming connections. Default: false.
2780 =item B<SSLCACertificateFile> I<Filename>
2782 =item B<SSLCertificateFile> I<Filename>
2784 =item B<SSLCertificateKeyFile> I<Filename>
2786 Filenames specifying SSL certificate and key material to be used with SSL
2793 =head2 Plugin C<hddtemp>
2795 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2796 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2797 default values, see below. C<hddtemp> has to be running to work correctly. If
2798 C<hddtemp> is not running timeouts may appear which may interfere with other
2801 The B<hddtemp> homepage can be found at
2802 L<http://www.guzu.net/linux/hddtemp.php>.
2806 =item B<Host> I<Hostname>
2808 Hostname to connect to. Defaults to B<127.0.0.1>.
2810 =item B<Port> I<Port>
2812 TCP-Port to connect to. Defaults to B<7634>.
2816 =head2 Plugin C<interface>
2820 =item B<Interface> I<Interface>
2822 Select this interface. By default these interfaces will then be collected. For
2823 a more detailed description see B<IgnoreSelected> below.
2825 =item B<IgnoreSelected> I<true>|I<false>
2827 If no configuration if given, the B<interface>-plugin will collect data from
2828 all interfaces. This may not be practical, especially for loopback- and
2829 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2830 interfaces you're interested in. Sometimes, however, it's easier/preferred
2831 to collect all interfaces I<except> a few ones. This option enables you to
2832 do that: By setting B<IgnoreSelected> to I<true> the effect of
2833 B<Interface> is inverted: All selected interfaces are ignored and all
2834 other interfaces are collected.
2836 It is possible to use regular expressions to match interface names, if the
2837 name is surrounded by I</.../> and collectd was compiled with support for
2838 regexps. This is useful if there's a need to collect (or ignore) data
2839 for a group of interfaces that are similarly named, without the need to
2840 explicitly list all of them (especially useful if the list is dynamic).
2845 Interface "/^tun[0-9]+/"
2846 IgnoreSelected "true"
2848 This will ignore the loopback interface, all interfaces with names starting
2849 with I<veth> and all interfaces with names starting with I<tun> followed by
2852 =item B<ReportInactive> I<true>|I<false>
2854 When set to I<false>, only interfaces with non-zero traffic will be
2855 reported. Note that the check is done by looking into whether a
2856 package was sent at any time from boot and the corresponding counter
2857 is non-zero. So, if the interface has been sending data in the past
2858 since boot, but not during the reported time-interval, it will still
2861 The default value is I<true> and results in collection of the data
2862 from all interfaces that are selected by B<Interface> and
2863 B<IgnoreSelected> options.
2865 =item B<UniqueName> I<true>|I<false>
2867 Interface name is not unique on Solaris (KSTAT), interface name is unique
2868 only within a module/instance. Following tuple is considered unique:
2869 (ks_module, ks_instance, ks_name)
2870 If this option is set to true, interface name contains above three fields
2871 separated by an underscore. For more info on KSTAT, visit
2872 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
2874 This option is only available on Solaris.
2878 =head2 Plugin C<ipmi>
2882 =item B<Sensor> I<Sensor>
2884 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2886 =item B<IgnoreSelected> I<true>|I<false>
2888 If no configuration if given, the B<ipmi> plugin will collect data from all
2889 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2890 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2891 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2892 all other sensors are collected.
2894 =item B<NotifySensorAdd> I<true>|I<false>
2896 If a sensor appears after initialization time of a minute a notification
2899 =item B<NotifySensorRemove> I<true>|I<false>
2901 If a sensor disappears a notification is sent.
2903 =item B<NotifySensorNotPresent> I<true>|I<false>
2905 If you have for example dual power supply and one of them is (un)plugged then
2906 a notification is sent.
2910 =head2 Plugin C<iptables>
2914 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2916 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2918 Select the iptables/ip6tables filter rules to count packets and bytes from.
2920 If only I<Table> and I<Chain> are given, this plugin will collect the counters
2921 of all rules which have a comment-match. The comment is then used as
2924 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2925 the I<n>th rule will be collected. Again, the comment (or the number) will be
2926 used as the type-instance.
2928 If I<Name> is supplied, it will be used as the type-instance instead of the
2929 comment or the number.
2933 =head2 Plugin C<irq>
2939 Select this irq. By default these irqs will then be collected. For a more
2940 detailed description see B<IgnoreSelected> below.
2942 =item B<IgnoreSelected> I<true>|I<false>
2944 If no configuration if given, the B<irq>-plugin will collect data from all
2945 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2946 can use the B<Irq>-option to pick the interrupt you're interested in.
2947 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2948 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2949 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2950 and all other interrupts are collected.
2954 =head2 Plugin C<java>
2956 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2957 This section only discusses the syntax and semantic of the configuration
2958 options. For more in-depth information on the I<Java> plugin, please read
2959 L<collectd-java(5)>.
2964 JVMArg "-verbose:jni"
2965 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2966 LoadPlugin "org.collectd.java.Foobar"
2967 <Plugin "org.collectd.java.Foobar">
2968 # To be parsed by the plugin
2972 Available configuration options:
2976 =item B<JVMArg> I<Argument>
2978 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2979 exactly the way the arguments to the I<java> binary on the command line work.
2980 Execute C<javaE<nbsp>--help> for details.
2982 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2983 any other options! When another option is found, the JVM will be started and
2984 later options will have to be ignored!
2986 =item B<LoadPlugin> I<JavaClass>
2988 Instantiates a new I<JavaClass> object. The constructor of this object very
2989 likely then registers one or more callback methods with the server.
2991 See L<collectd-java(5)> for details.
2993 When the first such option is found, the virtual machine (JVM) is created. This
2994 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2995 B<LoadPlugin> options!
2997 =item B<Plugin> I<Name>
2999 The entire block is passed to the Java plugin as an
3000 I<org.collectd.api.OConfigItem> object.
3002 For this to work, the plugin has to register a configuration callback first,
3003 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3004 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3005 depends on the (Java) plugin registering the callback and is completely
3006 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3010 =head2 Plugin C<load>
3012 The I<Load plugin> collects the system load. These numbers give a rough overview
3013 over the utilization of a machine. The system load is defined as the number of
3014 runnable tasks in the run-queue and is provided by many operating systems as a
3015 one, five or fifteen minute average.
3017 The following configuration options are available:
3021 =item B<ReportRelative> B<false>|B<true>
3023 When enabled, system load divided by number of available CPU cores is reported
3024 for intervals 1 min, 5 min and 15 min. Defaults to false.
3029 =head2 Plugin C<logfile>
3033 =item B<LogLevel> B<debug|info|notice|warning|err>
3035 Sets the log-level. If, for example, set to B<notice>, then all events with
3036 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3038 Please note that B<debug> is only available if collectd has been compiled with
3041 =item B<File> I<File>
3043 Sets the file to write log messages to. The special strings B<stdout> and
3044 B<stderr> can be used to write to the standard output and standard error
3045 channels, respectively. This, of course, only makes much sense when I<collectd>
3046 is running in foreground- or non-daemon-mode.
3048 =item B<Timestamp> B<true>|B<false>
3050 Prefix all lines printed by the current time. Defaults to B<true>.
3052 =item B<PrintSeverity> B<true>|B<false>
3054 When enabled, all lines are prefixed by the severity of the log message, for
3055 example "warning". Defaults to B<false>.
3059 B<Note>: There is no need to notify the daemon after moving or removing the
3060 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3061 for each line it writes.
3063 =head2 Plugin C<log_logstash>
3065 The I<log logstash plugin> behaves like the logfile plugin but formats
3066 messages as JSON events for logstash to parse and input.
3070 =item B<LogLevel> B<debug|info|notice|warning|err>
3072 Sets the log-level. If, for example, set to B<notice>, then all events with
3073 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3075 Please note that B<debug> is only available if collectd has been compiled with
3078 =item B<File> I<File>
3080 Sets the file to write log messages to. The special strings B<stdout> and
3081 B<stderr> can be used to write to the standard output and standard error
3082 channels, respectively. This, of course, only makes much sense when I<collectd>
3083 is running in foreground- or non-daemon-mode.
3087 B<Note>: There is no need to notify the daemon after moving or removing the
3088 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3089 for each line it writes.
3091 =head2 Plugin C<lpar>
3093 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3094 virtualization technique for IBM POWER processors. It takes into account CPU
3095 time stolen from or donated to a partition, in addition to the usual user,
3096 system, I/O statistics.
3098 The following configuration options are available:
3102 =item B<CpuPoolStats> B<false>|B<true>
3104 When enabled, statistics about the processor pool are read, too. The partition
3105 needs to have pool authority in order to be able to acquire this information.
3108 =item B<ReportBySerial> B<false>|B<true>
3110 If enabled, the serial of the physical machine the partition is currently
3111 running on is reported as I<hostname> and the logical hostname of the machine
3112 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3113 used (just like other plugins) and the I<plugin instance> will be empty.
3118 =head2 Plugin C<mbmon>
3120 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3122 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3123 B<Host> and B<Port> options can be used to change these values, see below.
3124 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3125 timeouts may appear which may interfere with other statistics..
3127 C<mbmon> must be run with the -r option ("print TAG and Value format");
3128 Debian's F</etc/init.d/mbmon> script already does this, other people
3129 will need to ensure that this is the case.
3133 =item B<Host> I<Hostname>
3135 Hostname to connect to. Defaults to B<127.0.0.1>.
3137 =item B<Port> I<Port>
3139 TCP-Port to connect to. Defaults to B<411>.
3145 The C<md plugin> collects information from Linux Software-RAID devices (md).
3147 All reported values are of the type C<md_disks>. Reported type instances are
3148 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3149 I<missing> (physically absent) disks.
3153 =item B<Device> I<Device>
3155 Select md devices based on device name. The I<device name> is the basename of
3156 the device, i.e. the name of the block device without the leading C</dev/>.
3157 See B<IgnoreSelected> for more details.
3159 =item B<IgnoreSelected> B<true>|B<false>
3161 Invert device selection: If set to B<true>, all md devices B<except> those
3162 listed using B<Device> are collected. If B<false> (the default), only those
3163 listed are collected. If no configuration is given, the B<md> plugin will
3164 collect data from all md devices.
3168 =head2 Plugin C<memcachec>
3170 The C<memcachec plugin> connects to a memcached server, queries one or more
3171 given I<pages> and parses the returned data according to user specification.
3172 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3175 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3176 library. Please note that there is another library with a very similar name,
3177 libmemcache (notice the missing `d'), which is not applicable.
3179 Synopsis of the configuration:
3181 <Plugin "memcachec">
3182 <Page "plugin_instance">
3186 Regex "(\\d+) bytes sent"
3189 Instance "type_instance"
3194 The configuration options are:
3198 =item E<lt>B<Page> I<Name>E<gt>
3200 Each B<Page> block defines one I<page> to be queried from the memcached server.
3201 The block requires one string argument which is used as I<plugin instance>.
3203 =item B<Server> I<Address>
3205 Sets the server address to connect to when querying the page. Must be inside a
3210 When connected to the memcached server, asks for the page I<Key>.
3212 =item E<lt>B<Match>E<gt>
3214 Match blocks define which strings to look for and how matches substrings are
3215 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3219 =head2 Plugin C<memcached>
3221 The B<memcached plugin> connects to a memcached server and queries statistics
3222 about cache utilization, memory and bandwidth used.
3223 L<http://www.danga.com/memcached/>
3225 <Plugin "memcached">
3227 Host "memcache.example.com"
3232 The plugin configuration consists of one or more B<Instance> blocks which
3233 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3234 following options are allowed:
3238 =item B<Host> I<Hostname>
3240 Hostname to connect to. Defaults to B<127.0.0.1>.
3242 =item B<Port> I<Port>
3244 TCP-Port to connect to. Defaults to B<11211>.
3246 =item B<Socket> I<Path>
3248 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3249 setting is given, the B<Host> and B<Port> settings are ignored.
3253 =head2 Plugin C<mic>
3255 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3256 Intel's Many Integrated Core (MIC) systems.
3265 ShowTemperatures true
3268 IgnoreSelectedTemperature true
3273 IgnoreSelectedPower true
3276 The following options are valid inside the B<PluginE<nbsp>mic> block:
3280 =item B<ShowCPU> B<true>|B<false>
3282 If enabled (the default) a sum of the CPU usage across all cores is reported.
3284 =item B<ShowCPUCores> B<true>|B<false>
3286 If enabled (the default) per-core CPU usage is reported.
3288 =item B<ShowMemory> B<true>|B<false>
3290 If enabled (the default) the physical memory usage of the MIC system is
3293 =item B<ShowTemperatures> B<true>|B<false>
3295 If enabled (the default) various temperatures of the MIC system are reported.
3297 =item B<Temperature> I<Name>
3299 This option controls which temperatures are being reported. Whether matching
3300 temperatures are being ignored or I<only> matching temperatures are reported
3301 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3302 temperatures are reported.
3304 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3306 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3307 (the default) only temperatures matching a B<Temperature> option are reported
3308 or, if no B<Temperature> option is specified, all temperatures are reported. If
3309 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3312 Known temperature names are:
3346 =item B<ShowPower> B<true>|B<false>
3348 If enabled (the default) various temperatures of the MIC system are reported.
3350 =item B<Power> I<Name>
3352 This option controls which power readings are being reported. Whether matching
3353 power readings are being ignored or I<only> matching power readings are reported
3354 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3355 power readings are reported.
3357 =item B<IgnoreSelectedPower> B<false>|B<true>
3359 Controls the behavior of the B<Power> setting above. If set to B<false>
3360 (the default) only power readings matching a B<Power> option are reported
3361 or, if no B<Power> option is specified, all power readings are reported. If
3362 set to B<true>, matching power readings are I<ignored> and all other power readings
3365 Known power names are:
3371 Total power utilization averaged over Time Window 0 (uWatts).
3375 Total power utilization averaged over Time Window 0 (uWatts).
3379 Instantaneous power (uWatts).
3383 Max instantaneous power (uWatts).
3387 PCI-E connector power (uWatts).
3391 2x3 connector power (uWatts).
3395 2x4 connector power (uWatts).
3403 Uncore rail (uVolts).
3407 Memory subsystem rail (uVolts).
3413 =head2 Plugin C<memory>
3415 The I<memory plugin> provides the following configuration options:
3419 =item B<ValuesAbsolute> B<true>|B<false>
3421 Enables or disables reporting of physical memory usage in absolute numbers,
3422 i.e. bytes. Defaults to B<true>.
3424 =item B<ValuesPercentage> B<false>|B<true>
3426 Enables or disables reporting of physical memory usage in percentages, e.g.
3427 percent of physical memory used. Defaults to B<false>.
3429 This is useful for deploying I<collectd> in a heterogeneous environment in
3430 which the sizes of physical memory vary.
3434 =head2 Plugin C<modbus>
3436 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3437 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3438 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3439 values (two registers interpreted as IEEE floats in big endian notation).
3443 <Data "voltage-input-1">
3446 RegisterCmd ReadHolding
3451 <Data "voltage-input-2">
3454 RegisterCmd ReadHolding
3459 <Data "supply-temperature-1">
3462 RegisterCmd ReadHolding
3467 <Host "modbus.example.com">
3468 Address "192.168.0.42"
3473 Instance "power-supply"
3474 Collect "voltage-input-1"
3475 Collect "voltage-input-2"
3480 Device "/dev/ttyUSB0"
3485 Instance "temperature"
3486 Collect "supply-temperature-1"
3492 =item E<lt>B<Data> I<Name>E<gt> blocks
3494 Data blocks define a mapping between register numbers and the "types" used by
3497 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3501 =item B<RegisterBase> I<Number>
3503 Configures the base register to read from the device. If the option
3504 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3505 register will be read (the register number is increased by one).
3507 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3509 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3510 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3511 combined into one value. Defaults to B<Uint16>.
3513 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3515 Specifies register type to be collected from device. Works only with libmodbus
3516 2.9.2 or higher. Defaults to B<ReadHolding>.
3518 =item B<Type> I<Type>
3520 Specifies the "type" (data set) to use when dispatching the value to
3521 I<collectd>. Currently, only data sets with exactly one data source are
3524 =item B<Instance> I<Instance>
3526 Sets the type instance to use when dispatching the value to I<collectd>. If
3527 unset, an empty string (no type instance) is used.
3531 =item E<lt>B<Host> I<Name>E<gt> blocks
3533 Host blocks are used to specify to which hosts to connect and what data to read
3534 from their "slaves". The string argument I<Name> is used as hostname when
3535 dispatching the values to I<collectd>.
3537 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3541 =item B<Address> I<Hostname>
3543 For Modbus/TCP, specifies the node name (the actual network address) used to
3544 connect to the host. This may be an IP address or a hostname. Please note that
3545 the used I<libmodbus> library only supports IPv4 at the moment.
3547 =item B<Port> I<Service>
3549 for Modbus/TCP, specifies the port used to connect to the host. The port can
3550 either be given as a number or as a service name. Please note that the
3551 I<Service> argument must be a string, even if ports are given in their numerical
3552 form. Defaults to "502".
3554 =item B<Device> I<Devicenode>
3556 For Modbus/RTU, specifies the path to the serial device being used.
3558 =item B<Baudrate> I<Baudrate>
3560 For Modbus/RTU, specifies the baud rate of the serial device.
3561 Note, connections currently support only 8/N/1.
3563 =item B<Interval> I<Interval>
3565 Sets the interval (in seconds) in which the values will be collected from this
3566 host. By default the global B<Interval> setting will be used.
3568 =item E<lt>B<Slave> I<ID>E<gt>
3570 Over each connection, multiple Modbus devices may be reached. The slave ID
3571 is used to specify which device should be addressed. For each device you want
3572 to query, one B<Slave> block must be given.
3574 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3578 =item B<Instance> I<Instance>
3580 Specify the plugin instance to use when dispatching the values to I<collectd>.
3581 By default "slave_I<ID>" is used.
3583 =item B<Collect> I<DataName>
3585 Specifies which data to retrieve from the device. I<DataName> must be the same
3586 string as the I<Name> argument passed to a B<Data> block. You can specify this
3587 option multiple times to collect more than one value from a slave. At least one
3588 B<Collect> option is mandatory.
3596 =head2 Plugin C<mqtt>
3598 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
3599 values from MQTT (B<Subscribe> blocks).
3605 Host "mqtt.example.com"
3609 Host "mqtt.example.com"
3614 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
3615 configuring the sending and receiving direction respectively. The plugin will
3616 register a write callback named C<mqtt/I<name>> where I<name> is the string
3617 argument given to the B<Publish> block. Both types of blocks share many but not
3618 all of the following options. If an option is valid in only one of the blocks,
3619 it will be mentioned explicitly.
3625 =item B<Host> I<Hostname>
3627 Hostname of the MQTT broker to connect to.
3629 =item B<Port> I<Service>
3631 Port number or service name of the MQTT broker to connect to.
3633 =item B<User> I<UserName>
3635 Username used when authenticating to the MQTT broker.
3637 =item B<Password> I<Password>
3639 Password used when authenticating to the MQTT broker.
3641 =item B<ClientId> I<ClientId>
3643 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
3645 =item B<QoS> [B<0>-B<2>]
3647 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
3665 In B<Publish> blocks, this option determines the QoS flag set on outgoing
3666 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
3667 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
3668 on a message is larger than the maximum accepted QoS of a subscriber, the
3669 message's QoS will be downgraded.
3671 =item B<Prefix> I<Prefix> (Publish only)
3673 This plugin will use one topic per I<value list> which will looks like a path.
3674 I<Prefix> is used as the first path element and defaults to B<collectd>.
3676 An example topic name would be:
3678 collectd/cpu-0/cpu-user
3680 =item B<Retain> B<false>|B<true> (Publish only)
3682 Controls whether the MQTT broker will retain (keep a copy of) the last message
3683 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
3685 =item B<StoreRates> B<true>|B<false> (Publish only)
3687 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
3688 before sending. Defaults to B<true>.
3690 =item B<CleanSession> B<true>|B<false> (Subscribe only)
3692 Controls whether the MQTT "cleans" the session up after the subscriber
3693 disconnects or if it maintains the subscriber's subscriptions and all messages
3694 that arrive while the subscriber is disconnected. Defaults to B<true>.
3696 =item B<Topic> I<TopicName> (Subscribe only)
3698 Configures the topic(s) to subscribe to. You can use the single level C<+> and
3699 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
3700 the B<collectd> branch.
3702 =item B<CACert> I<file>
3704 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
3705 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
3706 port of the MQTT broker.
3707 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3709 =item B<CertificateFile> I<file>
3711 Path to the PEM-encoded certificate file to use as client certificate when
3712 connecting to the MQTT broker.
3713 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3715 =item B<CertificateKeyFile> I<file>
3717 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
3718 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3720 =item B<TLSProtocol> I<protocol>
3722 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
3723 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
3724 version is used which depends on the version of OpenSSL the Mosquitto library
3727 =item B<CipherSuite> I<ciphersuite>
3729 A string describing the ciphers available for use. See L<ciphers(1)> and the
3730 C<openssl ciphers> utility for more information. If unset, the default ciphers
3736 =head2 Plugin C<mysql>
3738 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3739 one or more databases when started and keeps the connection up as long as
3740 possible. When the connection is interrupted for whatever reason it will try
3741 to re-connect. The plugin will complain loudly in case anything goes wrong.
3743 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3744 and collects information about MySQL network traffic, executed statements,
3745 requests, the query cache and threads by evaluating the
3746 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3747 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3748 Status Variables> for an explanation of these values.
3750 Optionally, master and slave statistics may be collected in a MySQL
3751 replication setup. In that case, information about the synchronization state
3752 of the nodes are collected by evaluating the C<Position> return value of the
3753 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3754 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3755 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3756 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3757 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3769 SSLKey "/path/to/key.pem"
3770 SSLCert "/path/to/cert.pem"
3771 SSLCA "/path/to/ca.pem"
3772 SSLCAPath "/path/to/cas/"
3773 SSLCipher "DHE-RSA-AES256-SHA"
3779 Socket "/var/run/mysql/mysqld.sock"
3781 SlaveNotifications true
3787 Socket "/var/run/mysql/mysqld.sock"
3792 A B<Database> block defines one connection to a MySQL database. It accepts a
3793 single argument which specifies the name of the database. None of the other
3794 options are required. MySQL will use default values as documented in the
3795 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
3796 B<MySQL reference manual>.
3800 =item B<Alias> I<Alias>
3802 Alias to use as sender instead of hostname when reporting. This may be useful
3803 when having cryptic hostnames.
3805 =item B<Host> I<Hostname>
3807 Hostname of the database server. Defaults to B<localhost>.
3809 =item B<User> I<Username>
3811 Username to use when connecting to the database. The user does not have to be
3812 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3813 unless you want to collectd replication statistics (see B<MasterStats> and
3814 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3815 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3817 =item B<Password> I<Password>
3819 Password needed to log into the database.
3821 =item B<Database> I<Database>
3823 Select this database. Defaults to I<no database> which is a perfectly reasonable
3824 option for what this plugin does.
3826 =item B<Port> I<Port>
3828 TCP-port to connect to. The port must be specified in its numeric form, but it
3829 must be passed as a string nonetheless. For example:
3833 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3834 See the documentation for the C<mysql_real_connect> function for details.
3836 =item B<Socket> I<Socket>
3838 Specifies the path to the UNIX domain socket of the MySQL server. This option
3839 only has any effect, if B<Host> is set to B<localhost> (the default).
3840 Otherwise, use the B<Port> option above. See the documentation for the
3841 C<mysql_real_connect> function for details.
3843 =item B<InnodbStats> I<true|false>
3845 If enabled, metrics about the InnoDB storage engine are collected.
3846 Disabled by default.
3848 =item B<MasterStats> I<true|false>
3850 =item B<SlaveStats> I<true|false>
3852 Enable the collection of master / slave statistics in a replication setup. In
3853 order to be able to get access to these statistics, the user needs special
3854 privileges. See the B<User> documentation above. Defaults to B<false>.
3856 =item B<SlaveNotifications> I<true|false>
3858 If enabled, the plugin sends a notification if the replication slave I/O and /
3859 or SQL threads are not running. Defaults to B<false>.
3861 =item B<WsrepStats> I<true|false>
3863 Enable the collection of wsrep plugin statistics, used in Master-Master
3864 replication setups like in MySQL Galera/Percona XtraDB Cluster.
3865 User needs only privileges to execute 'SHOW GLOBAL STATUS'
3867 =item B<ConnectTimeout> I<Seconds>
3869 Sets the connect timeout for the MySQL client.
3871 =item B<SSLKey> I<Path>
3873 If provided, the X509 key in PEM format.
3875 =item B<SSLCert> I<Path>
3877 If provided, the X509 cert in PEM format.
3879 =item B<SSLCA> I<Path>
3881 If provided, the CA file in PEM format (check OpenSSL docs).
3883 =item B<SSLCAPath> I<Path>
3885 If provided, the CA directory (check OpenSSL docs).
3887 =item B<SSLCipher> I<String>
3889 If provided, the SSL cipher to use.
3893 =head2 Plugin C<netapp>
3895 The netapp plugin can collect various performance and capacity information
3896 from a NetApp filer using the NetApp API.
3898 Please note that NetApp has a wide line of products and a lot of different
3899 software versions for each of these products. This plugin was developed for a
3900 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3901 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3902 model and software version but it is very hard to test this.
3903 If you have used this plugin with other models and/or software version, feel
3904 free to send us a mail to tell us about the results, even if it's just a short
3907 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3908 basic authentication.
3910 B<Do not use a regular user for this!> Create a special collectd user with just
3911 the minimum of capabilities needed. The user only needs the "login-http-admin"
3912 capability as well as a few more depending on which data will be collected.
3913 Required capabilities are documented below.
3918 <Host "netapp1.example.com">
3942 IgnoreSelectedIO false
3944 IgnoreSelectedOps false
3945 GetLatency "volume0"
3946 IgnoreSelectedLatency false
3953 IgnoreSelectedCapacity false
3956 IgnoreSelectedSnapshot false
3984 The netapp plugin accepts the following configuration options:
3988 =item B<Host> I<Name>
3990 A host block defines one NetApp filer. It will appear in collectd with the name
3991 you specify here which does not have to be its real name nor its hostname (see
3992 the B<Address> option below).
3994 =item B<VFiler> I<Name>
3996 A B<VFiler> block may only be used inside a host block. It accepts all the
3997 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3998 will execute all NetApp API commands in the context of the specified
3999 VFiler(R). It will appear in collectd with the name you specify here which
4000 does not have to be its real name. The VFiler name may be specified using the
4001 B<VFilerName> option. If this is not specified, it will default to the name
4004 The VFiler block inherits all connection related settings from the surrounding
4005 B<Host> block (which appear before the B<VFiler> block) but they may be
4006 overwritten inside the B<VFiler> block.
4008 This feature is useful, for example, when using a VFiler as SnapVault target
4009 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4010 available in the host filer (vfiler0) but only in the respective VFiler
4013 =item B<Protocol> B<httpd>|B<http>
4015 The protocol collectd will use to query this host.
4023 Valid options: http, https
4025 =item B<Address> I<Address>
4027 The hostname or IP address of the host.
4033 Default: The "host" block's name.
4035 =item B<Port> I<Port>
4037 The TCP port to connect to on the host.
4043 Default: 80 for protocol "http", 443 for protocol "https"
4045 =item B<User> I<User>
4047 =item B<Password> I<Password>
4049 The username and password to use to login to the NetApp.
4055 =item B<VFilerName> I<Name>
4057 The name of the VFiler in which context to execute API commands. If not
4058 specified, the name provided to the B<VFiler> block will be used instead.
4064 Default: name of the B<VFiler> block
4066 B<Note:> This option may only be used inside B<VFiler> blocks.
4068 =item B<Interval> I<Interval>
4074 The following options decide what kind of data will be collected. You can
4075 either use them as a block and fine tune various parameters inside this block,
4076 use them as a single statement to just accept all default values, or omit it to
4077 not collect any data.
4079 The following options are valid inside all blocks:
4083 =item B<Interval> I<Seconds>
4085 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4086 host specific setting.
4090 =head3 The System block
4092 This will collect various performance data about the whole system.
4094 B<Note:> To get this data the collectd user needs the
4095 "api-perf-object-get-instances" capability.
4099 =item B<Interval> I<Seconds>
4101 Collect disk statistics every I<Seconds> seconds.
4103 =item B<GetCPULoad> B<true>|B<false>
4105 If you set this option to true the current CPU usage will be read. This will be
4106 the average usage between all CPUs in your NetApp without any information about
4109 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4110 returns in the "CPU" field.
4118 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4120 =item B<GetInterfaces> B<true>|B<false>
4122 If you set this option to true the current traffic of the network interfaces
4123 will be read. This will be the total traffic over all interfaces of your NetApp
4124 without any information about individual interfaces.
4126 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4127 in the "Net kB/s" field.
4137 Result: One value list of type "if_octects".
4139 =item B<GetDiskIO> B<true>|B<false>
4141 If you set this option to true the current IO throughput will be read. This
4142 will be the total IO of your NetApp without any information about individual
4143 disks, volumes or aggregates.
4145 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4146 in the "DiskE<nbsp>kB/s" field.
4154 Result: One value list of type "disk_octets".
4156 =item B<GetDiskOps> B<true>|B<false>
4158 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4159 iSCSI, etc. operations will be read. This will be the total number of
4160 operations on your NetApp without any information about individual volumes or
4163 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4164 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4172 Result: A variable number of value lists of type "disk_ops_complex". Each type
4173 of operation will result in one value list with the name of the operation as
4178 =head3 The WAFL block
4180 This will collect various performance data about the WAFL file system. At the
4181 moment this just means cache performance.
4183 B<Note:> To get this data the collectd user needs the
4184 "api-perf-object-get-instances" capability.
4186 B<Note:> The interface to get these values is classified as "Diagnostics" by
4187 NetApp. This means that it is not guaranteed to be stable even between minor
4192 =item B<Interval> I<Seconds>
4194 Collect disk statistics every I<Seconds> seconds.
4196 =item B<GetNameCache> B<true>|B<false>
4204 Result: One value list of type "cache_ratio" and type instance
4207 =item B<GetDirCache> B<true>|B<false>
4215 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4217 =item B<GetInodeCache> B<true>|B<false>
4225 Result: One value list of type "cache_ratio" and type instance
4228 =item B<GetBufferCache> B<true>|B<false>
4230 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4231 in the "Cache hit" field.
4239 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4243 =head3 The Disks block
4245 This will collect performance data about the individual disks in the NetApp.
4247 B<Note:> To get this data the collectd user needs the
4248 "api-perf-object-get-instances" capability.
4252 =item B<Interval> I<Seconds>
4254 Collect disk statistics every I<Seconds> seconds.
4256 =item B<GetBusy> B<true>|B<false>
4258 If you set this option to true the busy time of all disks will be calculated
4259 and the value of the busiest disk in the system will be written.
4261 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4262 in the "Disk util" field. Probably.
4270 Result: One value list of type "percent" and type instance "disk_busy".
4274 =head3 The VolumePerf block
4276 This will collect various performance data about the individual volumes.
4278 You can select which data to collect about which volume using the following
4279 options. They follow the standard ignorelist semantic.
4281 B<Note:> To get this data the collectd user needs the
4282 I<api-perf-object-get-instances> capability.
4286 =item B<Interval> I<Seconds>
4288 Collect volume performance data every I<Seconds> seconds.
4290 =item B<GetIO> I<Volume>
4292 =item B<GetOps> I<Volume>
4294 =item B<GetLatency> I<Volume>
4296 Select the given volume for IO, operations or latency statistics collection.
4297 The argument is the name of the volume without the C</vol/> prefix.
4299 Since the standard ignorelist functionality is used here, you can use a string
4300 starting and ending with a slash to specify regular expression matching: To
4301 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4304 GetIO "/^vol[027]$/"
4306 If no regular expression is specified, an exact match is required. Both,
4307 regular and exact matching are case sensitive.
4309 If no volume was specified at all for either of the three options, that data
4310 will be collected for all available volumes.
4312 =item B<IgnoreSelectedIO> B<true>|B<false>
4314 =item B<IgnoreSelectedOps> B<true>|B<false>
4316 =item B<IgnoreSelectedLatency> B<true>|B<false>
4318 When set to B<true>, the volumes selected for IO, operations or latency
4319 statistics collection will be ignored and the data will be collected for all
4322 When set to B<false>, data will only be collected for the specified volumes and
4323 all other volumes will be ignored.
4325 If no volumes have been specified with the above B<Get*> options, all volumes
4326 will be collected regardless of the B<IgnoreSelected*> option.
4328 Defaults to B<false>
4332 =head3 The VolumeUsage block
4334 This will collect capacity data about the individual volumes.
4336 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4341 =item B<Interval> I<Seconds>
4343 Collect volume usage statistics every I<Seconds> seconds.
4345 =item B<GetCapacity> I<VolumeName>
4347 The current capacity of the volume will be collected. This will result in two
4348 to four value lists, depending on the configuration of the volume. All data
4349 sources are of type "df_complex" with the name of the volume as
4352 There will be type_instances "used" and "free" for the number of used and
4353 available bytes on the volume. If the volume has some space reserved for
4354 snapshots, a type_instance "snap_reserved" will be available. If the volume
4355 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4356 number of bytes saved by the SIS feature.
4358 B<Note:> The current NetApp API has a bug that results in this value being
4359 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4360 number which works most of the time. If you see strange values here, bug
4361 NetApp support to fix this.
4363 Repeat this option to specify multiple volumes.
4365 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4367 Specify whether to collect only the volumes selected by the B<GetCapacity>
4368 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4369 B<false>. However, if no B<GetCapacity> option is specified at all, all
4370 capacities will be selected anyway.
4372 =item B<GetSnapshot> I<VolumeName>
4374 Select volumes from which to collect snapshot information.
4376 Usually, the space used for snapshots is included in the space reported as
4377 "used". If snapshot information is collected as well, the space used for
4378 snapshots is subtracted from the used space.
4380 To make things even more interesting, it is possible to reserve space to be
4381 used for snapshots. If the space required for snapshots is less than that
4382 reserved space, there is "reserved free" and "reserved used" space in addition
4383 to "free" and "used". If the space required for snapshots exceeds the reserved
4384 space, that part allocated in the normal space is subtracted from the "used"
4387 Repeat this option to specify multiple volumes.
4389 =item B<IgnoreSelectedSnapshot>
4391 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4392 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4393 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4394 capacities will be selected anyway.
4398 =head3 The Quota block
4400 This will collect (tree) quota statistics (used disk space and number of used
4401 files). This mechanism is useful to get usage information for single qtrees.
4402 In case the quotas are not used for any other purpose, an entry similar to the
4403 following in C</etc/quotas> would be sufficient:
4405 /vol/volA/some_qtree tree - - - - -
4407 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4411 =item B<Interval> I<Seconds>
4413 Collect SnapVault(R) statistics every I<Seconds> seconds.
4417 =head3 The SnapVault block
4419 This will collect statistics about the time and traffic of SnapVault(R)
4424 =item B<Interval> I<Seconds>
4426 Collect SnapVault(R) statistics every I<Seconds> seconds.
4430 =head2 Plugin C<netlink>
4432 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4433 statistics of various interface and routing aspects.
4437 =item B<Interface> I<Interface>
4439 =item B<VerboseInterface> I<Interface>
4441 Instruct the plugin to collect interface statistics. This is basically the same
4442 as the statistics provided by the C<interface> plugin (see above) but
4443 potentially much more detailed.
4445 When configuring with B<Interface> only the basic statistics will be collected,
4446 namely octets, packets, and errors. These statistics are collected by
4447 the C<interface> plugin, too, so using both at the same time is no benefit.
4449 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4450 so that no data needs to be collected twice if you use the C<interface> plugin.
4451 This includes dropped packets, received multicast packets, collisions and a
4452 whole zoo of differentiated RX and TX errors. You can try the following command
4453 to get an idea of what awaits you:
4457 If I<Interface> is B<All>, all interfaces will be selected.
4459 =item B<QDisc> I<Interface> [I<QDisc>]
4461 =item B<Class> I<Interface> [I<Class>]
4463 =item B<Filter> I<Interface> [I<Filter>]
4465 Collect the octets and packets that pass a certain qdisc, class or filter.
4467 QDiscs and classes are identified by their type and handle (or classid).
4468 Filters don't necessarily have a handle, therefore the parent's handle is used.
4469 The notation used in collectd differs from that used in tc(1) in that it
4470 doesn't skip the major or minor number if it's zero and doesn't print special
4471 ids by their name. So, for example, a qdisc may be identified by
4472 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4473 thus not displayed by tc(1).
4475 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4476 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4477 associated with that interface will be collected.
4479 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4480 used. This may lead to problems when more than one filter is attached to a
4481 qdisc or class. This isn't nice, but we don't know how this could be done any
4482 better. If you have a idea, please don't hesitate to tell us.
4484 As with the B<Interface> option you can specify B<All> as the interface,
4485 meaning all interfaces.
4487 Here are some examples to help you understand the above text more easily:
4490 VerboseInterface "All"
4491 QDisc "eth0" "pfifo_fast-1:0"
4493 Class "ppp0" "htb-1:10"
4494 Filter "ppp0" "u32-1:0"
4497 =item B<IgnoreSelected>
4499 The behavior is the same as with all other similar plugins: If nothing is
4500 selected at all, everything is collected. If some things are selected using the
4501 options described above, only these statistics are collected. If you set
4502 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4503 specified statistics will not be collected.
4507 =head2 Plugin C<network>
4509 The Network plugin sends data to a remote instance of collectd, receives data
4510 from a remote instance, or both at the same time. Data which has been received
4511 from the network is usually not transmitted again, but this can be activated, see
4512 the B<Forward> option below.
4514 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4515 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4517 Both, B<Server> and B<Listen> can be used as single option or as block. When
4518 used as block, given options are valid for this socket only. The following
4519 example will export the metrics twice: Once to an "internal" server (without
4520 encryption and signing) and one to an external server (with cryptographic
4524 # Export to an internal server
4525 # (demonstrates usage without additional options)
4526 Server "collectd.internal.tld"
4528 # Export to an external server
4529 # (demonstrates usage with signature options)
4530 <Server "collectd.external.tld">
4531 SecurityLevel "sign"
4532 Username "myhostname"
4539 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4541 The B<Server> statement/block sets the server to send datagrams to. The
4542 statement may occur multiple times to send each datagram to multiple
4545 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
4546 optional second argument specifies a port number or a service name. If not
4547 given, the default, B<25826>, is used.
4549 The following options are recognized within B<Server> blocks:
4553 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4555 Set the security you require for network communication. When the security level
4556 has been set to B<Encrypt>, data sent over the network will be encrypted using
4557 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4558 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4559 authentication code. When set to B<None>, data is sent without any security.
4561 This feature is only available if the I<network> plugin was linked with
4564 =item B<Username> I<Username>
4566 Sets the username to transmit. This is used by the server to lookup the
4567 password. See B<AuthFile> below. All security levels except B<None> require
4570 This feature is only available if the I<network> plugin was linked with
4573 =item B<Password> I<Password>
4575 Sets a password (shared secret) for this socket. All security levels except
4576 B<None> require this setting.
4578 This feature is only available if the I<network> plugin was linked with
4581 =item B<Interface> I<Interface name>
4583 Set the outgoing interface for IP packets. This applies at least
4584 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4585 undefined or a non-existent interface name is specified, the default
4586 behavior is to let the kernel choose the appropriate interface. Be warned
4587 that the manual selection of an interface for unicast traffic is only
4588 necessary in rare cases.
4590 =item B<ResolveInterval> I<Seconds>
4592 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4593 useful to force a regular DNS lookup to support a high availability setup. If
4594 not specified, re-resolves are never attempted.
4598 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4600 The B<Listen> statement sets the interfaces to bind to. When multiple
4601 statements are found the daemon will bind to multiple interfaces.
4603 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4604 the argument is a multicast address the daemon will join that multicast group.
4605 The optional second argument specifies a port number or a service name. If not
4606 given, the default, B<25826>, is used.
4608 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4612 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4614 Set the security you require for network communication. When the security level
4615 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4616 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4617 signed and encrypted data is accepted. When set to B<None>, all data will be
4618 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4619 decrypted if possible.
4621 This feature is only available if the I<network> plugin was linked with
4624 =item B<AuthFile> I<Filename>
4626 Sets a file in which usernames are mapped to passwords. These passwords are
4627 used to verify signatures and to decrypt encrypted network packets. If
4628 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4629 verified and encrypted packets are decrypted. Otherwise, signed data is
4630 accepted without checking the signature and encrypted data cannot be decrypted.
4631 For the other security levels this option is mandatory.
4633 The file format is very simple: Each line consists of a username followed by a
4634 colon and any number of spaces followed by the password. To demonstrate, an
4635 example file could look like this:
4640 Each time a packet is received, the modification time of the file is checked
4641 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4642 the file is being read, it is locked using L<fcntl(2)>.
4644 =item B<Interface> I<Interface name>
4646 Set the incoming interface for IP packets explicitly. This applies at least
4647 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4648 undefined or a non-existent interface name is specified, the default
4649 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4650 traffic gets only accepted, if it arrives on the given interface.
4654 =item B<TimeToLive> I<1-255>
4656 Set the time-to-live of sent packets. This applies to all, unicast and
4657 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4658 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4661 =item B<MaxPacketSize> I<1024-65535>
4663 Set the maximum size for datagrams received over the network. Packets larger
4664 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4665 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4668 On the server side, this limit should be set to the largest value used on
4669 I<any> client. Likewise, the value on the client must not be larger than the
4670 value on the server, or data will be lost.
4672 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4673 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4674 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4677 =item B<Forward> I<true|false>
4679 If set to I<true>, write packets that were received via the network plugin to
4680 the sending sockets. This should only be activated when the B<Listen>- and
4681 B<Server>-statements differ. Otherwise packets may be send multiple times to
4682 the same multicast group. While this results in more network traffic than
4683 necessary it's not a huge problem since the plugin has a duplicate detection,
4684 so the values will not loop.
4686 =item B<ReportStats> B<true>|B<false>
4688 The network plugin cannot only receive and send statistics, it can also create
4689 statistics about itself. Collected data included the number of received and
4690 sent octets and packets, the length of the receive queue and the number of
4691 values handled. When set to B<true>, the I<Network plugin> will make these
4692 statistics available. Defaults to B<false>.
4696 =head2 Plugin C<nginx>
4698 This plugin collects the number of connections and requests handled by the
4699 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4700 queries the page provided by the C<ngx_http_stub_status_module> module, which
4701 isn't compiled by default. Please refer to
4702 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4703 how to compile and configure nginx and this module.
4705 The following options are accepted by the C<nginx plugin>:
4709 =item B<URL> I<http://host/nginx_status>
4711 Sets the URL of the C<ngx_http_stub_status_module> output.
4713 =item B<User> I<Username>
4715 Optional user name needed for authentication.
4717 =item B<Password> I<Password>
4719 Optional password needed for authentication.
4721 =item B<VerifyPeer> B<true|false>
4723 Enable or disable peer SSL certificate verification. See
4724 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4726 =item B<VerifyHost> B<true|false>
4728 Enable or disable peer host name verification. If enabled, the plugin checks
4729 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4730 certificate matches the host name provided by the B<URL> option. If this
4731 identity check fails, the connection is aborted. Obviously, only works when
4732 connecting to a SSL enabled server. Enabled by default.
4734 =item B<CACert> I<File>
4736 File that holds one or more SSL certificates. If you want to use HTTPS you will
4737 possibly need this option. What CA certificates come bundled with C<libcurl>
4738 and are checked by default depends on the distribution you use.
4740 =item B<Timeout> I<Milliseconds>
4742 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4743 milliseconds. By default, the configured B<Interval> is used to set the
4748 =head2 Plugin C<notify_desktop>
4750 This plugin sends a desktop notification to a notification daemon, as defined
4751 in the Desktop Notification Specification. To actually display the
4752 notifications, B<notification-daemon> is required and B<collectd> has to be
4753 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4754 environment variables have to be set correctly) and the D-Bus message bus.
4756 The Desktop Notification Specification can be found at
4757 L<http://www.galago-project.org/specs/notification/>.
4761 =item B<OkayTimeout> I<timeout>
4763 =item B<WarningTimeout> I<timeout>
4765 =item B<FailureTimeout> I<timeout>
4767 Set the I<timeout>, in milliseconds, after which to expire the notification
4768 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4769 been specified, the displayed notification will not be closed at all - the
4770 user has to do so herself. These options default to 5000. If a negative number
4771 has been specified, the default is used as well.
4775 =head2 Plugin C<notify_email>
4777 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4778 configured email address.
4780 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4782 Available configuration options:
4786 =item B<From> I<Address>
4788 Email address from which the emails should appear to come from.
4790 Default: C<root@localhost>
4792 =item B<Recipient> I<Address>
4794 Configures the email address(es) to which the notifications should be mailed.
4795 May be repeated to send notifications to multiple addresses.
4797 At least one B<Recipient> must be present for the plugin to work correctly.
4799 =item B<SMTPServer> I<Hostname>
4801 Hostname of the SMTP server to connect to.
4803 Default: C<localhost>
4805 =item B<SMTPPort> I<Port>
4807 TCP port to connect to.
4811 =item B<SMTPUser> I<Username>
4813 Username for ASMTP authentication. Optional.
4815 =item B<SMTPPassword> I<Password>
4817 Password for ASMTP authentication. Optional.
4819 =item B<Subject> I<Subject>
4821 Subject-template to use when sending emails. There must be exactly two
4822 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4823 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4826 Default: C<Collectd notify: %s@%s>
4830 =head2 Plugin C<notify_nagios>
4832 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
4833 a I<passive service check result>.
4835 Available configuration options:
4839 =item B<CommandFile> I<Path>
4841 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
4845 =head2 Plugin C<ntpd>
4847 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
4850 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
4851 the wire - using B<mode 7> specific requests. This mode is deprecated with
4852 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
4853 correctly with them, the ntp daemon must be explicitly configured to
4854 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
4855 manual page for details.
4857 Available configuration options for the C<ntpd> plugin:
4861 =item B<Host> I<Hostname>
4863 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4865 =item B<Port> I<Port>
4867 UDP-Port to connect to. Defaults to B<123>.
4869 =item B<ReverseLookups> B<true>|B<false>
4871 Sets whether or not to perform reverse lookups on peers. Since the name or
4872 IP-address may be used in a filename it is recommended to disable reverse
4873 lookups. The default is to do reverse lookups to preserve backwards
4874 compatibility, though.
4876 =item B<IncludeUnitID> B<true>|B<false>
4878 When a peer is a refclock, include the unit ID in the I<type instance>.
4879 Defaults to B<false> for backward compatibility.
4881 If two refclock peers use the same driver and this is B<false>, the plugin will
4882 try to write simultaneous measurements from both to the same type instance.
4883 This will result in error messages in the log and only one set of measurements
4888 =head2 Plugin C<nut>
4892 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4894 Add a UPS to collect data from. The format is identical to the one accepted by
4899 =head2 Plugin C<olsrd>
4901 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4902 the Optimized Link State Routing daemon and reads information about the current
4903 state of the meshed network.
4905 The following configuration options are understood:
4909 =item B<Host> I<Host>
4911 Connect to I<Host>. Defaults to B<"localhost">.
4913 =item B<Port> I<Port>
4915 Specifies the port to connect to. This must be a string, even if you give the
4916 port as a number rather than a service name. Defaults to B<"2006">.
4918 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4920 Specifies what information to collect about links, i.E<nbsp>e. direct
4921 connections of the daemon queried. If set to B<No>, no information is
4922 collected. If set to B<Summary>, the number of links and the average of all
4923 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4924 If set to B<Detail> LQ and NLQ are collected per link.
4926 Defaults to B<Detail>.
4928 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4930 Specifies what information to collect about routes of the daemon queried. If
4931 set to B<No>, no information is collected. If set to B<Summary>, the number of
4932 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4933 metric and ETX are collected per route.
4935 Defaults to B<Summary>.
4937 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4939 Specifies what information to collect about the global topology. If set to
4940 B<No>, no information is collected. If set to B<Summary>, the number of links
4941 in the entire topology and the average I<link quality> (LQ) is calculated.
4942 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4944 Defaults to B<Summary>.
4948 =head2 Plugin C<onewire>
4950 B<EXPERIMENTAL!> See notes below.
4952 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4953 L<http://owfs.org/> to read sensors connected via the onewire bus.
4955 It can be used in two possible modes - standard or advanced.
4957 In the standard mode only temperature sensors (sensors with the family code
4958 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4959 other sensors you would like to have included, please send a sort request to
4960 the mailing list. You can select sensors to be read or to be ignored depending
4961 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4962 walked and all sensors are read.
4964 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4965 experimental, below.
4967 In the advanced mode you can configure any sensor to be read (only numerical
4968 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4969 In this mode you have to list all the sensors. Neither default bus walk nor
4970 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4971 the path automatically and should produce compatible structure with the "standard"
4972 mode (basically the path is expected as for example
4973 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4974 "F10FCA000800" and the rest after the slash is considered the type - here
4976 There are two advantages to this mode - you can access virtually any sensor
4977 (not just temperature), select whether to use cached or directly read values
4978 and it is slighlty faster. The downside is more complex configuration.
4980 The two modes are distinguished automatically by the format of the address.
4981 It is not possible to mix the two modes. Once a full path is detected in any
4982 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4983 (and as standard addresses will fail parsing they will be ignored).
4987 =item B<Device> I<Device>
4989 Sets the device to read the values from. This can either be a "real" hardware
4990 device, such as a serial port or an USB port, or the address of the
4991 L<owserver(1)> socket, usually B<localhost:4304>.
4993 Though the documentation claims to automatically recognize the given address
4994 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4995 with that version, the following configuration worked for us:
4998 Device "-s localhost:4304"
5001 This directive is B<required> and does not have a default value.
5003 =item B<Sensor> I<Sensor>
5005 In the standard mode selects sensors to collect or to ignore
5006 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5007 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5008 and B<not> include the leading C<10.> family byte and point.
5009 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5010 sensors (see above) are read.
5012 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5013 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5014 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5016 As there can be multiple devices on the bus you can list multiple sensor (use
5017 multiple B<Sensor> elements).
5019 =item B<IgnoreSelected> I<true>|I<false>
5021 If no configuration is given, the B<onewire> plugin will collect data from all
5022 sensors found. This may not be practical, especially if sensors are added and
5023 removed regularly. Sometimes, however, it's easier/preferred to collect only
5024 specific sensors or all sensors I<except> a few specified ones. This option
5025 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5026 B<Sensor> is inverted: All selected interfaces are ignored and all other
5027 interfaces are collected.
5029 Used only in the standard mode - see above.
5031 =item B<Interval> I<Seconds>
5033 Sets the interval in which all sensors should be read. If not specified, the
5034 global B<Interval> setting is used.
5038 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5039 work with big setups. It works with one sensor being attached to one
5040 controller, but as soon as you throw in a couple more senors and maybe a hub
5041 or two, reading all values will take more than ten seconds (the default
5042 interval). We will probably add some separate thread for reading the sensors
5043 and some cache or something like that, but it's not done yet. We will try to
5044 maintain backwards compatibility in the future, but we can't promise. So in
5045 short: If it works for you: Great! But keep in mind that the config I<might>
5046 change, though this is unlikely. Oh, and if you want to help improving this
5047 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5049 =head2 Plugin C<openldap>
5051 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5052 server correctly. The backend database C<monitor> needs to be loaded and
5053 working. See slapd-monitor(5) for the details.
5055 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5056 blocks. Each block requires one string argument as the instance name. For
5061 URL "ldap://localhost/"
5064 URL "ldaps://localhost/"
5068 The instance name will be used as the I<plugin instance>. To emulate the old
5069 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5070 plugin to work correctly, each instance name must be unique. This is not
5071 enforced by the plugin and it is your responsibility to ensure it is.
5073 The following options are accepted within each B<Instance> block:
5077 =item B<URL> I<ldap://host/binddn>
5079 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5082 =item B<BindDN> I<BindDN>
5084 Name in the form of an LDAP distinguished name intended to be used for
5085 authentication. Defaults to empty string to establish an anonymous authorization.
5087 =item B<Password> I<Password>
5089 Password for simple bind authentication. If this option is not set,
5090 unauthenticated bind operation is used.
5092 =item B<StartTLS> B<true|false>
5094 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5095 Disabled by default.
5097 =item B<VerifyHost> B<true|false>
5099 Enables or disables peer host name verification. If enabled, the plugin checks
5100 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5101 certificate matches the host name provided by the B<URL> option. If this
5102 identity check fails, the connection is aborted. Enabled by default.
5104 =item B<CACert> I<File>
5106 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5107 may possibly need this option. What CA certificates are checked by default
5108 depends on the distribution you use and can be changed with the usual ldap
5109 client configuration mechanisms. See ldap.conf(5) for the details.
5111 =item B<Timeout> I<Seconds>
5113 Sets the timeout value for ldap operations, in seconds. By default, the
5114 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5117 =item B<Version> I<Version>
5119 An integer which sets the LDAP protocol version number to use when connecting
5120 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5124 =head2 Plugin C<openvpn>
5126 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5127 traffic statistics about connected clients.
5129 To set up OpenVPN to write to the status file periodically, use the
5130 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
5131 you need to set the required format, too. This is done by setting
5132 B<--status-version> to B<2>.
5134 So, in a nutshell you need:
5136 openvpn $OTHER_OPTIONS \
5137 --status "/var/run/openvpn-status" 10 \
5144 =item B<StatusFile> I<File>
5146 Specifies the location of the status file.
5148 =item B<ImprovedNamingSchema> B<true>|B<false>
5150 When enabled, the filename of the status file will be used as plugin instance
5151 and the client's "common name" will be used as type instance. This is required
5152 when reading multiple status files. Enabling this option is recommended, but to
5153 maintain backwards compatibility this option is disabled by default.
5155 =item B<CollectCompression> B<true>|B<false>
5157 Sets whether or not statistics about the compression used by OpenVPN should be
5158 collected. This information is only available in I<single> mode. Enabled by
5161 =item B<CollectIndividualUsers> B<true>|B<false>
5163 Sets whether or not traffic information is collected for each connected client
5164 individually. If set to false, currently no traffic data is collected at all
5165 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5167 =item B<CollectUserCount> B<true>|B<false>
5169 When enabled, the number of currently connected clients or users is collected.
5170 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5171 can be configured independently from that option. Defaults to B<false>.
5175 =head2 Plugin C<oracle>
5177 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5178 Oracle® Database and lets you execute SQL statements there. It is very similar
5179 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5180 plugin's documentation above for details.
5183 <Query "out_of_stock">
5184 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5187 # InstancePrefix "foo"
5188 InstancesFrom "category"
5192 <Database "product_information">
5196 Query "out_of_stock"
5200 =head3 B<Query> blocks
5202 The Query blocks are handled identically to the Query blocks of the "dbi"
5203 plugin. Please see its documentation above for details on how to specify
5206 =head3 B<Database> blocks
5208 Database blocks define a connection to a database and which queries should be
5209 sent to that database. Each database needs a "name" as string argument in the
5210 starting tag of the block. This name will be used as "PluginInstance" in the
5211 values submitted to the daemon. Other than that, that name is not used.
5215 =item B<ConnectID> I<ID>
5217 Defines the "database alias" or "service name" to connect to. Usually, these
5218 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5220 =item B<Host> I<Host>
5222 Hostname to use when dispatching values for this database. Defaults to using
5223 the global hostname of the I<collectd> instance.
5225 =item B<Username> I<Username>
5227 Username used for authentication.
5229 =item B<Password> I<Password>
5231 Password used for authentication.
5233 =item B<Query> I<QueryName>
5235 Associates the query named I<QueryName> with this database connection. The
5236 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5237 blocks you want to refer to must be placed above the database block you want to
5242 =head2 Plugin C<perl>
5244 This plugin embeds a Perl-interpreter into collectd and provides an interface
5245 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
5247 =head2 Plugin C<pinba>
5249 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
5250 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
5251 PHP-based webpage has been delivered, the extension will send a UDP packet
5252 containing timing information, peak memory usage and so on. The plugin will
5253 wait for such packets, parse them and account the provided information, which
5254 is then dispatched to the daemon once per interval.
5261 # Overall statistics for the website.
5263 Server "www.example.com"
5265 # Statistics for www-a only
5267 Host "www-a.example.com"
5268 Server "www.example.com"
5270 # Statistics for www-b only
5272 Host "www-b.example.com"
5273 Server "www.example.com"
5277 The plugin provides the following configuration options:
5281 =item B<Address> I<Node>
5283 Configures the address used to open a listening socket. By default, plugin will
5284 bind to the I<any> address C<::0>.
5286 =item B<Port> I<Service>
5288 Configures the port (service) to bind to. By default the default Pinba port
5289 "30002" will be used. The option accepts service names in addition to port
5290 numbers and thus requires a I<string> argument.
5292 =item E<lt>B<View> I<Name>E<gt> block
5294 The packets sent by the Pinba extension include the hostname of the server, the
5295 server name (the name of the virtual host) and the script that was executed.
5296 Using B<View> blocks it is possible to separate the data into multiple groups
5297 to get more meaningful statistics. Each packet is added to all matching groups,
5298 so that a packet may be accounted for more than once.
5302 =item B<Host> I<Host>
5304 Matches the hostname of the system the webserver / script is running on. This
5305 will contain the result of the L<gethostname(2)> system call. If not
5306 configured, all hostnames will be accepted.
5308 =item B<Server> I<Server>
5310 Matches the name of the I<virtual host>, i.e. the contents of the
5311 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
5312 server names will be accepted.
5314 =item B<Script> I<Script>
5316 Matches the name of the I<script name>, i.e. the contents of the
5317 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
5318 script names will be accepted.
5324 =head2 Plugin C<ping>
5326 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
5327 configured hosts periodically and measures the network latency. Whenever the
5328 C<read> function of the plugin is called, it submits the average latency, the
5329 standard deviation and the drop rate for each host.
5331 Available configuration options:
5335 =item B<Host> I<IP-address>
5337 Host to ping periodically. This option may be repeated several times to ping
5340 =item B<Interval> I<Seconds>
5342 Sets the interval in which to send ICMP echo packets to the configured hosts.
5343 This is B<not> the interval in which statistics are queries from the plugin but
5344 the interval in which the hosts are "pinged". Therefore, the setting here
5345 should be smaller than or equal to the global B<Interval> setting. Fractional
5346 times, such as "1.24" are allowed.
5350 =item B<Timeout> I<Seconds>
5352 Time to wait for a response from the host to which an ICMP packet had been
5353 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
5354 to be down or the packet to be dropped. This setting must be smaller than the
5355 B<Interval> setting above for the plugin to work correctly. Fractional
5356 arguments are accepted.
5360 =item B<TTL> I<0-255>
5362 Sets the Time-To-Live of generated ICMP packets.
5364 =item B<Size> I<size>
5366 Sets the size of the data payload in ICMP packet to specified I<size> (it
5367 will be filled with regular ASCII pattern). If not set, default 56 byte
5368 long string is used so that the packet size of an ICMPv4 packet is exactly
5369 64 bytes, similar to the behaviour of normal ping(1) command.
5371 =item B<SourceAddress> I<host>
5373 Sets the source address to use. I<host> may either be a numerical network
5374 address or a network hostname.
5376 =item B<Device> I<name>
5378 Sets the outgoing network device to be used. I<name> has to specify an
5379 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
5382 =item B<MaxMissed> I<Packets>
5384 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
5385 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
5387 Default: B<-1> (disabled)
5391 =head2 Plugin C<postgresql>
5393 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
5394 keeps a persistent connection to all configured databases and tries to
5395 reconnect if the connection has been interrupted. A database is configured by
5396 specifying a B<Database> block as described below. The default statistics are
5397 collected from PostgreSQL's B<statistics collector> which thus has to be
5398 enabled for this plugin to work correctly. This should usually be the case by
5399 default. See the section "The Statistics Collector" of the B<PostgreSQL
5400 Documentation> for details.
5402 By specifying custom database queries using a B<Query> block as described
5403 below, you may collect any data that is available from some PostgreSQL
5404 database. This way, you are able to access statistics of external daemons
5405 which are available in a PostgreSQL database or use future or special
5406 statistics provided by PostgreSQL without the need to upgrade your collectd
5409 Starting with version 5.2, the C<postgresql> plugin supports writing data to
5410 PostgreSQL databases as well. This has been implemented in a generic way. You
5411 need to specify an SQL statement which will then be executed by collectd in
5412 order to write the data (see below for details). The benefit of that approach
5413 is that there is no fixed database layout. Rather, the layout may be optimized
5414 for the current setup.
5416 The B<PostgreSQL Documentation> manual can be found at
5417 L<http://www.postgresql.org/docs/manuals/>.
5421 Statement "SELECT magic FROM wizard WHERE host = $1;"
5425 InstancePrefix "magic"
5430 <Query rt36_tickets>
5431 Statement "SELECT COUNT(type) AS count, type \
5433 WHEN resolved = 'epoch' THEN 'open' \
5434 ELSE 'resolved' END AS type \
5435 FROM tickets) type \
5439 InstancePrefix "rt36_tickets"
5440 InstancesFrom "type"
5446 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
5456 KRBSrvName "kerberos_service_name"
5462 Service "service_name"
5463 Query backend # predefined
5474 The B<Query> block defines one database query which may later be used by a
5475 database definition. It accepts a single mandatory argument which specifies
5476 the name of the query. The names of all queries have to be unique (see the
5477 B<MinVersion> and B<MaxVersion> options below for an exception to this
5480 In each B<Query> block, there is one or more B<Result> blocks. Multiple
5481 B<Result> blocks may be used to extract multiple values from a single query.
5483 The following configuration options are available to define the query:
5487 =item B<Statement> I<sql query statement>
5489 Specify the I<sql query statement> which the plugin should execute. The string
5490 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
5491 first, second, etc. parameter. The value of the parameters is specified by the
5492 B<Param> configuration option - see below for details. To include a literal
5493 B<$> character followed by a number, surround it with single quotes (B<'>).
5495 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
5496 allowed. Note, however, that only a single command may be used. Semicolons are
5497 allowed as long as a single non-empty command has been specified only.
5499 The returned lines will be handled separately one after another.
5501 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
5503 Specify the parameters which should be passed to the SQL query. The parameters
5504 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
5505 they appear in the configuration file. The value of the parameter is
5506 determined depending on the value of the B<Param> option as follows:
5512 The configured hostname of the database connection. If a UNIX domain socket is
5513 used, the parameter expands to "localhost".
5517 The name of the database of the current connection.
5521 The name of the database plugin instance. See the B<Instance> option of the
5522 database specification below for details.
5526 The username used to connect to the database.
5530 The interval with which this database is queried (as specified by the database
5531 specific or global B<Interval> options).
5535 Please note that parameters are only supported by PostgreSQL's protocol
5536 version 3 and above which was introduced in version 7.4 of PostgreSQL.
5538 =item B<PluginInstanceFrom> I<column>
5540 Specify how to create the "PluginInstance" for reporting this query results.
5541 Only one column is supported. You may concatenate fields and string values in
5542 the query statement to get the required results.
5544 =item B<MinVersion> I<version>
5546 =item B<MaxVersion> I<version>
5548 Specify the minimum or maximum version of PostgreSQL that this query should be
5549 used with. Some statistics might only be available with certain versions of
5550 PostgreSQL. This allows you to specify multiple queries with the same name but
5551 which apply to different versions, thus allowing you to use the same
5552 configuration in a heterogeneous environment.
5554 The I<version> has to be specified as the concatenation of the major, minor
5555 and patch-level versions, each represented as two-decimal-digit numbers. For
5556 example, version 8.2.3 will become 80203.
5560 The B<Result> block defines how to handle the values returned from the query.
5561 It defines which column holds which value and how to dispatch that value to
5566 =item B<Type> I<type>
5568 The I<type> name to be used when dispatching the values. The type describes
5569 how to handle the data and where to store it. See L<types.db(5)> for more
5570 details on types and their configuration. The number and type of values (as
5571 selected by the B<ValuesFrom> option) has to match the type of the given name.
5573 This option is mandatory.
5575 =item B<InstancePrefix> I<prefix>
5577 =item B<InstancesFrom> I<column0> [I<column1> ...]
5579 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
5580 B<InstancePrefix> defines a static prefix that will be prepended to all type
5581 instances. B<InstancesFrom> defines the column names whose values will be used
5582 to create the type instance. Multiple values will be joined together using the
5583 hyphen (C<->) as separation character.
5585 The plugin itself does not check whether or not all built instances are
5586 different. It is your responsibility to assure that each is unique.
5588 Both options are optional. If none is specified, the type instance will be
5591 =item B<ValuesFrom> I<column0> [I<column1> ...]
5593 Names the columns whose content is used as the actual data for the data sets
5594 that are dispatched to the daemon. How many such columns you need is
5595 determined by the B<Type> setting as explained above. If you specify too many
5596 or not enough columns, the plugin will complain about that and no data will be
5597 submitted to the daemon.
5599 The actual data type, as seen by PostgreSQL, is not that important as long as
5600 it represents numbers. The plugin will automatically cast the values to the
5601 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
5602 L<strtod(3)> functions, so anything supported by those functions is supported
5603 by the plugin as well.
5605 This option is required inside a B<Result> block and may be specified multiple
5606 times. If multiple B<ValuesFrom> options are specified, the columns are read
5611 The following predefined queries are available (the definitions can be found
5612 in the F<postgresql_default.conf> file which, by default, is available at
5613 C<I<prefix>/share/collectd/>):
5619 This query collects the number of backends, i.E<nbsp>e. the number of
5622 =item B<transactions>
5624 This query collects the numbers of committed and rolled-back transactions of
5629 This query collects the numbers of various table modifications (i.E<nbsp>e.
5630 insertions, updates, deletions) of the user tables.
5632 =item B<query_plans>
5634 This query collects the numbers of various table scans and returned tuples of
5637 =item B<table_states>
5639 This query collects the numbers of live and dead rows in the user tables.
5643 This query collects disk block access counts for user tables.
5647 This query collects the on-disk size of the database in bytes.
5651 In addition, the following detailed queries are available by default. Please
5652 note that each of those queries collects information B<by table>, thus,
5653 potentially producing B<a lot> of data. For details see the description of the
5654 non-by_table queries above.
5658 =item B<queries_by_table>
5660 =item B<query_plans_by_table>
5662 =item B<table_states_by_table>
5664 =item B<disk_io_by_table>
5668 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5669 mandatory argument specifying the name of the writer. This will then be used
5670 in the B<Database> specification in order to activate the writer instance. The
5671 names of all writers have to be unique. The following options may be
5676 =item B<Statement> I<sql statement>
5678 This mandatory option specifies the SQL statement that will be executed for
5679 each submitted value. A single SQL statement is allowed only. Anything after
5680 the first semicolon will be ignored.
5682 Nine parameters will be passed to the statement and should be specified as
5683 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5684 values are made available through those parameters:
5690 The timestamp of the queried value as a floating point number.
5694 The hostname of the queried value.
5698 The plugin name of the queried value.
5702 The plugin instance of the queried value. This value may be B<NULL> if there
5703 is no plugin instance.
5707 The type of the queried value (cf. L<types.db(5)>).
5711 The type instance of the queried value. This value may be B<NULL> if there is
5716 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5717 sources of the submitted value-list).
5721 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5722 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5723 B<StoreRates> is enabled (which is the default, see below), all types will be
5728 An array of the submitted values. The dimensions of the value name and value
5733 In general, it is advisable to create and call a custom function in the
5734 PostgreSQL database for this purpose. Any procedural language supported by
5735 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5738 =item B<StoreRates> B<false>|B<true>
5740 If set to B<true> (the default), convert counter values to rates. If set to
5741 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5746 The B<Database> block defines one PostgreSQL database for which to collect
5747 statistics. It accepts a single mandatory argument which specifies the
5748 database name. None of the other options are required. PostgreSQL will use
5749 default values as documented in the section "CONNECTING TO A DATABASE" in the
5750 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5751 the user collectd is run as and special environment variables. See the manpage
5756 =item B<Interval> I<seconds>
5758 Specify the interval with which the database should be queried. The default is
5759 to use the global B<Interval> setting.
5761 =item B<CommitInterval> I<seconds>
5763 This option may be used for database connections which have "writers" assigned
5764 (see above). If specified, it causes a writer to put several updates into a
5765 single transaction. This transaction will last for the specified amount of
5766 time. By default, each update will be executed in a separate transaction. Each
5767 transaction generates a fair amount of overhead which can, thus, be reduced by
5768 activating this option. The draw-back is, that data covering the specified
5769 amount of time will be lost, for example, if a single statement within the
5770 transaction fails or if the database server crashes.
5772 =item B<Instance> I<name>
5774 Specify the plugin instance name that should be used instead of the database
5775 name (which is the default, if this option has not been specified). This
5776 allows to query multiple databases of the same name on the same host (e.g.
5777 when running multiple database server versions in parallel).
5778 The plugin instance name can also be set from the query result using
5779 the B<PluginInstanceFrom> option in B<Query> block.
5781 =item B<Host> I<hostname>
5783 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5784 value begins with a slash, it is interpreted as the directory name in which to
5785 look for the UNIX domain socket.
5787 This option is also used to determine the hostname that is associated with a
5788 collected data set. If it has been omitted or either begins with with a slash
5789 or equals B<localhost> it will be replaced with the global hostname definition
5790 of collectd. Any other value will be passed literally to collectd when
5791 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5793 =item B<Port> I<port>
5795 Specify the TCP port or the local UNIX domain socket file extension of the
5798 =item B<User> I<username>
5800 Specify the username to be used when connecting to the server.
5802 =item B<Password> I<password>
5804 Specify the password to be used when connecting to the server.
5806 =item B<ExpireDelay> I<delay>
5808 Skip expired values in query output.
5810 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5812 Specify whether to use an SSL connection when contacting the server. The
5813 following modes are supported:
5819 Do not use SSL at all.
5823 First, try to connect without using SSL. If that fails, try using SSL.
5825 =item I<prefer> (default)
5827 First, try to connect using SSL. If that fails, try without using SSL.
5835 =item B<Instance> I<name>
5837 Specify the plugin instance name that should be used instead of the database
5838 name (which is the default, if this option has not been specified). This
5839 allows to query multiple databases of the same name on the same host (e.g.
5840 when running multiple database server versions in parallel).
5842 =item B<KRBSrvName> I<kerberos_service_name>
5844 Specify the Kerberos service name to use when authenticating with Kerberos 5
5845 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5846 B<PostgreSQL Documentation> for details.
5848 =item B<Service> I<service_name>
5850 Specify the PostgreSQL service name to use for additional parameters. That
5851 service has to be defined in F<pg_service.conf> and holds additional
5852 connection parameters. See the section "The Connection Service File" in the
5853 B<PostgreSQL Documentation> for details.
5855 =item B<Query> I<query>
5857 Specifies a I<query> which should be executed in the context of the database
5858 connection. This may be any of the predefined or user-defined queries. If no
5859 such option is given, it defaults to "backends", "transactions", "queries",
5860 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5861 has been specified). Else, the specified queries are used only.
5863 =item B<Writer> I<writer>
5865 Assigns the specified I<writer> backend to the database connection. This
5866 causes all collected data to be send to the database using the settings
5867 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5868 below for details on how to selectively send data to certain plugins).
5870 Each writer will register a flush callback which may be used when having long
5871 transactions enabled (see the B<CommitInterval> option above). When issuing
5872 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5873 transaction will be committed right away. Two different kinds of flush
5874 callbacks are available with the C<postgresql> plugin:
5880 Flush all writer backends.
5882 =item B<postgresql->I<database>
5884 Flush all writers of the specified I<database> only.
5890 =head2 Plugin C<powerdns>
5892 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5893 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5894 values, many of which are probably meaningless to most users, but may be useful
5895 for some. So you may chose which values to collect, but if you don't, some
5896 reasonable defaults will be collected.
5899 <Server "server_name">
5901 Collect "udp-answers" "udp-queries"
5902 Socket "/var/run/pdns.controlsocket"
5904 <Recursor "recursor_name">
5906 Collect "cache-hits" "cache-misses"
5907 Socket "/var/run/pdns_recursor.controlsocket"
5909 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5914 =item B<Server> and B<Recursor> block
5916 The B<Server> block defines one authoritative server to query, the B<Recursor>
5917 does the same for an recursing server. The possible options in both blocks are
5918 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5923 =item B<Collect> I<Field>
5925 Using the B<Collect> statement you can select which values to collect. Here,
5926 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5927 C<dlg-only-drops>, C<answers10-100>.
5929 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5930 When querying the server a C<SHOW *> command is issued in any case, because
5931 that's the only way of getting multiple values out of the server at once.
5932 collectd then picks out the values you have selected. When querying the
5933 recursor, a command is generated to query exactly these values. So if you
5934 specify invalid fields when querying the recursor, a syntax error may be
5935 returned by the daemon and collectd may not collect any values at all.
5937 If no B<Collect> statement is given, the following B<Server> values will be
5944 =item packetcache-hit
5946 =item packetcache-miss
5948 =item packetcache-size
5950 =item query-cache-hit
5952 =item query-cache-miss
5954 =item recursing-answers
5956 =item recursing-questions
5968 The following B<Recursor> values will be collected by default:
5972 =item noerror-answers
5974 =item nxdomain-answers
5976 =item servfail-answers
5994 Please note that up to that point collectd doesn't know what values are
5995 available on the server and values that are added do not need a change of the
5996 mechanism so far. However, the values must be mapped to collectd's naming
5997 scheme, which is done using a lookup table that lists all known values. If
5998 values are added in the future and collectd does not know about them, you will
5999 get an error much like this:
6001 powerdns plugin: submit: Not found in lookup table: foobar = 42
6003 In this case please file a bug report with the collectd team.
6005 =item B<Socket> I<Path>
6007 Configures the path to the UNIX domain socket to be used when connecting to the
6008 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6009 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6010 will be used for the recursor.
6014 =item B<LocalSocket> I<Path>
6016 Querying the recursor is done using UDP. When using UDP over UNIX domain
6017 sockets, the client socket needs a name in the file system, too. You can set
6018 this local name to I<Path> using the B<LocalSocket> option. The default is
6019 C<I<prefix>/var/run/collectd-powerdns>.
6023 =head2 Plugin C<processes>
6027 =item B<Process> I<Name>
6029 Select more detailed statistics of processes matching this name. The statistics
6030 collected for these selected processes are size of the resident segment size
6031 (RSS), user- and system-time used, number of processes and number of threads,
6032 io data (where available) and minor and major pagefaults.
6034 Some platforms have a limit on the length of process names. I<Name> must stay
6037 =item B<ProcessMatch> I<name> I<regex>
6039 Similar to the B<Process> option this allows to select more detailed
6040 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6041 details). The statistics of all matching processes are summed up and
6042 dispatched to the daemon using the specified I<name> as an identifier. This
6043 allows to "group" several processes together. I<name> must not contain
6046 =item B<CollectContextSwitch> I<Boolean>
6048 Collect context switch of the process.
6052 =head2 Plugin C<protocols>
6054 Collects a lot of information about various network protocols, such as I<IP>,
6055 I<TCP>, I<UDP>, etc.
6057 Available configuration options:
6061 =item B<Value> I<Selector>
6063 Selects whether or not to select a specific value. The string being matched is
6064 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6065 plugin instance and I<ValueName> will be used as type instance. An example of
6066 the string being used would be C<Tcp:RetransSegs>.
6068 You can use regular expressions to match a large number of values with just one
6069 configuration option. To select all "extended" I<TCP> values, you could use the
6070 following statement:
6074 Whether only matched values are selected or all matched values are ignored
6075 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6076 If no value is configured at all, all values will be selected.
6078 =item B<IgnoreSelected> B<true>|B<false>
6080 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6081 matching values will be ignored.
6085 =head2 Plugin C<python>
6087 This plugin embeds a Python-interpreter into collectd and provides an interface
6088 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6090 =head2 Plugin C<routeros>
6092 The C<routeros> plugin connects to a device running I<RouterOS>, the
6093 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6094 I<librouteros> to connect and reads information about the interfaces and
6095 wireless connections of the device. The configuration supports querying
6100 Host "router0.example.com"
6103 CollectInterface true
6108 Host "router1.example.com"
6111 CollectInterface true
6112 CollectRegistrationTable true
6118 As you can see above, the configuration of the I<routeros> plugin consists of
6119 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6120 options are understood:
6124 =item B<Host> I<Host>
6126 Hostname or IP-address of the router to connect to.
6128 =item B<Port> I<Port>
6130 Port name or port number used when connecting. If left unspecified, the default
6131 will be chosen by I<librouteros>, currently "8728". This option expects a
6132 string argument, even when a numeric port number is given.
6134 =item B<User> I<User>
6136 Use the user name I<User> to authenticate. Defaults to "admin".
6138 =item B<Password> I<Password>
6140 Set the password used to authenticate.
6142 =item B<CollectInterface> B<true>|B<false>
6144 When set to B<true>, interface statistics will be collected for all interfaces
6145 present on the device. Defaults to B<false>.
6147 =item B<CollectRegistrationTable> B<true>|B<false>
6149 When set to B<true>, information about wireless LAN connections will be
6150 collected. Defaults to B<false>.
6152 =item B<CollectCPULoad> B<true>|B<false>
6154 When set to B<true>, information about the CPU usage will be collected. The
6155 number is a dimensionless value where zero indicates no CPU usage at all.
6156 Defaults to B<false>.
6158 =item B<CollectMemory> B<true>|B<false>
6160 When enabled, the amount of used and free memory will be collected. How used
6161 memory is calculated is unknown, for example whether or not caches are counted
6163 Defaults to B<false>.
6165 =item B<CollectDF> B<true>|B<false>
6167 When enabled, the amount of used and free disk space will be collected.
6168 Defaults to B<false>.
6170 =item B<CollectDisk> B<true>|B<false>
6172 When enabled, the number of sectors written and bad blocks will be collected.
6173 Defaults to B<false>.
6177 =head2 Plugin C<redis>
6179 The I<Redis plugin> connects to one or more Redis servers and gathers
6180 information about each server's state. For each server there is a I<Node> block
6181 which configures the connection parameters for this node.
6188 <Query "LLEN myqueue">
6195 The information shown in the synopsis above is the I<default configuration>
6196 which is used by the plugin if no configuration is present.
6200 =item B<Node> I<Nodename>
6202 The B<Node> block identifies a new Redis node, that is a new Redis instance
6203 running in an specified host and port. The name for node is a canonical
6204 identifier which is used as I<plugin instance>. It is limited to
6205 64E<nbsp>characters in length.
6207 =item B<Host> I<Hostname>
6209 The B<Host> option is the hostname or IP-address where the Redis instance is
6212 =item B<Port> I<Port>
6214 The B<Port> option is the TCP port on which the Redis instance accepts
6215 connections. Either a service name of a port number may be given. Please note
6216 that numerical port numbers must be given as a string, too.
6218 =item B<Password> I<Password>
6220 Use I<Password> to authenticate when connecting to I<Redis>.
6222 =item B<Timeout> I<Milliseconds>
6224 The B<Timeout> option set the socket timeout for node response. Since the Redis
6225 read function is blocking, you should keep this value as low as possible. Keep
6226 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
6227 than B<Interval> defined globally.
6229 =item B<Query> I<Querystring>
6231 The B<Query> block identifies a query to execute against the redis server.
6232 There may be an arbitrary number of queries to execute.
6234 =item B<Type> I<Collectd type>
6236 Within a query definition, a valid collectd type to use as when submitting
6237 the result of the query. When not supplied, will default to B<gauge>.
6239 =item B<Instance> I<Type instance>
6241 Within a query definition, an optional type instance to use when submitting
6242 the result of the query. When not supplied will default to the escaped
6243 command, up to 64 chars.
6247 =head2 Plugin C<rrdcached>
6249 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
6250 to store values to RRD files in an efficient manner. The combination of the
6251 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
6252 way the C<rrdtool> plugin works (see below). The added abstraction layer
6253 provides a number of benefits, though: Because the cache is not within
6254 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
6255 restarted. This results in much shorter (if any) gaps in graphs, especially
6256 under heavy load. Also, the C<rrdtool> command line utility is aware of the
6257 daemon so that it can flush values to disk automatically when needed. This
6258 allows to integrate automated flushing of values into graphing solutions much
6261 There are disadvantages, though: The daemon may reside on a different host, so
6262 it may not be possible for C<collectd> to create the appropriate RRD files
6263 anymore. And even if C<rrdcached> runs on the same host, it may run in a
6264 different base directory, so relative paths may do weird stuff if you're not
6267 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
6268 on the same host, communicating via a UNIX domain socket. The B<DataDir>
6269 setting should be set to an absolute path, so that a changed base directory
6270 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
6274 =item B<DaemonAddress> I<Address>
6276 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
6277 library. See L<rrdcached(1)> for details. Example:
6279 <Plugin "rrdcached">
6280 DaemonAddress "unix:/var/run/rrdcached.sock"
6283 =item B<DataDir> I<Directory>
6285 Set the base directory in which the RRD files reside. If this is a relative
6286 path, it is relative to the working base directory of the C<rrdcached> daemon!
6287 Use of an absolute path is recommended.
6289 =item B<CreateFiles> B<true>|B<false>
6291 Enables or disables the creation of RRD files. If the daemon is not running
6292 locally, or B<DataDir> is set to a relative path, this will not work as
6293 expected. Default is B<true>.
6295 =item B<CreateFilesAsync> B<false>|B<true>
6297 When enabled, new RRD files are enabled asynchronously, using a separate thread
6298 that runs in the background. This prevents writes to block, which is a problem
6299 especially when many hundreds of files need to be created at once. However,
6300 since the purpose of creating the files asynchronously is I<not> to block until
6301 the file is available, values before the file is available will be discarded.
6302 When disabled (the default) files are created synchronously, blocking for a
6303 short while, while the file is being written.
6305 =item B<StepSize> I<Seconds>
6307 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6308 this setting is unset and the stepsize is set to the interval in which the data
6309 is collected. Do not use this option unless you absolutely have to for some
6310 reason. Setting this option may cause problems with the C<snmp plugin>, the
6311 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6313 =item B<HeartBeat> I<Seconds>
6315 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6316 in which case the heartbeat is set to twice the B<StepSize> which should equal
6317 the interval in which data is collected. Do not set this option unless you have
6318 a very good reason to do so.
6320 =item B<RRARows> I<NumRows>
6322 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6323 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6324 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6325 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6326 week, one month, and one year.
6328 So for each timespan, it calculates how many PDPs need to be consolidated into
6329 one CDP by calculating:
6330 number of PDPs = timespan / (stepsize * rrarows)
6332 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6335 =item B<RRATimespan> I<Seconds>
6337 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6338 more then one RRA. If this option is never used, the built-in default of (3600,
6339 86400, 604800, 2678400, 31622400) is used.
6341 For more information on how RRA-sizes are calculated see B<RRARows> above.
6343 =item B<XFF> I<Factor>
6345 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6346 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6349 =item B<CollectStatistics> B<false>|B<true>
6351 When set to B<true>, various statistics about the I<rrdcached> daemon will be
6352 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
6354 Statistics are read via I<rrdcached>s socket using the STATS command.
6355 See L<rrdcached(1)> for details.
6359 =head2 Plugin C<rrdtool>
6361 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
6362 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
6363 using these settings. If you don't want to dive into the depths of RRDtool, you
6364 can safely ignore these settings.
6368 =item B<DataDir> I<Directory>
6370 Set the directory to store RRD files under. By default RRD files are generated
6371 beneath the daemon's working directory, i.e. the B<BaseDir>.
6373 =item B<CreateFilesAsync> B<false>|B<true>
6375 When enabled, new RRD files are enabled asynchronously, using a separate thread
6376 that runs in the background. This prevents writes to block, which is a problem
6377 especially when many hundreds of files need to be created at once. However,
6378 since the purpose of creating the files asynchronously is I<not> to block until
6379 the file is available, values before the file is available will be discarded.
6380 When disabled (the default) files are created synchronously, blocking for a
6381 short while, while the file is being written.
6383 =item B<StepSize> I<Seconds>
6385 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6386 this setting is unset and the stepsize is set to the interval in which the data
6387 is collected. Do not use this option unless you absolutely have to for some
6388 reason. Setting this option may cause problems with the C<snmp plugin>, the
6389 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6391 =item B<HeartBeat> I<Seconds>
6393 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6394 in which case the heartbeat is set to twice the B<StepSize> which should equal
6395 the interval in which data is collected. Do not set this option unless you have
6396 a very good reason to do so.
6398 =item B<RRARows> I<NumRows>
6400 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6401 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6402 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6403 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6404 week, one month, and one year.
6406 So for each timespan, it calculates how many PDPs need to be consolidated into
6407 one CDP by calculating:
6408 number of PDPs = timespan / (stepsize * rrarows)
6410 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6413 =item B<RRATimespan> I<Seconds>
6415 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6416 more then one RRA. If this option is never used, the built-in default of (3600,
6417 86400, 604800, 2678400, 31622400) is used.
6419 For more information on how RRA-sizes are calculated see B<RRARows> above.
6421 =item B<XFF> I<Factor>
6423 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6424 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6427 =item B<CacheFlush> I<Seconds>
6429 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
6430 it writes all values for a certain RRD-file if the oldest value is older than
6431 (or equal to) the number of seconds specified. If some RRD-file is not updated
6432 anymore for some reason (the computer was shut down, the network is broken,
6433 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
6434 entire cache is searched for entries older than B<CacheTimeout> seconds and
6435 written to disk every I<Seconds> seconds. Since this is kind of expensive and
6436 does nothing under normal circumstances, this value should not be too small.
6437 900 seconds might be a good value, though setting this to 7200 seconds doesn't
6438 normally do much harm either.
6440 =item B<CacheTimeout> I<Seconds>
6442 If this option is set to a value greater than zero, the C<rrdtool plugin> will
6443 save values in a cache, as described above. Writing multiple values at once
6444 reduces IO-operations and thus lessens the load produced by updating the files.
6445 The trade off is that the graphs kind of "drag behind" and that more memory is
6448 =item B<WritesPerSecond> I<Updates>
6450 When collecting many statistics with collectd and the C<rrdtool> plugin, you
6451 will run serious performance problems. The B<CacheFlush> setting and the
6452 internal update queue assert that collectd continues to work just fine even
6453 under heavy load, but the system may become very unresponsive and slow. This is
6454 a problem especially if you create graphs from the RRD files on the same
6455 machine, for example using the C<graph.cgi> script included in the
6456 C<contrib/collection3/> directory.
6458 This setting is designed for very large setups. Setting this option to a value
6459 between 25 and 80 updates per second, depending on your hardware, will leave
6460 the server responsive enough to draw graphs even while all the cached values
6461 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
6462 by the B<FLUSH> command, are B<not> effected by this limit. They are still
6463 written as fast as possible, so that web frontends have up to date data when
6466 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
6467 updates per second, writing all values to disk will take approximately
6468 56E<nbsp>minutes. Together with the flushing ability that's integrated into
6469 "collection3" you'll end up with a responsive and fast system, up to date
6470 graphs and basically a "backup" of your values every hour.
6472 =item B<RandomTimeout> I<Seconds>
6474 When set, the actual timeout for each value is chosen randomly between
6475 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
6476 intention is to avoid high load situations that appear when many values timeout
6477 at the same time. This is especially a problem shortly after the daemon starts,
6478 because all values were added to the internal cache at roughly the same time.
6482 =head2 Plugin C<sensors>
6484 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
6485 that all the needed modules have to be loaded and lm_sensors has to be
6486 configured (most likely by editing F</etc/sensors.conf>. Read
6487 L<sensors.conf(5)> for details.
6489 The B<lm_sensors> homepage can be found at
6490 L<http://secure.netroedge.com/~lm78/>.
6494 =item B<SensorConfigFile> I<File>
6496 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
6497 the library's default will be used.
6499 =item B<Sensor> I<chip-bus-address/type-feature>
6501 Selects the name of the sensor which you want to collect or ignore, depending
6502 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
6503 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
6504 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
6506 =item B<IgnoreSelected> I<true>|I<false>
6508 If no configuration if given, the B<sensors>-plugin will collect data from all
6509 sensors. This may not be practical, especially for uninteresting sensors.
6510 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
6511 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
6512 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
6513 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
6514 and all other sensors are collected.
6516 =item B<UseLabels> I<true>|I<false>
6518 Configures how sensor readings are reported. When set to I<true>, sensor
6519 readings are reported using their descriptive label (e.g. "VCore"). When set to
6520 I<false> (the default) the sensor name is used ("in0").
6524 =head2 Plugin C<sigrok>
6526 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
6527 supported by the L<sigrok|http://sigrok.org/> project.
6533 <Device "AC Voltage">
6538 <Device "Sound Level">
6539 Driver "cem-dt-885x"
6546 =item B<LogLevel> B<0-5>
6548 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
6549 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
6550 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
6551 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
6552 their level, are always submitted to I<collectd> at its INFO log level.
6554 =item E<lt>B<Device> I<Name>E<gt>
6556 A sigrok-supported device, uniquely identified by this section's options. The
6557 I<Name> is passed to I<collectd> as the I<plugin instance>.
6559 =item B<Driver> I<DriverName>
6561 The sigrok driver to use for this device.
6563 =item B<Conn> I<ConnectionSpec>
6565 If the device cannot be auto-discovered, or more than one might be discovered
6566 by the driver, I<ConnectionSpec> specifies the connection string to the device.
6567 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
6568 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
6569 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
6570 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
6572 =item B<SerialComm> I<SerialSpec>
6574 For serial devices with non-standard port settings, this option can be used
6575 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
6576 This should not be necessary; drivers know how to communicate with devices they
6579 =item B<MinimumInterval> I<Seconds>
6581 Specifies the minimum time between measurement dispatches to I<collectd>, in
6582 seconds. Since some I<sigrok> supported devices can acquire measurements many
6583 times per second, it may be necessary to throttle these. For example, the
6584 I<RRD plugin> cannot process writes more than once per second.
6586 The default B<MinimumInterval> is B<0>, meaning measurements received from the
6587 device are always dispatched to I<collectd>. When throttled, unused
6588 measurements are discarded.
6592 =head2 Plugin C<smart>
6594 The C<smart> plugin collects SMART information from physical
6595 disks. Values collectd include temperature, power cycle count, poweron
6596 time and bad sectors. Also, all SMART attributes are collected along
6597 with the normalized current value, the worst value, the threshold and
6598 a human readable value.
6600 Using the following two options you can ignore some disks or configure the
6601 collection only of specific disks.
6605 =item B<Disk> I<Name>
6607 Select the disk I<Name>. Whether it is collected or ignored depends on the
6608 B<IgnoreSelected> setting, see below. As with other plugins that use the
6609 daemon's ignorelist functionality, a string that starts and ends with a slash
6610 is interpreted as a regular expression. Examples:
6615 =item B<IgnoreSelected> B<true>|B<false>
6617 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
6618 statements, are ignored or if all other disks are ignored. The behavior
6619 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
6620 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
6621 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
6622 is set to B<true>, all disks are collected B<except> the ones matched.
6624 =item B<IgnoreSleepMode> B<true>|B<false>
6626 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
6627 This option disables the sleep mode check and allows the plugin to collect data
6628 from these disks anyway. This is useful in cases where libatasmart mistakenly
6629 reports disks as asleep because it has not been updated to incorporate support
6630 for newer idle states in the ATA spec.
6632 =item B<UseSerial> B<true>|B<false>
6634 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
6635 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
6636 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
6637 storing data. This ensures that the data for a given disk will be kept together
6638 even if the kernel name changes.
6642 =head2 Plugin C<snmp>
6644 Since the configuration of the C<snmp plugin> is a little more complicated than
6645 other plugins, its documentation has been moved to an own manpage,
6646 L<collectd-snmp(5)>. Please see there for details.
6648 =head2 Plugin C<statsd>
6650 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
6651 protocol and dispatches rates or other aggregates of these numbers
6654 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
6655 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
6656 C<objects> respectively.
6658 The following configuration options are valid:
6662 =item B<Host> I<Host>
6664 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
6665 "any" address, i.e. accept packets sent to any of the hosts addresses.
6667 =item B<Port> I<Port>
6669 UDP port to listen to. This can be either a service name or a port number.
6670 Defaults to C<8125>.
6672 =item B<DeleteCounters> B<false>|B<true>
6674 =item B<DeleteTimers> B<false>|B<true>
6676 =item B<DeleteGauges> B<false>|B<true>
6678 =item B<DeleteSets> B<false>|B<true>
6680 These options control what happens if metrics are not updated in an interval.
6681 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6682 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6683 are unchanged. If set to B<True>, the such metrics are not dispatched and
6684 removed from the internal cache.
6686 =item B<CounterSum> B<false>|B<true>
6688 When enabled, creates a C<count> metric which reports the change since the last
6689 read. This option primarily exists for compatibility with the I<statsd>
6690 implementation by Etsy.
6692 =item B<TimerPercentile> I<Percent>
6694 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6695 that I<Percent> of all reported timers are smaller than or equal to the
6696 computed latency. This is useful for cutting off the long tail latency, as it's
6697 often done in I<Service Level Agreements> (SLAs).
6699 Different percentiles can be calculated by setting this option several times.
6700 If none are specified, no percentiles are calculated / dispatched.
6702 =item B<TimerLower> B<false>|B<true>
6704 =item B<TimerUpper> B<false>|B<true>
6706 =item B<TimerSum> B<false>|B<true>
6708 =item B<TimerCount> B<false>|B<true>
6710 Calculate and dispatch various values out of I<Timer> metrics received during
6711 an interval. If set to B<False>, the default, these values aren't calculated /
6716 =head2 Plugin C<swap>
6718 The I<Swap plugin> collects information about used and available swap space. On
6719 I<Linux> and I<Solaris>, the following options are available:
6723 =item B<ReportByDevice> B<false>|B<true>
6725 Configures how to report physical swap devices. If set to B<false> (the
6726 default), the summary over all swap devices is reported only, i.e. the globally
6727 used and available space over all devices. If B<true> is configured, the used
6728 and available space of each device will be reported separately.
6730 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6731 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6733 =item B<ReportBytes> B<false>|B<true>
6735 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6736 I<swap I/O> is reported in pages. This option is available under Linux only.
6738 =item B<ValuesAbsolute> B<true>|B<false>
6740 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6741 available and used. Defaults to B<true>.
6743 =item B<ValuesPercentage> B<false>|B<true>
6745 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6746 available and free. Defaults to B<false>.
6748 This is useful for deploying I<collectd> in a heterogeneous environment, where
6749 swap sizes differ and you want to specify generic thresholds or similar.
6753 =head2 Plugin C<syslog>
6757 =item B<LogLevel> B<debug|info|notice|warning|err>
6759 Sets the log-level. If, for example, set to B<notice>, then all events with
6760 severity B<notice>, B<warning>, or B<err> will be submitted to the
6763 Please note that B<debug> is only available if collectd has been compiled with
6766 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6768 Controls which notifications should be sent to syslog. The default behaviour is
6769 not to send any. Less severe notifications always imply logging more severe
6770 notifications: Setting this to B<OKAY> means all notifications will be sent to
6771 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6772 notifications but will dismiss B<OKAY> notifications. Setting this option to
6773 B<FAILURE> will only send failures to syslog.
6777 =head2 Plugin C<table>
6779 The C<table plugin> provides generic means to parse tabular data and dispatch
6780 user specified values. Values are selected based on column numbers. For
6781 example, this plugin may be used to get values from the Linux L<proc(5)>
6782 filesystem or CSV (comma separated values) files.
6785 <Table "/proc/slabinfo">
6790 InstancePrefix "active_objs"
6796 InstancePrefix "objperslab"
6803 The configuration consists of one or more B<Table> blocks, each of which
6804 configures one file to parse. Within each B<Table> block, there are one or
6805 more B<Result> blocks, which configure which data to select and how to
6808 The following options are available inside a B<Table> block:
6812 =item B<Instance> I<instance>
6814 If specified, I<instance> is used as the plugin instance. So, in the above
6815 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6816 filename of the table is used instead, with all special characters replaced
6817 with an underscore (C<_>).
6819 =item B<Separator> I<string>
6821 Any character of I<string> is interpreted as a delimiter between the different
6822 columns of the table. A sequence of two or more contiguous delimiters in the
6823 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6824 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6825 of a table - see its documentation for more details. This option is mandatory.
6827 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6828 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6829 required because of collectd's config parsing.
6833 The following options are available inside a B<Result> block:
6837 =item B<Type> I<type>
6839 Sets the type used to dispatch the values to the daemon. Detailed information
6840 about types and their configuration can be found in L<types.db(5)>. This
6841 option is mandatory.
6843 =item B<InstancePrefix> I<prefix>
6845 If specified, prepend I<prefix> to the type instance. If omitted, only the
6846 B<InstancesFrom> option is considered for the type instance.
6848 =item B<InstancesFrom> I<column0> [I<column1> ...]
6850 If specified, the content of the given columns (identified by the column
6851 number starting at zero) will be used to create the type instance for each
6852 row. Multiple values (and the instance prefix) will be joined together with
6853 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6854 option is considered for the type instance.
6856 The plugin itself does not check whether or not all built instances are
6857 different. It’s your responsibility to assure that each is unique. This is
6858 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6859 sure that the table only contains one row.
6861 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6864 =item B<ValuesFrom> I<column0> [I<column1> ...]
6866 Specifies the columns (identified by the column numbers starting at zero)
6867 whose content is used as the actual data for the data sets that are dispatched
6868 to the daemon. How many such columns you need is determined by the B<Type>
6869 setting above. If you specify too many or not enough columns, the plugin will
6870 complain about that and no data will be submitted to the daemon. The plugin
6871 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6872 respectively, so anything supported by those functions is supported by the
6873 plugin as well. This option is mandatory.
6877 =head2 Plugin C<tail>
6879 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6880 each line and dispatches found values. What is matched can be configured by the
6881 user using (extended) regular expressions, as described in L<regex(7)>.
6884 <File "/var/log/exim4/mainlog">
6888 Regex "S=([1-9][0-9]*)"
6894 Regex "\\<R=local_user\\>"
6895 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6898 Instance "local_user"
6903 The config consists of one or more B<File> blocks, each of which configures one
6904 logfile to parse. Within each B<File> block, there are one or more B<Match>
6905 blocks, which configure a regular expression to search for.
6907 The B<Instance> option in the B<File> block may be used to set the plugin
6908 instance. So in the above example the plugin name C<tail-foo> would be used.
6909 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6910 next B<Instance> option. This way you can extract several plugin instances from
6911 one logfile, handy when parsing syslog and the like.
6913 The B<Interval> option allows you to define the length of time between reads. If
6914 this is not set, the default Interval will be used.
6916 Each B<Match> block has the following options to describe how the match should
6921 =item B<Regex> I<regex>
6923 Sets the regular expression to use for matching against a line. The first
6924 subexpression has to match something that can be turned into a number by
6925 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6926 below. Because B<extended> regular expressions are used, you do not need to use
6927 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6928 collectd's config parsing you need to escape backslashes, though. So if you
6929 want to match literal parentheses you need to do the following:
6931 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6933 =item B<ExcludeRegex> I<regex>
6935 Sets an optional regular expression to use for excluding lines from the match.
6936 An example which excludes all connections from localhost from the match:
6938 ExcludeRegex "127\\.0\\.0\\.1"
6940 =item B<DSType> I<Type>
6942 Sets how the values are cumulated. I<Type> is one of:
6946 =item B<GaugeAverage>
6948 Calculate the average.
6952 Use the smallest number only.
6956 Use the greatest number only.
6960 Use the last number found.
6966 =item B<AbsoluteSet>
6968 The matched number is a counter. Simply I<sets> the internal counter to this
6969 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6977 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6978 matched number may be negative, which will effectively subtract from the
6987 Increase the internal counter by one. These B<DSType> are the only ones that do
6988 not use the matched subexpression, but simply count the number of matched
6989 lines. Thus, you may use a regular expression without submatch in this case.
6993 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6994 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6995 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6996 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6997 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
7000 =item B<Type> I<Type>
7002 Sets the type used to dispatch this value. Detailed information about types and
7003 their configuration can be found in L<types.db(5)>.
7005 =item B<Instance> I<TypeInstance>
7007 This optional setting sets the type instance to use.
7011 =head2 Plugin C<tail_csv>
7013 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
7014 written by I<Snort>.
7019 <Metric "snort-dropped">
7024 <File "/var/log/snort/snort.stats">
7025 Instance "snort-eth0"
7027 Collect "snort-dropped"
7031 The configuration consists of one or more B<Metric> blocks that define an index
7032 into the line of the CSV file and how this value is mapped to I<collectd's>
7033 internal representation. These are followed by one or more B<Instance> blocks
7034 which configure which file to read, in which interval and which metrics to
7039 =item E<lt>B<Metric> I<Name>E<gt>
7041 The B<Metric> block configures a new metric to be extracted from the statistics
7042 file and how it is mapped on I<collectd's> data model. The string I<Name> is
7043 only used inside the B<Instance> blocks to refer to this block, so you can use
7044 one B<Metric> block for multiple CSV files.
7048 =item B<Type> I<Type>
7050 Configures which I<Type> to use when dispatching this metric. Types are defined
7051 in the L<types.db(5)> file, see the appropriate manual page for more
7052 information on specifying types. Only types with a single I<data source> are
7053 supported by the I<tail_csv plugin>. The information whether the value is an
7054 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
7055 I<Type's> definition.
7057 =item B<Instance> I<TypeInstance>
7059 If set, I<TypeInstance> is used to populate the type instance field of the
7060 created value lists. Otherwise, no type instance is used.
7062 =item B<ValueFrom> I<Index>
7064 Configure to read the value from the field with the zero-based index I<Index>.
7065 If the value is parsed as signed integer, unsigned integer or double depends on
7066 the B<Type> setting, see above.
7070 =item E<lt>B<File> I<Path>E<gt>
7072 Each B<File> block represents one CSV file to read. There must be at least one
7073 I<File> block but there can be multiple if you have multiple CSV files.
7077 =item B<Instance> I<PluginInstance>
7079 Sets the I<plugin instance> used when dispatching the values.
7081 =item B<Collect> I<Metric>
7083 Specifies which I<Metric> to collect. This option must be specified at least
7084 once, and you can use this option multiple times to specify more than one
7085 metric to be extracted from this statistic file.
7087 =item B<Interval> I<Seconds>
7089 Configures the interval in which to read values from this instance / file.
7090 Defaults to the plugin's default interval.
7092 =item B<TimeFrom> I<Index>
7094 Rather than using the local time when dispatching a value, read the timestamp
7095 from the field with the zero-based index I<Index>. The value is interpreted as
7096 seconds since epoch. The value is parsed as a double and may be factional.
7102 =head2 Plugin C<teamspeak2>
7104 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
7105 polls interesting global and virtual server data. The plugin can query only one
7106 physical server but unlimited virtual servers. You can use the following
7107 options to configure it:
7111 =item B<Host> I<hostname/ip>
7113 The hostname or ip which identifies the physical server.
7116 =item B<Port> I<port>
7118 The query port of the physical server. This needs to be a string.
7121 =item B<Server> I<port>
7123 This option has to be added once for every virtual server the plugin should
7124 query. If you want to query the virtual server on port 8767 this is what the
7125 option would look like:
7129 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
7130 use quotes around it! If no such statement is given only global information
7135 =head2 Plugin C<ted>
7137 The I<TED> plugin connects to a device of "The Energy Detective", a device to
7138 measure power consumption. These devices are usually connected to a serial
7139 (RS232) or USB port. The plugin opens a configured device and tries to read the
7140 current energy readings. For more information on TED, visit
7141 L<http://www.theenergydetective.com/>.
7143 Available configuration options:
7147 =item B<Device> I<Path>
7149 Path to the device on which TED is connected. collectd will need read and write
7150 permissions on that file.
7152 Default: B</dev/ttyUSB0>
7154 =item B<Retries> I<Num>
7156 Apparently reading from TED is not that reliable. You can therefore configure a
7157 number of retries here. You only configure the I<retries> here, to if you
7158 specify zero, one reading will be performed (but no retries if that fails); if
7159 you specify three, a maximum of four readings are performed. Negative values
7166 =head2 Plugin C<tcpconns>
7168 The C<tcpconns plugin> counts the number of currently established TCP
7169 connections based on the local port and/or the remote port. Since there may be
7170 a lot of connections the default if to count all connections with a local port,
7171 for which a listening socket is opened. You can use the following options to
7172 fine-tune the ports you are interested in:
7176 =item B<ListeningPorts> I<true>|I<false>
7178 If this option is set to I<true>, statistics for all local ports for which a
7179 listening socket exists are collected. The default depends on B<LocalPort> and
7180 B<RemotePort> (see below): If no port at all is specifically selected, the
7181 default is to collect listening ports. If specific ports (no matter if local or
7182 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
7183 the selected ports will be collected unless this option is set to I<true>
7186 =item B<LocalPort> I<Port>
7188 Count the connections to a specific local port. This can be used to see how
7189 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
7190 You have to specify the port in numeric form, so for the mailserver example
7191 you'd need to set B<25>.
7193 =item B<RemotePort> I<Port>
7195 Count the connections to a specific remote port. This is useful to see how
7196 much a remote service is used. This is most useful if you want to know how many
7197 connections a local service has opened to remote services, e.E<nbsp>g. how many
7198 connections a mail server or news server has to other mail or news servers, or
7199 how many connections a web proxy holds to web servers. You have to give the
7200 port in numeric form.
7202 =item B<AllPortsSummary> I<true>|I<false>
7204 If this option is set to I<true> a summary of statistics from all connections
7205 are collected. This option defaults to I<false>.
7209 =head2 Plugin C<thermal>
7213 =item B<ForceUseProcfs> I<true>|I<false>
7215 By default, the I<Thermal plugin> tries to read the statistics from the Linux
7216 C<sysfs> interface. If that is not available, the plugin falls back to the
7217 C<procfs> interface. By setting this option to I<true>, you can force the
7218 plugin to use the latter. This option defaults to I<false>.
7220 =item B<Device> I<Device>
7222 Selects the name of the thermal device that you want to collect or ignore,
7223 depending on the value of the B<IgnoreSelected> option. This option may be
7224 used multiple times to specify a list of devices.
7226 =item B<IgnoreSelected> I<true>|I<false>
7228 Invert the selection: If set to true, all devices B<except> the ones that
7229 match the device names specified by the B<Device> option are collected. By
7230 default only selected devices are collected if a selection is made. If no
7231 selection is configured at all, B<all> devices are selected.
7235 =head2 Plugin C<threshold>
7237 The I<Threshold plugin> checks values collected or received by I<collectd>
7238 against a configurable I<threshold> and issues I<notifications> if values are
7241 Documentation for this plugin is available in the L<collectd-threshold(5)>
7244 =head2 Plugin C<tokyotyrant>
7246 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
7247 couple metrics: number of records, and database size on disk.
7251 =item B<Host> I<Hostname/IP>
7253 The hostname or ip which identifies the server.
7254 Default: B<127.0.0.1>
7256 =item B<Port> I<Service/Port>
7258 The query port of the server. This needs to be a string, even if the port is
7259 given in its numeric form.
7264 =head2 Plugin C<turbostat>
7266 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
7267 Intel processors by using the new Model Specific Registers.
7271 =item B<CoreCstates> I<Bitmask(Integer)>
7273 Bitmask of the list of core C states supported by the processor.
7274 This option should only be used if the automated detection fails.
7275 Default value extracted from the cpu model and family.
7277 Currently supported C-states (by this plugin): 3, 6, 7
7279 Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states
7281 =item B<PackageCstates> I<Bitmask(Integer)>
7283 Bitmask of the list of pacages C states supported by the processor.
7284 This option should only be used if the automated detection fails.
7285 Default value extracted from the cpu model and family.
7287 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
7289 Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7
7291 =item B<SystemManagementInterrupt> I<true>|I<false>
7293 Boolean enabling the collection of the I/O System-Management Interrupt
7294 counter'. This option should only be used if the automated detection
7295 fails or if you want to disable this feature.
7297 =item B<DigitalTemperatureSensor> I<true>|I<false>
7299 Boolean enabling the collection of the temperature of each core.
7300 This option should only be used if the automated detectionfails or
7301 if you want to disable this feature.
7303 =item B<DigitalTemperatureSensor> I<true>|I<false>
7305 Boolean enabling the collection of the temperature of each package.
7306 This option should only be used if the automated detectionfails or
7307 if you want to disable this feature.
7309 =item B<TCCActivationTemp> I<Temperature>
7311 Thermal Control Circuit Activation Temperature of the installed
7312 CPU. This temperature is used when collecting the temperature of
7313 cores or packages. This option should only be used if the automated
7314 detection fails. Default value extracted from B<MSR_IA32_TEMPERATURE_TARGET>
7316 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
7318 Bitmask of the list of elements to be thermally monitored. This option
7319 should only be used if the automated detection fails or if you want to
7320 disable some collections. The different bits of this bitmask accepted
7325 =item 0 ('1'): Package
7329 =item 2 ('4'): Cores
7331 =item 3 ('8'): Embedded graphic device
7337 =head2 Plugin C<unixsock>
7341 =item B<SocketFile> I<Path>
7343 Sets the socket-file which is to be created.
7345 =item B<SocketGroup> I<Group>
7347 If running as root change the group of the UNIX-socket after it has been
7348 created. Defaults to B<collectd>.
7350 =item B<SocketPerms> I<Permissions>
7352 Change the file permissions of the UNIX-socket after it has been created. The
7353 permissions must be given as a numeric, octal value as you would pass to
7354 L<chmod(1)>. Defaults to B<0770>.
7356 =item B<DeleteSocket> B<false>|B<true>
7358 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
7359 with the given name already exists. If I<collectd> crashes a socket file may be
7360 left over, preventing the daemon from opening a new socket when restarted.
7361 Since this is potentially dangerous, this defaults to B<false>.
7365 =head2 Plugin C<uuid>
7367 This plugin, if loaded, causes the Hostname to be taken from the machine's
7368 UUID. The UUID is a universally unique designation for the machine, usually
7369 taken from the machine's BIOS. This is most useful if the machine is running in
7370 a virtual environment such as Xen, in which case the UUID is preserved across
7371 shutdowns and migration.
7373 The following methods are used to find the machine's UUID, in order:
7379 Check I</etc/uuid> (or I<UUIDFile>).
7383 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
7388 Check for UUID from C<dmidecode> / SMBIOS.
7392 Check for UUID from Xen hypervisor.
7396 If no UUID can be found then the hostname is not modified.
7400 =item B<UUIDFile> I<Path>
7402 Take the UUID from the given file (default I</etc/uuid>).
7406 =head2 Plugin C<varnish>
7408 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
7409 It collects a subset of the values displayed by L<varnishstat(1)>, and
7410 organizes them in categories which can be enabled or disabled. Currently only
7411 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
7412 meaning of each metric can be found in L<varnish-counters(7)>.
7417 <Instance "example">
7421 CollectConnections true
7422 CollectDirectorDNS false
7426 CollectObjects false
7428 CollectSession false
7438 CollectWorkers false
7442 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
7443 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
7444 will collectd statistics from the default "varnishd" instance (this should work
7445 fine in most cases).
7447 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
7451 =item B<CollectBackend> B<true>|B<false>
7453 Back-end connection statistics, such as successful, reused,
7454 and closed connections. True by default.
7456 =item B<CollectBan> B<true>|B<false>
7458 Statistics about ban operations, such as number of bans added, retired, and
7459 number of objects tested against ban operations. Only available with Varnish
7460 3.x and above. False by default.
7462 =item B<CollectCache> B<true>|B<false>
7464 Cache hits and misses. True by default.
7466 =item B<CollectConnections> B<true>|B<false>
7468 Number of client connections received, accepted and dropped. True by default.
7470 =item B<CollectDirectorDNS> B<true>|B<false>
7472 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
7475 =item B<CollectESI> B<true>|B<false>
7477 Edge Side Includes (ESI) parse statistics. False by default.
7479 =item B<CollectFetch> B<true>|B<false>
7481 Statistics about fetches (HTTP requests sent to the backend). False by default.
7483 =item B<CollectHCB> B<true>|B<false>
7485 Inserts and look-ups in the crit bit tree based hash. Look-ups are
7486 divided into locked and unlocked look-ups. False by default.
7488 =item B<CollectObjects> B<true>|B<false>
7490 Statistics on cached objects: number of objects expired, nuked (prematurely
7491 expired), saved, moved, etc. False by default.
7493 =item B<CollectPurge> B<true>|B<false>
7495 Statistics about purge operations, such as number of purges added, retired, and
7496 number of objects tested against purge operations. Only available with Varnish
7497 2.x. False by default.
7499 =item B<CollectSession> B<true>|B<false>
7501 Client session statistics. Number of past and current sessions, session herd and
7502 linger counters, etc. False by default. Note that if using Varnish 4.x, some
7503 metrics found in the Connections and Threads sections with previous versions of
7504 Varnish have been moved here.
7506 =item B<CollectSHM> B<true>|B<false>
7508 Statistics about the shared memory log, a memory region to store
7509 log messages which is flushed to disk when full. True by default.
7511 =item B<CollectSMA> B<true>|B<false>
7513 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
7514 component is Solaris specific. Only available with Varnish 2.x. False by
7517 =item B<CollectSMS> B<true>|B<false>
7519 synth (synthetic content) storage statistics. This storage
7520 component is used internally only. False by default.
7522 =item B<CollectSM> B<true>|B<false>
7524 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
7527 =item B<CollectStruct> B<true>|B<false>
7529 Current varnish internal state statistics. Number of current sessions, objects
7530 in cache store, open connections to backends (with Varnish 2.x), etc. False by
7533 =item B<CollectTotals> B<true>|B<false>
7535 Collects overview counters, such as the number of sessions created,
7536 the number of requests and bytes transferred. False by default.
7538 =item B<CollectUptime> B<true>|B<false>
7540 Varnish uptime. Only available with Varnish 3.x and above. False by default.
7542 =item B<CollectVCL> B<true>|B<false>
7544 Number of total (available + discarded) VCL (config files). False by default.
7546 =item B<CollectVSM> B<true>|B<false>
7548 Collect statistics about Varnish's shared memory usage (used by the logging and
7549 statistics subsystems). Only available with Varnish 4.x. False by default.
7551 =item B<CollectWorkers> B<true>|B<false>
7553 Collect statistics about worker threads. False by default.
7557 =head2 Plugin C<virt>
7559 This plugin allows CPU, disk and network load to be collected for virtualized
7560 guests on the machine. This means that these metrics can be collected for guest
7561 systems without installing any software on them - I<collectd> only runs on the
7562 host system. The statistics are collected through libvirt
7563 (L<http://libvirt.org/>).
7565 Only I<Connection> is required.
7569 =item B<Connection> I<uri>
7571 Connect to the hypervisor given by I<uri>. For example if using Xen use:
7573 Connection "xen:///"
7575 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
7577 =item B<RefreshInterval> I<seconds>
7579 Refresh the list of domains and devices every I<seconds>. The default is 60
7580 seconds. Setting this to be the same or smaller than the I<Interval> will cause
7581 the list of domains and devices to be refreshed on every iteration.
7583 Refreshing the devices in particular is quite a costly operation, so if your
7584 virtualization setup is static you might consider increasing this. If this
7585 option is set to 0, refreshing is disabled completely.
7587 =item B<Domain> I<name>
7589 =item B<BlockDevice> I<name:dev>
7591 =item B<InterfaceDevice> I<name:dev>
7593 =item B<IgnoreSelected> B<true>|B<false>
7595 Select which domains and devices are collected.
7597 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
7598 disk/network devices are collected.
7600 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
7601 domains and disk/network devices are ignored, while the rest are collected.
7603 The domain name and device names may use a regular expression, if the name is
7604 surrounded by I</.../> and collectd was compiled with support for regexps.
7606 The default is to collect statistics for all domains and all their devices.
7610 BlockDevice "/:hdb/"
7611 IgnoreSelected "true"
7613 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
7616 =item B<HostnameFormat> B<name|uuid|hostname|...>
7618 When the virt plugin logs data, it sets the hostname of the collected data
7619 according to this setting. The default is to use the guest name as provided by
7620 the hypervisor, which is equal to setting B<name>.
7622 B<uuid> means use the guest's UUID. This is useful if you want to track the
7623 same guest across migrations.
7625 B<hostname> means to use the global B<Hostname> setting, which is probably not
7626 useful on its own because all guests will appear to have the same name.
7628 You can also specify combinations of these fields. For example B<name uuid>
7629 means to concatenate the guest name and UUID (with a literal colon character
7630 between, thus I<"foo:1234-1234-1234-1234">).
7632 At the moment of writing (collectd-5.5), hostname string is limited to 62
7633 characters. In case when combination of fields exceeds 62 characters,
7634 hostname will be truncated without a warning.
7636 =item B<InterfaceFormat> B<name>|B<address>
7638 When the virt plugin logs interface data, it sets the name of the collected
7639 data according to this setting. The default is to use the path as provided by
7640 the hypervisor (the "dev" property of the target node), which is equal to
7643 B<address> means use the interface's mac address. This is useful since the
7644 interface path might change between reboots of a guest or across migrations.
7646 =item B<PluginInstanceFormat> B<name|uuid|none>
7648 When the virt plugin logs data, it sets the plugin_instance of the collected
7649 data according to this setting. The default is to not set the plugin_instance.
7651 B<name> means use the guest's name as provided by the hypervisor.
7652 B<uuid> means use the guest's UUID.
7654 You can also specify combinations of the B<name> and B<uuid> fields.
7655 For example B<name uuid> means to concatenate the guest name and UUID
7656 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
7660 =head2 Plugin C<vmem>
7662 The C<vmem> plugin collects information about the usage of virtual memory.
7663 Since the statistics provided by the Linux kernel are very detailed, they are
7664 collected very detailed. However, to get all the details, you have to switch
7665 them on manually. Most people just want an overview over, such as the number of
7666 pages read from swap space.
7670 =item B<Verbose> B<true>|B<false>
7672 Enables verbose collection of information. This will start collecting page
7673 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
7674 Part of these statistics are collected on a "per zone" basis.
7678 =head2 Plugin C<vserver>
7680 This plugin doesn't have any options. B<VServer> support is only available for
7681 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
7682 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
7683 need to apply the patches and compile your own kernel, which will then provide
7684 the F</proc/virtual> filesystem that is required by this plugin.
7686 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
7688 B<Note>: The traffic collected by this plugin accounts for the amount of
7689 traffic passing a socket which might be a lot less than the actual on-wire
7690 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
7691 collect on-wire traffic you could, for example, use the logging facilities of
7692 iptables to feed data for the guest IPs into the iptables plugin.
7694 =head2 Plugin C<write_graphite>
7696 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
7697 storage and graphing project. The plugin connects to I<Carbon>, the data layer
7698 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
7699 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
7700 of at most 1428 bytes to minimize the number of network packets.
7704 <Plugin write_graphite>
7714 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7715 blocks. Inside the B<Node> blocks, the following options are recognized:
7719 =item B<Host> I<Address>
7721 Hostname or address to connect to. Defaults to C<localhost>.
7723 =item B<Port> I<Service>
7725 Service name or port number to connect to. Defaults to C<2003>.
7727 =item B<Protocol> I<String>
7729 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
7731 =item B<ReconnectInterval> I<Seconds>
7733 When set to non-zero, forces the connection to the Graphite backend to be
7734 closed and re-opend periodically. This behavior is desirable in environments
7735 where the connection to the Graphite backend is done through load balancers,
7736 for example. When set to zero, the default, the connetion is kept open for as
7739 =item B<LogSendErrors> B<false>|B<true>
7741 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
7742 If set to B<false>, it will not log the errors. This is especially useful when
7743 using Protocol UDP since many times we want to use the "fire-and-forget"
7744 approach and logging errors fills syslog with unneeded messages.
7746 =item B<Prefix> I<String>
7748 When set, I<String> is added in front of the host name. Dots and whitespace are
7749 I<not> escaped in this string (see B<EscapeCharacter> below).
7751 =item B<Postfix> I<String>
7753 When set, I<String> is appended to the host name. Dots and whitespace are
7754 I<not> escaped in this string (see B<EscapeCharacter> below).
7756 =item B<EscapeCharacter> I<Char>
7758 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
7759 in the identifier. The B<EscapeCharacter> option determines which character
7760 dots, whitespace and control characters are replaced with. Defaults to
7763 =item B<StoreRates> B<false>|B<true>
7765 If set to B<true> (the default), convert counter values to rates. If set to
7766 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7769 =item B<SeparateInstances> B<false>|B<true>
7771 If set to B<true>, the plugin instance and type instance will be in their own
7772 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7773 default), the plugin and plugin instance (and likewise the type and type
7774 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7776 =item B<AlwaysAppendDS> B<false>|B<true>
7778 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7779 identifier. If set to B<false> (the default), this is only done when there is
7784 =head2 Plugin C<write_tsdb>
7786 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7787 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7788 state daemon that ingests metrics and stores them in HBase. The plugin uses
7789 I<TCP> over the "line based" protocol with a default port 4242. The data will
7790 be sent in blocks of at most 1428 bytes to minimize the number of network
7797 Host "tsd-1.my.domain"
7799 HostTags "status=production"
7803 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7804 blocks. Inside the B<Node> blocks, the following options are recognized:
7808 =item B<Host> I<Address>
7810 Hostname or address to connect to. Defaults to C<localhost>.
7812 =item B<Port> I<Service>
7814 Service name or port number to connect to. Defaults to C<4242>.
7817 =item B<HostTags> I<String>
7819 When set, I<HostTags> is added to the end of the metric. It is intended to be
7820 used for name=value pairs that the TSD will tag the metric with. Dots and
7821 whitespace are I<not> escaped in this string.
7823 =item B<StoreRates> B<false>|B<true>
7825 If set to B<true>, convert counter values to rates. If set to B<false>
7826 (the default) counter values are stored as is, as an increasing
7829 =item B<AlwaysAppendDS> B<false>|B<true>
7831 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7832 identifier. If set to B<false> (the default), this is only done when there is
7837 =head2 Plugin C<write_mongodb>
7839 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7844 <Plugin "write_mongodb">
7853 The plugin can send values to multiple instances of I<MongoDB> by specifying
7854 one B<Node> block for each instance. Within the B<Node> blocks, the following
7855 options are available:
7859 =item B<Host> I<Address>
7861 Hostname or address to connect to. Defaults to C<localhost>.
7863 =item B<Port> I<Service>
7865 Service name or port number to connect to. Defaults to C<27017>.
7867 =item B<Timeout> I<Milliseconds>
7869 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7870 Setting this option to zero means no timeout, which is the default.
7872 =item B<StoreRates> B<false>|B<true>
7874 If set to B<true> (the default), convert counter values to rates. If set to
7875 B<false> counter values are stored as is, i.e. as an increasing integer
7878 =item B<Database> I<Database>
7880 =item B<User> I<User>
7882 =item B<Password> I<Password>
7884 Sets the information used when authenticating to a I<MongoDB> database. The
7885 fields are optional (in which case no authentication is attempted), but if you
7886 want to use authentication all three fields must be set.
7890 =head2 Plugin C<write_http>
7892 This output plugin submits values to an HTTP server using POST requests and
7893 encoding metrics with JSON or using the C<PUTVAL> command described in
7894 L<collectd-unixsock(5)>.
7898 <Plugin "write_http">
7900 URL "http://example.com/post-collectd"
7907 The plugin can send values to multiple HTTP servers by specifying one
7908 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7909 block, the following options are available:
7915 URL to which the values are submitted to. Mandatory.
7917 =item B<User> I<Username>
7919 Optional user name needed for authentication.
7921 =item B<Password> I<Password>
7923 Optional password needed for authentication.
7925 =item B<VerifyPeer> B<true>|B<false>
7927 Enable or disable peer SSL certificate verification. See
7928 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7930 =item B<VerifyHost> B<true|false>
7932 Enable or disable peer host name verification. If enabled, the plugin checks if
7933 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7934 matches the host name provided by the B<URL> option. If this identity check
7935 fails, the connection is aborted. Obviously, only works when connecting to a
7936 SSL enabled server. Enabled by default.
7938 =item B<CACert> I<File>
7940 File that holds one or more SSL certificates. If you want to use HTTPS you will
7941 possibly need this option. What CA certificates come bundled with C<libcurl>
7942 and are checked by default depends on the distribution you use.
7944 =item B<CAPath> I<Directory>
7946 Directory holding one or more CA certificate files. You can use this if for
7947 some reason all the needed CA certificates aren't in the same file and can't be
7948 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7951 =item B<ClientKey> I<File>
7953 File that holds the private key in PEM format to be used for certificate-based
7956 =item B<ClientCert> I<File>
7958 File that holds the SSL certificate to be used for certificate-based
7961 =item B<ClientKeyPass> I<Password>
7963 Password required to load the private key in B<ClientKey>.
7965 =item B<Header> I<Header>
7967 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
7969 Header "X-Custom-Header: custom_value"
7971 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7973 Define which SSL protocol version must be used. By default C<libcurl> will
7974 attempt to figure out the remote SSL protocol version. See
7975 L<curl_easy_setopt(3)> for more details.
7977 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
7979 Format of the output to generate. If set to B<Command>, will create output that
7980 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7981 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
7982 , will create output in the KairosDB format.
7984 Defaults to B<Command>.
7986 =item B<Metrics> B<true>|B<false>
7988 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
7990 =item B<Notifications> B<false>|B<true>
7992 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
7994 =item B<StoreRates> B<true|false>
7996 If set to B<true>, convert counter values to rates. If set to B<false> (the
7997 default) counter values are stored as is, i.e. as an increasing integer number.
7999 =item B<BufferSize> I<Bytes>
8001 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
8002 requests will be generated, but more metrics will be batched / metrics are
8003 cached for longer before being sent, introducing additional delay until they
8004 are available on the server side. I<Bytes> must be at least 1024 and cannot
8005 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
8006 Defaults to C<4096>.
8008 =item B<LowSpeedLimit> I<Bytes per Second>
8010 Sets the minimal transfer rate in I<Bytes per Second> below which the
8011 connection with the HTTP server will be considered too slow and aborted. All
8012 the data submitted over this connection will probably be lost. Defaults to 0,
8013 which means no minimum transfer rate is enforced.
8015 =item B<Timeout> I<Timeout>
8017 Sets the maximum time in milliseconds given for HTTP POST operations to
8018 complete. When this limit is reached, the POST operation will be aborted, and
8019 all the data in the current send buffer will probably be lost. Defaults to 0,
8020 which means the connection never times out.
8022 =item B<LogHttpError> B<false>|B<true>
8024 Enables printing of HTTP error code to log. Turned off by default.
8026 The C<write_http> plugin regularly submits the collected values to the HTTP
8027 server. How frequently this happens depends on how much data you are collecting
8028 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
8029 slightly below this interval, which you can estimate by monitoring the network
8030 traffic between collectd and the HTTP server.
8034 =head2 Plugin C<write_kafka>
8036 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
8040 <Plugin "write_kafka">
8041 Property "metadata.broker.list" "broker1:9092,broker2:9092"
8047 The following options are understood by the I<write_kafka plugin>:
8051 =item E<lt>B<Topic> I<Name>E<gt>
8053 The plugin's configuration consists of one or more B<Topic> blocks. Each block
8054 is given a unique I<Name> and specifies one kafka producer.
8055 Inside the B<Topic> block, the following per-topic options are
8060 =item B<Property> I<String> I<String>
8062 Configure the named property for the current topic. Properties are
8063 forwarded to the kafka producer library B<librdkafka>.
8065 =item B<Key> I<String>
8067 Use the specified string as a partioning key for the topic. Kafka breaks
8068 topic into partitions and guarantees that for a given topology, the same
8069 consumer will be used for a specific key. The special (case insensitive)
8070 string B<Random> can be used to specify that an arbitrary partition should
8073 =item B<Format> B<Command>|B<JSON>|B<Graphite>
8075 Selects the format in which messages are sent to the broker. If set to
8076 B<Command> (the default), values are sent as C<PUTVAL> commands which are
8077 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
8079 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
8080 an easy and straight forward exchange format.
8082 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
8083 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
8085 =item B<StoreRates> B<true>|B<false>
8087 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
8088 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
8089 default), no conversion is performed. Otherwise the conversion is performed
8090 using the internal value cache.
8092 Please note that currently this option is only used if the B<Format> option has
8093 been set to B<JSON>.
8095 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
8097 A prefix can be added in the metric name when outputting in the I<Graphite>
8098 format. It's added before the I<Host> name.
8100 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>>
8102 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
8104 A postfix can be added in the metric name when outputting in the I<Graphite>
8105 format. It's added after the I<Host> name.
8107 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>>
8109 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
8111 Specify a character to replace dots (.) in the host part of the metric name.
8112 In I<Graphite> metric name, dots are used as separators between different
8113 metric parts (host, plugin, type).
8114 Default is C<_> (I<Underscore>).
8116 =item B<GraphiteSeparateInstances> B<false>|B<true>
8118 If set to B<true>, the plugin instance and type instance will be in their own
8119 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8120 default), the plugin and plugin instance (and likewise the type and type
8121 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8123 =item B<StoreRates> B<true>|B<false>
8125 If set to B<true> (the default), convert counter values to rates. If set to
8126 B<false> counter values are stored as is, i.e. as an increasing integer number.
8128 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
8129 converted values will have "rate" appended to the data source type, e.g.
8130 C<ds_type:derive:rate>.
8134 =item B<Property> I<String> I<String>
8136 Configure the kafka producer through properties, you almost always will
8137 want to set B<metadata.broker.list> to your Kafka broker list.
8141 =head2 Plugin C<write_redis>
8143 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
8147 <Plugin "write_redis">
8159 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
8160 the timestamp as the score. Retrieving a date range can then be done using the
8161 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
8162 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
8163 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
8164 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
8165 with the B<Database> parameter (default is C<0>). See
8166 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
8169 The information shown in the synopsis above is the I<default configuration>
8170 which is used by the plugin if no configuration is present.
8172 The plugin can send values to multiple instances of I<Redis> by specifying
8173 one B<Node> block for each instance. Within the B<Node> blocks, the following
8174 options are available:
8178 =item B<Node> I<Nodename>
8180 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
8181 instance running on a specified host and port. The node name is a
8182 canonical identifier which is used as I<plugin instance>. It is limited to
8183 51E<nbsp>characters in length.
8185 =item B<Host> I<Hostname>
8187 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
8190 =item B<Port> I<Port>
8192 The B<Port> option is the TCP port on which the Redis instance accepts
8193 connections. Either a service name of a port number may be given. Please note
8194 that numerical port numbers must be given as a string, too.
8196 =item B<Timeout> I<Milliseconds>
8198 The B<Timeout> option sets the socket connection timeout, in milliseconds.
8200 =item B<Prefix> I<Prefix>
8202 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
8203 containing all metrics. Defaults to C<collectd/>, so metrics will have names
8204 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
8205 is recommended but not required to include a trailing slash in I<Prefix>.
8207 =item B<Database> I<Index>
8209 This index selects the redis database to use for writing operations. Defaults
8212 =item B<MaxSetSize> I<Items>
8214 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
8215 hold. Negative values for I<Items> sets no limit, which is the default behavior.
8217 =item B<StoreRates> B<true>|B<false>
8219 If set to B<true> (the default), convert counter values to rates. If set to
8220 B<false> counter values are stored as is, i.e. as an increasing integer number.
8224 =head2 Plugin C<write_riemann>
8226 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
8227 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
8228 I<Riemann> using UDP packets.
8232 <Plugin "write_riemann">
8238 AlwaysAppendDS false
8242 Attribute "foo" "bar"
8245 The following options are understood by the I<write_riemann plugin>:
8249 =item E<lt>B<Node> I<Name>E<gt>
8251 The plugin's configuration consists of one or more B<Node> blocks. Each block
8252 is given a unique I<Name> and specifies one connection to an instance of
8253 I<Riemann>. Indise the B<Node> block, the following per-connection options are
8258 =item B<Host> I<Address>
8260 Hostname or address to connect to. Defaults to C<localhost>.
8262 =item B<Port> I<Service>
8264 Service name or port number to connect to. Defaults to C<5555>.
8266 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
8268 Specify the protocol to use when communicating with I<Riemann>. Defaults to
8271 =item B<TLSCertFile> I<Path>
8273 When using the B<TLS> protocol, path to a PEM certificate to present
8276 =item B<TLSCAFile> I<Path>
8278 When using the B<TLS> protocol, path to a PEM CA certificate to
8279 use to validate the remote hosts's identity.
8281 =item B<TLSKeyFile> I<Path>
8283 When using the B<TLS> protocol, path to a PEM private key associated
8284 with the certificate defined by B<TLSCertFile>.
8286 =item B<Batch> B<true>|B<false>
8288 If set to B<true> and B<Protocol> is set to B<TCP>,
8289 events will be batched in memory and flushed at
8290 regular intervals or when B<BatchMaxSize> is exceeded.
8292 Notifications are not batched and sent as soon as possible.
8294 When enabled, it can occur that events get processed by the Riemann server
8295 close to or after their expiration time. Tune the B<TTLFactor> and
8296 B<BatchMaxSize> settings according to the amount of values collected, if this
8301 =item B<BatchMaxSize> I<size>
8303 Maximum payload size for a riemann packet. Defaults to 8192
8305 =item B<BatchFlushTimeout> I<seconds>
8307 Maximum amount of seconds to wait in between to batch flushes.
8308 No timeout by default.
8310 =item B<StoreRates> B<true>|B<false>
8312 If set to B<true> (the default), convert counter values to rates. If set to
8313 B<false> counter values are stored as is, i.e. as an increasing integer number.
8315 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
8316 converted values will have "rate" appended to the data source type, e.g.
8317 C<ds_type:derive:rate>.
8319 =item B<AlwaysAppendDS> B<false>|B<true>
8321 If set to B<true>, append the name of the I<Data Source> (DS) to the
8322 "service", i.e. the field that, together with the "host" field, uniquely
8323 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
8324 only done when there is more than one DS.
8326 =item B<TTLFactor> I<Factor>
8328 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
8329 event is considered active. I<collectd> populates this field based on the
8330 metrics interval setting. This setting controls the factor with which the
8331 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
8332 know exactly what you're doing, you should only increase this setting from its
8335 =item B<Notifications> B<false>|B<true>
8337 If set to B<true>, create riemann events for notifications. This is B<true>
8338 by default. When processing thresholds from write_riemann, it might prove
8339 useful to avoid getting notification events.
8341 =item B<CheckThresholds> B<false>|B<true>
8343 If set to B<true>, attach state to events based on thresholds defined
8344 in the B<Threshold> plugin. Defaults to B<false>.
8346 =item B<EventServicePrefix> I<String>
8348 Add the given string as a prefix to the event service name.
8349 If B<EventServicePrefix> not set or set to an empty string (""),
8350 no prefix will be used.
8354 =item B<Tag> I<String>
8356 Add the given string as an additional tag to the metric being sent to
8359 =item B<Attribute> I<String> I<String>
8361 Consider the two given strings to be the key and value of an additional
8362 attribute for each metric being sent out to I<Riemann>.
8366 =head2 Plugin C<write_sensu>
8368 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
8369 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
8370 a local I<Sensu> client using a TCP socket.
8372 At the moment, the I<write_sensu plugin> does not send over a collectd_host
8373 parameter so it is not possible to use one collectd instance as a gateway for
8374 others. Each collectd host must pair with one I<Sensu> client.
8378 <Plugin "write_sensu">
8383 AlwaysAppendDS false
8384 MetricHandler "influx"
8385 MetricHandler "default"
8386 NotificationHandler "flapjack"
8387 NotificationHandler "howling_monkey"
8391 Attribute "foo" "bar"
8394 The following options are understood by the I<write_sensu plugin>:
8398 =item E<lt>B<Node> I<Name>E<gt>
8400 The plugin's configuration consists of one or more B<Node> blocks. Each block
8401 is given a unique I<Name> and specifies one connection to an instance of
8402 I<Sensu>. Inside the B<Node> block, the following per-connection options are
8407 =item B<Host> I<Address>
8409 Hostname or address to connect to. Defaults to C<localhost>.
8411 =item B<Port> I<Service>
8413 Service name or port number to connect to. Defaults to C<3030>.
8415 =item B<StoreRates> B<true>|B<false>
8417 If set to B<true> (the default), convert counter values to rates. If set to
8418 B<false> counter values are stored as is, i.e. as an increasing integer number.
8420 This will be reflected in the C<collectd_data_source_type> tag: If
8421 B<StoreRates> is enabled, converted values will have "rate" appended to the
8422 data source type, e.g. C<collectd_data_source_type:derive:rate>.
8424 =item B<AlwaysAppendDS> B<false>|B<true>
8426 If set the B<true>, append the name of the I<Data Source> (DS) to the
8427 "service", i.e. the field that, together with the "host" field, uniquely
8428 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
8429 only done when there is more than one DS.
8431 =item B<Notifications> B<false>|B<true>
8433 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
8434 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
8436 =item B<Metrics> B<false>|B<true>
8438 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
8439 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
8442 =item B<Separator> I<String>
8444 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
8446 =item B<MetricHandler> I<String>
8448 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
8449 several of them, one per line. Defaults to no handler.
8451 =item B<NotificationHandler> I<String>
8453 Add a handler that will be set when notifications are sent to I<Sensu>. You can
8454 add several of them, one per line. Defaults to no handler.
8456 =item B<EventServicePrefix> I<String>
8458 Add the given string as a prefix to the event service name.
8459 If B<EventServicePrefix> not set or set to an empty string (""),
8460 no prefix will be used.
8464 =item B<Tag> I<String>
8466 Add the given string as an additional tag to the metric being sent to
8469 =item B<Attribute> I<String> I<String>
8471 Consider the two given strings to be the key and value of an additional
8472 attribute for each metric being sent out to I<Sensu>.
8476 =head2 Plugin C<xencpu>
8478 This plugin collects metrics of hardware CPU load for machine running Xen
8479 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
8480 Result is reported using the C<percent> type, for each CPU (core).
8482 This plugin doesn't have any options (yet).
8484 =head2 Plugin C<zookeeper>
8486 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
8487 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
8492 <Plugin "zookeeper">
8499 =item B<Host> I<Address>
8501 Hostname or address to connect to. Defaults to C<localhost>.
8503 =item B<Port> I<Service>
8505 Service name or port number to connect to. Defaults to C<2181>.
8509 =head1 THRESHOLD CONFIGURATION
8511 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
8512 we mean that the values are not only stored or sent somewhere, but that they
8513 are judged and, if a problem is recognized, acted upon. The only action
8514 collectd takes itself is to generate and dispatch a "notification". Plugins can
8515 register to receive notifications and perform appropriate further actions.
8517 Since systems and what you expect them to do differ a lot, you can configure
8518 B<thresholds> for your values freely. This gives you a lot of flexibility but
8519 also a lot of responsibility.
8521 Every time a value is out of range a notification is dispatched. This means
8522 that the idle percentage of your CPU needs to be less then the configured
8523 threshold only once for a notification to be generated. There's no such thing
8524 as a moving average or similar - at least not now.
8526 Also, all values that match a threshold are considered to be relevant or
8527 "interesting". As a consequence collectd will issue a notification if they are
8528 not received for B<Timeout> iterations. The B<Timeout> configuration option is
8529 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
8530 "2" (the default) and some hosts sends it's CPU statistics to the server every
8531 60 seconds, a notification will be dispatched after about 120 seconds. It may
8532 take a little longer because the timeout is checked only once each B<Interval>
8535 When a value comes within range again or is received after it was missing, an
8536 "OKAY-notification" is dispatched.
8538 Here is a configuration example to get you started. Read below for more
8551 <Plugin "interface">
8568 WarningMin 100000000
8574 There are basically two types of configuration statements: The C<Host>,
8575 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
8576 configured. The C<Plugin> and C<Type> blocks may be specified further using the
8577 C<Instance> option. You can combine the block by nesting the blocks, though
8578 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
8579 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
8580 C<Type> may not contain other blocks. If multiple blocks apply to the same
8581 value the most specific block is used.
8583 The other statements specify the threshold to configure. They B<must> be
8584 included in a C<Type> block. Currently the following statements are recognized:
8588 =item B<FailureMax> I<Value>
8590 =item B<WarningMax> I<Value>
8592 Sets the upper bound of acceptable values. If unset defaults to positive
8593 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
8594 will be created. If the value is greater than B<WarningMax> but less than (or
8595 equal to) B<FailureMax> a B<WARNING> notification will be created.
8597 =item B<FailureMin> I<Value>
8599 =item B<WarningMin> I<Value>
8601 Sets the lower bound of acceptable values. If unset defaults to negative
8602 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
8603 be created. If the value is less than B<WarningMin> but greater than (or equal
8604 to) B<FailureMin> a B<WARNING> notification will be created.
8606 =item B<DataSource> I<DSName>
8608 Some data sets have more than one "data source". Interesting examples are the
8609 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
8610 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
8611 system load data set, C<load>, even has three data sources: C<shortterm>,
8612 C<midterm>, and C<longterm>.
8614 Normally, all data sources are checked against a configured threshold. If this
8615 is undesirable, or if you want to specify different limits for each data
8616 source, you can use the B<DataSource> option to have a threshold apply only to
8619 =item B<Invert> B<true>|B<false>
8621 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
8622 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
8623 B<WarningMax>) are not okay. Defaults to B<false>.
8625 =item B<Persist> B<true>|B<false>
8627 Sets how often notifications are generated. If set to B<true> one notification
8628 will be generated for each value that is out of the acceptable range. If set to
8629 B<false> (the default) then a notification is only generated if a value is out
8630 of range but the previous value was okay.
8632 This applies to missing values, too: If set to B<true> a notification about a
8633 missing value is generated once every B<Interval> seconds. If set to B<false>
8634 only one such notification is generated until the value appears again.
8636 =item B<Percentage> B<true>|B<false>
8638 If set to B<true>, the minimum and maximum values given are interpreted as
8639 percentage value, relative to the other data sources. This is helpful for
8640 example for the "df" type, where you may want to issue a warning when less than
8641 5E<nbsp>% of the total space is available. Defaults to B<false>.
8643 =item B<Hits> I<Number>
8645 Delay creating the notification until the threshold has been passed I<Number>
8646 times. When a notification has been generated, or when a subsequent value is
8647 inside the threshold, the counter is reset. If, for example, a value is
8648 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
8649 will be dispatched at most once every 30E<nbsp>seconds.
8651 This is useful when short bursts are not a problem. If, for example, 100% CPU
8652 usage for up to a minute is normal (and data is collected every
8653 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
8655 =item B<Hysteresis> I<Number>
8657 When set to non-zero, a hysteresis value is applied when checking minimum and
8658 maximum bounds. This is useful for values that increase slowly and fluctuate a
8659 bit while doing so. When these values come close to the threshold, they may
8660 "flap", i.e. switch between failure / warning case and okay case repeatedly.
8662 If, for example, the threshold is configures as
8667 then a I<Warning> notification is created when the value exceeds I<101> and the
8668 corresponding I<Okay> notification is only created once the value falls below
8669 I<99>, thus avoiding the "flapping".
8673 =head1 FILTER CONFIGURATION
8675 Starting with collectd 4.6 there is a powerful filtering infrastructure
8676 implemented in the daemon. The concept has mostly been copied from
8677 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
8678 terminology, so that users that are familiar with iptables feel right at home.
8682 The following are the terms used in the remainder of the filter configuration
8683 documentation. For an ASCII-art schema of the mechanism, see
8684 L<"General structure"> below.
8690 A I<match> is a criteria to select specific values. Examples are, of course, the
8691 name of the value or it's current value.
8693 Matches are implemented in plugins which you have to load prior to using the
8694 match. The name of such plugins starts with the "match_" prefix.
8698 A I<target> is some action that is to be performed with data. Such actions
8699 could, for example, be to change part of the value's identifier or to ignore
8700 the value completely.
8702 Some of these targets are built into the daemon, see L<"Built-in targets">
8703 below. Other targets are implemented in plugins which you have to load prior to
8704 using the target. The name of such plugins starts with the "target_" prefix.
8708 The combination of any number of matches and at least one target is called a
8709 I<rule>. The target actions will be performed for all values for which B<all>
8710 matches apply. If the rule does not have any matches associated with it, the
8711 target action will be performed for all values.
8715 A I<chain> is a list of rules and possibly default targets. The rules are tried
8716 in order and if one matches, the associated target will be called. If a value
8717 is handled by a rule, it depends on the target whether or not any subsequent
8718 rules are considered or if traversal of the chain is aborted, see
8719 L<"Flow control"> below. After all rules have been checked, the default targets
8724 =head2 General structure
8726 The following shows the resulting structure:
8733 +---------+ +---------+ +---------+ +---------+
8734 ! Rule !->! Match !->! Match !->! Target !
8735 +---------+ +---------+ +---------+ +---------+
8738 +---------+ +---------+ +---------+
8739 ! Rule !->! Target !->! Target !
8740 +---------+ +---------+ +---------+
8747 +---------+ +---------+ +---------+
8748 ! Rule !->! Match !->! Target !
8749 +---------+ +---------+ +---------+
8759 There are four ways to control which way a value takes through the filter
8766 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
8767 process the value with another chain. When the called chain finishes, usually
8768 the next target or rule after the jump is executed.
8772 The stop condition, signaled for example by the built-in target B<stop>, causes
8773 all processing of the value to be stopped immediately.
8777 Causes processing in the current chain to be aborted, but processing of the
8778 value generally will continue. This means that if the chain was called via
8779 B<Jump>, the next target or rule after the jump will be executed. If the chain
8780 was not called by another chain, control will be returned to the daemon and it
8781 may pass the value to another chain.
8785 Most targets will signal the B<continue> condition, meaning that processing
8786 should continue normally. There is no special built-in target for this
8793 The configuration reflects this structure directly:
8795 PostCacheChain "PostCache"
8797 <Rule "ignore_mysql_show">
8800 Type "^mysql_command$"
8801 TypeInstance "^show_"
8811 The above configuration example will ignore all values where the plugin field
8812 is "mysql", the type is "mysql_command" and the type instance begins with
8813 "show_". All other values will be sent to the C<rrdtool> write plugin via the
8814 default target of the chain. Since this chain is run after the value has been
8815 added to the cache, the MySQL C<show_*> command statistics will be available
8816 via the C<unixsock> plugin.
8818 =head2 List of configuration options
8822 =item B<PreCacheChain> I<ChainName>
8824 =item B<PostCacheChain> I<ChainName>
8826 Configure the name of the "pre-cache chain" and the "post-cache chain". The
8827 argument is the name of a I<chain> that should be executed before and/or after
8828 the values have been added to the cache.
8830 To understand the implications, it's important you know what is going on inside
8831 I<collectd>. The following diagram shows how values are passed from the
8832 read-plugins to the write-plugins:
8838 + - - - - V - - - - +
8839 : +---------------+ :
8842 : +-------+-------+ :
8845 : +-------+-------+ : +---------------+
8846 : ! Cache !--->! Value Cache !
8847 : ! insert ! : +---+---+-------+
8848 : +-------+-------+ : ! !
8849 : ! ,------------' !
8851 : +-------+---+---+ : +-------+-------+
8852 : ! Post-Cache +--->! Write-Plugins !
8853 : ! Chain ! : +---------------+
8854 : +---------------+ :
8857 + - - - - - - - - - +
8859 After the values are passed from the "read" plugins to the dispatch functions,
8860 the pre-cache chain is run first. The values are added to the internal cache
8861 afterwards. The post-cache chain is run after the values have been added to the
8862 cache. So why is it such a huge deal if chains are run before or after the
8863 values have been added to this cache?
8865 Targets that change the identifier of a value list should be executed before
8866 the values are added to the cache, so that the name in the cache matches the
8867 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
8868 this cache to receive a list of all available values. If you change the
8869 identifier after the value list has been added to the cache, this may easily
8870 lead to confusion, but it's not forbidden of course.
8872 The cache is also used to convert counter values to rates. These rates are, for
8873 example, used by the C<value> match (see below). If you use the rate stored in
8874 the cache B<before> the new value is added, you will use the old, B<previous>
8875 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
8876 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
8879 Last but not last, the B<stop> target makes a difference: If the pre-cache
8880 chain returns the stop condition, the value will not be added to the cache and
8881 the post-cache chain will not be run.
8883 =item B<Chain> I<Name>
8885 Adds a new chain with a certain name. This name can be used to refer to a
8886 specific chain, for example to jump to it.
8888 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
8890 =item B<Rule> [I<Name>]
8892 Adds a new rule to the current chain. The name of the rule is optional and
8893 currently has no meaning for the daemon.
8895 Within the B<Rule> block, there may be any number of B<Match> blocks and there
8896 must be at least one B<Target> block.
8898 =item B<Match> I<Name>
8900 Adds a match to a B<Rule> block. The name specifies what kind of match should
8901 be performed. Available matches depend on the plugins that have been loaded.
8903 The arguments inside the B<Match> block are passed to the plugin implementing
8904 the match, so which arguments are valid here depends on the plugin being used.
8905 If you do not need any to pass any arguments to a match, you can use the
8910 Which is equivalent to:
8915 =item B<Target> I<Name>
8917 Add a target to a rule or a default target to a chain. The name specifies what
8918 kind of target is to be added. Which targets are available depends on the
8919 plugins being loaded.
8921 The arguments inside the B<Target> block are passed to the plugin implementing
8922 the target, so which arguments are valid here depends on the plugin being used.
8923 If you do not need any to pass any arguments to a target, you can use the
8928 This is the same as writing:
8935 =head2 Built-in targets
8937 The following targets are built into the core daemon and therefore need no
8938 plugins to be loaded:
8944 Signals the "return" condition, see the L<"Flow control"> section above. This
8945 causes the current chain to stop processing the value and returns control to
8946 the calling chain. The calling chain will continue processing targets and rules
8947 just after the B<jump> target (see below). This is very similar to the
8948 B<RETURN> target of iptables, see L<iptables(8)>.
8950 This target does not have any options.
8958 Signals the "stop" condition, see the L<"Flow control"> section above. This
8959 causes processing of the value to be aborted immediately. This is similar to
8960 the B<DROP> target of iptables, see L<iptables(8)>.
8962 This target does not have any options.
8970 Sends the value to "write" plugins.
8976 =item B<Plugin> I<Name>
8978 Name of the write plugin to which the data should be sent. This option may be
8979 given multiple times to send the data to more than one write plugin. If the
8980 plugin supports multiple instances, the plugin's instance(s) must also be
8985 If no plugin is explicitly specified, the values will be sent to all available
8988 Single-instance plugin example:
8994 Multi-instance plugin example:
8996 <Plugin "write_graphite">
9006 Plugin "write_graphite/foo"
9011 Starts processing the rules of another chain, see L<"Flow control"> above. If
9012 the end of that chain is reached, or a stop condition is encountered,
9013 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
9014 next target or the next rule. This is similar to the B<-j> command line option
9015 of iptables, see L<iptables(8)>.
9021 =item B<Chain> I<Name>
9023 Jumps to the chain I<Name>. This argument is required and may appear only once.
9035 =head2 Available matches
9041 Matches a value using regular expressions.
9047 =item B<Host> I<Regex>
9049 =item B<Plugin> I<Regex>
9051 =item B<PluginInstance> I<Regex>
9053 =item B<Type> I<Regex>
9055 =item B<TypeInstance> I<Regex>
9057 Match values where the given regular expressions match the various fields of
9058 the identifier of a value. If multiple regular expressions are given, B<all>
9059 regexen must match for a value to match.
9061 =item B<Invert> B<false>|B<true>
9063 When set to B<true>, the result of the match is inverted, i.e. all value lists
9064 where all regular expressions apply are not matched, all other value lists are
9065 matched. Defaults to B<false>.
9072 Host "customer[0-9]+"
9078 Matches values that have a time which differs from the time on the server.
9080 This match is mainly intended for servers that receive values over the
9081 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
9082 is very sensitive to the timestamp used when updating the RRD files. In
9083 particular, the time must be ever increasing. If a misbehaving client sends one
9084 packet with a timestamp far in the future, all further packets with a correct
9085 time will be ignored because of that one packet. What's worse, such corrupted
9086 RRD files are hard to fix.
9088 This match lets one match all values B<outside> a specified time range
9089 (relative to the server's time), so you can use the B<stop> target (see below)
9090 to ignore the value, for example.
9096 =item B<Future> I<Seconds>
9098 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
9099 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
9102 =item B<Past> I<Seconds>
9104 Matches all values that are I<behind> of the server's time by I<Seconds> or
9105 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
9117 This example matches all values that are five minutes or more ahead of the
9118 server or one hour (or more) lagging behind.
9122 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
9123 values. If a data-set consists of more than one data-source, all data-sources
9124 must match the specified ranges for a positive match.
9130 =item B<Min> I<Value>
9132 Sets the smallest value which still results in a match. If unset, behaves like
9135 =item B<Max> I<Value>
9137 Sets the largest value which still results in a match. If unset, behaves like
9140 =item B<Invert> B<true>|B<false>
9142 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
9143 no-match is returned and vice versa. Please note that the B<Invert> setting
9144 only effects how B<Min> and B<Max> are applied to a specific value. Especially
9145 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
9147 =item B<DataSource> I<DSName> [I<DSName> ...]
9149 Select one or more of the data sources. If no data source is configured, all
9150 data sources will be checked. If the type handled by the match does not have a
9151 data source of the specified name(s), this will always result in no match
9152 (independent of the B<Invert> setting).
9154 =item B<Satisfy> B<Any>|B<All>
9156 Specifies how checking with several data sources is performed. If set to
9157 B<Any>, the match succeeds if one of the data sources is in the configured
9158 range. If set to B<All> the match only succeeds if all data sources are within
9159 the configured range. Default is B<All>.
9161 Usually B<All> is used for positive matches, B<Any> is used for negative
9162 matches. This means that with B<All> you usually check that all values are in a
9163 "good" range, while with B<Any> you check if any value is within a "bad" range
9164 (or outside the "good" range).
9168 Either B<Min> or B<Max>, but not both, may be unset.
9172 # Match all values smaller than or equal to 100. Matches only if all data
9173 # sources are below 100.
9179 # Match if the value of any data source is outside the range of 0 - 100.
9187 =item B<empty_counter>
9189 Matches all values with one or more data sources of type B<COUNTER> and where
9190 all counter values are zero. These counters usually I<never> increased since
9191 they started existing (and are therefore uninteresting), or got reset recently
9192 or overflowed and you had really, I<really> bad luck.
9194 Please keep in mind that ignoring such counters can result in confusing
9195 behavior: Counters which hardly ever increase will be zero for long periods of
9196 time. If the counter is reset for some reason (machine or service restarted,
9197 usually), the graph will be empty (NAN) for a long time. People may not
9202 Calculates a hash value of the host name and matches values according to that
9203 hash value. This makes it possible to divide all hosts into groups and match
9204 only values that are in a specific group. The intended use is in load
9205 balancing, where you want to handle only part of all data and leave the rest
9208 The hashing function used tries to distribute the hosts evenly. First, it
9209 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
9212 for (i = 0; host[i] != 0; i++)
9213 hash_value = (hash_value * 251) + host[i];
9215 The constant 251 is a prime number which is supposed to make this hash value
9216 more random. The code then checks the group for this host according to the
9217 I<Total> and I<Match> arguments:
9219 if ((hash_value % Total) == Match)
9224 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
9225 groups), then the least significant bit of the hash value will be the XOR of
9226 all least significant bits in the host name. One consequence is that when you
9227 have two hosts, "server0.example.com" and "server1.example.com", where the host
9228 name differs in one digit only and the digits differ by one, those hosts will
9229 never end up in the same group.
9235 =item B<Match> I<Match> I<Total>
9237 Divide the data into I<Total> groups and match all hosts in group I<Match> as
9238 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
9239 be smaller than I<Total>. I<Total> must be at least one, although only values
9240 greater than one really do make any sense.
9242 You can repeat this option to match multiple groups, for example:
9247 The above config will divide the data into seven groups and match groups three
9248 and five. One use would be to keep every value on two hosts so that if one
9249 fails the missing data can later be reconstructed from the second host.
9255 # Operate on the pre-cache chain, so that ignored values are not even in the
9260 # Divide all received hosts in seven groups and accept all hosts in
9264 # If matched: Return and continue.
9267 # If not matched: Return and stop.
9273 =head2 Available targets
9277 =item B<notification>
9279 Creates and dispatches a notification.
9285 =item B<Message> I<String>
9287 This required option sets the message of the notification. The following
9288 placeholders will be replaced by an appropriate value:
9296 =item B<%{plugin_instance}>
9300 =item B<%{type_instance}>
9302 These placeholders are replaced by the identifier field of the same name.
9304 =item B<%{ds:>I<name>B<}>
9306 These placeholders are replaced by a (hopefully) human readable representation
9307 of the current rate of this data source. If you changed the instance name
9308 (using the B<set> or B<replace> targets, see below), it may not be possible to
9309 convert counter values to rates.
9313 Please note that these placeholders are B<case sensitive>!
9315 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
9317 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
9324 <Target "notification">
9325 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
9331 Replaces parts of the identifier using regular expressions.
9337 =item B<Host> I<Regex> I<Replacement>
9339 =item B<Plugin> I<Regex> I<Replacement>
9341 =item B<PluginInstance> I<Regex> I<Replacement>
9343 =item B<TypeInstance> I<Regex> I<Replacement>
9345 Match the appropriate field with the given regular expression I<Regex>. If the
9346 regular expression matches, that part that matches is replaced with
9347 I<Replacement>. If multiple places of the input buffer match a given regular
9348 expression, only the first occurrence will be replaced.
9350 You can specify each option multiple times to use multiple regular expressions
9358 # Replace "example.net" with "example.com"
9359 Host "\\<example.net\\>" "example.com"
9361 # Strip "www." from hostnames
9367 Sets part of the identifier of a value to a given string.
9373 =item B<Host> I<String>
9375 =item B<Plugin> I<String>
9377 =item B<PluginInstance> I<String>
9379 =item B<TypeInstance> I<String>
9381 =item B<MetaDataSet> I<String> I<String>
9383 Set the appropriate field to the given string. The strings for plugin instance
9384 and type instance may be empty, the strings for host and plugin may not be
9385 empty. It's currently not possible to set the type of a value this way.
9392 PluginInstance "coretemp"
9393 TypeInstance "core3"
9398 =head2 Backwards compatibility
9400 If you use collectd with an old configuration, i.E<nbsp>e. one without a
9401 B<Chain> block, it will behave as it used to. This is equivalent to the
9402 following configuration:
9408 If you specify a B<PostCacheChain>, the B<write> target will not be added
9409 anywhere and you will have to make sure that it is called where appropriate. We
9410 suggest to add the above snippet as default target to your "PostCache" chain.
9414 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
9430 L<collectd-exec(5)>,
9431 L<collectd-perl(5)>,
9432 L<collectd-unixsock(5)>,
9445 Florian Forster E<lt>octo@collectd.orgE<gt>