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<#>) is 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 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> then 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.:
105 The following options are valid inside B<LoadPlugin> blocks:
109 =item B<Globals> B<true|false>
111 If enabled, collectd will export all global symbols of the plugin (and of all
112 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
113 available for resolving unresolved symbols in subsequently loaded plugins if
114 that is supported by your system.
116 This is useful (or possibly even required), e.g., when loading a plugin that
117 embeds some scripting language into the daemon (e.g. the I<Perl> and
118 I<Python plugins>). Scripting languages usually provide means to load
119 extensions written in C. Those extensions require symbols provided by the
120 interpreter, which is loaded as a dependency of the respective collectd plugin.
121 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
122 L<collectd-python(5)>) for details.
124 By default, this is disabled. As a special exception, if the plugin name is
125 either C<perl> or C<python>, the default is changed to enabled in order to keep
126 the average user from ever having to deal with this low level linking stuff.
128 =item B<Interval> I<Seconds>
130 Sets a plugin-specific interval for collecting metrics. This overrides the
131 global B<Interval> setting. If a plugin provides own support for specifying an
132 interval, that setting will take precedence.
136 =item B<AutoLoadPlugin> B<false>|B<true>
138 When set to B<false> (the default), each plugin needs to be loaded explicitly,
139 using the B<LoadPlugin> statement documented above. If a
140 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
141 handling callback for this plugin has been registered, a warning is logged and
142 the block is ignored.
144 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
145 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
146 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
147 plugins that don't provide any configuration, e.g. the I<Load plugin>.
149 =item B<CollectInternalStats> B<false>|B<true>
151 When set to B<true>, various statistics about the I<collectd> daemon will be
152 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
154 The "write_queue" I<plugin instance> reports the number of elements currently
155 queued and the number of elements dropped off the queue by the
156 B<WriteQueueLimitLow>/B<WriteQueueLimitHigh> mechanism.
158 The "cache" I<plugin instance> reports the number of elements in the value list
159 cache (the cache you can interact with using L<collectd-unixsock(5)>).
161 =item B<Include> I<Path> [I<pattern>]
163 If I<Path> points to a file, includes that file. If I<Path> points to a
164 directory, recursively includes all files within that directory and its
165 subdirectories. If the C<wordexp> function is available on your system,
166 shell-like wildcards are expanded before files are included. This means you can
167 use statements like the following:
169 Include "/etc/collectd.d/*.conf"
171 Starting with version 5.3, this may also be a block in which further options
172 affecting the behavior of B<Include> may be specified. The following option is
175 <Include "/etc/collectd.d">
181 =item B<Filter> I<pattern>
183 If the C<fnmatch> function is available on your system, a shell-like wildcard
184 I<pattern> may be specified to filter which files to include. This may be used
185 in combination with recursively including a directory to easily be able to
186 arbitrarily mix configuration files and other documents (e.g. README files).
187 The given example is similar to the first example above but includes all files
188 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
190 Include "/etc/collectd.d" "*.conf"
194 If more than one files are included by a single B<Include> option, the files
195 will be included in lexicographical order (as defined by the C<strcmp>
196 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
197 order in which the files are loaded.
199 To prevent loops and shooting yourself in the foot in interesting ways the
200 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
201 most uses. Since symlinks are followed it is still possible to crash the daemon
202 by looping symlinks. In our opinion significant stupidity should result in an
203 appropriate amount of pain.
205 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
206 file, but you cannot include files from within blocks.
208 =item B<PIDFile> I<File>
210 Sets where to write the PID file to. This file is overwritten when it exists
211 and deleted when the program is stopped. Some init-scripts might override this
212 setting using the B<-P> command-line option.
214 =item B<PluginDir> I<Directory>
216 Path to the plugins (shared objects) of collectd.
218 =item B<TypesDB> I<File> [I<File> ...]
220 Set one or more files that contain the data-set descriptions. See
221 L<types.db(5)> for a description of the format of this file.
223 =item B<Interval> I<Seconds>
225 Configures the interval in which to query the read plugins. Obviously smaller
226 values lead to a higher system load produced by collectd, while higher values
227 lead to more coarse statistics.
229 B<Warning:> You should set this once and then never touch it again. If you do,
230 I<you will have to delete all your RRD files> or know some serious RRDtool
231 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
233 =item B<MaxReadInterval> I<Seconds>
235 Read plugin doubles interval between queries after each failed attempt
238 This options limits the maximum value of the interval. The default value is
241 =item B<Timeout> I<Iterations>
243 Consider a value list "missing" when no update has been read or received for
244 I<Iterations> iterations. By default, I<collectd> considers a value list
245 missing when no update has been received for twice the update interval. Since
246 this setting uses iterations, the maximum allowed time without update depends
247 on the I<Interval> information contained in each value list. This is used in
248 the I<Threshold> configuration to dispatch notifications about missing values,
249 see L<collectd-threshold(5)> for details.
251 =item B<ReadThreads> I<Num>
253 Number of threads to start for reading plugins. The default value is B<5>, but
254 you may want to increase this if you have more than five plugins that take a
255 long time to read. Mostly those are plugins that do network-IO. Setting this to
256 a value higher than the number of registered read callbacks is not recommended.
258 =item B<WriteThreads> I<Num>
260 Number of threads to start for dispatching value lists to write plugins. The
261 default value is B<5>, but you may want to increase this if you have more than
262 five plugins that may take relatively long to write to.
264 =item B<WriteQueueLimitHigh> I<HighNum>
266 =item B<WriteQueueLimitLow> I<LowNum>
268 Metrics are read by the I<read threads> and then put into a queue to be handled
269 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
270 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
271 running into memory issues in such a case, you can limit the size of this
274 By default, there is no limit and memory may grow indefinitely. This is most
275 likely not an issue for clients, i.e. instances that only handle the local
276 metrics. For servers it is recommended to set this to a non-zero value, though.
278 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
279 Each of them takes a numerical argument which is the number of metrics in the
280 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
281 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
282 I<will> be enqueued. If the number of metrics currently in the queue is between
283 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
284 proportional to the number of metrics in the queue (i.e. it increases linearly
285 until it reaches 100%.)
287 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
288 unset, the latter will default to half of B<WriteQueueLimitHigh>.
290 If you do not want to randomly drop values when the queue size is between
291 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
294 Enabling the B<CollectInternalStats> option is of great help to figure out the
295 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
297 =item B<Hostname> I<Name>
299 Sets the hostname that identifies a host. If you omit this setting, the
300 hostname will be determined using the L<gethostname(2)> system call.
302 =item B<FQDNLookup> B<true|false>
304 If B<Hostname> is determined automatically this setting controls whether or not
305 the daemon should try to figure out the "fully qualified domain name", FQDN.
306 This is done using a lookup of the name returned by C<gethostname>. This option
307 is enabled by default.
309 =item B<PreCacheChain> I<ChainName>
311 =item B<PostCacheChain> I<ChainName>
313 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
314 see L<FILTER CONFIGURATION> below on information on chains and how these
315 setting change the daemon's behavior.
319 =head1 PLUGIN OPTIONS
321 Some plugins may register own options. These options must be enclosed in a
322 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
323 require external configuration, too. The C<apache plugin>, for example,
324 required C<mod_status> to be configured in the webserver you're going to
325 collect data from. These plugins are listed below as well, even if they don't
326 require any configuration within collectd's configuration file.
328 A list of all plugins and a short summary for each plugin can be found in the
329 F<README> file shipped with the sourcecode and hopefully binary packets as
332 =head2 Plugin C<aggregation>
334 The I<Aggregation plugin> makes it possible to aggregate several values into
335 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
336 This can be put to a wide variety of uses, e.g. average and total CPU
337 statistics for your entire fleet.
339 The grouping is powerful but, as with many powerful tools, may be a bit
340 difficult to wrap your head around. The grouping will therefore be
341 demonstrated using an example: The average and sum of the CPU usage across
342 all CPUs of each host is to be calculated.
344 To select all the affected values for our example, set C<Plugin cpu> and
345 C<Type cpu>. The other values are left unspecified, meaning "all values". The
346 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
347 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
353 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
354 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
355 example, the intention is to have a new value for each host / type instance
356 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
357 It can be specified multiple times to group by more than one field.
360 GroupBy "TypeInstance"
362 We do neither specify nor group by I<plugin instance> (the CPU number), so all
363 metrics that differ in the CPU number only will be aggregated. Each
364 aggregation needs I<at least one> such field, otherwise no aggregation would
367 The full example configuration looks like this:
369 <Plugin "aggregation">
375 GroupBy "TypeInstance"
378 CalculateAverage true
382 There are a couple of limitations you should be aware of:
388 The I<Type> cannot be left unspecified, because it is not reasonable to add
389 apples to oranges. Also, the internal lookup structure won't work if you try
394 There must be at least one unspecified, ungrouped field. Otherwise nothing
399 As you can see in the example above, each aggregation has its own
400 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
401 blocks may match the same values, i.e. one value list can update multiple
402 aggregations. The following options are valid inside B<Aggregation> blocks:
406 =item B<Host> I<Host>
408 =item B<Plugin> I<Plugin>
410 =item B<PluginInstance> I<PluginInstance>
412 =item B<Type> I<Type>
414 =item B<TypeInstance> I<TypeInstance>
416 Selects the value lists to be added to this aggregation. B<Type> must be a
417 valid data set name, see L<types.db(5)> for details.
419 If the string starts with and ends with a slash (C</>), the string is
420 interpreted as a I<regular expression>. The regex flavor used are POSIX
421 extended regular expressions as described in L<regex(7)>. Example usage:
423 Host "/^db[0-9]\\.example\\.com$/"
425 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
427 Group valued by the specified field. The B<GroupBy> option may be repeated to
428 group by multiple fields.
430 =item B<SetHost> I<Host>
432 =item B<SetPlugin> I<Plugin>
434 =item B<SetPluginInstance> I<PluginInstance>
436 =item B<SetTypeInstance> I<TypeInstance>
438 Sets the appropriate part of the identifier to the provided string.
440 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
441 will be replaced with the aggregation function, e.g. "average". Not including
442 the placeholder will result in duplication warnings and/or messed up values if
443 more than one aggregation function are enabled.
445 The following example calculates the average usage of all "even" CPUs:
447 <Plugin "aggregation">
450 PluginInstance "/[0,2,4,6,8]$/"
454 SetPluginInstance "even-%{aggregation}"
457 GroupBy "TypeInstance"
459 CalculateAverage true
463 This will create the files:
469 foo.example.com/cpu-even-average/cpu-idle
473 foo.example.com/cpu-even-average/cpu-system
477 foo.example.com/cpu-even-average/cpu-user
485 =item B<CalculateNum> B<true>|B<false>
487 =item B<CalculateSum> B<true>|B<false>
489 =item B<CalculateAverage> B<true>|B<false>
491 =item B<CalculateMinimum> B<true>|B<false>
493 =item B<CalculateMaximum> B<true>|B<false>
495 =item B<CalculateStddev> B<true>|B<false>
497 Boolean options for enabling calculation of the number of value lists, their
498 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
499 are disabled by default.
503 =head2 Plugin C<amqp>
505 The I<AMQMP plugin> can be used to communicate with other instances of
506 I<collectd> or third party applications using an AMQP message broker. Values
507 are sent to or received from the broker, which handles routing, queueing and
508 possibly filtering or messages.
511 # Send values to an AMQP broker
512 <Publish "some_name">
518 Exchange "amq.fanout"
519 # ExchangeType "fanout"
520 # RoutingKey "collectd"
522 # ConnectionRetryDelay 0
525 # GraphitePrefix "collectd."
526 # GraphiteEscapeChar "_"
527 # GraphiteSeparateInstances false
528 # GraphiteAlwaysAppendDS false
531 # Receive values from an AMQP broker
532 <Subscribe "some_name">
538 Exchange "amq.fanout"
539 # ExchangeType "fanout"
542 # QueueAutoDelete true
543 # RoutingKey "collectd.#"
544 # ConnectionRetryDelay 0
548 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
549 blocks, which configure sending and receiving of values respectively. The two
550 blocks are very similar, so unless otherwise noted, an option can be used in
551 either block. The name given in the blocks starting tag is only used for
552 reporting messages, but may be used to support I<flushing> of certain
553 I<Publish> blocks in the future.
557 =item B<Host> I<Host>
559 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
560 the underlying communications library, I<rabbitmq-c>, which is "localhost".
562 =item B<Port> I<Port>
564 Service name or port number on which the AMQP broker accepts connections. This
565 argument must be a string, even if the numeric form is used. Defaults to
568 =item B<VHost> I<VHost>
570 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
572 =item B<User> I<User>
574 =item B<Password> I<Password>
576 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
579 =item B<Exchange> I<Exchange>
581 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
582 By default, "amq.fanout" will be used.
584 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
585 the given exchange and the I<queue> is created, using the I<routing key> if
586 configured. See the B<Queue> and B<RoutingKey> options below.
588 =item B<ExchangeType> I<Type>
590 If given, the plugin will try to create the configured I<exchange> with this
591 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
592 be bound to this exchange.
594 =item B<Queue> I<Queue> (Subscribe only)
596 Configures the I<queue> name to subscribe to. If no queue name was configured
597 explicitly, a unique queue name will be created by the broker.
599 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
601 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
602 or transient (will disappear if the AMQP broker is restarted). Defaults to
605 This option should be used in conjunction with the I<Persistent> option on the
608 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
610 Defines if the I<queue> subscribed to will be deleted once the last consumer
611 unsubscribes. Defaults to "true".
613 =item B<RoutingKey> I<Key>
615 In I<Publish> blocks, this configures the routing key to set on all outgoing
616 messages. If not given, the routing key will be computed from the I<identifier>
617 of the value. The host, plugin, type and the two instances are concatenated
618 together using dots as the separator and all containing dots replaced with
619 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
620 possible to receive only specific values using a "topic" exchange.
622 In I<Subscribe> blocks, configures the I<routing key> used when creating a
623 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
624 used to filter messages when using a "topic" exchange. If you're only
625 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
628 =item B<Persistent> B<true>|B<false> (Publish only)
630 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
631 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
632 default), the I<transient> delivery mode will be used, i.e. messages may be
633 lost due to high load, overflowing queues or similar issues.
635 =item B<ConnectionRetryDelay> I<Delay>
637 When the connection to the AMQP broker is lost, defines the time in seconds to
638 wait before attempting to reconnect. Defaults to 0, which implies collectd will
639 attempt to reconnect at each read interval (in Subscribe mode) or each time
640 values are ready for submission (in Publish mode).
642 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
644 Selects the format in which messages are sent to the broker. If set to
645 B<Command> (the default), values are sent as C<PUTVAL> commands which are
646 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
647 case, the C<Content-Type> header field will be set to C<text/collectd>.
649 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
650 an easy and straight forward exchange format. The C<Content-Type> header field
651 will be set to C<application/json>.
653 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
654 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
657 A subscribing client I<should> use the C<Content-Type> header field to
658 determine how to decode the values. Currently, the I<AMQP plugin> itself can
659 only decode the B<Command> format.
661 =item B<StoreRates> B<true>|B<false> (Publish only)
663 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
664 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
665 default), no conversion is performed. Otherwise the conversion is performed
666 using the internal value cache.
668 Please note that currently this option is only used if the B<Format> option has
671 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
673 A prefix can be added in the metric name when outputting in the I<Graphite> format.
674 It's added before the I<Host> name.
675 Metric name will be "<prefix><host><postfix><plugin><type><name>"
677 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
679 A postfix can be added in the metric name when outputting in the I<Graphite> format.
680 It's added after the I<Host> name.
681 Metric name will be "<prefix><host><postfix><plugin><type><name>"
683 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
685 Specify a character to replace dots (.) in the host part of the metric name.
686 In I<Graphite> metric name, dots are used as separators between different
687 metric parts (host, plugin, type).
688 Default is "_" (I<Underscore>).
690 =item B<GraphiteSeparateInstances> B<true>|B<false>
692 If set to B<true>, the plugin instance and type instance will be in their own
693 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
694 default), the plugin and plugin instance (and likewise the type and type
695 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
697 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
699 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
700 identifier. If set to B<false> (the default), this is only done when there is
705 =head2 Plugin C<apache>
707 To configure the C<apache>-plugin you first need to configure the Apache
708 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
709 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
710 the following snipped to base your Apache config upon:
713 <IfModule mod_status.c>
714 <Location /mod_status>
715 SetHandler server-status
719 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
720 also supported. It introduces a new field, called C<BusyServers>, to count the
721 number of currently connected clients. This field is also supported.
723 The configuration of the I<Apache> plugin consists of one or more
724 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
725 as the instance name. For example:
729 URL "http://www1.example.com/mod_status?auto"
732 URL "http://www2.example.com/mod_status?auto"
736 The instance name will be used as the I<plugin instance>. To emulate the old
737 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
738 plugin to work correctly, each instance name must be unique. This is not
739 enforced by the plugin and it is your responsibility to ensure it.
741 The following options are accepted within each I<Instance> block:
745 =item B<URL> I<http://host/mod_status?auto>
747 Sets the URL of the C<mod_status> output. This needs to be the output generated
748 by C<ExtendedStatus on> and it needs to be the machine readable output
749 generated by appending the C<?auto> argument. This option is I<mandatory>.
751 =item B<User> I<Username>
753 Optional user name needed for authentication.
755 =item B<Password> I<Password>
757 Optional password needed for authentication.
759 =item B<VerifyPeer> B<true|false>
761 Enable or disable peer SSL certificate verification. See
762 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
764 =item B<VerifyHost> B<true|false>
766 Enable or disable peer host name verification. If enabled, the plugin checks
767 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
768 certificate matches the host name provided by the B<URL> option. If this
769 identity check fails, the connection is aborted. Obviously, only works when
770 connecting to a SSL enabled server. Enabled by default.
772 =item B<CACert> I<File>
774 File that holds one or more SSL certificates. If you want to use HTTPS you will
775 possibly need this option. What CA certificates come bundled with C<libcurl>
776 and are checked by default depends on the distribution you use.
778 =item B<Timeout> I<Milliseconds>
780 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
781 milliseconds. By default, the configured B<Interval> is used to set the
786 =head2 Plugin C<apcups>
790 =item B<Host> I<Hostname>
792 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
793 that IPv6 support has been disabled unless someone can confirm or decline that
794 B<apcupsd> can handle it.
796 =item B<Port> I<Port>
798 TCP-Port to connect to. Defaults to B<3551>.
800 =item B<ReportSeconds> B<true|false>
802 If set to B<true>, the time reported in the C<timeleft> metric will be
803 converted to seconds. This is the recommended setting. If set to B<false>, the
804 default for backwards compatibility, the time will be reported in minutes.
808 =head2 Plugin C<aquaero>
810 This plugin collects the value of the available sensors in an
811 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
812 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
813 connection for monitoring and configuration. The board can handle multiple
814 temperature sensors, fans, water pumps and water level sensors and adjust the
815 output settings such as fan voltage or power used by the water pump based on
816 the available inputs using a configurable controller included in the board.
817 This plugin collects all the available inputs as well as some of the output
818 values chosen by this controller. The plugin is based on the I<libaquaero5>
819 library provided by I<aquatools-ng>.
823 =item B<Device> I<DevicePath>
825 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
826 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
827 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
831 =head2 Plugin C<ascent>
833 This plugin collects information about an Ascent server, a free server for the
834 "World of Warcraft" game. This plugin gathers the information by fetching the
835 XML status page using C<libcurl> and parses it using C<libxml2>.
837 The configuration options are the same as for the C<apache> plugin above:
841 =item B<URL> I<http://localhost/ascent/status/>
843 Sets the URL of the XML status output.
845 =item B<User> I<Username>
847 Optional user name needed for authentication.
849 =item B<Password> I<Password>
851 Optional password needed for authentication.
853 =item B<VerifyPeer> B<true|false>
855 Enable or disable peer SSL certificate verification. See
856 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
858 =item B<VerifyHost> B<true|false>
860 Enable or disable peer host name verification. If enabled, the plugin checks
861 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
862 certificate matches the host name provided by the B<URL> option. If this
863 identity check fails, the connection is aborted. Obviously, only works when
864 connecting to a SSL enabled server. Enabled by default.
866 =item B<CACert> I<File>
868 File that holds one or more SSL certificates. If you want to use HTTPS you will
869 possibly need this option. What CA certificates come bundled with C<libcurl>
870 and are checked by default depends on the distribution you use.
872 =item B<Timeout> I<Milliseconds>
874 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
875 milliseconds. By default, the configured B<Interval> is used to set the
880 =head2 Plugin C<barometer>
882 This plugin reads absolute air pressure using digital barometer sensor on a I2C
883 bus. Supported sensors are:
887 =item I<MPL115A2> from Freescale,
888 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
891 =item I<MPL3115> from Freescale
892 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
895 =item I<BMP085> from Bosch Sensortec
899 The sensor type - one of the above - is detected automatically by the plugin
900 and indicated in the plugin_instance (you will see subdirectory
901 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
902 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
903 (only one sensor can be used by the plugin).
905 The plugin provides absolute barometric pressure, air pressure reduced to sea
906 level (several possible approximations) and as an auxiliary value also internal
907 sensor temperature. It uses (expects/provides) typical metric units - pressure
908 in [hPa], temperature in [C], altitude in [m].
910 It was developed and tested under Linux only. The only platform dependency is
911 the standard Linux i2c-dev interface (the particular bus driver has to
912 support the SM Bus command subset).
914 The reduction or normalization to mean sea level pressure requires (depending
915 on selected method/approximation) also altitude and reference to temperature
916 sensor(s). When multiple temperature sensors are configured the minumum of
917 their values is always used (expecting that the warmer ones are affected by
918 e.g. direct sun light at that moment).
926 TemperatureOffset 0.0
929 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
934 =item B<Device> I<device>
936 The only mandatory configuration parameter.
938 Device name of the I2C bus to which the sensor is connected. Note that
939 typically you need to have loaded the i2c-dev module.
940 Using i2c-tools you can check/list i2c buses available on your system by:
944 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
948 This way you should be able to verify that the pressure sensor (either type) is
949 connected and detected on address 0x60.
951 =item B<Oversampling> I<value>
953 Optional parameter controlling the oversampling/accuracy. Default value
954 is 1 providing fastest and least accurate reading.
956 For I<MPL115> this is the size of the averaging window. To filter out sensor
957 noise a simple averaging using floating window of this configurable size is
958 used. The plugin will use average of the last C<value> measurements (value of 1
959 means no averaging). Minimal size is 1, maximal 1024.
961 For I<MPL3115> this is the oversampling value. The actual oversampling is
962 performed by the sensor and the higher value the higher accuracy and longer
963 conversion time (although nothing to worry about in the collectd context).
964 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
965 adjusted by the plugin to the closest supported one.
967 For I<BMP085> this is the oversampling value. The actual oversampling is
968 performed by the sensor and the higher value the higher accuracy and longer
969 conversion time (although nothing to worry about in the collectd context).
970 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
971 the closest supported one.
973 =item B<PressureOffset> I<offset>
975 Optional parameter for MPL3115 only.
977 You can further calibrate the sensor by supplying pressure and/or temperature
978 offsets. This is added to the measured/caclulated value (i.e. if the measured
979 value is too high then use negative offset).
980 In hPa, default is 0.0.
982 =item B<TemperatureOffset> I<offset>
984 Optional parameter for MPL3115 only.
986 You can further calibrate the sensor by supplying pressure and/or temperature
987 offsets. This is added to the measured/caclulated value (i.e. if the measured
988 value is too high then use negative offset).
989 In C, default is 0.0.
991 =item B<Normalization> I<method>
993 Optional parameter, default value is 0.
995 Normalization method - what approximation/model is used to compute the mean sea
996 level pressure from the air absolute pressure.
998 Supported values of the C<method> (integer between from 0 to 2) are:
1002 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1003 do not need to configure C<Altitude> or C<TemperatureSensor>.
1005 =item B<1> - international formula for conversion ,
1007 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1008 For this method you have to configure C<Altitude> but do not need
1009 C<TemperatureSensor> (uses fixed global temperature average instead).
1011 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1012 Meteorological Service).
1013 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1014 For this method you have to configure both C<Altitude> and
1015 C<TemperatureSensor>.
1020 =item B<Altitude> I<altitude>
1022 The altitude (in meters) of the location where you meassure the pressure.
1024 =item B<TemperatureSensor> I<reference>
1026 Temperature sensor(s) which should be used as a reference when normalizing the
1027 pressure using C<Normalization> method 2.
1028 When specified more sensors a minumum is found and used each time. The
1029 temperature reading directly from this pressure sensor/plugin is typically not
1030 suitable as the pressure sensor will be probably inside while we want outside
1031 temperature. The collectd reference name is something like
1032 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1033 (<type_instance> is usually omitted when there is just single value type). Or
1034 you can figure it out from the path of the output data files.
1038 =head2 Plugin C<battery>
1040 The I<battery plugin> reports the remaining capacity, power and voltage of
1045 =item B<ValuesPercentage> B<false>|B<true>
1047 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1048 capacity remaining". Otherwise the capacity is stored as reported by the
1049 battery, most likely in "Wh". This option does not work with all input methods,
1050 in particular when only C</proc/pmu> is available on an old Linux system.
1051 Defaults to B<false>.
1053 =item B<ReportDegraded> B<false>|B<true>
1055 Typical laptop batteries degrade over time, meaning the capacity decreases with
1056 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1057 "last full capacity" and used to determine that a battery is "fully charged".
1059 When this option is set to B<false>, the default, the I<battery plugin> will
1060 only report the remaining capacity. If the B<ValuesPercentage> option is
1061 enabled, the relative remaining capacity is calculated as the ratio of the
1062 "remaining capacity" and the "last full capacity". This is what most tools,
1063 such as the status bar of desktop environments, also do.
1065 When set to B<true>, the battery plugin will report three values: B<charged>
1066 (remaining capacity), B<discharged> (difference between "last full capacity"
1067 and "remaining capacity") and B<degraded> (difference between "design capacity"
1068 and "last full capacity").
1072 =head2 Plugin C<bind>
1074 Starting with BIND 9.5.0, the most widely used DNS server software provides
1075 extensive statistics about queries, responses and lots of other information.
1076 The bind plugin retrieves this information that's encoded in XML and provided
1077 via HTTP and submits the values to collectd.
1079 To use this plugin, you first need to tell BIND to make this information
1080 available. This is done with the C<statistics-channels> configuration option:
1082 statistics-channels {
1083 inet localhost port 8053;
1086 The configuration follows the grouping that can be seen when looking at the
1087 data with an XSLT compatible viewer, such as a modern web browser. It's
1088 probably a good idea to make yourself familiar with the provided values, so you
1089 can understand what the collected statistics actually mean.
1094 URL "http://localhost:8053/"
1109 Zone "127.in-addr.arpa/IN"
1113 The bind plugin accepts the following configuration options:
1119 URL from which to retrieve the XML data. If not specified,
1120 C<http://localhost:8053/> will be used.
1122 =item B<ParseTime> B<true>|B<false>
1124 When set to B<true>, the time provided by BIND will be parsed and used to
1125 dispatch the values. When set to B<false>, the local time source is queried.
1127 This setting is set to B<true> by default for backwards compatibility; setting
1128 this to B<false> is I<recommended> to avoid problems with timezones and
1131 =item B<OpCodes> B<true>|B<false>
1133 When enabled, statistics about the I<"OpCodes">, for example the number of
1134 C<QUERY> packets, are collected.
1138 =item B<QTypes> B<true>|B<false>
1140 When enabled, the number of I<incoming> queries by query types (for example
1141 C<A>, C<MX>, C<AAAA>) is collected.
1145 =item B<ServerStats> B<true>|B<false>
1147 Collect global server statistics, such as requests received over IPv4 and IPv6,
1148 successful queries, and failed updates.
1152 =item B<ZoneMaintStats> B<true>|B<false>
1154 Collect zone maintenance statistics, mostly information about notifications
1155 (zone updates) and zone transfers.
1159 =item B<ResolverStats> B<true>|B<false>
1161 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1162 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1163 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1164 default. Use the B<ResolverStats> option within a B<View "_default"> block
1165 instead for the same functionality.
1169 =item B<MemoryStats>
1171 Collect global memory statistics.
1175 =item B<Timeout> I<Milliseconds>
1177 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1178 milliseconds. By default, the configured B<Interval> is used to set the
1181 =item B<View> I<Name>
1183 Collect statistics about a specific I<"view">. BIND can behave different,
1184 mostly depending on the source IP-address of the request. These different
1185 configurations are called "views". If you don't use this feature, you most
1186 likely are only interested in the C<_default> view.
1188 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1189 information you want to collect about a view. If no B<View> block is
1190 configured, no detailed view statistics will be collected.
1194 =item B<QTypes> B<true>|B<false>
1196 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1197 C<MX>) is collected.
1201 =item B<ResolverStats> B<true>|B<false>
1203 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1204 (e.E<nbsp>g. queries over IPv4, lame servers).
1208 =item B<CacheRRSets> B<true>|B<false>
1210 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1211 type is collected. Negative entries (queries which resulted in an error, for
1212 example names that do not exist) are reported with a leading exclamation mark,
1217 =item B<Zone> I<Name>
1219 When given, collect detailed information about the given zone in the view. The
1220 information collected if very similar to the global B<ServerStats> information
1223 You can repeat this option to collect detailed information about multiple
1226 By default no detailed zone information is collected.
1232 =head2 Plugin C<ceph>
1234 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1235 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1237 A separate B<Daemon> block must be configured for each ceph daemon to be
1238 monitored. The following example will read daemon statistics from four
1239 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1242 LongRunAvgLatency false
1243 ConvertSpecialMetricTypes true
1245 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1248 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1251 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1254 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1258 The ceph plugin accepts the following configuration options:
1262 =item B<LongRunAvgLatency> B<true>|B<false>
1264 If enabled, latency values(sum,count pairs) are calculated as the long run
1265 average - average since the ceph daemon was started = (sum / count).
1266 When disabled, latency values are calculated as the average since the last
1267 collection = (sum_now - sum_last) / (count_now - count_last).
1271 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1273 If enabled, special metrics (metrics that differ in type from similar counters)
1274 are converted to the type of those similar counters. This currently only
1275 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1276 ceph schema reports this metric type as a sum,count pair while similar counters
1277 are treated as derive types. When converted, the sum is used as the counter
1278 value and is treated as a derive type.
1279 When disabled, all metrics are treated as the types received from the ceph schema.
1285 Each B<Daemon> block must have a string argument for the plugin instance name.
1286 A B<SocketPath> is also required for each B<Daemon> block:
1290 =item B<Daemon> I<DaemonName>
1292 Name to be used as the instance name for this daemon.
1294 =item B<SocketPath> I<SocketPath>
1296 Specifies the path to the UNIX admin socket of the ceph daemon.
1300 =head2 Plugin C<cgroups>
1302 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1303 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1304 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1308 =item B<CGroup> I<Directory>
1310 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1311 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1314 =item B<IgnoreSelected> B<true>|B<false>
1316 Invert the selection: If set to true, all cgroups I<except> the ones that
1317 match any one of the criteria are collected. By default only selected
1318 cgroups are collected if a selection is made. If no selection is configured
1319 at all, B<all> cgroups are selected.
1323 =head2 Plugin C<conntrack>
1325 This plugin collects IP conntrack statistics.
1331 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1332 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1336 =head2 Plugin C<cpu>
1338 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1339 as Jiffies, using the C<cpu> type. Two aggregations are available:
1345 Sum, per-state, over all CPUs installed in the system; and
1349 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1353 The two aggregations can be combined, leading to I<collectd> only emitting a
1354 single "active" metric for the entire system. As soon as one of these
1355 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1356 rather than Jiffies. In addition, you can request individual, per-state,
1357 per-CPU metrics to be reported as percentage.
1359 The following configuration options are available:
1363 =item B<ReportByState> B<true>|B<false>
1365 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1367 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1370 =item B<ReportByCpu> B<true>|B<false>
1372 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1373 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1374 global sum of CPU states is emitted.
1376 =item B<ValuesPercentage> B<false>|B<true>
1378 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1379 are set to B<true>. In this case, by default, metrics will be reported as
1380 Jiffies. By setting this option to B<true>, you can request percentage values
1381 in the un-aggregated (per-CPU, per-state) mode as well.
1385 =head2 Plugin C<cpufreq>
1387 This plugin doesn't have any options. It reads
1388 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1389 installed) to get the current CPU frequency. If this file does not exist make
1390 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1391 installed and an "cpu governor" (that's a kernel module) is loaded.
1393 =head2 Plugin C<csv>
1397 =item B<DataDir> I<Directory>
1399 Set the directory to store CSV-files under. Per default CSV-files are generated
1400 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1401 The special strings B<stdout> and B<stderr> can be used to write to the standard
1402 output and standard error channels, respectively. This, of course, only makes
1403 much sense when collectd is running in foreground- or non-daemon-mode.
1405 =item B<StoreRates> B<true|false>
1407 If set to B<true>, convert counter values to rates. If set to B<false> (the
1408 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1413 =head2 Plugin C<curl>
1415 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1416 and the match infrastructure (the same code used by the tail plugin) to use
1417 regular expressions with the received data.
1419 The following example will read the current value of AMD stock from Google's
1420 finance page and dispatch the value to collectd.
1423 <Page "stock_quotes">
1424 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1430 CACert "/path/to/ca.crt"
1431 Header "X-Custom-Header: foobar"
1434 MeasureResponseTime false
1435 MeasureResponseCode false
1438 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1439 DSType "GaugeAverage"
1440 # Note: `stock_value' is not a standard type.
1447 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1448 a web page and one or more "matches" to be performed on the returned data. The
1449 string argument to the B<Page> block is used as plugin instance.
1451 The following options are valid within B<Page> blocks:
1457 URL of the web site to retrieve. Since a regular expression will be used to
1458 extract information from this data, non-binary data is a big plus here ;)
1460 =item B<User> I<Name>
1462 Username to use if authorization is required to read the page.
1464 =item B<Password> I<Password>
1466 Password to use if authorization is required to read the page.
1468 =item B<Digest> B<true>|B<false>
1470 Enable HTTP digest authentication.
1472 =item B<VerifyPeer> B<true>|B<false>
1474 Enable or disable peer SSL certificate verification. See
1475 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1477 =item B<VerifyHost> B<true>|B<false>
1479 Enable or disable peer host name verification. If enabled, the plugin checks if
1480 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1481 matches the host name provided by the B<URL> option. If this identity check
1482 fails, the connection is aborted. Obviously, only works when connecting to a
1483 SSL enabled server. Enabled by default.
1485 =item B<CACert> I<file>
1487 File that holds one or more SSL certificates. If you want to use HTTPS you will
1488 possibly need this option. What CA certificates come bundled with C<libcurl>
1489 and are checked by default depends on the distribution you use.
1491 =item B<Header> I<Header>
1493 A HTTP header to add to the request. Multiple headers are added if this option
1494 is specified more than once.
1496 =item B<Post> I<Body>
1498 Specifies that the HTTP operation should be a POST instead of a GET. The
1499 complete data to be posted is given as the argument. This option will usually
1500 need to be accompanied by a B<Header> option to set an appropriate
1501 C<Content-Type> for the post body (e.g. to
1502 C<application/x-www-form-urlencoded>).
1504 =item B<MeasureResponseTime> B<true>|B<false>
1506 Measure response time for the request. If this setting is enabled, B<Match>
1507 blocks (see below) are optional. Disabled by default.
1509 Beware that requests will get aborted if they take too long to complete. Adjust
1510 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1513 =item B<MeasureResponseCode> B<true>|B<false>
1515 Measure response code for the request. If this setting is enabled, B<Match>
1516 blocks (see below) are optional. Disabled by default.
1518 =item B<E<lt>MatchE<gt>>
1520 One or more B<Match> blocks that define how to match information in the data
1521 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1522 used by the C<tail> plugin, so please see the documentation of the C<tail>
1523 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1524 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1527 =item B<Timeout> I<Milliseconds>
1529 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1530 milliseconds. By default, the configured B<Interval> is used to set the
1531 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1532 indefinitely. This legacy behaviour can be achieved by setting the value of
1535 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1536 network connection will stall one read thread. Adjust the B<ReadThreads> global
1537 setting accordingly to prevent this from blocking other plugins.
1541 =head2 Plugin C<curl_json>
1543 The B<curl_json plugin> collects values from JSON data to be parsed by
1544 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1545 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1546 unix socket. The former can be used, for example, to collect values
1547 from CouchDB documents (which are stored JSON notation), and the
1548 latter to collect values from a uWSGI stats socket.
1550 The following example will collect several values from the built-in
1551 C<_stats> runtime statistics module of I<CouchDB>
1552 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1555 <URL "http://localhost:5984/_stats">
1557 <Key "httpd/requests/count">
1558 Type "http_requests"
1561 <Key "httpd_request_methods/*/count">
1562 Type "http_request_methods"
1565 <Key "httpd_status_codes/*/count">
1566 Type "http_response_codes"
1571 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1574 <Sock "/var/run/uwsgi.stats.sock">
1576 <Key "workers/*/requests">
1577 Type "http_requests"
1580 <Key "workers/*/apps/*/requests">
1581 Type "http_requests"
1586 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1587 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1588 blocks defining a unix socket to read JSON from directly. Each of
1589 these blocks may have one or more B<Key> blocks.
1591 The B<Key> string argument must be in a path format. Each component is
1592 used to match the key from a JSON map or the index of an JSON
1593 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1594 values for all map keys or array indices will be collectd.
1596 The following options are valid within B<URL> blocks:
1600 =item B<Instance> I<Instance>
1602 Sets the plugin instance to I<Instance>.
1604 =item B<Interval> I<Interval>
1606 Sets the interval (in seconds) in which the values will be collected from this
1607 URL. By default the global B<Interval> setting will be used.
1609 =item B<User> I<Name>
1611 =item B<Password> I<Password>
1613 =item B<Digest> B<true>|B<false>
1615 =item B<VerifyPeer> B<true>|B<false>
1617 =item B<VerifyHost> B<true>|B<false>
1619 =item B<CACert> I<file>
1621 =item B<Header> I<Header>
1623 =item B<Post> I<Body>
1625 =item B<Timeout> I<Milliseconds>
1627 These options behave exactly equivalent to the appropriate options of the
1628 I<cURL> plugin. Please see there for a detailed description.
1632 The following options are valid within B<Key> blocks:
1636 =item B<Type> I<Type>
1638 Sets the type used to dispatch the values to the daemon. Detailed information
1639 about types and their configuration can be found in L<types.db(5)>. This
1640 option is mandatory.
1642 =item B<Instance> I<Instance>
1644 Type-instance to use. Defaults to the current map key or current string array element value.
1648 =head2 Plugin C<curl_xml>
1650 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1651 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1654 <URL "http://localhost/stats.xml">
1656 Instance "some_instance"
1661 CACert "/path/to/ca.crt"
1662 Header "X-Custom-Header: foobar"
1665 <XPath "table[@id=\"magic_level\"]/tr">
1667 #InstancePrefix "prefix-"
1668 InstanceFrom "td[1]"
1669 ValuesFrom "td[2]/span[@class=\"level\"]"
1674 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1675 URL to be fetched using libcurl. Within each B<URL> block there are
1676 options which specify the connection parameters, for example authentication
1677 information, and one or more B<XPath> blocks.
1679 Each B<XPath> block specifies how to get one type of information. The
1680 string argument must be a valid XPath expression which returns a list
1681 of "base elements". One value is dispatched for each "base element". The
1682 I<type instance> and values are looked up using further I<XPath> expressions
1683 that should be relative to the base element.
1685 Within the B<URL> block the following options are accepted:
1689 =item B<Host> I<Name>
1691 Use I<Name> as the host name when submitting values. Defaults to the global
1694 =item B<Instance> I<Instance>
1696 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1697 empty string (no plugin instance).
1699 =item B<Namespace> I<Prefix> I<URL>
1701 If an XPath expression references namespaces, they must be specified
1702 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1703 I<URL> is the "namespace name", an URI reference uniquely identifying the
1704 namespace. The option can be repeated to register multiple namespaces.
1708 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1709 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1711 =item B<User> I<User>
1713 =item B<Password> I<Password>
1715 =item B<Digest> B<true>|B<false>
1717 =item B<VerifyPeer> B<true>|B<false>
1719 =item B<VerifyHost> B<true>|B<false>
1721 =item B<CACert> I<CA Cert File>
1723 =item B<Header> I<Header>
1725 =item B<Post> I<Body>
1727 =item B<Timeout> I<Milliseconds>
1729 These options behave exactly equivalent to the appropriate options of the
1730 I<cURL plugin>. Please see there for a detailed description.
1732 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1734 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1735 B<XPath> block specifies how to get one type of information. The string
1736 argument must be a valid XPath expression which returns a list of "base
1737 elements". One value is dispatched for each "base element".
1739 Within the B<XPath> block the following options are accepted:
1743 =item B<Type> I<Type>
1745 Specifies the I<Type> used for submitting patches. This determines the number
1746 of values that are required / expected and whether the strings are parsed as
1747 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1748 This option is required.
1750 =item B<InstancePrefix> I<InstancePrefix>
1752 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1753 concatenated together without any separator.
1754 This option is optional.
1756 =item B<InstanceFrom> I<InstanceFrom>
1758 Specifies a XPath expression to use for determining the I<type instance>. The
1759 XPath expression must return exactly one element. The element's value is then
1760 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1762 This value is required. As a special exception, if the "base XPath expression"
1763 (the argument to the B<XPath> block) returns exactly one argument, then this
1764 option may be omitted.
1766 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1768 Specifies one or more XPath expression to use for reading the values. The
1769 number of XPath expressions must match the number of data sources in the
1770 I<type> specified with B<Type> (see above). Each XPath expression must return
1771 exactly one element. The element's value is then parsed as a number and used as
1772 value for the appropriate value in the value list dispatched to the daemon.
1778 =head2 Plugin C<dbi>
1780 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1781 connect to various databases, execute I<SQL> statements and read back the
1782 results. I<dbi> is an acronym for "database interface" in case you were
1783 wondering about the name. You can configure how each column is to be
1784 interpreted and the plugin will generate one or more data sets from each row
1785 returned according to these rules.
1787 Because the plugin is very generic, the configuration is a little more complex
1788 than those of other plugins. It usually looks something like this:
1791 <Query "out_of_stock">
1792 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1793 # Use with MySQL 5.0.0 or later
1797 InstancePrefix "out_of_stock"
1798 InstancesFrom "category"
1802 <Database "product_information">
1804 DriverOption "host" "localhost"
1805 DriverOption "username" "collectd"
1806 DriverOption "password" "aZo6daiw"
1807 DriverOption "dbname" "prod_info"
1808 SelectDB "prod_info"
1809 Query "out_of_stock"
1813 The configuration above defines one query with one result and one database. The
1814 query is then linked to the database with the B<Query> option I<within> the
1815 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1816 and you can also use the B<Include> statement to split up the configuration
1817 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1818 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1821 The following is a complete list of options:
1823 =head3 B<Query> blocks
1825 Query blocks define I<SQL> statements and how the returned data should be
1826 interpreted. They are identified by the name that is given in the opening line
1827 of the block. Thus the name needs to be unique. Other than that, the name is
1828 not used in collectd.
1830 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1831 define which column holds which value or instance information. You can use
1832 multiple B<Result> blocks to create multiple values from one returned row. This
1833 is especially useful, when queries take a long time and sending almost the same
1834 query again and again is not desirable.
1838 <Query "environment">
1839 Statement "select station, temperature, humidity from environment"
1842 # InstancePrefix "foo"
1843 InstancesFrom "station"
1844 ValuesFrom "temperature"
1848 InstancesFrom "station"
1849 ValuesFrom "humidity"
1853 The following options are accepted:
1857 =item B<Statement> I<SQL>
1859 Sets the statement that should be executed on the server. This is B<not>
1860 interpreted by collectd, but simply passed to the database server. Therefore,
1861 the SQL dialect that's used depends on the server collectd is connected to.
1863 The query has to return at least two columns, one for the instance and one
1864 value. You cannot omit the instance, even if the statement is guaranteed to
1865 always return exactly one line. In that case, you can usually specify something
1868 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1870 (That works with MySQL but may not be valid SQL according to the spec. If you
1871 use a more strict database server, you may have to select from a dummy table or
1874 Please note that some databases, for example B<Oracle>, will fail if you
1875 include a semicolon at the end of the statement.
1877 =item B<MinVersion> I<Version>
1879 =item B<MaxVersion> I<Value>
1881 Only use this query for the specified database version. You can use these
1882 options to provide multiple queries with the same name but with a slightly
1883 different syntax. The plugin will use only those queries, where the specified
1884 minimum and maximum versions fit the version of the database in use.
1886 The database version is determined by C<dbi_conn_get_engine_version>, see the
1887 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1888 for details. Basically, each part of the version is assumed to be in the range
1889 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1890 "40102", version "5.0.42" becomes "50042".
1892 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1893 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1894 happen. Don't to it! A valid example would be something along these lines:
1905 In the above example, there are three ranges that don't overlap. The last one
1906 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1907 before "4.0.0" are not specified.
1909 =item B<Type> I<Type>
1911 The B<type> that's used for each line returned. See L<types.db(5)> for more
1912 details on how types are defined. In short: A type is a predefined layout of
1913 data and the number of values and type of values has to match the type
1916 If you specify "temperature" here, you need exactly one gauge column. If you
1917 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1920 There must be exactly one B<Type> option inside each B<Result> block.
1922 =item B<InstancePrefix> I<prefix>
1924 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1925 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1926 all strings returned in the appropriate columns are concatenated together,
1927 separated by dashes I<("-")>.
1929 =item B<InstancesFrom> I<column0> [I<column1> ...]
1931 Specifies the columns whose values will be used to create the "type-instance"
1932 for each row. If you specify more than one column, the value of all columns
1933 will be joined together with dashes I<("-")> as separation characters.
1935 The plugin itself does not check whether or not all built instances are
1936 different. It's your responsibility to assure that each is unique. This is
1937 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1938 sure that only one row is returned in this case.
1940 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1943 =item B<ValuesFrom> I<column0> [I<column1> ...]
1945 Names the columns whose content is used as the actual data for the data sets
1946 that are dispatched to the daemon. How many such columns you need is determined
1947 by the B<Type> setting above. If you specify too many or not enough columns,
1948 the plugin will complain about that and no data will be submitted to the
1951 The actual data type in the columns is not that important. The plugin will
1952 automatically cast the values to the right type if it know how to do that. So
1953 it should be able to handle integer an floating point types, as well as strings
1954 (if they include a number at the beginning).
1956 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1958 =item B<MetadataFrom> [I<column0> I<column1> ...]
1960 Names the columns whose content is used as metadata for the data sets
1961 that are dispatched to the daemon.
1963 The actual data type in the columns is not that important. The plugin will
1964 automatically cast the values to the right type if it know how to do that. So
1965 it should be able to handle integer an floating point types, as well as strings
1966 (if they include a number at the beginning).
1970 =head3 B<Database> blocks
1972 Database blocks define a connection to a database and which queries should be
1973 sent to that database. Since the used "dbi" library can handle a wide variety
1974 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1975 documentationE<nbsp>- we stick as close to the terminology used there.
1977 Each database needs a "name" as string argument in the starting tag of the
1978 block. This name will be used as "PluginInstance" in the values submitted to
1979 the daemon. Other than that, that name is not used.
1983 =item B<Driver> I<Driver>
1985 Specifies the driver to use to connect to the database. In many cases those
1986 drivers are named after the database they can connect to, but this is not a
1987 technical necessity. These drivers are sometimes referred to as "DBD",
1988 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1989 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1990 project at L<http://libdbi-drivers.sourceforge.net/>.
1992 You need to give the driver name as expected by the "dbi" library here. You
1993 should be able to find that in the documentation for each driver. If you
1994 mistype the driver name, the plugin will dump a list of all known driver names
1997 =item B<DriverOption> I<Key> I<Value>
1999 Sets driver-specific options. What option a driver supports can be found in the
2000 documentation for each driver, somewhere at
2001 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2002 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2004 DBDs can register two types of options: String options and numeric options. The
2005 plugin will use the C<dbi_conn_set_option> function when the configuration
2006 provides a string and the C<dbi_conn_require_option_numeric> function when the
2007 configuration provides a number. So these two lines will actually result in
2008 different calls being used:
2010 DriverOption "Port" 1234 # numeric
2011 DriverOption "Port" "1234" # string
2013 Unfortunately, drivers are not too keen to report errors when an unknown option
2014 is passed to them, so invalid settings here may go unnoticed. This is not the
2015 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2016 the driver. If a driver complains about an option, the plugin will dump a
2017 complete list of all options understood by that driver to the log. There is no
2018 way to programatically find out if an option expects a string or a numeric
2019 argument, so you will have to refer to the appropriate DBD's documentation to
2020 find this out. Sorry.
2022 =item B<SelectDB> I<Database>
2024 In some cases, the database name you connect with is not the database name you
2025 want to use for querying data. If this option is set, the plugin will "select"
2026 (switch to) that database after the connection is established.
2028 =item B<Query> I<QueryName>
2030 Associates the query named I<QueryName> with this database connection. The
2031 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2032 blocks you want to refer to must be placed above the database block you want to
2035 =item B<Host> I<Hostname>
2037 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2038 values. Defaults to the global hostname setting.
2046 =item B<Device> I<Device>
2048 Select partitions based on the devicename.
2050 =item B<MountPoint> I<Directory>
2052 Select partitions based on the mountpoint.
2054 =item B<FSType> I<FSType>
2056 Select partitions based on the filesystem type.
2058 =item B<IgnoreSelected> B<true>|B<false>
2060 Invert the selection: If set to true, all partitions B<except> the ones that
2061 match any one of the criteria are collected. By default only selected
2062 partitions are collected if a selection is made. If no selection is configured
2063 at all, B<all> partitions are selected.
2065 =item B<ReportByDevice> B<true>|B<false>
2067 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2068 (the default), it will report a disk as "root", but with it I<true>, it will be
2069 "sda1" (or whichever).
2071 =item B<ReportInodes> B<true>|B<false>
2073 Enables or disables reporting of free, reserved and used inodes. Defaults to
2074 inode collection being disabled.
2076 Enable this option if inodes are a scarce resource for you, usually because
2077 many small files are stored on the disk. This is a usual scenario for mail
2078 transfer agents and web caches.
2080 =item B<ValuesAbsolute> B<true>|B<false>
2082 Enables or disables reporting of free and used disk space in 1K-blocks.
2083 Defaults to B<true>.
2085 =item B<ValuesPercentage> B<false>|B<true>
2087 Enables or disables reporting of free and used disk space in percentage.
2088 Defaults to B<false>.
2090 This is useful for deploying I<collectd> on the cloud, where machines with
2091 different disk size may exist. Then it is more practical to configure
2092 thresholds based on relative disk size.
2096 =head2 Plugin C<disk>
2098 The C<disk> plugin collects information about the usage of physical disks and
2099 logical disks (partitions). Values collected are the number of octets written
2100 to and read from a disk or partition, the number of read/write operations
2101 issued to the disk and a rather complex "time" it took for these commands to be
2104 Using the following two options you can ignore some disks or configure the
2105 collection only of specific disks.
2109 =item B<Disk> I<Name>
2111 Select the disk I<Name>. Whether it is collected or ignored depends on the
2112 B<IgnoreSelected> setting, see below. As with other plugins that use the
2113 daemon's ignorelist functionality, a string that starts and ends with a slash
2114 is interpreted as a regular expression. Examples:
2119 =item B<IgnoreSelected> B<true>|B<false>
2121 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2122 statements, are ignored or if all other disks are ignored. The behavior
2123 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2124 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2125 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2126 is set to B<true>, all disks are collected B<except> the ones matched.
2128 =item B<UseBSDName> B<true>|B<false>
2130 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2131 default major/minor numbers. Requires collectd to be built with Apple's
2134 =item B<UdevNameAttr> I<Attribute>
2136 Attempt to override disk instance name with the value of a specified udev
2137 attribute when built with B<libudev>. If the attribute is not defined for the
2138 given device, the default name is used. Example:
2140 UdevNameAttr "DM_NAME"
2144 =head2 Plugin C<dns>
2148 =item B<Interface> I<Interface>
2150 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2151 option sets the interface that should be used. If this option is not set, or
2152 set to "any", the plugin will try to get packets from B<all> interfaces. This
2153 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2155 =item B<IgnoreSource> I<IP-address>
2157 Ignore packets that originate from this address.
2159 =item B<SelectNumericQueryTypes> B<true>|B<false>
2161 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2165 =head2 Plugin C<email>
2169 =item B<SocketFile> I<Path>
2171 Sets the socket-file which is to be created.
2173 =item B<SocketGroup> I<Group>
2175 If running as root change the group of the UNIX-socket after it has been
2176 created. Defaults to B<collectd>.
2178 =item B<SocketPerms> I<Permissions>
2180 Change the file permissions of the UNIX-socket after it has been created. The
2181 permissions must be given as a numeric, octal value as you would pass to
2182 L<chmod(1)>. Defaults to B<0770>.
2184 =item B<MaxConns> I<Number>
2186 Sets the maximum number of connections that can be handled in parallel. Since
2187 this many threads will be started immediately setting this to a very high
2188 value will waste valuable resources. Defaults to B<5> and will be forced to be
2189 at most B<16384> to prevent typos and dumb mistakes.
2193 =head2 Plugin C<ethstat>
2195 The I<ethstat plugin> collects information about network interface cards (NICs)
2196 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2202 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2203 Map "multicast" "if_multicast"
2210 =item B<Interface> I<Name>
2212 Collect statistical information about interface I<Name>.
2214 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2216 By default, the plugin will submit values as type C<derive> and I<type
2217 instance> set to I<Name>, the name of the metric as reported by the driver. If
2218 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2219 I<TypeInstance> will be used.
2221 =item B<MappedOnly> B<true>|B<false>
2223 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2224 collected, all other metrics will be ignored. Defaults to B<false>.
2228 =head2 Plugin C<exec>
2230 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2231 contains valuable information on when the executable is executed and the
2232 output that is expected from it.
2236 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2238 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2240 Execute the executable I<Executable> as user I<User>. If the user name is
2241 followed by a colon and a group name, the effective group is set to that group.
2242 The real group and saved-set group will be set to the default group of that
2243 user. If no group is given the effective group ID will be the same as the real
2246 Please note that in order to change the user and/or group the daemon needs
2247 superuser privileges. If the daemon is run as an unprivileged user you must
2248 specify the same user/group here. If the daemon is run with superuser
2249 privileges, you must supply a non-root user here.
2251 The executable may be followed by optional arguments that are passed to the
2252 program. Please note that due to the configuration parsing numbers and boolean
2253 values may be changed. If you want to be absolutely sure that something is
2254 passed as-is please enclose it in quotes.
2256 The B<Exec> and B<NotificationExec> statements change the semantics of the
2257 programs executed, i.E<nbsp>e. the data passed to them and the response
2258 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2262 =head2 Plugin C<filecount>
2264 The C<filecount> plugin counts the number of files in a certain directory (and
2265 its subdirectories) and their combined size. The configuration is very straight
2268 <Plugin "filecount">
2269 <Directory "/var/qmail/queue/mess">
2270 Instance "qmail-message"
2272 <Directory "/var/qmail/queue/todo">
2273 Instance "qmail-todo"
2275 <Directory "/var/lib/php5">
2276 Instance "php5-sessions"
2281 The example above counts the number of files in QMail's queue directories and
2282 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2283 QMail has not yet looked at, the "message" queue holds the messages that were
2284 classified into "local" and "remote".
2286 As you can see, the configuration consists of one or more C<Directory> blocks,
2287 each of which specifies a directory in which to count the files. Within those
2288 blocks, the following options are recognized:
2292 =item B<Instance> I<Instance>
2294 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2295 it's your responsibility, the plugin doesn't check for that. If not given, the
2296 instance is set to the directory name with all slashes replaced by underscores
2297 and all leading underscores removed.
2299 =item B<Name> I<Pattern>
2301 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2302 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2303 against the pattern, not the entire path. In case this makes it easier for you:
2304 This option has been named after the B<-name> parameter to L<find(1)>.
2306 =item B<MTime> I<Age>
2308 Count only files of a specific age: If I<Age> is greater than zero, only files
2309 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2310 a negative number, this is inversed. For example, if B<-60> is specified, only
2311 files that have been modified in the last minute will be counted.
2313 The number can also be followed by a "multiplier" to easily specify a larger
2314 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2315 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2316 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2317 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2318 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2321 =item B<Size> I<Size>
2323 Count only files of a specific size. When I<Size> is a positive number, only
2324 files that are at least this big are counted. If I<Size> is a negative number,
2325 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2326 I<Size> are counted.
2328 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2329 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2330 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2331 note that there are 1000 bytes in a kilobyte, not 1024.
2333 =item B<Recursive> I<true>|I<false>
2335 Controls whether or not to recurse into subdirectories. Enabled by default.
2337 =item B<IncludeHidden> I<true>|I<false>
2339 Controls whether or not to include "hidden" files and directories in the count.
2340 "Hidden" files and directories are those, whose name begins with a dot.
2341 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2345 =head2 Plugin C<GenericJMX>
2347 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2348 L<collectd-java(5)>.
2350 =head2 Plugin C<gmond>
2352 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2353 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2354 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2359 MCReceiveFrom "239.2.11.71" "8649"
2360 <Metric "swap_total">
2362 TypeInstance "total"
2365 <Metric "swap_free">
2372 The following metrics are built-in:
2378 load_one, load_five, load_fifteen
2382 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2386 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2398 Available configuration options:
2402 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2404 Sets sets the multicast group and UDP port to which to subscribe.
2406 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2408 =item E<lt>B<Metric> I<Name>E<gt>
2410 These blocks add a new metric conversion to the internal table. I<Name>, the
2411 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2415 =item B<Type> I<Type>
2417 Type to map this metric to. Required.
2419 =item B<TypeInstance> I<Instance>
2421 Type-instance to use. Optional.
2423 =item B<DataSource> I<Name>
2425 Data source to map this metric to. If the configured type has exactly one data
2426 source, this is optional. Otherwise the option is required.
2432 =head2 Plugin C<hddtemp>
2434 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2435 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2436 default values, see below. C<hddtemp> has to be running to work correctly. If
2437 C<hddtemp> is not running timeouts may appear which may interfere with other
2440 The B<hddtemp> homepage can be found at
2441 L<http://www.guzu.net/linux/hddtemp.php>.
2445 =item B<Host> I<Hostname>
2447 Hostname to connect to. Defaults to B<127.0.0.1>.
2449 =item B<Port> I<Port>
2451 TCP-Port to connect to. Defaults to B<7634>.
2455 =head2 Plugin C<interface>
2459 =item B<Interface> I<Interface>
2461 Select this interface. By default these interfaces will then be collected. For
2462 a more detailed description see B<IgnoreSelected> below.
2464 =item B<IgnoreSelected> I<true>|I<false>
2466 If no configuration if given, the B<traffic>-plugin will collect data from
2467 all interfaces. This may not be practical, especially for loopback- and
2468 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2469 interfaces you're interested in. Sometimes, however, it's easier/preferred
2470 to collect all interfaces I<except> a few ones. This option enables you to
2471 do that: By setting B<IgnoreSelected> to I<true> the effect of
2472 B<Interface> is inverted: All selected interfaces are ignored and all
2473 other interfaces are collected.
2477 =head2 Plugin C<ipmi>
2481 =item B<Sensor> I<Sensor>
2483 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2485 =item B<IgnoreSelected> I<true>|I<false>
2487 If no configuration if given, the B<ipmi> plugin will collect data from all
2488 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2489 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2490 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2491 all other sensors are collected.
2493 =item B<NotifySensorAdd> I<true>|I<false>
2495 If a sensor appears after initialization time of a minute a notification
2498 =item B<NotifySensorRemove> I<true>|I<false>
2500 If a sensor disappears a notification is sent.
2502 =item B<NotifySensorNotPresent> I<true>|I<false>
2504 If you have for example dual power supply and one of them is (un)plugged then
2505 a notification is sent.
2509 =head2 Plugin C<iptables>
2513 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2515 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2516 will collect the counters of all rules which have a comment-match. The comment
2517 is then used as type-instance.
2519 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2520 the I<n>th rule will be collected. Again, the comment (or the number) will be
2521 used as the type-instance.
2523 If I<Name> is supplied, it will be used as the type-instance instead of the
2524 comment or the number.
2528 =head2 Plugin C<irq>
2534 Select this irq. By default these irqs will then be collected. For a more
2535 detailed description see B<IgnoreSelected> below.
2537 =item B<IgnoreSelected> I<true>|I<false>
2539 If no configuration if given, the B<irq>-plugin will collect data from all
2540 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2541 can use the B<Irq>-option to pick the interrupt you're interested in.
2542 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2543 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2544 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2545 and all other interrupts are collected.
2549 =head2 Plugin C<java>
2551 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2552 This section only discusses the syntax and semantic of the configuration
2553 options. For more in-depth information on the I<Java> plugin, please read
2554 L<collectd-java(5)>.
2559 JVMArg "-verbose:jni"
2560 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2561 LoadPlugin "org.collectd.java.Foobar"
2562 <Plugin "org.collectd.java.Foobar">
2563 # To be parsed by the plugin
2567 Available configuration options:
2571 =item B<JVMArg> I<Argument>
2573 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2574 exactly the way the arguments to the I<java> binary on the command line work.
2575 Execute C<javaE<nbsp>--help> for details.
2577 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2578 any other options! When another option is found, the JVM will be started and
2579 later options will have to be ignored!
2581 =item B<LoadPlugin> I<JavaClass>
2583 Instantiates a new I<JavaClass> object. The constructor of this object very
2584 likely then registers one or more callback methods with the server.
2586 See L<collectd-java(5)> for details.
2588 When the first such option is found, the virtual machine (JVM) is created. This
2589 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2590 B<LoadPlugin> options!
2592 =item B<Plugin> I<Name>
2594 The entire block is passed to the Java plugin as an
2595 I<org.collectd.api.OConfigItem> object.
2597 For this to work, the plugin has to register a configuration callback first,
2598 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2599 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2600 depends on the (Java) plugin registering the callback and is completely
2601 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2605 =head2 Plugin C<load>
2607 The I<Load plugin> collects the system load. These numbers give a rough overview
2608 over the utilization of a machine. The system load is defined as the number of
2609 runnable tasks in the run-queue and is provided by many operating systems as a
2610 one, five or fifteen minute average.
2612 The following configuration options are available:
2616 =item B<ReportRelative> B<false>|B<true>
2618 When enabled, system load divided by number of available CPU cores is reported
2619 for intervals 1 min, 5 min and 15 min. Defaults to false.
2624 =head2 Plugin C<logfile>
2628 =item B<LogLevel> B<debug|info|notice|warning|err>
2630 Sets the log-level. If, for example, set to B<notice>, then all events with
2631 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2633 Please note that B<debug> is only available if collectd has been compiled with
2636 =item B<File> I<File>
2638 Sets the file to write log messages to. The special strings B<stdout> and
2639 B<stderr> can be used to write to the standard output and standard error
2640 channels, respectively. This, of course, only makes much sense when I<collectd>
2641 is running in foreground- or non-daemon-mode.
2643 =item B<Timestamp> B<true>|B<false>
2645 Prefix all lines printed by the current time. Defaults to B<true>.
2647 =item B<PrintSeverity> B<true>|B<false>
2649 When enabled, all lines are prefixed by the severity of the log message, for
2650 example "warning". Defaults to B<false>.
2654 B<Note>: There is no need to notify the daemon after moving or removing the
2655 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2656 for each line it writes.
2658 =head2 Plugin C<log_logstash>
2660 The I<log logstash plugin> behaves like the logfile plugin but formats
2661 messages as JSON events for logstash to parse and input.
2665 =item B<LogLevel> B<debug|info|notice|warning|err>
2667 Sets the log-level. If, for example, set to B<notice>, then all events with
2668 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2670 Please note that B<debug> is only available if collectd has been compiled with
2673 =item B<File> I<File>
2675 Sets the file to write log messages to. The special strings B<stdout> and
2676 B<stderr> can be used to write to the standard output and standard error
2677 channels, respectively. This, of course, only makes much sense when I<collectd>
2678 is running in foreground- or non-daemon-mode.
2682 B<Note>: There is no need to notify the daemon after moving or removing the
2683 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2684 for each line it writes.
2686 =head2 Plugin C<lpar>
2688 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2689 virtualization technique for IBM POWER processors. It takes into account CPU
2690 time stolen from or donated to a partition, in addition to the usual user,
2691 system, I/O statistics.
2693 The following configuration options are available:
2697 =item B<CpuPoolStats> B<false>|B<true>
2699 When enabled, statistics about the processor pool are read, too. The partition
2700 needs to have pool authority in order to be able to acquire this information.
2703 =item B<ReportBySerial> B<false>|B<true>
2705 If enabled, the serial of the physical machine the partition is currently
2706 running on is reported as I<hostname> and the logical hostname of the machine
2707 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2708 used (just like other plugins) and the I<plugin instance> will be empty.
2713 =head2 Plugin C<mbmon>
2715 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2717 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2718 B<Host> and B<Port> options can be used to change these values, see below.
2719 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2720 timeouts may appear which may interfere with other statistics..
2722 C<mbmon> must be run with the -r option ("print TAG and Value format");
2723 Debian's F</etc/init.d/mbmon> script already does this, other people
2724 will need to ensure that this is the case.
2728 =item B<Host> I<Hostname>
2730 Hostname to connect to. Defaults to B<127.0.0.1>.
2732 =item B<Port> I<Port>
2734 TCP-Port to connect to. Defaults to B<411>.
2740 The C<md plugin> collects information from Linux Software-RAID devices (md).
2742 All reported values are of the type C<md_disks>. Reported type instances are
2743 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2744 I<missing> (physically absent) disks.
2748 =item B<Device> I<Device>
2750 Select md devices based on device name. The I<device name> is the basename of
2751 the device, i.e. the name of the block device without the leading C</dev/>.
2752 See B<IgnoreSelected> for more details.
2754 =item B<IgnoreSelected> B<true>|B<false>
2756 Invert device selection: If set to B<true>, all md devices B<except> those
2757 listed using B<Device> are collected. If B<false> (the default), only those
2758 listed are collected. If no configuration is given, the B<md> plugin will
2759 collect data from all md devices.
2763 =head2 Plugin C<memcachec>
2765 The C<memcachec plugin> connects to a memcached server, queries one or more
2766 given I<pages> and parses the returned data according to user specification.
2767 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2770 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2771 library. Please note that there is another library with a very similar name,
2772 libmemcache (notice the missing `d'), which is not applicable.
2774 Synopsis of the configuration:
2776 <Plugin "memcachec">
2777 <Page "plugin_instance">
2781 Regex "(\\d+) bytes sent"
2784 Instance "type_instance"
2789 The configuration options are:
2793 =item E<lt>B<Page> I<Name>E<gt>
2795 Each B<Page> block defines one I<page> to be queried from the memcached server.
2796 The block requires one string argument which is used as I<plugin instance>.
2798 =item B<Server> I<Address>
2800 Sets the server address to connect to when querying the page. Must be inside a
2805 When connected to the memcached server, asks for the page I<Key>.
2807 =item E<lt>B<Match>E<gt>
2809 Match blocks define which strings to look for and how matches substrings are
2810 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2814 =head2 Plugin C<memcached>
2816 The B<memcached plugin> connects to a memcached server and queries statistics
2817 about cache utilization, memory and bandwidth used.
2818 L<http://www.danga.com/memcached/>
2820 <Plugin "memcached">
2822 Host "memcache.example.com"
2827 The plugin configuration consists of one or more B<Instance> blocks which
2828 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2829 following options are allowed:
2833 =item B<Host> I<Hostname>
2835 Hostname to connect to. Defaults to B<127.0.0.1>.
2837 =item B<Port> I<Port>
2839 TCP-Port to connect to. Defaults to B<11211>.
2841 =item B<Socket> I<Path>
2843 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2844 setting is given, the B<Host> and B<Port> settings are ignored.
2848 =head2 Plugin C<mic>
2850 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2851 Intel's Many Integrated Core (MIC) systems.
2860 ShowTemperatures true
2863 IgnoreSelectedTemperature true
2868 IgnoreSelectedPower true
2871 The following options are valid inside the B<PluginE<nbsp>mic> block:
2875 =item B<ShowCPU> B<true>|B<false>
2877 If enabled (the default) a sum of the CPU usage across all cores is reported.
2879 =item B<ShowCPUCores> B<true>|B<false>
2881 If enabled (the default) per-core CPU usage is reported.
2883 =item B<ShowMemory> B<true>|B<false>
2885 If enabled (the default) the physical memory usage of the MIC system is
2888 =item B<ShowTemperatures> B<true>|B<false>
2890 If enabled (the default) various temperatures of the MIC system are reported.
2892 =item B<Temperature> I<Name>
2894 This option controls which temperatures are being reported. Whether matching
2895 temperatures are being ignored or I<only> matching temperatures are reported
2896 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2897 temperatures are reported.
2899 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2901 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2902 (the default) only temperatures matching a B<Temperature> option are reported
2903 or, if no B<Temperature> option is specified, all temperatures are reported. If
2904 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2907 Known temperature names are:
2941 =item B<ShowPower> B<true>|B<false>
2943 If enabled (the default) various temperatures of the MIC system are reported.
2945 =item B<Power> I<Name>
2947 This option controls which power readings are being reported. Whether matching
2948 power readings are being ignored or I<only> matching power readings are reported
2949 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2950 power readings are reported.
2952 =item B<IgnoreSelectedPower> B<false>|B<true>
2954 Controls the behavior of the B<Power> setting above. If set to B<false>
2955 (the default) only power readings matching a B<Power> option are reported
2956 or, if no B<Power> option is specified, all power readings are reported. If
2957 set to B<true>, matching power readings are I<ignored> and all other power readings
2960 Known power names are:
2966 Total power utilization averaged over Time Window 0 (uWatts).
2970 Total power utilization averaged over Time Window 0 (uWatts).
2974 Instantaneous power (uWatts).
2978 Max instantaneous power (uWatts).
2982 PCI-E connector power (uWatts).
2986 2x3 connector power (uWatts).
2990 2x4 connector power (uWatts).
2998 Uncore rail (uVolts).
3002 Memory subsystem rail (uVolts).
3008 =head2 Plugin C<memory>
3010 The I<memory plugin> provides the following configuration options:
3014 =item B<ValuesAbsolute> B<true>|B<false>
3016 Enables or disables reporting of physical memory usage in absolute numbers,
3017 i.e. bytes. Defaults to B<true>.
3019 =item B<ValuesPercentage> B<false>|B<true>
3021 Enables or disables reporting of physical memory usage in percentages, e.g.
3022 percent of physical memory used. Defaults to B<false>.
3024 This is useful for deploying I<collectd> in a heterogeneous environment in
3025 which the sizes of physical memory vary.
3029 =head2 Plugin C<modbus>
3031 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3032 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3033 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3034 values (two registers interpreted as IEEE floats in big endian notation).
3038 <Data "voltage-input-1">
3041 RegisterCmd ReadHolding
3046 <Data "voltage-input-2">
3049 RegisterCmd ReadHolding
3054 <Data "supply-temperature-1">
3057 RegisterCmd ReadHolding
3062 <Host "modbus.example.com">
3063 Address "192.168.0.42"
3068 Instance "power-supply"
3069 Collect "voltage-input-1"
3070 Collect "voltage-input-2"
3075 Device "/dev/ttyUSB0"
3080 Instance "temperature"
3081 Collect "supply-temperature-1"
3087 =item E<lt>B<Data> I<Name>E<gt> blocks
3089 Data blocks define a mapping between register numbers and the "types" used by
3092 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3096 =item B<RegisterBase> I<Number>
3098 Configures the base register to read from the device. If the option
3099 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3100 register will be read (the register number is increased by one).
3102 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3104 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3105 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3106 combined into one value. Defaults to B<Uint16>.
3108 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3110 Specifies register type to be collected from device. Works only with libmodbus
3111 2.9.2 or higher. Defaults to B<ReadHolding>.
3113 =item B<Type> I<Type>
3115 Specifies the "type" (data set) to use when dispatching the value to
3116 I<collectd>. Currently, only data sets with exactly one data source are
3119 =item B<Instance> I<Instance>
3121 Sets the type instance to use when dispatching the value to I<collectd>. If
3122 unset, an empty string (no type instance) is used.
3126 =item E<lt>B<Host> I<Name>E<gt> blocks
3128 Host blocks are used to specify to which hosts to connect and what data to read
3129 from their "slaves". The string argument I<Name> is used as hostname when
3130 dispatching the values to I<collectd>.
3132 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3136 =item B<Address> I<Hostname>
3138 For Modbus/TCP, specifies the node name (the actual network address) used to
3139 connect to the host. This may be an IP address or a hostname. Please note that
3140 the used I<libmodbus> library only supports IPv4 at the moment.
3142 =item B<Port> I<Service>
3144 for Modbus/TCP, specifies the port used to connect to the host. The port can
3145 either be given as a number or as a service name. Please note that the
3146 I<Service> argument must be a string, even if ports are given in their numerical
3147 form. Defaults to "502".
3149 =item B<Device> I<Devicenode>
3151 For Modbus/RTU, specifies the path to the serial device being used.
3153 =item B<Baudrate> I<Baudrate>
3155 For Modbus/RTU, specifies the baud rate of the serial device.
3156 Note, connections currently support only 8/N/1.
3158 =item B<Interval> I<Interval>
3160 Sets the interval (in seconds) in which the values will be collected from this
3161 host. By default the global B<Interval> setting will be used.
3163 =item E<lt>B<Slave> I<ID>E<gt>
3165 Over each connection, multiple Modbus devices may be reached. The slave ID
3166 is used to specify which device should be addressed. For each device you want
3167 to query, one B<Slave> block must be given.
3169 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3173 =item B<Instance> I<Instance>
3175 Specify the plugin instance to use when dispatching the values to I<collectd>.
3176 By default "slave_I<ID>" is used.
3178 =item B<Collect> I<DataName>
3180 Specifies which data to retrieve from the device. I<DataName> must be the same
3181 string as the I<Name> argument passed to a B<Data> block. You can specify this
3182 option multiple times to collect more than one value from a slave. At least one
3183 B<Collect> option is mandatory.
3191 =head2 Plugin C<mysql>
3193 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3194 one or more databases when started and keeps the connection up as long as
3195 possible. When the connection is interrupted for whatever reason it will try
3196 to re-connect. The plugin will complain loudly in case anything goes wrong.
3198 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3199 and collects information about MySQL network traffic, executed statements,
3200 requests, the query cache and threads by evaluating the
3201 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3202 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3203 Status Variables> for an explanation of these values.
3205 Optionally, master and slave statistics may be collected in a MySQL
3206 replication setup. In that case, information about the synchronization state
3207 of the nodes are collected by evaluating the C<Position> return value of the
3208 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3209 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3210 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3211 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3212 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3229 Socket "/var/run/mysql/mysqld.sock"
3231 SlaveNotifications true
3235 A B<Database> block defines one connection to a MySQL database. It accepts a
3236 single argument which specifies the name of the database. None of the other
3237 options are required. MySQL will use default values as documented in the
3238 section "mysql_real_connect()" in the B<MySQL reference manual>.
3242 =item B<Alias> I<Alias>
3244 Alias to use as sender instead of hostname when reporting. This may be useful
3245 when having cryptic hostnames.
3247 =item B<Host> I<Hostname>
3249 Hostname of the database server. Defaults to B<localhost>.
3251 =item B<User> I<Username>
3253 Username to use when connecting to the database. The user does not have to be
3254 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3255 unless you want to collectd replication statistics (see B<MasterStats> and
3256 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3257 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3259 =item B<Password> I<Password>
3261 Password needed to log into the database.
3263 =item B<Database> I<Database>
3265 Select this database. Defaults to I<no database> which is a perfectly reasonable
3266 option for what this plugin does.
3268 =item B<Port> I<Port>
3270 TCP-port to connect to. The port must be specified in its numeric form, but it
3271 must be passed as a string nonetheless. For example:
3275 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3276 See the documentation for the C<mysql_real_connect> function for details.
3278 =item B<Socket> I<Socket>
3280 Specifies the path to the UNIX domain socket of the MySQL server. This option
3281 only has any effect, if B<Host> is set to B<localhost> (the default).
3282 Otherwise, use the B<Port> option above. See the documentation for the
3283 C<mysql_real_connect> function for details.
3285 =item B<InnodbStats> I<true|false>
3287 If enabled, metrics about the InnoDB storage engine are collected.
3288 Disabled by default.
3290 =item B<MasterStats> I<true|false>
3292 =item B<SlaveStats> I<true|false>
3294 Enable the collection of master / slave statistics in a replication setup. In
3295 order to be able to get access to these statistics, the user needs special
3296 privileges. See the B<User> documentation above. Defaults to B<false>.
3298 =item B<SlaveNotifications> I<true|false>
3300 If enabled, the plugin sends a notification if the replication slave I/O and /
3301 or SQL threads are not running. Defaults to B<false>.
3303 =item B<ConnectTimeout> I<Seconds>
3305 Sets the connect timeout for the MySQL client.
3309 =head2 Plugin C<netapp>
3311 The netapp plugin can collect various performance and capacity information
3312 from a NetApp filer using the NetApp API.
3314 Please note that NetApp has a wide line of products and a lot of different
3315 software versions for each of these products. This plugin was developed for a
3316 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3317 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3318 model and software version but it is very hard to test this.
3319 If you have used this plugin with other models and/or software version, feel
3320 free to send us a mail to tell us about the results, even if it's just a short
3323 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3324 basic authentication.
3326 B<Do not use a regular user for this!> Create a special collectd user with just
3327 the minimum of capabilities needed. The user only needs the "login-http-admin"
3328 capability as well as a few more depending on which data will be collected.
3329 Required capabilities are documented below.
3334 <Host "netapp1.example.com">
3358 IgnoreSelectedIO false
3360 IgnoreSelectedOps false
3361 GetLatency "volume0"
3362 IgnoreSelectedLatency false
3369 IgnoreSelectedCapacity false
3372 IgnoreSelectedSnapshot false
3400 The netapp plugin accepts the following configuration options:
3404 =item B<Host> I<Name>
3406 A host block defines one NetApp filer. It will appear in collectd with the name
3407 you specify here which does not have to be its real name nor its hostname (see
3408 the B<Address> option below).
3410 =item B<VFiler> I<Name>
3412 A B<VFiler> block may only be used inside a host block. It accepts all the
3413 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3414 will execute all NetApp API commands in the context of the specified
3415 VFiler(R). It will appear in collectd with the name you specify here which
3416 does not have to be its real name. The VFiler name may be specified using the
3417 B<VFilerName> option. If this is not specified, it will default to the name
3420 The VFiler block inherits all connection related settings from the surrounding
3421 B<Host> block (which appear before the B<VFiler> block) but they may be
3422 overwritten inside the B<VFiler> block.
3424 This feature is useful, for example, when using a VFiler as SnapVault target
3425 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3426 available in the host filer (vfiler0) but only in the respective VFiler
3429 =item B<Protocol> B<httpd>|B<http>
3431 The protocol collectd will use to query this host.
3439 Valid options: http, https
3441 =item B<Address> I<Address>
3443 The hostname or IP address of the host.
3449 Default: The "host" block's name.
3451 =item B<Port> I<Port>
3453 The TCP port to connect to on the host.
3459 Default: 80 for protocol "http", 443 for protocol "https"
3461 =item B<User> I<User>
3463 =item B<Password> I<Password>
3465 The username and password to use to login to the NetApp.
3471 =item B<VFilerName> I<Name>
3473 The name of the VFiler in which context to execute API commands. If not
3474 specified, the name provided to the B<VFiler> block will be used instead.
3480 Default: name of the B<VFiler> block
3482 B<Note:> This option may only be used inside B<VFiler> blocks.
3484 =item B<Interval> I<Interval>
3490 The following options decide what kind of data will be collected. You can
3491 either use them as a block and fine tune various parameters inside this block,
3492 use them as a single statement to just accept all default values, or omit it to
3493 not collect any data.
3495 The following options are valid inside all blocks:
3499 =item B<Interval> I<Seconds>
3501 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3502 host specific setting.
3506 =head3 The System block
3508 This will collect various performance data about the whole system.
3510 B<Note:> To get this data the collectd user needs the
3511 "api-perf-object-get-instances" capability.
3515 =item B<Interval> I<Seconds>
3517 Collect disk statistics every I<Seconds> seconds.
3519 =item B<GetCPULoad> B<true>|B<false>
3521 If you set this option to true the current CPU usage will be read. This will be
3522 the average usage between all CPUs in your NetApp without any information about
3525 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3526 returns in the "CPU" field.
3534 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3536 =item B<GetInterfaces> B<true>|B<false>
3538 If you set this option to true the current traffic of the network interfaces
3539 will be read. This will be the total traffic over all interfaces of your NetApp
3540 without any information about individual interfaces.
3542 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3543 in the "Net kB/s" field.
3553 Result: One value list of type "if_octects".
3555 =item B<GetDiskIO> B<true>|B<false>
3557 If you set this option to true the current IO throughput will be read. This
3558 will be the total IO of your NetApp without any information about individual
3559 disks, volumes or aggregates.
3561 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3562 in the "DiskE<nbsp>kB/s" field.
3570 Result: One value list of type "disk_octets".
3572 =item B<GetDiskOps> B<true>|B<false>
3574 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3575 iSCSI, etc. operations will be read. This will be the total number of
3576 operations on your NetApp without any information about individual volumes or
3579 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3580 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3588 Result: A variable number of value lists of type "disk_ops_complex". Each type
3589 of operation will result in one value list with the name of the operation as
3594 =head3 The WAFL block
3596 This will collect various performance data about the WAFL file system. At the
3597 moment this just means cache performance.
3599 B<Note:> To get this data the collectd user needs the
3600 "api-perf-object-get-instances" capability.
3602 B<Note:> The interface to get these values is classified as "Diagnostics" by
3603 NetApp. This means that it is not guaranteed to be stable even between minor
3608 =item B<Interval> I<Seconds>
3610 Collect disk statistics every I<Seconds> seconds.
3612 =item B<GetNameCache> B<true>|B<false>
3620 Result: One value list of type "cache_ratio" and type instance
3623 =item B<GetDirCache> B<true>|B<false>
3631 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3633 =item B<GetInodeCache> B<true>|B<false>
3641 Result: One value list of type "cache_ratio" and type instance
3644 =item B<GetBufferCache> B<true>|B<false>
3646 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3647 in the "Cache hit" field.
3655 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3659 =head3 The Disks block
3661 This will collect performance data about the individual disks in the NetApp.
3663 B<Note:> To get this data the collectd user needs the
3664 "api-perf-object-get-instances" capability.
3668 =item B<Interval> I<Seconds>
3670 Collect disk statistics every I<Seconds> seconds.
3672 =item B<GetBusy> B<true>|B<false>
3674 If you set this option to true the busy time of all disks will be calculated
3675 and the value of the busiest disk in the system will be written.
3677 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3678 in the "Disk util" field. Probably.
3686 Result: One value list of type "percent" and type instance "disk_busy".
3690 =head3 The VolumePerf block
3692 This will collect various performance data about the individual volumes.
3694 You can select which data to collect about which volume using the following
3695 options. They follow the standard ignorelist semantic.
3697 B<Note:> To get this data the collectd user needs the
3698 I<api-perf-object-get-instances> capability.
3702 =item B<Interval> I<Seconds>
3704 Collect volume performance data every I<Seconds> seconds.
3706 =item B<GetIO> I<Volume>
3708 =item B<GetOps> I<Volume>
3710 =item B<GetLatency> I<Volume>
3712 Select the given volume for IO, operations or latency statistics collection.
3713 The argument is the name of the volume without the C</vol/> prefix.
3715 Since the standard ignorelist functionality is used here, you can use a string
3716 starting and ending with a slash to specify regular expression matching: To
3717 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3720 GetIO "/^vol[027]$/"
3722 If no regular expression is specified, an exact match is required. Both,
3723 regular and exact matching are case sensitive.
3725 If no volume was specified at all for either of the three options, that data
3726 will be collected for all available volumes.
3728 =item B<IgnoreSelectedIO> B<true>|B<false>
3730 =item B<IgnoreSelectedOps> B<true>|B<false>
3732 =item B<IgnoreSelectedLatency> B<true>|B<false>
3734 When set to B<true>, the volumes selected for IO, operations or latency
3735 statistics collection will be ignored and the data will be collected for all
3738 When set to B<false>, data will only be collected for the specified volumes and
3739 all other volumes will be ignored.
3741 If no volumes have been specified with the above B<Get*> options, all volumes
3742 will be collected regardless of the B<IgnoreSelected*> option.
3744 Defaults to B<false>
3748 =head3 The VolumeUsage block
3750 This will collect capacity data about the individual volumes.
3752 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3757 =item B<Interval> I<Seconds>
3759 Collect volume usage statistics every I<Seconds> seconds.
3761 =item B<GetCapacity> I<VolumeName>
3763 The current capacity of the volume will be collected. This will result in two
3764 to four value lists, depending on the configuration of the volume. All data
3765 sources are of type "df_complex" with the name of the volume as
3768 There will be type_instances "used" and "free" for the number of used and
3769 available bytes on the volume. If the volume has some space reserved for
3770 snapshots, a type_instance "snap_reserved" will be available. If the volume
3771 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3772 number of bytes saved by the SIS feature.
3774 B<Note:> The current NetApp API has a bug that results in this value being
3775 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3776 number which works most of the time. If you see strange values here, bug
3777 NetApp support to fix this.
3779 Repeat this option to specify multiple volumes.
3781 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3783 Specify whether to collect only the volumes selected by the B<GetCapacity>
3784 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3785 B<false>. However, if no B<GetCapacity> option is specified at all, all
3786 capacities will be selected anyway.
3788 =item B<GetSnapshot> I<VolumeName>
3790 Select volumes from which to collect snapshot information.
3792 Usually, the space used for snapshots is included in the space reported as
3793 "used". If snapshot information is collected as well, the space used for
3794 snapshots is subtracted from the used space.
3796 To make things even more interesting, it is possible to reserve space to be
3797 used for snapshots. If the space required for snapshots is less than that
3798 reserved space, there is "reserved free" and "reserved used" space in addition
3799 to "free" and "used". If the space required for snapshots exceeds the reserved
3800 space, that part allocated in the normal space is subtracted from the "used"
3803 Repeat this option to specify multiple volumes.
3805 =item B<IgnoreSelectedSnapshot>
3807 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3808 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3809 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3810 capacities will be selected anyway.
3814 =head3 The Quota block
3816 This will collect (tree) quota statistics (used disk space and number of used
3817 files). This mechanism is useful to get usage information for single qtrees.
3818 In case the quotas are not used for any other purpose, an entry similar to the
3819 following in C</etc/quotas> would be sufficient:
3821 /vol/volA/some_qtree tree - - - - -
3823 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3827 =item B<Interval> I<Seconds>
3829 Collect SnapVault(R) statistics every I<Seconds> seconds.
3833 =head3 The SnapVault block
3835 This will collect statistics about the time and traffic of SnapVault(R)
3840 =item B<Interval> I<Seconds>
3842 Collect SnapVault(R) statistics every I<Seconds> seconds.
3846 =head2 Plugin C<netlink>
3848 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3849 statistics of various interface and routing aspects.
3853 =item B<Interface> I<Interface>
3855 =item B<VerboseInterface> I<Interface>
3857 Instruct the plugin to collect interface statistics. This is basically the same
3858 as the statistics provided by the C<interface> plugin (see above) but
3859 potentially much more detailed.
3861 When configuring with B<Interface> only the basic statistics will be collected,
3862 namely octets, packets, and errors. These statistics are collected by
3863 the C<interface> plugin, too, so using both at the same time is no benefit.
3865 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3866 so that no data needs to be collected twice if you use the C<interface> plugin.
3867 This includes dropped packets, received multicast packets, collisions and a
3868 whole zoo of differentiated RX and TX errors. You can try the following command
3869 to get an idea of what awaits you:
3873 If I<Interface> is B<All>, all interfaces will be selected.
3875 =item B<QDisc> I<Interface> [I<QDisc>]
3877 =item B<Class> I<Interface> [I<Class>]
3879 =item B<Filter> I<Interface> [I<Filter>]
3881 Collect the octets and packets that pass a certain qdisc, class or filter.
3883 QDiscs and classes are identified by their type and handle (or classid).
3884 Filters don't necessarily have a handle, therefore the parent's handle is used.
3885 The notation used in collectd differs from that used in tc(1) in that it
3886 doesn't skip the major or minor number if it's zero and doesn't print special
3887 ids by their name. So, for example, a qdisc may be identified by
3888 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3889 thus not displayed by tc(1).
3891 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3892 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3893 associated with that interface will be collected.
3895 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3896 used. This may lead to problems when more than one filter is attached to a
3897 qdisc or class. This isn't nice, but we don't know how this could be done any
3898 better. If you have a idea, please don't hesitate to tell us.
3900 As with the B<Interface> option you can specify B<All> as the interface,
3901 meaning all interfaces.
3903 Here are some examples to help you understand the above text more easily:
3906 VerboseInterface "All"
3907 QDisc "eth0" "pfifo_fast-1:0"
3909 Class "ppp0" "htb-1:10"
3910 Filter "ppp0" "u32-1:0"
3913 =item B<IgnoreSelected>
3915 The behavior is the same as with all other similar plugins: If nothing is
3916 selected at all, everything is collected. If some things are selected using the
3917 options described above, only these statistics are collected. If you set
3918 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3919 specified statistics will not be collected.
3923 =head2 Plugin C<network>
3925 The Network plugin sends data to a remote instance of collectd, receives data
3926 from a remote instance, or both at the same time. Data which has been received
3927 from the network is usually not transmitted again, but this can be activated, see
3928 the B<Forward> option below.
3930 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3931 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3933 Both, B<Server> and B<Listen> can be used as single option or as block. When
3934 used as block, given options are valid for this socket only. The following
3935 example will export the metrics twice: Once to an "internal" server (without
3936 encryption and signing) and one to an external server (with cryptographic
3940 # Export to an internal server
3941 # (demonstrates usage without additional options)
3942 Server "collectd.internal.tld"
3944 # Export to an external server
3945 # (demonstrates usage with signature options)
3946 <Server "collectd.external.tld">
3947 SecurityLevel "sign"
3948 Username "myhostname"
3955 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3957 The B<Server> statement/block sets the server to send datagrams to. The
3958 statement may occur multiple times to send each datagram to multiple
3961 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3962 optional second argument specifies a port number or a service name. If not
3963 given, the default, B<25826>, is used.
3965 The following options are recognized within B<Server> blocks:
3969 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3971 Set the security you require for network communication. When the security level
3972 has been set to B<Encrypt>, data sent over the network will be encrypted using
3973 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3974 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3975 authentication code. When set to B<None>, data is sent without any security.
3977 This feature is only available if the I<network> plugin was linked with
3980 =item B<Username> I<Username>
3982 Sets the username to transmit. This is used by the server to lookup the
3983 password. See B<AuthFile> below. All security levels except B<None> require
3986 This feature is only available if the I<network> plugin was linked with
3989 =item B<Password> I<Password>
3991 Sets a password (shared secret) for this socket. All security levels except
3992 B<None> require this setting.
3994 This feature is only available if the I<network> plugin was linked with
3997 =item B<Interface> I<Interface name>
3999 Set the outgoing interface for IP packets. This applies at least
4000 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4001 undefined or a non-existent interface name is specified, the default
4002 behavior is to let the kernel choose the appropriate interface. Be warned
4003 that the manual selection of an interface for unicast traffic is only
4004 necessary in rare cases.
4006 =item B<ResolveInterval> I<Seconds>
4008 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4009 useful to force a regular DNS lookup to support a high availability setup. If
4010 not specified, re-resolves are never attempted.
4014 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4016 The B<Listen> statement sets the interfaces to bind to. When multiple
4017 statements are found the daemon will bind to multiple interfaces.
4019 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4020 the argument is a multicast address the daemon will join that multicast group.
4021 The optional second argument specifies a port number or a service name. If not
4022 given, the default, B<25826>, is used.
4024 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4028 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4030 Set the security you require for network communication. When the security level
4031 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4032 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4033 signed and encrypted data is accepted. When set to B<None>, all data will be
4034 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4035 decrypted if possible.
4037 This feature is only available if the I<network> plugin was linked with
4040 =item B<AuthFile> I<Filename>
4042 Sets a file in which usernames are mapped to passwords. These passwords are
4043 used to verify signatures and to decrypt encrypted network packets. If
4044 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4045 verified and encrypted packets are decrypted. Otherwise, signed data is
4046 accepted without checking the signature and encrypted data cannot be decrypted.
4047 For the other security levels this option is mandatory.
4049 The file format is very simple: Each line consists of a username followed by a
4050 colon and any number of spaces followed by the password. To demonstrate, an
4051 example file could look like this:
4056 Each time a packet is received, the modification time of the file is checked
4057 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4058 the file is being read, it is locked using L<fcntl(2)>.
4060 =item B<Interface> I<Interface name>
4062 Set the incoming interface for IP packets explicitly. This applies at least
4063 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4064 undefined or a non-existent interface name is specified, the default
4065 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4066 traffic gets only accepted, if it arrives on the given interface.
4070 =item B<TimeToLive> I<1-255>
4072 Set the time-to-live of sent packets. This applies to all, unicast and
4073 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4074 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4077 =item B<MaxPacketSize> I<1024-65535>
4079 Set the maximum size for datagrams received over the network. Packets larger
4080 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4081 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4084 On the server side, this limit should be set to the largest value used on
4085 I<any> client. Likewise, the value on the client must not be larger than the
4086 value on the server, or data will be lost.
4088 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4089 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4090 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4093 =item B<Forward> I<true|false>
4095 If set to I<true>, write packets that were received via the network plugin to
4096 the sending sockets. This should only be activated when the B<Listen>- and
4097 B<Server>-statements differ. Otherwise packets may be send multiple times to
4098 the same multicast group. While this results in more network traffic than
4099 necessary it's not a huge problem since the plugin has a duplicate detection,
4100 so the values will not loop.
4102 =item B<ReportStats> B<true>|B<false>
4104 The network plugin cannot only receive and send statistics, it can also create
4105 statistics about itself. Collected data included the number of received and
4106 sent octets and packets, the length of the receive queue and the number of
4107 values handled. When set to B<true>, the I<Network plugin> will make these
4108 statistics available. Defaults to B<false>.
4112 =head2 Plugin C<nginx>
4114 This plugin collects the number of connections and requests handled by the
4115 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4116 queries the page provided by the C<ngx_http_stub_status_module> module, which
4117 isn't compiled by default. Please refer to
4118 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4119 how to compile and configure nginx and this module.
4121 The following options are accepted by the C<nginx plugin>:
4125 =item B<URL> I<http://host/nginx_status>
4127 Sets the URL of the C<ngx_http_stub_status_module> output.
4129 =item B<User> I<Username>
4131 Optional user name needed for authentication.
4133 =item B<Password> I<Password>
4135 Optional password needed for authentication.
4137 =item B<VerifyPeer> B<true|false>
4139 Enable or disable peer SSL certificate verification. See
4140 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4142 =item B<VerifyHost> B<true|false>
4144 Enable or disable peer host name verification. If enabled, the plugin checks
4145 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4146 certificate matches the host name provided by the B<URL> option. If this
4147 identity check fails, the connection is aborted. Obviously, only works when
4148 connecting to a SSL enabled server. Enabled by default.
4150 =item B<CACert> I<File>
4152 File that holds one or more SSL certificates. If you want to use HTTPS you will
4153 possibly need this option. What CA certificates come bundled with C<libcurl>
4154 and are checked by default depends on the distribution you use.
4156 =item B<Timeout> I<Milliseconds>
4158 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4159 milliseconds. By default, the configured B<Interval> is used to set the
4164 =head2 Plugin C<notify_desktop>
4166 This plugin sends a desktop notification to a notification daemon, as defined
4167 in the Desktop Notification Specification. To actually display the
4168 notifications, B<notification-daemon> is required and B<collectd> has to be
4169 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4170 environment variables have to be set correctly) and the D-Bus message bus.
4172 The Desktop Notification Specification can be found at
4173 L<http://www.galago-project.org/specs/notification/>.
4177 =item B<OkayTimeout> I<timeout>
4179 =item B<WarningTimeout> I<timeout>
4181 =item B<FailureTimeout> I<timeout>
4183 Set the I<timeout>, in milliseconds, after which to expire the notification
4184 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4185 been specified, the displayed notification will not be closed at all - the
4186 user has to do so herself. These options default to 5000. If a negative number
4187 has been specified, the default is used as well.
4191 =head2 Plugin C<notify_email>
4193 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4194 configured email address.
4196 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4198 Available configuration options:
4202 =item B<From> I<Address>
4204 Email address from which the emails should appear to come from.
4206 Default: C<root@localhost>
4208 =item B<Recipient> I<Address>
4210 Configures the email address(es) to which the notifications should be mailed.
4211 May be repeated to send notifications to multiple addresses.
4213 At least one B<Recipient> must be present for the plugin to work correctly.
4215 =item B<SMTPServer> I<Hostname>
4217 Hostname of the SMTP server to connect to.
4219 Default: C<localhost>
4221 =item B<SMTPPort> I<Port>
4223 TCP port to connect to.
4227 =item B<SMTPUser> I<Username>
4229 Username for ASMTP authentication. Optional.
4231 =item B<SMTPPassword> I<Password>
4233 Password for ASMTP authentication. Optional.
4235 =item B<Subject> I<Subject>
4237 Subject-template to use when sending emails. There must be exactly two
4238 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4239 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4242 Default: C<Collectd notify: %s@%s>
4246 =head2 Plugin C<ntpd>
4250 =item B<Host> I<Hostname>
4252 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4254 =item B<Port> I<Port>
4256 UDP-Port to connect to. Defaults to B<123>.
4258 =item B<ReverseLookups> B<true>|B<false>
4260 Sets whether or not to perform reverse lookups on peers. Since the name or
4261 IP-address may be used in a filename it is recommended to disable reverse
4262 lookups. The default is to do reverse lookups to preserve backwards
4263 compatibility, though.
4265 =item B<IncludeUnitID> B<true>|B<false>
4267 When a peer is a refclock, include the unit ID in the I<type instance>.
4268 Defaults to B<false> for backward compatibility.
4270 If two refclock peers use the same driver and this is B<false>, the plugin will
4271 try to write simultaneous measurements from both to the same type instance.
4272 This will result in error messages in the log and only one set of measurements
4277 =head2 Plugin C<nut>
4281 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4283 Add a UPS to collect data from. The format is identical to the one accepted by
4288 =head2 Plugin C<olsrd>
4290 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4291 the Optimized Link State Routing daemon and reads information about the current
4292 state of the meshed network.
4294 The following configuration options are understood:
4298 =item B<Host> I<Host>
4300 Connect to I<Host>. Defaults to B<"localhost">.
4302 =item B<Port> I<Port>
4304 Specifies the port to connect to. This must be a string, even if you give the
4305 port as a number rather than a service name. Defaults to B<"2006">.
4307 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4309 Specifies what information to collect about links, i.E<nbsp>e. direct
4310 connections of the daemon queried. If set to B<No>, no information is
4311 collected. If set to B<Summary>, the number of links and the average of all
4312 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4313 If set to B<Detail> LQ and NLQ are collected per link.
4315 Defaults to B<Detail>.
4317 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4319 Specifies what information to collect about routes of the daemon queried. If
4320 set to B<No>, no information is collected. If set to B<Summary>, the number of
4321 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4322 metric and ETX are collected per route.
4324 Defaults to B<Summary>.
4326 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4328 Specifies what information to collect about the global topology. If set to
4329 B<No>, no information is collected. If set to B<Summary>, the number of links
4330 in the entire topology and the average I<link quality> (LQ) is calculated.
4331 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4333 Defaults to B<Summary>.
4337 =head2 Plugin C<onewire>
4339 B<EXPERIMENTAL!> See notes below.
4341 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4342 L<http://owfs.org/> to read sensors connected via the onewire bus.
4344 It can be used in two possible modes - standard or advanced.
4346 In the standard mode only temperature sensors (sensors with the family code
4347 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4348 other sensors you would like to have included, please send a sort request to
4349 the mailing list. You can select sensors to be read or to be ignored depending
4350 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4351 walked and all sensors are read.
4353 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4354 experimental, below.
4356 In the advanced mode you can configure any sensor to be read (only numerical
4357 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4358 In this mode you have to list all the sensors. Neither default bus walk nor
4359 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4360 the path automatically and should produce compatible structure with the "standard"
4361 mode (basically the path is expected as for example
4362 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4363 "F10FCA000800" and the rest after the slash is considered the type - here
4365 There are two advantages to this mode - you can access virtually any sensor
4366 (not just temperature), select whether to use cached or directly read values
4367 and it is slighlty faster. The downside is more complex configuration.
4369 The two modes are distinguished automatically by the format of the address.
4370 It is not possible to mix the two modes. Once a full path is detected in any
4371 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4372 (and as standard addresses will fail parsing they will be ignored).
4376 =item B<Device> I<Device>
4378 Sets the device to read the values from. This can either be a "real" hardware
4379 device, such as a serial port or an USB port, or the address of the
4380 L<owserver(1)> socket, usually B<localhost:4304>.
4382 Though the documentation claims to automatically recognize the given address
4383 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4384 with that version, the following configuration worked for us:
4387 Device "-s localhost:4304"
4390 This directive is B<required> and does not have a default value.
4392 =item B<Sensor> I<Sensor>
4394 In the standard mode selects sensors to collect or to ignore
4395 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4396 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4397 and B<not> include the leading C<10.> family byte and point.
4398 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4399 sensors (see above) are read.
4401 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4402 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4403 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4405 As there can be multiple devices on the bus you can list multiple sensor (use
4406 multiple B<Sensor> elements).
4408 =item B<IgnoreSelected> I<true>|I<false>
4410 If no configuration is given, the B<onewire> plugin will collect data from all
4411 sensors found. This may not be practical, especially if sensors are added and
4412 removed regularly. Sometimes, however, it's easier/preferred to collect only
4413 specific sensors or all sensors I<except> a few specified ones. This option
4414 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4415 B<Sensor> is inverted: All selected interfaces are ignored and all other
4416 interfaces are collected.
4418 Used only in the standard mode - see above.
4420 =item B<Interval> I<Seconds>
4422 Sets the interval in which all sensors should be read. If not specified, the
4423 global B<Interval> setting is used.
4427 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4428 work with big setups. It works with one sensor being attached to one
4429 controller, but as soon as you throw in a couple more senors and maybe a hub
4430 or two, reading all values will take more than ten seconds (the default
4431 interval). We will probably add some separate thread for reading the sensors
4432 and some cache or something like that, but it's not done yet. We will try to
4433 maintain backwards compatibility in the future, but we can't promise. So in
4434 short: If it works for you: Great! But keep in mind that the config I<might>
4435 change, though this is unlikely. Oh, and if you want to help improving this
4436 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4438 =head2 Plugin C<openldap>
4440 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4441 server correctly. The backend database C<monitor> needs to be loaded and
4442 working. See slapd-monitor(5) for the details.
4444 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4445 blocks. Each block requires one string argument as the instance name. For
4450 URL "ldap://localhost/"
4453 URL "ldaps://localhost/"
4457 The instance name will be used as the I<plugin instance>. To emulate the old
4458 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4459 plugin to work correctly, each instance name must be unique. This is not
4460 enforced by the plugin and it is your responsibility to ensure it is.
4462 The following options are accepted within each B<Instance> block:
4466 =item B<URL> I<ldap://host/binddn>
4468 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4471 =item B<StartTLS> B<true|false>
4473 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4474 Disabled by default.
4476 =item B<VerifyHost> B<true|false>
4478 Enables or disables peer host name verification. If enabled, the plugin checks
4479 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4480 certificate matches the host name provided by the B<URL> option. If this
4481 identity check fails, the connection is aborted. Enabled by default.
4483 =item B<CACert> I<File>
4485 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4486 may possibly need this option. What CA certificates are checked by default
4487 depends on the distribution you use and can be changed with the usual ldap
4488 client configuration mechanisms. See ldap.conf(5) for the details.
4490 =item B<Timeout> I<Seconds>
4492 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4493 an infinite timeout.
4495 =item B<Version> I<Version>
4497 An integer which sets the LDAP protocol version number to use when connecting
4498 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4502 =head2 Plugin C<openvpn>
4504 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4505 traffic statistics about connected clients.
4507 To set up OpenVPN to write to the status file periodically, use the
4508 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4509 you need to set the required format, too. This is done by setting
4510 B<--status-version> to B<2>.
4512 So, in a nutshell you need:
4514 openvpn $OTHER_OPTIONS \
4515 --status "/var/run/openvpn-status" 10 \
4522 =item B<StatusFile> I<File>
4524 Specifies the location of the status file.
4526 =item B<ImprovedNamingSchema> B<true>|B<false>
4528 When enabled, the filename of the status file will be used as plugin instance
4529 and the client's "common name" will be used as type instance. This is required
4530 when reading multiple status files. Enabling this option is recommended, but to
4531 maintain backwards compatibility this option is disabled by default.
4533 =item B<CollectCompression> B<true>|B<false>
4535 Sets whether or not statistics about the compression used by OpenVPN should be
4536 collected. This information is only available in I<single> mode. Enabled by
4539 =item B<CollectIndividualUsers> B<true>|B<false>
4541 Sets whether or not traffic information is collected for each connected client
4542 individually. If set to false, currently no traffic data is collected at all
4543 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4545 =item B<CollectUserCount> B<true>|B<false>
4547 When enabled, the number of currently connected clients or users is collected.
4548 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4549 can be configured independently from that option. Defaults to B<false>.
4553 =head2 Plugin C<oracle>
4555 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4556 Oracle® Database and lets you execute SQL statements there. It is very similar
4557 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4558 plugin's documentation above for details.
4561 <Query "out_of_stock">
4562 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4565 # InstancePrefix "foo"
4566 InstancesFrom "category"
4570 <Database "product_information">
4574 Query "out_of_stock"
4578 =head3 B<Query> blocks
4580 The Query blocks are handled identically to the Query blocks of the "dbi"
4581 plugin. Please see its documentation above for details on how to specify
4584 =head3 B<Database> blocks
4586 Database blocks define a connection to a database and which queries should be
4587 sent to that database. Each database needs a "name" as string argument in the
4588 starting tag of the block. This name will be used as "PluginInstance" in the
4589 values submitted to the daemon. Other than that, that name is not used.
4593 =item B<ConnectID> I<ID>
4595 Defines the "database alias" or "service name" to connect to. Usually, these
4596 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4598 =item B<Host> I<Host>
4600 Hostname to use when dispatching values for this database. Defaults to using
4601 the global hostname of the I<collectd> instance.
4603 =item B<Username> I<Username>
4605 Username used for authentication.
4607 =item B<Password> I<Password>
4609 Password used for authentication.
4611 =item B<Query> I<QueryName>
4613 Associates the query named I<QueryName> with this database connection. The
4614 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4615 blocks you want to refer to must be placed above the database block you want to
4620 =head2 Plugin C<perl>
4622 This plugin embeds a Perl-interpreter into collectd and provides an interface
4623 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4625 =head2 Plugin C<pinba>
4627 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4628 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4629 PHP-based webpage has been delivered, the extension will send a UDP packet
4630 containing timing information, peak memory usage and so on. The plugin will
4631 wait for such packets, parse them and account the provided information, which
4632 is then dispatched to the daemon once per interval.
4639 # Overall statistics for the website.
4641 Server "www.example.com"
4643 # Statistics for www-a only
4645 Host "www-a.example.com"
4646 Server "www.example.com"
4648 # Statistics for www-b only
4650 Host "www-b.example.com"
4651 Server "www.example.com"
4655 The plugin provides the following configuration options:
4659 =item B<Address> I<Node>
4661 Configures the address used to open a listening socket. By default, plugin will
4662 bind to the I<any> address C<::0>.
4664 =item B<Port> I<Service>
4666 Configures the port (service) to bind to. By default the default Pinba port
4667 "30002" will be used. The option accepts service names in addition to port
4668 numbers and thus requires a I<string> argument.
4670 =item E<lt>B<View> I<Name>E<gt> block
4672 The packets sent by the Pinba extension include the hostname of the server, the
4673 server name (the name of the virtual host) and the script that was executed.
4674 Using B<View> blocks it is possible to separate the data into multiple groups
4675 to get more meaningful statistics. Each packet is added to all matching groups,
4676 so that a packet may be accounted for more than once.
4680 =item B<Host> I<Host>
4682 Matches the hostname of the system the webserver / script is running on. This
4683 will contain the result of the L<gethostname(2)> system call. If not
4684 configured, all hostnames will be accepted.
4686 =item B<Server> I<Server>
4688 Matches the name of the I<virtual host>, i.e. the contents of the
4689 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4690 server names will be accepted.
4692 =item B<Script> I<Script>
4694 Matches the name of the I<script name>, i.e. the contents of the
4695 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4696 script names will be accepted.
4702 =head2 Plugin C<ping>
4704 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4705 configured hosts periodically and measures the network latency. Whenever the
4706 C<read> function of the plugin is called, it submits the average latency, the
4707 standard deviation and the drop rate for each host.
4709 Available configuration options:
4713 =item B<Host> I<IP-address>
4715 Host to ping periodically. This option may be repeated several times to ping
4718 =item B<Interval> I<Seconds>
4720 Sets the interval in which to send ICMP echo packets to the configured hosts.
4721 This is B<not> the interval in which statistics are queries from the plugin but
4722 the interval in which the hosts are "pinged". Therefore, the setting here
4723 should be smaller than or equal to the global B<Interval> setting. Fractional
4724 times, such as "1.24" are allowed.
4728 =item B<Timeout> I<Seconds>
4730 Time to wait for a response from the host to which an ICMP packet had been
4731 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4732 to be down or the packet to be dropped. This setting must be smaller than the
4733 B<Interval> setting above for the plugin to work correctly. Fractional
4734 arguments are accepted.
4738 =item B<TTL> I<0-255>
4740 Sets the Time-To-Live of generated ICMP packets.
4742 =item B<SourceAddress> I<host>
4744 Sets the source address to use. I<host> may either be a numerical network
4745 address or a network hostname.
4747 =item B<Device> I<name>
4749 Sets the outgoing network device to be used. I<name> has to specify an
4750 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4753 =item B<MaxMissed> I<Packets>
4755 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4756 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4758 Default: B<-1> (disabled)
4762 =head2 Plugin C<postgresql>
4764 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4765 keeps a persistent connection to all configured databases and tries to
4766 reconnect if the connection has been interrupted. A database is configured by
4767 specifying a B<Database> block as described below. The default statistics are
4768 collected from PostgreSQL's B<statistics collector> which thus has to be
4769 enabled for this plugin to work correctly. This should usually be the case by
4770 default. See the section "The Statistics Collector" of the B<PostgreSQL
4771 Documentation> for details.
4773 By specifying custom database queries using a B<Query> block as described
4774 below, you may collect any data that is available from some PostgreSQL
4775 database. This way, you are able to access statistics of external daemons
4776 which are available in a PostgreSQL database or use future or special
4777 statistics provided by PostgreSQL without the need to upgrade your collectd
4780 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4781 PostgreSQL databases as well. This has been implemented in a generic way. You
4782 need to specify an SQL statement which will then be executed by collectd in
4783 order to write the data (see below for details). The benefit of that approach
4784 is that there is no fixed database layout. Rather, the layout may be optimized
4785 for the current setup.
4787 The B<PostgreSQL Documentation> manual can be found at
4788 L<http://www.postgresql.org/docs/manuals/>.
4792 Statement "SELECT magic FROM wizard WHERE host = $1;"
4796 InstancePrefix "magic"
4801 <Query rt36_tickets>
4802 Statement "SELECT COUNT(type) AS count, type \
4804 WHEN resolved = 'epoch' THEN 'open' \
4805 ELSE 'resolved' END AS type \
4806 FROM tickets) type \
4810 InstancePrefix "rt36_tickets"
4811 InstancesFrom "type"
4817 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4827 KRBSrvName "kerberos_service_name"
4833 Service "service_name"
4834 Query backend # predefined
4845 The B<Query> block defines one database query which may later be used by a
4846 database definition. It accepts a single mandatory argument which specifies
4847 the name of the query. The names of all queries have to be unique (see the
4848 B<MinVersion> and B<MaxVersion> options below for an exception to this
4849 rule). The following configuration options are available to define the query:
4851 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4852 blocks define how to handle the values returned from the query. They define
4853 which column holds which value and how to dispatch that value to the daemon.
4854 Multiple B<Result> blocks may be used to extract multiple values from a single
4859 =item B<Statement> I<sql query statement>
4861 Specify the I<sql query statement> which the plugin should execute. The string
4862 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4863 first, second, etc. parameter. The value of the parameters is specified by the
4864 B<Param> configuration option - see below for details. To include a literal
4865 B<$> character followed by a number, surround it with single quotes (B<'>).
4867 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4868 allowed. Note, however, that only a single command may be used. Semicolons are
4869 allowed as long as a single non-empty command has been specified only.
4871 The returned lines will be handled separately one after another.
4873 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4875 Specify the parameters which should be passed to the SQL query. The parameters
4876 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4877 they appear in the configuration file. The value of the parameter is
4878 determined depending on the value of the B<Param> option as follows:
4884 The configured hostname of the database connection. If a UNIX domain socket is
4885 used, the parameter expands to "localhost".
4889 The name of the database of the current connection.
4893 The name of the database plugin instance. See the B<Instance> option of the
4894 database specification below for details.
4898 The username used to connect to the database.
4902 The interval with which this database is queried (as specified by the database
4903 specific or global B<Interval> options).
4907 Please note that parameters are only supported by PostgreSQL's protocol
4908 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4910 =item B<Type> I<type>
4912 The I<type> name to be used when dispatching the values. The type describes
4913 how to handle the data and where to store it. See L<types.db(5)> for more
4914 details on types and their configuration. The number and type of values (as
4915 selected by the B<ValuesFrom> option) has to match the type of the given name.
4917 This option is required inside a B<Result> block.
4919 =item B<InstancePrefix> I<prefix>
4921 =item B<InstancesFrom> I<column0> [I<column1> ...]
4923 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4924 B<InstancePrefix> defines a static prefix that will be prepended to all type
4925 instances. B<InstancesFrom> defines the column names whose values will be used
4926 to create the type instance. Multiple values will be joined together using the
4927 hyphen (C<->) as separation character.
4929 The plugin itself does not check whether or not all built instances are
4930 different. It is your responsibility to assure that each is unique.
4932 Both options are optional. If none is specified, the type instance will be
4935 =item B<ValuesFrom> I<column0> [I<column1> ...]
4937 Names the columns whose content is used as the actual data for the data sets
4938 that are dispatched to the daemon. How many such columns you need is
4939 determined by the B<Type> setting as explained above. If you specify too many
4940 or not enough columns, the plugin will complain about that and no data will be
4941 submitted to the daemon.
4943 The actual data type, as seen by PostgreSQL, is not that important as long as
4944 it represents numbers. The plugin will automatically cast the values to the
4945 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4946 L<strtod(3)> functions, so anything supported by those functions is supported
4947 by the plugin as well.
4949 This option is required inside a B<Result> block and may be specified multiple
4950 times. If multiple B<ValuesFrom> options are specified, the columns are read
4953 =item B<MinVersion> I<version>
4955 =item B<MaxVersion> I<version>
4957 Specify the minimum or maximum version of PostgreSQL that this query should be
4958 used with. Some statistics might only be available with certain versions of
4959 PostgreSQL. This allows you to specify multiple queries with the same name but
4960 which apply to different versions, thus allowing you to use the same
4961 configuration in a heterogeneous environment.
4963 The I<version> has to be specified as the concatenation of the major, minor
4964 and patch-level versions, each represented as two-decimal-digit numbers. For
4965 example, version 8.2.3 will become 80203.
4969 The following predefined queries are available (the definitions can be found
4970 in the F<postgresql_default.conf> file which, by default, is available at
4971 C<I<prefix>/share/collectd/>):
4977 This query collects the number of backends, i.E<nbsp>e. the number of
4980 =item B<transactions>
4982 This query collects the numbers of committed and rolled-back transactions of
4987 This query collects the numbers of various table modifications (i.E<nbsp>e.
4988 insertions, updates, deletions) of the user tables.
4990 =item B<query_plans>
4992 This query collects the numbers of various table scans and returned tuples of
4995 =item B<table_states>
4997 This query collects the numbers of live and dead rows in the user tables.
5001 This query collects disk block access counts for user tables.
5005 This query collects the on-disk size of the database in bytes.
5009 In addition, the following detailed queries are available by default. Please
5010 note that each of those queries collects information B<by table>, thus,
5011 potentially producing B<a lot> of data. For details see the description of the
5012 non-by_table queries above.
5016 =item B<queries_by_table>
5018 =item B<query_plans_by_table>
5020 =item B<table_states_by_table>
5022 =item B<disk_io_by_table>
5026 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5027 mandatory argument specifying the name of the writer. This will then be used
5028 in the B<Database> specification in order to activate the writer instance. The
5029 names of all writers have to be unique. The following options may be
5034 =item B<Statement> I<sql statement>
5036 This mandatory option specifies the SQL statement that will be executed for
5037 each submitted value. A single SQL statement is allowed only. Anything after
5038 the first semicolon will be ignored.
5040 Nine parameters will be passed to the statement and should be specified as
5041 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5042 values are made available through those parameters:
5048 The timestamp of the queried value as a floating point number.
5052 The hostname of the queried value.
5056 The plugin name of the queried value.
5060 The plugin instance of the queried value. This value may be B<NULL> if there
5061 is no plugin instance.
5065 The type of the queried value (cf. L<types.db(5)>).
5069 The type instance of the queried value. This value may be B<NULL> if there is
5074 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5075 sources of the submitted value-list).
5079 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5080 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5081 B<StoreRates> is enabled (which is the default, see below), all types will be
5086 An array of the submitted values. The dimensions of the value name and value
5091 In general, it is advisable to create and call a custom function in the
5092 PostgreSQL database for this purpose. Any procedural language supported by
5093 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5096 =item B<StoreRates> B<false>|B<true>
5098 If set to B<true> (the default), convert counter values to rates. If set to
5099 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5104 The B<Database> block defines one PostgreSQL database for which to collect
5105 statistics. It accepts a single mandatory argument which specifies the
5106 database name. None of the other options are required. PostgreSQL will use
5107 default values as documented in the section "CONNECTING TO A DATABASE" in the
5108 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5109 the user collectd is run as and special environment variables. See the manpage
5114 =item B<Interval> I<seconds>
5116 Specify the interval with which the database should be queried. The default is
5117 to use the global B<Interval> setting.
5119 =item B<CommitInterval> I<seconds>
5121 This option may be used for database connections which have "writers" assigned
5122 (see above). If specified, it causes a writer to put several updates into a
5123 single transaction. This transaction will last for the specified amount of
5124 time. By default, each update will be executed in a separate transaction. Each
5125 transaction generates a fair amount of overhead which can, thus, be reduced by
5126 activating this option. The draw-back is, that data covering the specified
5127 amount of time will be lost, for example, if a single statement within the
5128 transaction fails or if the database server crashes.
5130 =item B<Host> I<hostname>
5132 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5133 value begins with a slash, it is interpreted as the directory name in which to
5134 look for the UNIX domain socket.
5136 This option is also used to determine the hostname that is associated with a
5137 collected data set. If it has been omitted or either begins with with a slash
5138 or equals B<localhost> it will be replaced with the global hostname definition
5139 of collectd. Any other value will be passed literally to collectd when
5140 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5142 =item B<Port> I<port>
5144 Specify the TCP port or the local UNIX domain socket file extension of the
5147 =item B<User> I<username>
5149 Specify the username to be used when connecting to the server.
5151 =item B<Password> I<password>
5153 Specify the password to be used when connecting to the server.
5155 =item B<ExpireDelay> I<delay>
5157 Skip expired values in query output.
5159 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5161 Specify whether to use an SSL connection when contacting the server. The
5162 following modes are supported:
5168 Do not use SSL at all.
5172 First, try to connect without using SSL. If that fails, try using SSL.
5174 =item I<prefer> (default)
5176 First, try to connect using SSL. If that fails, try without using SSL.
5184 =item B<Instance> I<name>
5186 Specify the plugin instance name that should be used instead of the database
5187 name (which is the default, if this option has not been specified). This
5188 allows to query multiple databases of the same name on the same host (e.g.
5189 when running multiple database server versions in parallel).
5191 =item B<KRBSrvName> I<kerberos_service_name>
5193 Specify the Kerberos service name to use when authenticating with Kerberos 5
5194 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5195 B<PostgreSQL Documentation> for details.
5197 =item B<Service> I<service_name>
5199 Specify the PostgreSQL service name to use for additional parameters. That
5200 service has to be defined in F<pg_service.conf> and holds additional
5201 connection parameters. See the section "The Connection Service File" in the
5202 B<PostgreSQL Documentation> for details.
5204 =item B<Query> I<query>
5206 Specifies a I<query> which should be executed in the context of the database
5207 connection. This may be any of the predefined or user-defined queries. If no
5208 such option is given, it defaults to "backends", "transactions", "queries",
5209 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5210 has been specified). Else, the specified queries are used only.
5212 =item B<Writer> I<writer>
5214 Assigns the specified I<writer> backend to the database connection. This
5215 causes all collected data to be send to the database using the settings
5216 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5217 below for details on how to selectively send data to certain plugins).
5219 Each writer will register a flush callback which may be used when having long
5220 transactions enabled (see the B<CommitInterval> option above). When issuing
5221 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5222 transaction will be committed right away. Two different kinds of flush
5223 callbacks are available with the C<postgresql> plugin:
5229 Flush all writer backends.
5231 =item B<postgresql->I<database>
5233 Flush all writers of the specified I<database> only.
5239 =head2 Plugin C<powerdns>
5241 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5242 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5243 values, many of which are probably meaningless to most users, but may be useful
5244 for some. So you may chose which values to collect, but if you don't, some
5245 reasonable defaults will be collected.
5248 <Server "server_name">
5250 Collect "udp-answers" "udp-queries"
5251 Socket "/var/run/pdns.controlsocket"
5253 <Recursor "recursor_name">
5255 Collect "cache-hits" "cache-misses"
5256 Socket "/var/run/pdns_recursor.controlsocket"
5258 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5263 =item B<Server> and B<Recursor> block
5265 The B<Server> block defines one authoritative server to query, the B<Recursor>
5266 does the same for an recursing server. The possible options in both blocks are
5267 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5272 =item B<Collect> I<Field>
5274 Using the B<Collect> statement you can select which values to collect. Here,
5275 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5276 C<dlg-only-drops>, C<answers10-100>.
5278 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5279 When querying the server a C<SHOW *> command is issued in any case, because
5280 that's the only way of getting multiple values out of the server at once.
5281 collectd then picks out the values you have selected. When querying the
5282 recursor, a command is generated to query exactly these values. So if you
5283 specify invalid fields when querying the recursor, a syntax error may be
5284 returned by the daemon and collectd may not collect any values at all.
5286 If no B<Collect> statement is given, the following B<Server> values will be
5293 =item packetcache-hit
5295 =item packetcache-miss
5297 =item packetcache-size
5299 =item query-cache-hit
5301 =item query-cache-miss
5303 =item recursing-answers
5305 =item recursing-questions
5317 The following B<Recursor> values will be collected by default:
5321 =item noerror-answers
5323 =item nxdomain-answers
5325 =item servfail-answers
5343 Please note that up to that point collectd doesn't know what values are
5344 available on the server and values that are added do not need a change of the
5345 mechanism so far. However, the values must be mapped to collectd's naming
5346 scheme, which is done using a lookup table that lists all known values. If
5347 values are added in the future and collectd does not know about them, you will
5348 get an error much like this:
5350 powerdns plugin: submit: Not found in lookup table: foobar = 42
5352 In this case please file a bug report with the collectd team.
5354 =item B<Socket> I<Path>
5356 Configures the path to the UNIX domain socket to be used when connecting to the
5357 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5358 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5359 will be used for the recursor.
5363 =item B<LocalSocket> I<Path>
5365 Querying the recursor is done using UDP. When using UDP over UNIX domain
5366 sockets, the client socket needs a name in the file system, too. You can set
5367 this local name to I<Path> using the B<LocalSocket> option. The default is
5368 C<I<prefix>/var/run/collectd-powerdns>.
5372 =head2 Plugin C<processes>
5376 =item B<Process> I<Name>
5378 Select more detailed statistics of processes matching this name. The statistics
5379 collected for these selected processes are size of the resident segment size
5380 (RSS), user- and system-time used, number of processes and number of threads,
5381 io data (where available) and minor and major pagefaults.
5383 =item B<ProcessMatch> I<name> I<regex>
5385 Similar to the B<Process> option this allows to select more detailed
5386 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5387 details). The statistics of all matching processes are summed up and
5388 dispatched to the daemon using the specified I<name> as an identifier. This
5389 allows to "group" several processes together. I<name> must not contain
5394 =head2 Plugin C<protocols>
5396 Collects a lot of information about various network protocols, such as I<IP>,
5397 I<TCP>, I<UDP>, etc.
5399 Available configuration options:
5403 =item B<Value> I<Selector>
5405 Selects whether or not to select a specific value. The string being matched is
5406 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5407 plugin instance and I<ValueName> will be used as type instance. An example of
5408 the string being used would be C<Tcp:RetransSegs>.
5410 You can use regular expressions to match a large number of values with just one
5411 configuration option. To select all "extended" I<TCP> values, you could use the
5412 following statement:
5416 Whether only matched values are selected or all matched values are ignored
5417 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5418 If no value is configured at all, all values will be selected.
5420 =item B<IgnoreSelected> B<true>|B<false>
5422 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5423 matching values will be ignored.
5427 =head2 Plugin C<python>
5429 This plugin embeds a Python-interpreter into collectd and provides an interface
5430 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5432 =head2 Plugin C<routeros>
5434 The C<routeros> plugin connects to a device running I<RouterOS>, the
5435 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5436 I<librouteros> to connect and reads information about the interfaces and
5437 wireless connections of the device. The configuration supports querying
5442 Host "router0.example.com"
5445 CollectInterface true
5450 Host "router1.example.com"
5453 CollectInterface true
5454 CollectRegistrationTable true
5460 As you can see above, the configuration of the I<routeros> plugin consists of
5461 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5462 options are understood:
5466 =item B<Host> I<Host>
5468 Hostname or IP-address of the router to connect to.
5470 =item B<Port> I<Port>
5472 Port name or port number used when connecting. If left unspecified, the default
5473 will be chosen by I<librouteros>, currently "8728". This option expects a
5474 string argument, even when a numeric port number is given.
5476 =item B<User> I<User>
5478 Use the user name I<User> to authenticate. Defaults to "admin".
5480 =item B<Password> I<Password>
5482 Set the password used to authenticate.
5484 =item B<CollectInterface> B<true>|B<false>
5486 When set to B<true>, interface statistics will be collected for all interfaces
5487 present on the device. Defaults to B<false>.
5489 =item B<CollectRegistrationTable> B<true>|B<false>
5491 When set to B<true>, information about wireless LAN connections will be
5492 collected. Defaults to B<false>.
5494 =item B<CollectCPULoad> B<true>|B<false>
5496 When set to B<true>, information about the CPU usage will be collected. The
5497 number is a dimensionless value where zero indicates no CPU usage at all.
5498 Defaults to B<false>.
5500 =item B<CollectMemory> B<true>|B<false>
5502 When enabled, the amount of used and free memory will be collected. How used
5503 memory is calculated is unknown, for example whether or not caches are counted
5505 Defaults to B<false>.
5507 =item B<CollectDF> B<true>|B<false>
5509 When enabled, the amount of used and free disk space will be collected.
5510 Defaults to B<false>.
5512 =item B<CollectDisk> B<true>|B<false>
5514 When enabled, the number of sectors written and bad blocks will be collected.
5515 Defaults to B<false>.
5519 =head2 Plugin C<redis>
5521 The I<Redis plugin> connects to one or more Redis servers and gathers
5522 information about each server's state. For each server there is a I<Node> block
5523 which configures the connection parameters for this node.
5530 <Query "LLEN myqueue">
5537 The information shown in the synopsis above is the I<default configuration>
5538 which is used by the plugin if no configuration is present.
5542 =item B<Node> I<Nodename>
5544 The B<Node> block identifies a new Redis node, that is a new Redis instance
5545 running in an specified host and port. The name for node is a canonical
5546 identifier which is used as I<plugin instance>. It is limited to
5547 64E<nbsp>characters in length.
5549 =item B<Host> I<Hostname>
5551 The B<Host> option is the hostname or IP-address where the Redis instance is
5554 =item B<Port> I<Port>
5556 The B<Port> option is the TCP port on which the Redis instance accepts
5557 connections. Either a service name of a port number may be given. Please note
5558 that numerical port numbers must be given as a string, too.
5560 =item B<Password> I<Password>
5562 Use I<Password> to authenticate when connecting to I<Redis>.
5564 =item B<Timeout> I<Timeout in miliseconds>
5566 The B<Timeout> option set the socket timeout for node response. Since the Redis
5567 read function is blocking, you should keep this value as low as possible. Keep
5568 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5569 than B<Interval> defined globally.
5571 =item B<Query> I<Querystring>
5573 The B<Query> block identifies a query to execute against the redis server.
5574 There may be an arbitrary number of queries to execute.
5576 =item B<Type> I<Collectd type>
5578 Within a query definition, a valid collectd type to use as when submitting
5579 the result of the query. When not supplied, will default to B<gauge>.
5581 =item B<Instance> I<Type instance>
5583 Within a query definition, an optional type instance to use when submitting
5584 the result of the query. When not supplied will default to the escaped
5585 command, up to 64 chars.
5589 =head2 Plugin C<rrdcached>
5591 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5592 to store values to RRD files in an efficient manner. The combination of the
5593 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5594 way the C<rrdtool> plugin works (see below). The added abstraction layer
5595 provides a number of benefits, though: Because the cache is not within
5596 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5597 restarted. This results in much shorter (if any) gaps in graphs, especially
5598 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5599 daemon so that it can flush values to disk automatically when needed. This
5600 allows to integrate automated flushing of values into graphing solutions much
5603 There are disadvantages, though: The daemon may reside on a different host, so
5604 it may not be possible for C<collectd> to create the appropriate RRD files
5605 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5606 different base directory, so relative paths may do weird stuff if you're not
5609 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5610 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5611 setting should be set to an absolute path, so that a changed base directory
5612 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5616 =item B<DaemonAddress> I<Address>
5618 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5619 library. See L<rrdcached(1)> for details. Example:
5621 <Plugin "rrdcached">
5622 DaemonAddress "unix:/var/run/rrdcached.sock"
5625 =item B<DataDir> I<Directory>
5627 Set the base directory in which the RRD files reside. If this is a relative
5628 path, it is relative to the working base directory of the C<rrdcached> daemon!
5629 Use of an absolute path is recommended.
5631 =item B<CreateFiles> B<true>|B<false>
5633 Enables or disables the creation of RRD files. If the daemon is not running
5634 locally, or B<DataDir> is set to a relative path, this will not work as
5635 expected. Default is B<true>.
5637 =item B<CreateFilesAsync> B<false>|B<true>
5639 When enabled, new RRD files are enabled asynchronously, using a separate thread
5640 that runs in the background. This prevents writes to block, which is a problem
5641 especially when many hundreds of files need to be created at once. However,
5642 since the purpose of creating the files asynchronously is I<not> to block until
5643 the file is available, values before the file is available will be discarded.
5644 When disabled (the default) files are created synchronously, blocking for a
5645 short while, while the file is being written.
5647 =item B<StepSize> I<Seconds>
5649 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5650 this setting is unset and the stepsize is set to the interval in which the data
5651 is collected. Do not use this option unless you absolutely have to for some
5652 reason. Setting this option may cause problems with the C<snmp plugin>, the
5653 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5655 =item B<HeartBeat> I<Seconds>
5657 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5658 in which case the heartbeat is set to twice the B<StepSize> which should equal
5659 the interval in which data is collected. Do not set this option unless you have
5660 a very good reason to do so.
5662 =item B<RRARows> I<NumRows>
5664 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5665 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5666 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5667 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5668 week, one month, and one year.
5670 So for each timespan, it calculates how many PDPs need to be consolidated into
5671 one CDP by calculating:
5672 number of PDPs = timespan / (stepsize * rrarows)
5674 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5677 =item B<RRATimespan> I<Seconds>
5679 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5680 more then one RRA. If this option is never used, the built-in default of (3600,
5681 86400, 604800, 2678400, 31622400) is used.
5683 For more information on how RRA-sizes are calculated see B<RRARows> above.
5685 =item B<XFF> I<Factor>
5687 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5688 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5691 =item B<CollectStatistics> B<false>|B<true>
5693 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5694 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5696 Statistics are read via I<rrdcached>s socket using the STATS command.
5697 See L<rrdcached(1)> for details.
5701 =head2 Plugin C<rrdtool>
5703 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5704 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5705 using these settings. If you don't want to dive into the depths of RRDtool, you
5706 can safely ignore these settings.
5710 =item B<DataDir> I<Directory>
5712 Set the directory to store RRD files under. By default RRD files are generated
5713 beneath the daemon's working directory, i.e. the B<BaseDir>.
5715 =item B<CreateFilesAsync> B<false>|B<true>
5717 When enabled, new RRD files are enabled asynchronously, using a separate thread
5718 that runs in the background. This prevents writes to block, which is a problem
5719 especially when many hundreds of files need to be created at once. However,
5720 since the purpose of creating the files asynchronously is I<not> to block until
5721 the file is available, values before the file is available will be discarded.
5722 When disabled (the default) files are created synchronously, blocking for a
5723 short while, while the file is being written.
5725 =item B<StepSize> I<Seconds>
5727 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5728 this setting is unset and the stepsize is set to the interval in which the data
5729 is collected. Do not use this option unless you absolutely have to for some
5730 reason. Setting this option may cause problems with the C<snmp plugin>, the
5731 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5733 =item B<HeartBeat> I<Seconds>
5735 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5736 in which case the heartbeat is set to twice the B<StepSize> which should equal
5737 the interval in which data is collected. Do not set this option unless you have
5738 a very good reason to do so.
5740 =item B<RRARows> I<NumRows>
5742 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5743 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5744 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5745 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5746 week, one month, and one year.
5748 So for each timespan, it calculates how many PDPs need to be consolidated into
5749 one CDP by calculating:
5750 number of PDPs = timespan / (stepsize * rrarows)
5752 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5755 =item B<RRATimespan> I<Seconds>
5757 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5758 more then one RRA. If this option is never used, the built-in default of (3600,
5759 86400, 604800, 2678400, 31622400) is used.
5761 For more information on how RRA-sizes are calculated see B<RRARows> above.
5763 =item B<XFF> I<Factor>
5765 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5766 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5769 =item B<CacheFlush> I<Seconds>
5771 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5772 it writes all values for a certain RRD-file if the oldest value is older than
5773 (or equal to) the number of seconds specified. If some RRD-file is not updated
5774 anymore for some reason (the computer was shut down, the network is broken,
5775 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5776 entire cache is searched for entries older than B<CacheTimeout> seconds and
5777 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5778 does nothing under normal circumstances, this value should not be too small.
5779 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5780 normally do much harm either.
5782 =item B<CacheTimeout> I<Seconds>
5784 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5785 save values in a cache, as described above. Writing multiple values at once
5786 reduces IO-operations and thus lessens the load produced by updating the files.
5787 The trade off is that the graphs kind of "drag behind" and that more memory is
5790 =item B<WritesPerSecond> I<Updates>
5792 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5793 will run serious performance problems. The B<CacheFlush> setting and the
5794 internal update queue assert that collectd continues to work just fine even
5795 under heavy load, but the system may become very unresponsive and slow. This is
5796 a problem especially if you create graphs from the RRD files on the same
5797 machine, for example using the C<graph.cgi> script included in the
5798 C<contrib/collection3/> directory.
5800 This setting is designed for very large setups. Setting this option to a value
5801 between 25 and 80 updates per second, depending on your hardware, will leave
5802 the server responsive enough to draw graphs even while all the cached values
5803 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5804 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5805 written as fast as possible, so that web frontends have up to date data when
5808 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5809 updates per second, writing all values to disk will take approximately
5810 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5811 "collection3" you'll end up with a responsive and fast system, up to date
5812 graphs and basically a "backup" of your values every hour.
5814 =item B<RandomTimeout> I<Seconds>
5816 When set, the actual timeout for each value is chosen randomly between
5817 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5818 intention is to avoid high load situations that appear when many values timeout
5819 at the same time. This is especially a problem shortly after the daemon starts,
5820 because all values were added to the internal cache at roughly the same time.
5824 =head2 Plugin C<sensors>
5826 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5827 that all the needed modules have to be loaded and lm_sensors has to be
5828 configured (most likely by editing F</etc/sensors.conf>. Read
5829 L<sensors.conf(5)> for details.
5831 The B<lm_sensors> homepage can be found at
5832 L<http://secure.netroedge.com/~lm78/>.
5836 =item B<SensorConfigFile> I<File>
5838 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5839 the library's default will be used.
5841 =item B<Sensor> I<chip-bus-address/type-feature>
5843 Selects the name of the sensor which you want to collect or ignore, depending
5844 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5845 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5846 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5848 =item B<IgnoreSelected> I<true>|I<false>
5850 If no configuration if given, the B<sensors>-plugin will collect data from all
5851 sensors. This may not be practical, especially for uninteresting sensors.
5852 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5853 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5854 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5855 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5856 and all other sensors are collected.
5860 =head2 Plugin C<sigrok>
5862 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5863 supported by the L<sigrok|http://sigrok.org/> project.
5869 <Device "AC Voltage">
5874 <Device "Sound Level">
5875 Driver "cem-dt-885x"
5882 =item B<LogLevel> B<0-5>
5884 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5885 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5886 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5887 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5888 their level, are always submitted to I<collectd> at its INFO log level.
5890 =item E<lt>B<Device> I<Name>E<gt>
5892 A sigrok-supported device, uniquely identified by this section's options. The
5893 I<Name> is passed to I<collectd> as the I<plugin instance>.
5895 =item B<Driver> I<DriverName>
5897 The sigrok driver to use for this device.
5899 =item B<Conn> I<ConnectionSpec>
5901 If the device cannot be auto-discovered, or more than one might be discovered
5902 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5903 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5904 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5905 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5906 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5908 =item B<SerialComm> I<SerialSpec>
5910 For serial devices with non-standard port settings, this option can be used
5911 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5912 This should not be necessary; drivers know how to communicate with devices they
5915 =item B<MinimumInterval> I<Seconds>
5917 Specifies the minimum time between measurement dispatches to I<collectd>, in
5918 seconds. Since some I<sigrok> supported devices can acquire measurements many
5919 times per second, it may be necessary to throttle these. For example, the
5920 I<RRD plugin> cannot process writes more than once per second.
5922 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5923 device are always dispatched to I<collectd>. When throttled, unused
5924 measurements are discarded.
5928 =head2 Plugin C<smart>
5930 The C<smart> plugin collects SMART information from physical
5931 disks. Values collectd include temperature, power cycle count, poweron
5932 time and bad sectors. Also, all SMART attributes are collected along
5933 with the normalized current value, the worst value, the threshold and
5934 a human readable value.
5936 Using the following two options you can ignore some disks or configure the
5937 collection only of specific disks.
5941 =item B<Disk> I<Name>
5943 Select the disk I<Name>. Whether it is collected or ignored depends on the
5944 B<IgnoreSelected> setting, see below. As with other plugins that use the
5945 daemon's ignorelist functionality, a string that starts and ends with a slash
5946 is interpreted as a regular expression. Examples:
5951 =item B<IgnoreSelected> B<true>|B<false>
5953 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
5954 statements, are ignored or if all other disks are ignored. The behavior
5955 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
5956 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
5957 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
5958 is set to B<true>, all disks are collected B<except> the ones matched.
5962 =head2 Plugin C<snmp>
5964 Since the configuration of the C<snmp plugin> is a little more complicated than
5965 other plugins, its documentation has been moved to an own manpage,
5966 L<collectd-snmp(5)>. Please see there for details.
5968 =head2 Plugin C<statsd>
5970 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5971 protocol and dispatches rates or other aggregates of these numbers
5974 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5975 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5976 C<objects> respectively.
5978 The following configuration options are valid:
5982 =item B<Host> I<Host>
5984 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5985 "any" address, i.e. accept packets sent to any of the hosts addresses.
5987 =item B<Port> I<Port>
5989 UDP port to listen to. This can be either a service name or a port number.
5990 Defaults to C<8125>.
5992 =item B<DeleteCounters> B<false>|B<true>
5994 =item B<DeleteTimers> B<false>|B<true>
5996 =item B<DeleteGauges> B<false>|B<true>
5998 =item B<DeleteSets> B<false>|B<true>
6000 These options control what happens if metrics are not updated in an interval.
6001 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6002 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6003 are unchanged. If set to B<True>, the such metrics are not dispatched and
6004 removed from the internal cache.
6006 =item B<TimerPercentile> I<Percent>
6008 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6009 that I<Percent> of all reported timers are smaller than or equal to the
6010 computed latency. This is useful for cutting off the long tail latency, as it's
6011 often done in I<Service Level Agreements> (SLAs).
6013 Different percentiles can be calculated by setting this option several times.
6014 If none are specified, no percentiles are calculated / dispatched.
6016 =item B<TimerLower> B<false>|B<true>
6018 =item B<TimerUpper> B<false>|B<true>
6020 =item B<TimerSum> B<false>|B<true>
6022 =item B<TimerCount> B<false>|B<true>
6024 Calculate and dispatch various values out of I<Timer> metrics received during
6025 an interval. If set to B<False>, the default, these values aren't calculated /
6030 =head2 Plugin C<swap>
6032 The I<Swap plugin> collects information about used and available swap space. On
6033 I<Linux> and I<Solaris>, the following options are available:
6037 =item B<ReportByDevice> B<false>|B<true>
6039 Configures how to report physical swap devices. If set to B<false> (the
6040 default), the summary over all swap devices is reported only, i.e. the globally
6041 used and available space over all devices. If B<true> is configured, the used
6042 and available space of each device will be reported separately.
6044 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6045 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6047 =item B<ReportBytes> B<false>|B<true>
6049 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6050 I<swap I/O> is reported in pages. This option is available under Linux only.
6052 =item B<ValuesAbsolute> B<true>|B<false>
6054 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6055 available and used. Defaults to B<true>.
6057 =item B<ValuesPercentage> B<false>|B<true>
6059 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6060 available and free. Defaults to B<false>.
6062 This is useful for deploying I<collectd> in a heterogeneous environment, where
6063 swap sizes differ and you want to specify generic thresholds or similar.
6067 =head2 Plugin C<syslog>
6071 =item B<LogLevel> B<debug|info|notice|warning|err>
6073 Sets the log-level. If, for example, set to B<notice>, then all events with
6074 severity B<notice>, B<warning>, or B<err> will be submitted to the
6077 Please note that B<debug> is only available if collectd has been compiled with
6080 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6082 Controls which notifications should be sent to syslog. The default behaviour is
6083 not to send any. Less severe notifications always imply logging more severe
6084 notifications: Setting this to B<OKAY> means all notifications will be sent to
6085 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6086 notifications but will dismiss B<OKAY> notifications. Setting this option to
6087 B<FAILURE> will only send failures to syslog.
6091 =head2 Plugin C<table>
6093 The C<table plugin> provides generic means to parse tabular data and dispatch
6094 user specified values. Values are selected based on column numbers. For
6095 example, this plugin may be used to get values from the Linux L<proc(5)>
6096 filesystem or CSV (comma separated values) files.
6099 <Table "/proc/slabinfo">
6104 InstancePrefix "active_objs"
6110 InstancePrefix "objperslab"
6117 The configuration consists of one or more B<Table> blocks, each of which
6118 configures one file to parse. Within each B<Table> block, there are one or
6119 more B<Result> blocks, which configure which data to select and how to
6122 The following options are available inside a B<Table> block:
6126 =item B<Instance> I<instance>
6128 If specified, I<instance> is used as the plugin instance. So, in the above
6129 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6130 filename of the table is used instead, with all special characters replaced
6131 with an underscore (C<_>).
6133 =item B<Separator> I<string>
6135 Any character of I<string> is interpreted as a delimiter between the different
6136 columns of the table. A sequence of two or more contiguous delimiters in the
6137 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6138 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6139 of a table - see its documentation for more details. This option is mandatory.
6141 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6142 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6143 required because of collectd's config parsing.
6147 The following options are available inside a B<Result> block:
6151 =item B<Type> I<type>
6153 Sets the type used to dispatch the values to the daemon. Detailed information
6154 about types and their configuration can be found in L<types.db(5)>. This
6155 option is mandatory.
6157 =item B<InstancePrefix> I<prefix>
6159 If specified, prepend I<prefix> to the type instance. If omitted, only the
6160 B<InstancesFrom> option is considered for the type instance.
6162 =item B<InstancesFrom> I<column0> [I<column1> ...]
6164 If specified, the content of the given columns (identified by the column
6165 number starting at zero) will be used to create the type instance for each
6166 row. Multiple values (and the instance prefix) will be joined together with
6167 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6168 option is considered for the type instance.
6170 The plugin itself does not check whether or not all built instances are
6171 different. It’s your responsibility to assure that each is unique. This is
6172 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6173 sure that the table only contains one row.
6175 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6178 =item B<ValuesFrom> I<column0> [I<column1> ...]
6180 Specifies the columns (identified by the column numbers starting at zero)
6181 whose content is used as the actual data for the data sets that are dispatched
6182 to the daemon. How many such columns you need is determined by the B<Type>
6183 setting above. If you specify too many or not enough columns, the plugin will
6184 complain about that and no data will be submitted to the daemon. The plugin
6185 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6186 respectively, so anything supported by those functions is supported by the
6187 plugin as well. This option is mandatory.
6191 =head2 Plugin C<tail>
6193 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6194 each line and dispatches found values. What is matched can be configured by the
6195 user using (extended) regular expressions, as described in L<regex(7)>.
6198 <File "/var/log/exim4/mainlog">
6202 Regex "S=([1-9][0-9]*)"
6208 Regex "\\<R=local_user\\>"
6209 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6212 Instance "local_user"
6217 The config consists of one or more B<File> blocks, each of which configures one
6218 logfile to parse. Within each B<File> block, there are one or more B<Match>
6219 blocks, which configure a regular expression to search for.
6221 The B<Instance> option in the B<File> block may be used to set the plugin
6222 instance. So in the above example the plugin name C<tail-foo> would be used.
6223 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6224 next B<Instance> option. This way you can extract several plugin instances from
6225 one logfile, handy when parsing syslog and the like.
6227 The B<Interval> option allows you to define the length of time between reads. If
6228 this is not set, the default Interval will be used.
6230 Each B<Match> block has the following options to describe how the match should
6235 =item B<Regex> I<regex>
6237 Sets the regular expression to use for matching against a line. The first
6238 subexpression has to match something that can be turned into a number by
6239 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6240 below. Because B<extended> regular expressions are used, you do not need to use
6241 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6242 collectd's config parsing you need to escape backslashes, though. So if you
6243 want to match literal parentheses you need to do the following:
6245 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6247 =item B<ExcludeRegex> I<regex>
6249 Sets an optional regular expression to use for excluding lines from the match.
6250 An example which excludes all connections from localhost from the match:
6252 ExcludeRegex "127\\.0\\.0\\.1"
6254 =item B<DSType> I<Type>
6256 Sets how the values are cumulated. I<Type> is one of:
6260 =item B<GaugeAverage>
6262 Calculate the average.
6266 Use the smallest number only.
6270 Use the greatest number only.
6274 Use the last number found.
6280 =item B<AbsoluteSet>
6282 The matched number is a counter. Simply I<sets> the internal counter to this
6283 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6291 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6292 matched number may be negative, which will effectively subtract from the
6301 Increase the internal counter by one. These B<DSType> are the only ones that do
6302 not use the matched subexpression, but simply count the number of matched
6303 lines. Thus, you may use a regular expression without submatch in this case.
6307 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6308 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6309 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6310 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6311 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6314 =item B<Type> I<Type>
6316 Sets the type used to dispatch this value. Detailed information about types and
6317 their configuration can be found in L<types.db(5)>.
6319 =item B<Instance> I<TypeInstance>
6321 This optional setting sets the type instance to use.
6325 =head2 Plugin C<tail_csv>
6327 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6328 written by I<Snort>.
6333 <Metric "snort-dropped">
6338 <File "/var/log/snort/snort.stats">
6339 Instance "snort-eth0"
6341 Collect "snort-dropped"
6345 The configuration consists of one or more B<Metric> blocks that define an index
6346 into the line of the CSV file and how this value is mapped to I<collectd's>
6347 internal representation. These are followed by one or more B<Instance> blocks
6348 which configure which file to read, in which interval and which metrics to
6353 =item E<lt>B<Metric> I<Name>E<gt>
6355 The B<Metric> block configures a new metric to be extracted from the statistics
6356 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6357 only used inside the B<Instance> blocks to refer to this block, so you can use
6358 one B<Metric> block for multiple CSV files.
6362 =item B<Type> I<Type>
6364 Configures which I<Type> to use when dispatching this metric. Types are defined
6365 in the L<types.db(5)> file, see the appropriate manual page for more
6366 information on specifying types. Only types with a single I<data source> are
6367 supported by the I<tail_csv plugin>. The information whether the value is an
6368 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6369 I<Type's> definition.
6371 =item B<Instance> I<TypeInstance>
6373 If set, I<TypeInstance> is used to populate the type instance field of the
6374 created value lists. Otherwise, no type instance is used.
6376 =item B<ValueFrom> I<Index>
6378 Configure to read the value from the field with the zero-based index I<Index>.
6379 If the value is parsed as signed integer, unsigned integer or double depends on
6380 the B<Type> setting, see above.
6384 =item E<lt>B<File> I<Path>E<gt>
6386 Each B<File> block represents one CSV file to read. There must be at least one
6387 I<File> block but there can be multiple if you have multiple CSV files.
6391 =item B<Instance> I<PluginInstance>
6393 Sets the I<plugin instance> used when dispatching the values.
6395 =item B<Collect> I<Metric>
6397 Specifies which I<Metric> to collect. This option must be specified at least
6398 once, and you can use this option multiple times to specify more than one
6399 metric to be extracted from this statistic file.
6401 =item B<Interval> I<Seconds>
6403 Configures the interval in which to read values from this instance / file.
6404 Defaults to the plugin's default interval.
6406 =item B<TimeFrom> I<Index>
6408 Rather than using the local time when dispatching a value, read the timestamp
6409 from the field with the zero-based index I<Index>. The value is interpreted as
6410 seconds since epoch. The value is parsed as a double and may be factional.
6416 =head2 Plugin C<teamspeak2>
6418 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6419 polls interesting global and virtual server data. The plugin can query only one
6420 physical server but unlimited virtual servers. You can use the following
6421 options to configure it:
6425 =item B<Host> I<hostname/ip>
6427 The hostname or ip which identifies the physical server.
6430 =item B<Port> I<port>
6432 The query port of the physical server. This needs to be a string.
6435 =item B<Server> I<port>
6437 This option has to be added once for every virtual server the plugin should
6438 query. If you want to query the virtual server on port 8767 this is what the
6439 option would look like:
6443 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6444 use quotes around it! If no such statement is given only global information
6449 =head2 Plugin C<ted>
6451 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6452 measure power consumption. These devices are usually connected to a serial
6453 (RS232) or USB port. The plugin opens a configured device and tries to read the
6454 current energy readings. For more information on TED, visit
6455 L<http://www.theenergydetective.com/>.
6457 Available configuration options:
6461 =item B<Device> I<Path>
6463 Path to the device on which TED is connected. collectd will need read and write
6464 permissions on that file.
6466 Default: B</dev/ttyUSB0>
6468 =item B<Retries> I<Num>
6470 Apparently reading from TED is not that reliable. You can therefore configure a
6471 number of retries here. You only configure the I<retries> here, to if you
6472 specify zero, one reading will be performed (but no retries if that fails); if
6473 you specify three, a maximum of four readings are performed. Negative values
6480 =head2 Plugin C<tcpconns>
6482 The C<tcpconns plugin> counts the number of currently established TCP
6483 connections based on the local port and/or the remote port. Since there may be
6484 a lot of connections the default if to count all connections with a local port,
6485 for which a listening socket is opened. You can use the following options to
6486 fine-tune the ports you are interested in:
6490 =item B<ListeningPorts> I<true>|I<false>
6492 If this option is set to I<true>, statistics for all local ports for which a
6493 listening socket exists are collected. The default depends on B<LocalPort> and
6494 B<RemotePort> (see below): If no port at all is specifically selected, the
6495 default is to collect listening ports. If specific ports (no matter if local or
6496 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6497 the selected ports will be collected unless this option is set to I<true>
6500 =item B<LocalPort> I<Port>
6502 Count the connections to a specific local port. This can be used to see how
6503 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6504 You have to specify the port in numeric form, so for the mailserver example
6505 you'd need to set B<25>.
6507 =item B<RemotePort> I<Port>
6509 Count the connections to a specific remote port. This is useful to see how
6510 much a remote service is used. This is most useful if you want to know how many
6511 connections a local service has opened to remote services, e.E<nbsp>g. how many
6512 connections a mail server or news server has to other mail or news servers, or
6513 how many connections a web proxy holds to web servers. You have to give the
6514 port in numeric form.
6516 =item B<AllPortsSummary> I<true>|I<false>
6518 If this option is set to I<true> a summary of statistics from all connections
6519 are collectd. This option defaults to I<false>.
6523 =head2 Plugin C<thermal>
6527 =item B<ForceUseProcfs> I<true>|I<false>
6529 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6530 C<sysfs> interface. If that is not available, the plugin falls back to the
6531 C<procfs> interface. By setting this option to I<true>, you can force the
6532 plugin to use the latter. This option defaults to I<false>.
6534 =item B<Device> I<Device>
6536 Selects the name of the thermal device that you want to collect or ignore,
6537 depending on the value of the B<IgnoreSelected> option. This option may be
6538 used multiple times to specify a list of devices.
6540 =item B<IgnoreSelected> I<true>|I<false>
6542 Invert the selection: If set to true, all devices B<except> the ones that
6543 match the device names specified by the B<Device> option are collected. By
6544 default only selected devices are collected if a selection is made. If no
6545 selection is configured at all, B<all> devices are selected.
6549 =head2 Plugin C<threshold>
6551 The I<Threshold plugin> checks values collected or received by I<collectd>
6552 against a configurable I<threshold> and issues I<notifications> if values are
6555 Documentation for this plugin is available in the L<collectd-threshold(5)>
6558 =head2 Plugin C<tokyotyrant>
6560 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6561 couple metrics: number of records, and database size on disk.
6565 =item B<Host> I<Hostname/IP>
6567 The hostname or ip which identifies the server.
6568 Default: B<127.0.0.1>
6570 =item B<Port> I<Service/Port>
6572 The query port of the server. This needs to be a string, even if the port is
6573 given in its numeric form.
6578 =head2 Plugin C<unixsock>
6582 =item B<SocketFile> I<Path>
6584 Sets the socket-file which is to be created.
6586 =item B<SocketGroup> I<Group>
6588 If running as root change the group of the UNIX-socket after it has been
6589 created. Defaults to B<collectd>.
6591 =item B<SocketPerms> I<Permissions>
6593 Change the file permissions of the UNIX-socket after it has been created. The
6594 permissions must be given as a numeric, octal value as you would pass to
6595 L<chmod(1)>. Defaults to B<0770>.
6597 =item B<DeleteSocket> B<false>|B<true>
6599 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6600 with the given name already exists. If I<collectd> crashes a socket file may be
6601 left over, preventing the daemon from opening a new socket when restarted.
6602 Since this is potentially dangerous, this defaults to B<false>.
6606 =head2 Plugin C<uuid>
6608 This plugin, if loaded, causes the Hostname to be taken from the machine's
6609 UUID. The UUID is a universally unique designation for the machine, usually
6610 taken from the machine's BIOS. This is most useful if the machine is running in
6611 a virtual environment such as Xen, in which case the UUID is preserved across
6612 shutdowns and migration.
6614 The following methods are used to find the machine's UUID, in order:
6620 Check I</etc/uuid> (or I<UUIDFile>).
6624 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6629 Check for UUID from C<dmidecode> / SMBIOS.
6633 Check for UUID from Xen hypervisor.
6637 If no UUID can be found then the hostname is not modified.
6641 =item B<UUIDFile> I<Path>
6643 Take the UUID from the given file (default I</etc/uuid>).
6647 =head2 Plugin C<varnish>
6649 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6650 It collects a subset of the values displayed by L<varnishstat(1)>, and
6651 organizes them in categories which can be enabled or disabled. Currently only
6652 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6653 meaning of each metric can be found in L<varnish-counters(7)>.
6658 <Instance "example">
6662 CollectConnections true
6663 CollectDirectorDNS false
6667 CollectObjects false
6669 CollectSession false
6679 CollectWorkers false
6683 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6684 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6685 will collectd statistics from the default "varnishd" instance (this should work
6686 fine in most cases).
6688 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6692 =item B<CollectBackend> B<true>|B<false>
6694 Back-end connection statistics, such as successful, reused,
6695 and closed connections. True by default.
6697 =item B<CollectBan> B<true>|B<false>
6699 Statistics about ban operations, such as number of bans added, retired, and
6700 number of objects tested against ban operations. Only available with Varnish
6701 3.x and above. False by default.
6703 =item B<CollectCache> B<true>|B<false>
6705 Cache hits and misses. True by default.
6707 =item B<CollectConnections> B<true>|B<false>
6709 Number of client connections received, accepted and dropped. True by default.
6711 =item B<CollectDirectorDNS> B<true>|B<false>
6713 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6716 =item B<CollectESI> B<true>|B<false>
6718 Edge Side Includes (ESI) parse statistics. False by default.
6720 =item B<CollectFetch> B<true>|B<false>
6722 Statistics about fetches (HTTP requests sent to the backend). False by default.
6724 =item B<CollectHCB> B<true>|B<false>
6726 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6727 divided into locked and unlocked look-ups. False by default.
6729 =item B<CollectObjects> B<true>|B<false>
6731 Statistics on cached objects: number of objects expired, nuked (prematurely
6732 expired), saved, moved, etc. False by default.
6734 =item B<CollectPurge> B<true>|B<false>
6736 Statistics about purge operations, such as number of purges added, retired, and
6737 number of objects tested against purge operations. Only available with Varnish
6738 2.x. False by default.
6740 =item B<CollectSession> B<true>|B<false>
6742 Client session statistics. Number of past and current sessions, session herd and
6743 linger counters, etc. False by default. Note that if using Varnish 4.x, some
6744 metrics found in the Connections and Threads sections with previous versions of
6745 Varnish have been moved here.
6747 =item B<CollectSHM> B<true>|B<false>
6749 Statistics about the shared memory log, a memory region to store
6750 log messages which is flushed to disk when full. True by default.
6752 =item B<CollectSMA> B<true>|B<false>
6754 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6755 component is Solaris specific. Only available with Varnish 2.x. False by
6758 =item B<CollectSMS> B<true>|B<false>
6760 synth (synthetic content) storage statistics. This storage
6761 component is used internally only. False by default.
6763 =item B<CollectSM> B<true>|B<false>
6765 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6768 =item B<CollectStruct> B<true>|B<false>
6770 Current varnish internal state statistics. Number of current sessions, objects
6771 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6774 =item B<CollectTotals> B<true>|B<false>
6776 Collects overview counters, such as the number of sessions created,
6777 the number of requests and bytes transferred. False by default.
6779 =item B<CollectUptime> B<true>|B<false>
6781 Varnish uptime. Only available with Varnish 3.x and above. False by default.
6783 =item B<CollectVCL> B<true>|B<false>
6785 Number of total (available + discarded) VCL (config files). False by default.
6787 =item B<CollectVSM> B<true>|B<false>
6789 Collect statistics about Varnish's shared memory usage (used by the logging and
6790 statistics subsystems). Only available with Varnish 4.x. False by default.
6792 =item B<CollectWorkers> B<true>|B<false>
6794 Collect statistics about worker threads. False by default.
6798 =head2 Plugin C<virt>
6800 This plugin allows CPU, disk and network load to be collected for virtualized
6801 guests on the machine. This means that these metrics can be collected for guest
6802 systems without installing any software on them - I<collectd> only runs on the
6803 host system. The statistics are collected through libvirt
6804 (L<http://libvirt.org/>).
6806 Only I<Connection> is required.
6810 =item B<Connection> I<uri>
6812 Connect to the hypervisor given by I<uri>. For example if using Xen use:
6814 Connection "xen:///"
6816 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
6818 =item B<RefreshInterval> I<seconds>
6820 Refresh the list of domains and devices every I<seconds>. The default is 60
6821 seconds. Setting this to be the same or smaller than the I<Interval> will cause
6822 the list of domains and devices to be refreshed on every iteration.
6824 Refreshing the devices in particular is quite a costly operation, so if your
6825 virtualization setup is static you might consider increasing this. If this
6826 option is set to 0, refreshing is disabled completely.
6828 =item B<Domain> I<name>
6830 =item B<BlockDevice> I<name:dev>
6832 =item B<InterfaceDevice> I<name:dev>
6834 =item B<IgnoreSelected> B<true>|B<false>
6836 Select which domains and devices are collected.
6838 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
6839 disk/network devices are collected.
6841 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
6842 domains and disk/network devices are ignored, while the rest are collected.
6844 The domain name and device names may use a regular expression, if the name is
6845 surrounded by I</.../> and collectd was compiled with support for regexps.
6847 The default is to collect statistics for all domains and all their devices.
6851 BlockDevice "/:hdb/"
6852 IgnoreSelected "true"
6854 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
6857 =item B<HostnameFormat> B<name|uuid|hostname|...>
6859 When the virt plugin logs data, it sets the hostname of the collected data
6860 according to this setting. The default is to use the guest name as provided by
6861 the hypervisor, which is equal to setting B<name>.
6863 B<uuid> means use the guest's UUID. This is useful if you want to track the
6864 same guest across migrations.
6866 B<hostname> means to use the global B<Hostname> setting, which is probably not
6867 useful on its own because all guests will appear to have the same name.
6869 You can also specify combinations of these fields. For example B<name uuid>
6870 means to concatenate the guest name and UUID (with a literal colon character
6871 between, thus I<"foo:1234-1234-1234-1234">).
6873 =item B<InterfaceFormat> B<name>|B<address>
6875 When the virt plugin logs interface data, it sets the name of the collected
6876 data according to this setting. The default is to use the path as provided by
6877 the hypervisor (the "dev" property of the target node), which is equal to
6880 B<address> means use the interface's mac address. This is useful since the
6881 interface path might change between reboots of a guest or across migrations.
6883 =item B<PluginInstanceFormat> B<name|uuid>
6885 When the virt plugin logs data, it sets the plugin_instance of the collected
6886 data according to this setting. The default is to use the guest name as provided
6887 by the hypervisor, which is equal to setting B<name>.
6889 B<uuid> means use the guest's UUID.
6893 =head2 Plugin C<vmem>
6895 The C<vmem> plugin collects information about the usage of virtual memory.
6896 Since the statistics provided by the Linux kernel are very detailed, they are
6897 collected very detailed. However, to get all the details, you have to switch
6898 them on manually. Most people just want an overview over, such as the number of
6899 pages read from swap space.
6903 =item B<Verbose> B<true>|B<false>
6905 Enables verbose collection of information. This will start collecting page
6906 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6907 Part of these statistics are collected on a "per zone" basis.
6911 =head2 Plugin C<vserver>
6913 This plugin doesn't have any options. B<VServer> support is only available for
6914 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6915 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6916 need to apply the patches and compile your own kernel, which will then provide
6917 the F</proc/virtual> filesystem that is required by this plugin.
6919 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6921 B<Note>: The traffic collected by this plugin accounts for the amount of
6922 traffic passing a socket which might be a lot less than the actual on-wire
6923 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6924 collect on-wire traffic you could, for example, use the logging facilities of
6925 iptables to feed data for the guest IPs into the iptables plugin.
6927 =head2 Plugin C<write_graphite>
6929 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6930 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6931 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6932 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6933 of at most 1428 bytes to minimize the number of network packets.
6937 <Plugin write_graphite>
6947 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6948 blocks. Inside the B<Node> blocks, the following options are recognized:
6952 =item B<Host> I<Address>
6954 Hostname or address to connect to. Defaults to C<localhost>.
6956 =item B<Port> I<Service>
6958 Service name or port number to connect to. Defaults to C<2003>.
6960 =item B<Protocol> I<String>
6962 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6964 =item B<LogSendErrors> B<false>|B<true>
6966 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6967 If set to B<false>, it will not log the errors. This is especially useful when
6968 using Protocol UDP since many times we want to use the "fire-and-forget"
6969 approach and logging errors fills syslog with unneeded messages.
6971 =item B<Prefix> I<String>
6973 When set, I<String> is added in front of the host name. Dots and whitespace are
6974 I<not> escaped in this string (see B<EscapeCharacter> below).
6976 =item B<Postfix> I<String>
6978 When set, I<String> is appended to the host name. Dots and whitespace are
6979 I<not> escaped in this string (see B<EscapeCharacter> below).
6981 =item B<EscapeCharacter> I<Char>
6983 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6984 in the identifier. The B<EscapeCharacter> option determines which character
6985 dots, whitespace and control characters are replaced with. Defaults to
6988 =item B<StoreRates> B<false>|B<true>
6990 If set to B<true> (the default), convert counter values to rates. If set to
6991 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6994 =item B<SeparateInstances> B<false>|B<true>
6996 If set to B<true>, the plugin instance and type instance will be in their own
6997 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6998 default), the plugin and plugin instance (and likewise the type and type
6999 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7001 =item B<AlwaysAppendDS> B<false>|B<true>
7003 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7004 identifier. If set to B<false> (the default), this is only done when there is
7009 =head2 Plugin C<write_tsdb>
7011 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7012 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7013 state daemon that ingests metrics and stores them in HBase. The plugin uses
7014 I<TCP> over the "line based" protocol with a default port 4242. The data will
7015 be sent in blocks of at most 1428 bytes to minimize the number of network
7022 Host "tsd-1.my.domain"
7024 HostTags "status=production"
7028 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7029 blocks. Inside the B<Node> blocks, the following options are recognized:
7033 =item B<Host> I<Address>
7035 Hostname or address to connect to. Defaults to C<localhost>.
7037 =item B<Port> I<Service>
7039 Service name or port number to connect to. Defaults to C<4242>.
7042 =item B<HostTags> I<String>
7044 When set, I<HostTags> is added to the end of the metric. It is intended to be
7045 used for name=value pairs that the TSD will tag the metric with. Dots and
7046 whitespace are I<not> escaped in this string.
7048 =item B<StoreRates> B<false>|B<true>
7050 If set to B<true>, convert counter values to rates. If set to B<false>
7051 (the default) counter values are stored as is, as an increasing
7054 =item B<AlwaysAppendDS> B<false>|B<true>
7056 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7057 identifier. If set to B<false> (the default), this is only done when there is
7062 =head2 Plugin C<write_mongodb>
7064 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7069 <Plugin "write_mongodb">
7078 The plugin can send values to multiple instances of I<MongoDB> by specifying
7079 one B<Node> block for each instance. Within the B<Node> blocks, the following
7080 options are available:
7084 =item B<Host> I<Address>
7086 Hostname or address to connect to. Defaults to C<localhost>.
7088 =item B<Port> I<Service>
7090 Service name or port number to connect to. Defaults to C<27017>.
7092 =item B<Timeout> I<Timeout>
7094 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7095 Setting this option to zero means no timeout, which is the default.
7097 =item B<StoreRates> B<false>|B<true>
7099 If set to B<true> (the default), convert counter values to rates. If set to
7100 B<false> counter values are stored as is, i.e. as an increasing integer
7103 =item B<Database> I<Database>
7105 =item B<User> I<User>
7107 =item B<Password> I<Password>
7109 Sets the information used when authenticating to a I<MongoDB> database. The
7110 fields are optional (in which case no authentication is attempted), but if you
7111 want to use authentication all three fields must be set.
7115 =head2 Plugin C<write_http>
7117 This output plugin submits values to an HTTP server using POST requests and
7118 encoding metrics with JSON or using the C<PUTVAL> command described in
7119 L<collectd-unixsock(5)>.
7123 <Plugin "write_http">
7125 URL "http://example.com/post-collectd"
7132 The plugin can send values to multiple HTTP servers by specifying one
7133 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7134 block, the following options are available:
7140 URL to which the values are submitted to. Mandatory.
7142 =item B<User> I<Username>
7144 Optional user name needed for authentication.
7146 =item B<Password> I<Password>
7148 Optional password needed for authentication.
7150 =item B<VerifyPeer> B<true>|B<false>
7152 Enable or disable peer SSL certificate verification. See
7153 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7155 =item B<VerifyHost> B<true|false>
7157 Enable or disable peer host name verification. If enabled, the plugin checks if
7158 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7159 matches the host name provided by the B<URL> option. If this identity check
7160 fails, the connection is aborted. Obviously, only works when connecting to a
7161 SSL enabled server. Enabled by default.
7163 =item B<CACert> I<File>
7165 File that holds one or more SSL certificates. If you want to use HTTPS you will
7166 possibly need this option. What CA certificates come bundled with C<libcurl>
7167 and are checked by default depends on the distribution you use.
7169 =item B<CAPath> I<Directory>
7171 Directory holding one or more CA certificate files. You can use this if for
7172 some reason all the needed CA certificates aren't in the same file and can't be
7173 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7176 =item B<ClientKey> I<File>
7178 File that holds the private key in PEM format to be used for certificate-based
7181 =item B<ClientCert> I<File>
7183 File that holds the SSL certificate to be used for certificate-based
7186 =item B<ClientKeyPass> I<Password>
7188 Password required to load the private key in B<ClientKey>.
7190 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7192 Define which SSL protocol version must be used. By default C<libcurl> will
7193 attempt to figure out the remote SSL protocol version. See
7194 L<curl_easy_setopt(3)> for more details.
7196 =item B<Format> B<Command>|B<JSON>
7198 Format of the output to generate. If set to B<Command>, will create output that
7199 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7200 create output in the I<JavaScript Object Notation> (JSON).
7202 Defaults to B<Command>.
7204 =item B<StoreRates> B<true|false>
7206 If set to B<true>, convert counter values to rates. If set to B<false> (the
7207 default) counter values are stored as is, i.e. as an increasing integer number.
7209 =item B<BufferSize> I<Bytes>
7211 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7212 requests will be generated, but more metrics will be batched / metrics are
7213 cached for longer before being sent, introducing additional delay until they
7214 are available on the server side. I<Bytes> must be at least 1024 and cannot
7215 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7216 Defaults to C<4096>.
7218 =item B<LowSpeedLimit> I<Bytes per Second>
7220 Sets the minimal transfer rate in I<Bytes per Second> below which the
7221 connection with the HTTP server will be considered too slow and aborted. All
7222 the data submitted over this connection will probably be lost. Defaults to 0,
7223 which means no minimum transfer rate is enforced.
7225 =item B<Timeout> I<Timeout>
7227 Sets the maximum time in milliseconds given for HTTP POST operations to
7228 complete. When this limit is reached, the POST operation will be aborted, and
7229 all the data in the current send buffer will probably be lost. Defaults to 0,
7230 which means the connection never times out.
7232 The C<write_http> plugin regularly submits the collected values to the HTTP
7233 server. How frequently this happens depends on how much data you are collecting
7234 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
7235 slightly below this interval, which you can estimate by monitoring the network
7236 traffic between collectd and the HTTP server.
7240 =head2 Plugin C<write_kafka>
7242 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7246 <Plugin "write_kafka">
7247 Property "metadata.broker.list" "broker1:9092,broker2:9092"
7253 The following options are understood by the I<write_kafka plugin>:
7257 =item E<lt>B<Topic> I<Name>E<gt>
7259 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7260 is given a unique I<Name> and specifies one kafka producer.
7261 Inside the B<Topic> block, the following per-topic options are
7266 =item B<Property> I<String> I<String>
7268 Configure the named property for the current topic. Properties are
7269 forwarded to the kafka producer library B<librdkafka>.
7271 =item B<Key> I<String>
7273 Use the specified string as a partioning key for the topic. Kafka breaks
7274 topic into partitions and guarantees that for a given topology, the same
7275 consumer will be used for a specific key. The special (case insensitive)
7276 string B<Random> can be used to specify that an arbitrary partition should
7279 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7281 Selects the format in which messages are sent to the broker. If set to
7282 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7283 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7285 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7286 an easy and straight forward exchange format.
7288 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7289 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7291 =item B<StoreRates> B<true>|B<false>
7293 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7294 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7295 default), no conversion is performed. Otherwise the conversion is performed
7296 using the internal value cache.
7298 Please note that currently this option is only used if the B<Format> option has
7299 been set to B<JSON>.
7301 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7303 A prefix can be added in the metric name when outputting in the I<Graphite>
7304 format. It's added before the I<Host> name.
7306 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>>
7308 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7310 A postfix can be added in the metric name when outputting in the I<Graphite>
7311 format. It's added after the I<Host> name.
7313 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>>
7315 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7317 Specify a character to replace dots (.) in the host part of the metric name.
7318 In I<Graphite> metric name, dots are used as separators between different
7319 metric parts (host, plugin, type).
7320 Default is C<_> (I<Underscore>).
7322 =item B<GraphiteSeparateInstances> B<false>|B<true>
7324 If set to B<true>, the plugin instance and type instance will be in their own
7325 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7326 default), the plugin and plugin instance (and likewise the type and type
7327 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7329 =item B<StoreRates> B<true>|B<false>
7331 If set to B<true> (the default), convert counter values to rates. If set to
7332 B<false> counter values are stored as is, i.e. as an increasing integer number.
7334 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7335 converted values will have "rate" appended to the data source type, e.g.
7336 C<ds_type:derive:rate>.
7340 =item B<Property> I<String> I<String>
7342 Configure the kafka producer through properties, you almost always will
7343 want to set B<metadata.broker.list> to your Kafka broker list.
7347 =head2 Plugin C<write_redis>
7349 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7353 <Plugin "write_redis">
7361 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7362 the timestamp as the score. Retrieving a date range can then be done using the
7363 C<ZRANGEBYSCORE> I<Redis> command. Additionnally, all the identifiers of these
7364 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
7365 retrieved using the C<SMEMBERS> I<Redis> command. See
7366 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7369 The information shown in the synopsis above is the I<default configuration>
7370 which is used by the plugin if no configuration is present.
7372 The plugin can send values to multiple instances of I<Redis> by specifying
7373 one B<Node> block for each instance. Within the B<Node> blocks, the following
7374 options are available:
7378 =item B<Node> I<Nodename>
7380 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7381 instance running in an specified host and port. The name for node is a
7382 canonical identifier which is used as I<plugin instance>. It is limited to
7383 64E<nbsp>characters in length.
7385 =item B<Host> I<Hostname>
7387 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7390 =item B<Port> I<Port>
7392 The B<Port> option is the TCP port on which the Redis instance accepts
7393 connections. Either a service name of a port number may be given. Please note
7394 that numerical port numbers must be given as a string, too.
7396 =item B<Timeout> I<Timeout in miliseconds>
7398 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7402 =head2 Plugin C<write_riemann>
7404 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7405 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7406 I<Riemann> using UDP packets.
7410 <Plugin "write_riemann">
7416 AlwaysAppendDS false
7420 Attribute "foo" "bar"
7423 The following options are understood by the I<write_riemann plugin>:
7427 =item E<lt>B<Node> I<Name>E<gt>
7429 The plugin's configuration consists of one or more B<Node> blocks. Each block
7430 is given a unique I<Name> and specifies one connection to an instance of
7431 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7436 =item B<Host> I<Address>
7438 Hostname or address to connect to. Defaults to C<localhost>.
7440 =item B<Port> I<Service>
7442 Service name or port number to connect to. Defaults to C<5555>.
7444 =item B<Protocol> B<UDP>|B<TCP>
7446 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7449 =item B<Batch> B<true>|B<false>
7451 If set to B<true> and B<Protocol> is set to B<TCP>,
7452 events will be batched in memory and flushed at
7453 regular intervals or when B<BatchMaxSize> is exceeded.
7455 Notifications are not batched and sent as soon as possible.
7457 When enabled, it can occur that events get processed by the Riemann server
7458 close to or after their expiration time. Tune the B<TTLFactor> and
7459 B<BatchMaxSize> settings according to the amount of values collected, if this
7464 =item B<BatchMaxSize> I<size>
7466 Maximum payload size for a riemann packet. Defaults to 8192
7468 =item B<StoreRates> B<true>|B<false>
7470 If set to B<true> (the default), convert counter values to rates. If set to
7471 B<false> counter values are stored as is, i.e. as an increasing integer number.
7473 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7474 converted values will have "rate" appended to the data source type, e.g.
7475 C<ds_type:derive:rate>.
7477 =item B<AlwaysAppendDS> B<false>|B<true>
7479 If set the B<true>, append the name of the I<Data Source> (DS) to the
7480 "service", i.e. the field that, together with the "host" field, uniquely
7481 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7482 only done when there is more than one DS.
7484 =item B<TTLFactor> I<Factor>
7486 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7487 event is considered active. I<collectd> populates this field based on the
7488 metrics interval setting. This setting controls the factor with which the
7489 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7490 know exactly what you're doing, you should only increase this setting from its
7493 =item B<Notifications> B<false>|B<true>
7495 If set to B<true>, create riemann events for notifications. This is B<true>
7496 by default. When processing thresholds from write_riemann, it might prove
7497 useful to avoid getting notification events.
7499 =item B<CheckThresholds> B<false>|B<true>
7501 If set to B<true>, attach state to events based on thresholds defined
7502 in the B<Threshold> plugin. Defaults to B<false>.
7504 =item B<EventServicePrefix> I<String>
7506 Add the given string as a prefix to the event service name.
7507 If B<EventServicePrefix> not set or set to an empty string (""),
7508 no prefix will be used.
7512 =item B<Tag> I<String>
7514 Add the given string as an additional tag to the metric being sent to
7517 =item B<Attribute> I<String> I<String>
7519 Consider the two given strings to be the key and value of an additional
7520 attribute for each metric being sent out to I<Riemann>.
7524 =head2 Plugin C<zookeeper>
7526 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
7527 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
7532 <Plugin "zookeeper">
7539 =item B<Host> I<Address>
7541 Hostname or address to connect to. Defaults to C<localhost>.
7543 =item B<Port> I<Service>
7545 Service name or port number to connect to. Defaults to C<2181>.
7549 =head1 THRESHOLD CONFIGURATION
7551 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7552 we mean that the values are not only stored or sent somewhere, but that they
7553 are judged and, if a problem is recognized, acted upon. The only action
7554 collectd takes itself is to generate and dispatch a "notification". Plugins can
7555 register to receive notifications and perform appropriate further actions.
7557 Since systems and what you expect them to do differ a lot, you can configure
7558 B<thresholds> for your values freely. This gives you a lot of flexibility but
7559 also a lot of responsibility.
7561 Every time a value is out of range a notification is dispatched. This means
7562 that the idle percentage of your CPU needs to be less then the configured
7563 threshold only once for a notification to be generated. There's no such thing
7564 as a moving average or similar - at least not now.
7566 Also, all values that match a threshold are considered to be relevant or
7567 "interesting". As a consequence collectd will issue a notification if they are
7568 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7569 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7570 "2" (the default) and some hosts sends it's CPU statistics to the server every
7571 60 seconds, a notification will be dispatched after about 120 seconds. It may
7572 take a little longer because the timeout is checked only once each B<Interval>
7575 When a value comes within range again or is received after it was missing, an
7576 "OKAY-notification" is dispatched.
7578 Here is a configuration example to get you started. Read below for more
7591 <Plugin "interface">
7608 WarningMin 100000000
7614 There are basically two types of configuration statements: The C<Host>,
7615 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7616 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7617 C<Instance> option. You can combine the block by nesting the blocks, though
7618 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7619 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7620 C<Type> may not contain other blocks. If multiple blocks apply to the same
7621 value the most specific block is used.
7623 The other statements specify the threshold to configure. They B<must> be
7624 included in a C<Type> block. Currently the following statements are recognized:
7628 =item B<FailureMax> I<Value>
7630 =item B<WarningMax> I<Value>
7632 Sets the upper bound of acceptable values. If unset defaults to positive
7633 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7634 will be created. If the value is greater than B<WarningMax> but less than (or
7635 equal to) B<FailureMax> a B<WARNING> notification will be created.
7637 =item B<FailureMin> I<Value>
7639 =item B<WarningMin> I<Value>
7641 Sets the lower bound of acceptable values. If unset defaults to negative
7642 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7643 be created. If the value is less than B<WarningMin> but greater than (or equal
7644 to) B<FailureMin> a B<WARNING> notification will be created.
7646 =item B<DataSource> I<DSName>
7648 Some data sets have more than one "data source". Interesting examples are the
7649 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7650 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7651 system load data set, C<load>, even has three data sources: C<shortterm>,
7652 C<midterm>, and C<longterm>.
7654 Normally, all data sources are checked against a configured threshold. If this
7655 is undesirable, or if you want to specify different limits for each data
7656 source, you can use the B<DataSource> option to have a threshold apply only to
7659 =item B<Invert> B<true>|B<false>
7661 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7662 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7663 B<WarningMax>) are not okay. Defaults to B<false>.
7665 =item B<Persist> B<true>|B<false>
7667 Sets how often notifications are generated. If set to B<true> one notification
7668 will be generated for each value that is out of the acceptable range. If set to
7669 B<false> (the default) then a notification is only generated if a value is out
7670 of range but the previous value was okay.
7672 This applies to missing values, too: If set to B<true> a notification about a
7673 missing value is generated once every B<Interval> seconds. If set to B<false>
7674 only one such notification is generated until the value appears again.
7676 =item B<Percentage> B<true>|B<false>
7678 If set to B<true>, the minimum and maximum values given are interpreted as
7679 percentage value, relative to the other data sources. This is helpful for
7680 example for the "df" type, where you may want to issue a warning when less than
7681 5E<nbsp>% of the total space is available. Defaults to B<false>.
7683 =item B<Hits> I<Number>
7685 Delay creating the notification until the threshold has been passed I<Number>
7686 times. When a notification has been generated, or when a subsequent value is
7687 inside the threshold, the counter is reset. If, for example, a value is
7688 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7689 will be dispatched at most once every 30E<nbsp>seconds.
7691 This is useful when short bursts are not a problem. If, for example, 100% CPU
7692 usage for up to a minute is normal (and data is collected every
7693 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7695 =item B<Hysteresis> I<Number>
7697 When set to non-zero, a hysteresis value is applied when checking minimum and
7698 maximum bounds. This is useful for values that increase slowly and fluctuate a
7699 bit while doing so. When these values come close to the threshold, they may
7700 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7702 If, for example, the threshold is configures as
7707 then a I<Warning> notification is created when the value exceeds I<101> and the
7708 corresponding I<Okay> notification is only created once the value falls below
7709 I<99>, thus avoiding the "flapping".
7713 =head1 FILTER CONFIGURATION
7715 Starting with collectd 4.6 there is a powerful filtering infrastructure
7716 implemented in the daemon. The concept has mostly been copied from
7717 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7718 terminology, so that users that are familiar with iptables feel right at home.
7722 The following are the terms used in the remainder of the filter configuration
7723 documentation. For an ASCII-art schema of the mechanism, see
7724 L<"General structure"> below.
7730 A I<match> is a criteria to select specific values. Examples are, of course, the
7731 name of the value or it's current value.
7733 Matches are implemented in plugins which you have to load prior to using the
7734 match. The name of such plugins starts with the "match_" prefix.
7738 A I<target> is some action that is to be performed with data. Such actions
7739 could, for example, be to change part of the value's identifier or to ignore
7740 the value completely.
7742 Some of these targets are built into the daemon, see L<"Built-in targets">
7743 below. Other targets are implemented in plugins which you have to load prior to
7744 using the target. The name of such plugins starts with the "target_" prefix.
7748 The combination of any number of matches and at least one target is called a
7749 I<rule>. The target actions will be performed for all values for which B<all>
7750 matches apply. If the rule does not have any matches associated with it, the
7751 target action will be performed for all values.
7755 A I<chain> is a list of rules and possibly default targets. The rules are tried
7756 in order and if one matches, the associated target will be called. If a value
7757 is handled by a rule, it depends on the target whether or not any subsequent
7758 rules are considered or if traversal of the chain is aborted, see
7759 L<"Flow control"> below. After all rules have been checked, the default targets
7764 =head2 General structure
7766 The following shows the resulting structure:
7773 +---------+ +---------+ +---------+ +---------+
7774 ! Rule !->! Match !->! Match !->! Target !
7775 +---------+ +---------+ +---------+ +---------+
7778 +---------+ +---------+ +---------+
7779 ! Rule !->! Target !->! Target !
7780 +---------+ +---------+ +---------+
7787 +---------+ +---------+ +---------+
7788 ! Rule !->! Match !->! Target !
7789 +---------+ +---------+ +---------+
7799 There are four ways to control which way a value takes through the filter
7806 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7807 process the value with another chain. When the called chain finishes, usually
7808 the next target or rule after the jump is executed.
7812 The stop condition, signaled for example by the built-in target B<stop>, causes
7813 all processing of the value to be stopped immediately.
7817 Causes processing in the current chain to be aborted, but processing of the
7818 value generally will continue. This means that if the chain was called via
7819 B<Jump>, the next target or rule after the jump will be executed. If the chain
7820 was not called by another chain, control will be returned to the daemon and it
7821 may pass the value to another chain.
7825 Most targets will signal the B<continue> condition, meaning that processing
7826 should continue normally. There is no special built-in target for this
7833 The configuration reflects this structure directly:
7835 PostCacheChain "PostCache"
7837 <Rule "ignore_mysql_show">
7840 Type "^mysql_command$"
7841 TypeInstance "^show_"
7851 The above configuration example will ignore all values where the plugin field
7852 is "mysql", the type is "mysql_command" and the type instance begins with
7853 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7854 default target of the chain. Since this chain is run after the value has been
7855 added to the cache, the MySQL C<show_*> command statistics will be available
7856 via the C<unixsock> plugin.
7858 =head2 List of configuration options
7862 =item B<PreCacheChain> I<ChainName>
7864 =item B<PostCacheChain> I<ChainName>
7866 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7867 argument is the name of a I<chain> that should be executed before and/or after
7868 the values have been added to the cache.
7870 To understand the implications, it's important you know what is going on inside
7871 I<collectd>. The following diagram shows how values are passed from the
7872 read-plugins to the write-plugins:
7878 + - - - - V - - - - +
7879 : +---------------+ :
7882 : +-------+-------+ :
7885 : +-------+-------+ : +---------------+
7886 : ! Cache !--->! Value Cache !
7887 : ! insert ! : +---+---+-------+
7888 : +-------+-------+ : ! !
7889 : ! ,------------' !
7891 : +-------+---+---+ : +-------+-------+
7892 : ! Post-Cache +--->! Write-Plugins !
7893 : ! Chain ! : +---------------+
7894 : +---------------+ :
7897 + - - - - - - - - - +
7899 After the values are passed from the "read" plugins to the dispatch functions,
7900 the pre-cache chain is run first. The values are added to the internal cache
7901 afterwards. The post-cache chain is run after the values have been added to the
7902 cache. So why is it such a huge deal if chains are run before or after the
7903 values have been added to this cache?
7905 Targets that change the identifier of a value list should be executed before
7906 the values are added to the cache, so that the name in the cache matches the
7907 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7908 this cache to receive a list of all available values. If you change the
7909 identifier after the value list has been added to the cache, this may easily
7910 lead to confusion, but it's not forbidden of course.
7912 The cache is also used to convert counter values to rates. These rates are, for
7913 example, used by the C<value> match (see below). If you use the rate stored in
7914 the cache B<before> the new value is added, you will use the old, B<previous>
7915 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7916 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7919 Last but not last, the B<stop> target makes a difference: If the pre-cache
7920 chain returns the stop condition, the value will not be added to the cache and
7921 the post-cache chain will not be run.
7923 =item B<Chain> I<Name>
7925 Adds a new chain with a certain name. This name can be used to refer to a
7926 specific chain, for example to jump to it.
7928 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7930 =item B<Rule> [I<Name>]
7932 Adds a new rule to the current chain. The name of the rule is optional and
7933 currently has no meaning for the daemon.
7935 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7936 must be at least one B<Target> block.
7938 =item B<Match> I<Name>
7940 Adds a match to a B<Rule> block. The name specifies what kind of match should
7941 be performed. Available matches depend on the plugins that have been loaded.
7943 The arguments inside the B<Match> block are passed to the plugin implementing
7944 the match, so which arguments are valid here depends on the plugin being used.
7945 If you do not need any to pass any arguments to a match, you can use the
7950 Which is equivalent to:
7955 =item B<Target> I<Name>
7957 Add a target to a rule or a default target to a chain. The name specifies what
7958 kind of target is to be added. Which targets are available depends on the
7959 plugins being loaded.
7961 The arguments inside the B<Target> block are passed to the plugin implementing
7962 the target, so which arguments are valid here depends on the plugin being used.
7963 If you do not need any to pass any arguments to a target, you can use the
7968 This is the same as writing:
7975 =head2 Built-in targets
7977 The following targets are built into the core daemon and therefore need no
7978 plugins to be loaded:
7984 Signals the "return" condition, see the L<"Flow control"> section above. This
7985 causes the current chain to stop processing the value and returns control to
7986 the calling chain. The calling chain will continue processing targets and rules
7987 just after the B<jump> target (see below). This is very similar to the
7988 B<RETURN> target of iptables, see L<iptables(8)>.
7990 This target does not have any options.
7998 Signals the "stop" condition, see the L<"Flow control"> section above. This
7999 causes processing of the value to be aborted immediately. This is similar to
8000 the B<DROP> target of iptables, see L<iptables(8)>.
8002 This target does not have any options.
8010 Sends the value to "write" plugins.
8016 =item B<Plugin> I<Name>
8018 Name of the write plugin to which the data should be sent. This option may be
8019 given multiple times to send the data to more than one write plugin. If the
8020 plugin supports multiple instances, the plugin's instance(s) must also be
8025 If no plugin is explicitly specified, the values will be sent to all available
8028 Single-instance plugin example:
8034 Multi-instance plugin example:
8036 <Plugin "write_graphite">
8046 Plugin "write_graphite/foo"
8051 Starts processing the rules of another chain, see L<"Flow control"> above. If
8052 the end of that chain is reached, or a stop condition is encountered,
8053 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
8054 next target or the next rule. This is similar to the B<-j> command line option
8055 of iptables, see L<iptables(8)>.
8061 =item B<Chain> I<Name>
8063 Jumps to the chain I<Name>. This argument is required and may appear only once.
8075 =head2 Available matches
8081 Matches a value using regular expressions.
8087 =item B<Host> I<Regex>
8089 =item B<Plugin> I<Regex>
8091 =item B<PluginInstance> I<Regex>
8093 =item B<Type> I<Regex>
8095 =item B<TypeInstance> I<Regex>
8097 Match values where the given regular expressions match the various fields of
8098 the identifier of a value. If multiple regular expressions are given, B<all>
8099 regexen must match for a value to match.
8101 =item B<Invert> B<false>|B<true>
8103 When set to B<true>, the result of the match is inverted, i.e. all value lists
8104 where all regular expressions apply are not matched, all other value lists are
8105 matched. Defaults to B<false>.
8112 Host "customer[0-9]+"
8118 Matches values that have a time which differs from the time on the server.
8120 This match is mainly intended for servers that receive values over the
8121 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8122 is very sensitive to the timestamp used when updating the RRD files. In
8123 particular, the time must be ever increasing. If a misbehaving client sends one
8124 packet with a timestamp far in the future, all further packets with a correct
8125 time will be ignored because of that one packet. What's worse, such corrupted
8126 RRD files are hard to fix.
8128 This match lets one match all values B<outside> a specified time range
8129 (relative to the server's time), so you can use the B<stop> target (see below)
8130 to ignore the value, for example.
8136 =item B<Future> I<Seconds>
8138 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8139 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8142 =item B<Past> I<Seconds>
8144 Matches all values that are I<behind> of the server's time by I<Seconds> or
8145 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8157 This example matches all values that are five minutes or more ahead of the
8158 server or one hour (or more) lagging behind.
8162 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8163 values. If a data-set consists of more than one data-source, all data-sources
8164 must match the specified ranges for a positive match.
8170 =item B<Min> I<Value>
8172 Sets the smallest value which still results in a match. If unset, behaves like
8175 =item B<Max> I<Value>
8177 Sets the largest value which still results in a match. If unset, behaves like
8180 =item B<Invert> B<true>|B<false>
8182 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8183 no-match is returned and vice versa. Please note that the B<Invert> setting
8184 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8185 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8187 =item B<DataSource> I<DSName> [I<DSName> ...]
8189 Select one or more of the data sources. If no data source is configured, all
8190 data sources will be checked. If the type handled by the match does not have a
8191 data source of the specified name(s), this will always result in no match
8192 (independent of the B<Invert> setting).
8194 =item B<Satisfy> B<Any>|B<All>
8196 Specifies how checking with several data sources is performed. If set to
8197 B<Any>, the match succeeds if one of the data sources is in the configured
8198 range. If set to B<All> the match only succeeds if all data sources are within
8199 the configured range. Default is B<All>.
8201 Usually B<All> is used for positive matches, B<Any> is used for negative
8202 matches. This means that with B<All> you usually check that all values are in a
8203 "good" range, while with B<Any> you check if any value is within a "bad" range
8204 (or outside the "good" range).
8208 Either B<Min> or B<Max>, but not both, may be unset.
8212 # Match all values smaller than or equal to 100. Matches only if all data
8213 # sources are below 100.
8219 # Match if the value of any data source is outside the range of 0 - 100.
8227 =item B<empty_counter>
8229 Matches all values with one or more data sources of type B<COUNTER> and where
8230 all counter values are zero. These counters usually I<never> increased since
8231 they started existing (and are therefore uninteresting), or got reset recently
8232 or overflowed and you had really, I<really> bad luck.
8234 Please keep in mind that ignoring such counters can result in confusing
8235 behavior: Counters which hardly ever increase will be zero for long periods of
8236 time. If the counter is reset for some reason (machine or service restarted,
8237 usually), the graph will be empty (NAN) for a long time. People may not
8242 Calculates a hash value of the host name and matches values according to that
8243 hash value. This makes it possible to divide all hosts into groups and match
8244 only values that are in a specific group. The intended use is in load
8245 balancing, where you want to handle only part of all data and leave the rest
8248 The hashing function used tries to distribute the hosts evenly. First, it
8249 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8252 for (i = 0; host[i] != 0; i++)
8253 hash_value = (hash_value * 251) + host[i];
8255 The constant 251 is a prime number which is supposed to make this hash value
8256 more random. The code then checks the group for this host according to the
8257 I<Total> and I<Match> arguments:
8259 if ((hash_value % Total) == Match)
8264 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8265 groups), then the least significant bit of the hash value will be the XOR of
8266 all least significant bits in the host name. One consequence is that when you
8267 have two hosts, "server0.example.com" and "server1.example.com", where the host
8268 name differs in one digit only and the digits differ by one, those hosts will
8269 never end up in the same group.
8275 =item B<Match> I<Match> I<Total>
8277 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8278 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8279 be smaller than I<Total>. I<Total> must be at least one, although only values
8280 greater than one really do make any sense.
8282 You can repeat this option to match multiple groups, for example:
8287 The above config will divide the data into seven groups and match groups three
8288 and five. One use would be to keep every value on two hosts so that if one
8289 fails the missing data can later be reconstructed from the second host.
8295 # Operate on the pre-cache chain, so that ignored values are not even in the
8300 # Divide all received hosts in seven groups and accept all hosts in
8304 # If matched: Return and continue.
8307 # If not matched: Return and stop.
8313 =head2 Available targets
8317 =item B<notification>
8319 Creates and dispatches a notification.
8325 =item B<Message> I<String>
8327 This required option sets the message of the notification. The following
8328 placeholders will be replaced by an appropriate value:
8336 =item B<%{plugin_instance}>
8340 =item B<%{type_instance}>
8342 These placeholders are replaced by the identifier field of the same name.
8344 =item B<%{ds:>I<name>B<}>
8346 These placeholders are replaced by a (hopefully) human readable representation
8347 of the current rate of this data source. If you changed the instance name
8348 (using the B<set> or B<replace> targets, see below), it may not be possible to
8349 convert counter values to rates.
8353 Please note that these placeholders are B<case sensitive>!
8355 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8357 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8364 <Target "notification">
8365 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8371 Replaces parts of the identifier using regular expressions.
8377 =item B<Host> I<Regex> I<Replacement>
8379 =item B<Plugin> I<Regex> I<Replacement>
8381 =item B<PluginInstance> I<Regex> I<Replacement>
8383 =item B<TypeInstance> I<Regex> I<Replacement>
8385 Match the appropriate field with the given regular expression I<Regex>. If the
8386 regular expression matches, that part that matches is replaced with
8387 I<Replacement>. If multiple places of the input buffer match a given regular
8388 expression, only the first occurrence will be replaced.
8390 You can specify each option multiple times to use multiple regular expressions
8398 # Replace "example.net" with "example.com"
8399 Host "\\<example.net\\>" "example.com"
8401 # Strip "www." from hostnames
8407 Sets part of the identifier of a value to a given string.
8413 =item B<Host> I<String>
8415 =item B<Plugin> I<String>
8417 =item B<PluginInstance> I<String>
8419 =item B<TypeInstance> I<String>
8421 Set the appropriate field to the given string. The strings for plugin instance
8422 and type instance may be empty, the strings for host and plugin may not be
8423 empty. It's currently not possible to set the type of a value this way.
8430 PluginInstance "coretemp"
8431 TypeInstance "core3"
8436 =head2 Backwards compatibility
8438 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8439 B<Chain> block, it will behave as it used to. This is equivalent to the
8440 following configuration:
8446 If you specify a B<PostCacheChain>, the B<write> target will not be added
8447 anywhere and you will have to make sure that it is called where appropriate. We
8448 suggest to add the above snippet as default target to your "PostCache" chain.
8452 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8468 L<collectd-exec(5)>,
8469 L<collectd-perl(5)>,
8470 L<collectd-unixsock(5)>,
8483 Florian Forster E<lt>octo@collectd.orgE<gt>