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<SSLCiphers> I<list of ciphers>
780 Specifies which ciphers to use in the connection. The list of ciphers
781 must specify valid ciphers. See
782 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
784 =item B<Timeout> I<Milliseconds>
786 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
787 milliseconds. By default, the configured B<Interval> is used to set the
792 =head2 Plugin C<apcups>
796 =item B<Host> I<Hostname>
798 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
799 that IPv6 support has been disabled unless someone can confirm or decline that
800 B<apcupsd> can handle it.
802 =item B<Port> I<Port>
804 TCP-Port to connect to. Defaults to B<3551>.
806 =item B<ReportSeconds> B<true|false>
808 If set to B<true>, the time reported in the C<timeleft> metric will be
809 converted to seconds. This is the recommended setting. If set to B<false>, the
810 default for backwards compatibility, the time will be reported in minutes.
814 =head2 Plugin C<aquaero>
816 This plugin collects the value of the available sensors in an
817 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
818 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
819 connection for monitoring and configuration. The board can handle multiple
820 temperature sensors, fans, water pumps and water level sensors and adjust the
821 output settings such as fan voltage or power used by the water pump based on
822 the available inputs using a configurable controller included in the board.
823 This plugin collects all the available inputs as well as some of the output
824 values chosen by this controller. The plugin is based on the I<libaquaero5>
825 library provided by I<aquatools-ng>.
829 =item B<Device> I<DevicePath>
831 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
832 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
833 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
837 =head2 Plugin C<ascent>
839 This plugin collects information about an Ascent server, a free server for the
840 "World of Warcraft" game. This plugin gathers the information by fetching the
841 XML status page using C<libcurl> and parses it using C<libxml2>.
843 The configuration options are the same as for the C<apache> plugin above:
847 =item B<URL> I<http://localhost/ascent/status/>
849 Sets the URL of the XML status output.
851 =item B<User> I<Username>
853 Optional user name needed for authentication.
855 =item B<Password> I<Password>
857 Optional password needed for authentication.
859 =item B<VerifyPeer> B<true|false>
861 Enable or disable peer SSL certificate verification. See
862 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
864 =item B<VerifyHost> B<true|false>
866 Enable or disable peer host name verification. If enabled, the plugin checks
867 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
868 certificate matches the host name provided by the B<URL> option. If this
869 identity check fails, the connection is aborted. Obviously, only works when
870 connecting to a SSL enabled server. Enabled by default.
872 =item B<CACert> I<File>
874 File that holds one or more SSL certificates. If you want to use HTTPS you will
875 possibly need this option. What CA certificates come bundled with C<libcurl>
876 and are checked by default depends on the distribution you use.
878 =item B<Timeout> I<Milliseconds>
880 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
881 milliseconds. By default, the configured B<Interval> is used to set the
886 =head2 Plugin C<barometer>
888 This plugin reads absolute air pressure using digital barometer sensor on a I2C
889 bus. Supported sensors are:
893 =item I<MPL115A2> from Freescale,
894 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
897 =item I<MPL3115> from Freescale
898 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
901 =item I<BMP085> from Bosch Sensortec
905 The sensor type - one of the above - is detected automatically by the plugin
906 and indicated in the plugin_instance (you will see subdirectory
907 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
908 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
909 (only one sensor can be used by the plugin).
911 The plugin provides absolute barometric pressure, air pressure reduced to sea
912 level (several possible approximations) and as an auxiliary value also internal
913 sensor temperature. It uses (expects/provides) typical metric units - pressure
914 in [hPa], temperature in [C], altitude in [m].
916 It was developed and tested under Linux only. The only platform dependency is
917 the standard Linux i2c-dev interface (the particular bus driver has to
918 support the SM Bus command subset).
920 The reduction or normalization to mean sea level pressure requires (depending
921 on selected method/approximation) also altitude and reference to temperature
922 sensor(s). When multiple temperature sensors are configured the minumum of
923 their values is always used (expecting that the warmer ones are affected by
924 e.g. direct sun light at that moment).
932 TemperatureOffset 0.0
935 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
940 =item B<Device> I<device>
942 The only mandatory configuration parameter.
944 Device name of the I2C bus to which the sensor is connected. Note that
945 typically you need to have loaded the i2c-dev module.
946 Using i2c-tools you can check/list i2c buses available on your system by:
950 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
954 This way you should be able to verify that the pressure sensor (either type) is
955 connected and detected on address 0x60.
957 =item B<Oversampling> I<value>
959 Optional parameter controlling the oversampling/accuracy. Default value
960 is 1 providing fastest and least accurate reading.
962 For I<MPL115> this is the size of the averaging window. To filter out sensor
963 noise a simple averaging using floating window of this configurable size is
964 used. The plugin will use average of the last C<value> measurements (value of 1
965 means no averaging). Minimal size is 1, maximal 1024.
967 For I<MPL3115> 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, 16, 32, 64 and 128. Any other value is
971 adjusted by the plugin to the closest supported one.
973 For I<BMP085> this is the oversampling value. The actual oversampling is
974 performed by the sensor and the higher value the higher accuracy and longer
975 conversion time (although nothing to worry about in the collectd context).
976 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
977 the closest supported one.
979 =item B<PressureOffset> I<offset>
981 Optional parameter for MPL3115 only.
983 You can further calibrate the sensor by supplying pressure and/or temperature
984 offsets. This is added to the measured/caclulated value (i.e. if the measured
985 value is too high then use negative offset).
986 In hPa, default is 0.0.
988 =item B<TemperatureOffset> I<offset>
990 Optional parameter for MPL3115 only.
992 You can further calibrate the sensor by supplying pressure and/or temperature
993 offsets. This is added to the measured/caclulated value (i.e. if the measured
994 value is too high then use negative offset).
995 In C, default is 0.0.
997 =item B<Normalization> I<method>
999 Optional parameter, default value is 0.
1001 Normalization method - what approximation/model is used to compute the mean sea
1002 level pressure from the air absolute pressure.
1004 Supported values of the C<method> (integer between from 0 to 2) are:
1008 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1009 do not need to configure C<Altitude> or C<TemperatureSensor>.
1011 =item B<1> - international formula for conversion ,
1013 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1014 For this method you have to configure C<Altitude> but do not need
1015 C<TemperatureSensor> (uses fixed global temperature average instead).
1017 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1018 Meteorological Service).
1019 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1020 For this method you have to configure both C<Altitude> and
1021 C<TemperatureSensor>.
1026 =item B<Altitude> I<altitude>
1028 The altitude (in meters) of the location where you meassure the pressure.
1030 =item B<TemperatureSensor> I<reference>
1032 Temperature sensor(s) which should be used as a reference when normalizing the
1033 pressure using C<Normalization> method 2.
1034 When specified more sensors a minumum is found and used each time. The
1035 temperature reading directly from this pressure sensor/plugin is typically not
1036 suitable as the pressure sensor will be probably inside while we want outside
1037 temperature. The collectd reference name is something like
1038 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1039 (<type_instance> is usually omitted when there is just single value type). Or
1040 you can figure it out from the path of the output data files.
1044 =head2 Plugin C<battery>
1046 The I<battery plugin> reports the remaining capacity, power and voltage of
1051 =item B<ValuesPercentage> B<false>|B<true>
1053 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1054 capacity remaining". Otherwise the capacity is stored as reported by the
1055 battery, most likely in "Wh". This option does not work with all input methods,
1056 in particular when only C</proc/pmu> is available on an old Linux system.
1057 Defaults to B<false>.
1059 =item B<ReportDegraded> B<false>|B<true>
1061 Typical laptop batteries degrade over time, meaning the capacity decreases with
1062 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1063 "last full capacity" and used to determine that a battery is "fully charged".
1065 When this option is set to B<false>, the default, the I<battery plugin> will
1066 only report the remaining capacity. If the B<ValuesPercentage> option is
1067 enabled, the relative remaining capacity is calculated as the ratio of the
1068 "remaining capacity" and the "last full capacity". This is what most tools,
1069 such as the status bar of desktop environments, also do.
1071 When set to B<true>, the battery plugin will report three values: B<charged>
1072 (remaining capacity), B<discharged> (difference between "last full capacity"
1073 and "remaining capacity") and B<degraded> (difference between "design capacity"
1074 and "last full capacity").
1078 =head2 Plugin C<bind>
1080 Starting with BIND 9.5.0, the most widely used DNS server software provides
1081 extensive statistics about queries, responses and lots of other information.
1082 The bind plugin retrieves this information that's encoded in XML and provided
1083 via HTTP and submits the values to collectd.
1085 To use this plugin, you first need to tell BIND to make this information
1086 available. This is done with the C<statistics-channels> configuration option:
1088 statistics-channels {
1089 inet localhost port 8053;
1092 The configuration follows the grouping that can be seen when looking at the
1093 data with an XSLT compatible viewer, such as a modern web browser. It's
1094 probably a good idea to make yourself familiar with the provided values, so you
1095 can understand what the collected statistics actually mean.
1100 URL "http://localhost:8053/"
1115 Zone "127.in-addr.arpa/IN"
1119 The bind plugin accepts the following configuration options:
1125 URL from which to retrieve the XML data. If not specified,
1126 C<http://localhost:8053/> will be used.
1128 =item B<ParseTime> B<true>|B<false>
1130 When set to B<true>, the time provided by BIND will be parsed and used to
1131 dispatch the values. When set to B<false>, the local time source is queried.
1133 This setting is set to B<true> by default for backwards compatibility; setting
1134 this to B<false> is I<recommended> to avoid problems with timezones and
1137 =item B<OpCodes> B<true>|B<false>
1139 When enabled, statistics about the I<"OpCodes">, for example the number of
1140 C<QUERY> packets, are collected.
1144 =item B<QTypes> B<true>|B<false>
1146 When enabled, the number of I<incoming> queries by query types (for example
1147 C<A>, C<MX>, C<AAAA>) is collected.
1151 =item B<ServerStats> B<true>|B<false>
1153 Collect global server statistics, such as requests received over IPv4 and IPv6,
1154 successful queries, and failed updates.
1158 =item B<ZoneMaintStats> B<true>|B<false>
1160 Collect zone maintenance statistics, mostly information about notifications
1161 (zone updates) and zone transfers.
1165 =item B<ResolverStats> B<true>|B<false>
1167 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1168 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1169 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1170 default. Use the B<ResolverStats> option within a B<View "_default"> block
1171 instead for the same functionality.
1175 =item B<MemoryStats>
1177 Collect global memory statistics.
1181 =item B<Timeout> I<Milliseconds>
1183 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1184 milliseconds. By default, the configured B<Interval> is used to set the
1187 =item B<View> I<Name>
1189 Collect statistics about a specific I<"view">. BIND can behave different,
1190 mostly depending on the source IP-address of the request. These different
1191 configurations are called "views". If you don't use this feature, you most
1192 likely are only interested in the C<_default> view.
1194 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1195 information you want to collect about a view. If no B<View> block is
1196 configured, no detailed view statistics will be collected.
1200 =item B<QTypes> B<true>|B<false>
1202 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1203 C<MX>) is collected.
1207 =item B<ResolverStats> B<true>|B<false>
1209 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1210 (e.E<nbsp>g. queries over IPv4, lame servers).
1214 =item B<CacheRRSets> B<true>|B<false>
1216 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1217 type is collected. Negative entries (queries which resulted in an error, for
1218 example names that do not exist) are reported with a leading exclamation mark,
1223 =item B<Zone> I<Name>
1225 When given, collect detailed information about the given zone in the view. The
1226 information collected if very similar to the global B<ServerStats> information
1229 You can repeat this option to collect detailed information about multiple
1232 By default no detailed zone information is collected.
1238 =head2 Plugin C<ceph>
1240 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1241 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1243 A separate B<Daemon> block must be configured for each ceph daemon to be
1244 monitored. The following example will read daemon statistics from four
1245 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1248 LongRunAvgLatency false
1249 ConvertSpecialMetricTypes true
1251 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1254 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1257 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1260 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1264 The ceph plugin accepts the following configuration options:
1268 =item B<LongRunAvgLatency> B<true>|B<false>
1270 If enabled, latency values(sum,count pairs) are calculated as the long run
1271 average - average since the ceph daemon was started = (sum / count).
1272 When disabled, latency values are calculated as the average since the last
1273 collection = (sum_now - sum_last) / (count_now - count_last).
1277 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1279 If enabled, special metrics (metrics that differ in type from similar counters)
1280 are converted to the type of those similar counters. This currently only
1281 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1282 ceph schema reports this metric type as a sum,count pair while similar counters
1283 are treated as derive types. When converted, the sum is used as the counter
1284 value and is treated as a derive type.
1285 When disabled, all metrics are treated as the types received from the ceph schema.
1291 Each B<Daemon> block must have a string argument for the plugin instance name.
1292 A B<SocketPath> is also required for each B<Daemon> block:
1296 =item B<Daemon> I<DaemonName>
1298 Name to be used as the instance name for this daemon.
1300 =item B<SocketPath> I<SocketPath>
1302 Specifies the path to the UNIX admin socket of the ceph daemon.
1306 =head2 Plugin C<cgroups>
1308 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1309 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1310 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1314 =item B<CGroup> I<Directory>
1316 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1317 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1320 =item B<IgnoreSelected> B<true>|B<false>
1322 Invert the selection: If set to true, all cgroups I<except> the ones that
1323 match any one of the criteria are collected. By default only selected
1324 cgroups are collected if a selection is made. If no selection is configured
1325 at all, B<all> cgroups are selected.
1329 =head2 Plugin C<conntrack>
1331 This plugin collects IP conntrack statistics.
1337 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1338 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1342 =head2 Plugin C<cpu>
1344 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1345 as Jiffies, using the C<cpu> type. Two aggregations are available:
1351 Sum, per-state, over all CPUs installed in the system; and
1355 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1359 The two aggregations can be combined, leading to I<collectd> only emitting a
1360 single "active" metric for the entire system. As soon as one of these
1361 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1362 rather than Jiffies. In addition, you can request individual, per-state,
1363 per-CPU metrics to be reported as percentage.
1365 The following configuration options are available:
1369 =item B<ReportByState> B<true>|B<false>
1371 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1373 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1376 =item B<ReportByCpu> B<true>|B<false>
1378 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1379 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1380 global sum of CPU states is emitted.
1382 =item B<ValuesPercentage> B<false>|B<true>
1384 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1385 are set to B<true>. In this case, by default, metrics will be reported as
1386 Jiffies. By setting this option to B<true>, you can request percentage values
1387 in the un-aggregated (per-CPU, per-state) mode as well.
1391 =head2 Plugin C<cpufreq>
1393 This plugin doesn't have any options. It reads
1394 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1395 installed) to get the current CPU frequency. If this file does not exist make
1396 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1397 installed and an "cpu governor" (that's a kernel module) is loaded.
1399 =head2 Plugin C<csv>
1403 =item B<DataDir> I<Directory>
1405 Set the directory to store CSV-files under. Per default CSV-files are generated
1406 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1407 The special strings B<stdout> and B<stderr> can be used to write to the standard
1408 output and standard error channels, respectively. This, of course, only makes
1409 much sense when collectd is running in foreground- or non-daemon-mode.
1411 =item B<StoreRates> B<true|false>
1413 If set to B<true>, convert counter values to rates. If set to B<false> (the
1414 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1419 =head2 Plugin C<curl>
1421 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1422 and the match infrastructure (the same code used by the tail plugin) to use
1423 regular expressions with the received data.
1425 The following example will read the current value of AMD stock from Google's
1426 finance page and dispatch the value to collectd.
1429 <Page "stock_quotes">
1430 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1436 CACert "/path/to/ca.crt"
1437 Header "X-Custom-Header: foobar"
1440 MeasureResponseTime false
1441 MeasureResponseCode false
1444 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1445 DSType "GaugeAverage"
1446 # Note: `stock_value' is not a standard type.
1453 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1454 a web page and one or more "matches" to be performed on the returned data. The
1455 string argument to the B<Page> block is used as plugin instance.
1457 The following options are valid within B<Page> blocks:
1463 URL of the web site to retrieve. Since a regular expression will be used to
1464 extract information from this data, non-binary data is a big plus here ;)
1466 =item B<User> I<Name>
1468 Username to use if authorization is required to read the page.
1470 =item B<Password> I<Password>
1472 Password to use if authorization is required to read the page.
1474 =item B<Digest> B<true>|B<false>
1476 Enable HTTP digest authentication.
1478 =item B<VerifyPeer> B<true>|B<false>
1480 Enable or disable peer SSL certificate verification. See
1481 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1483 =item B<VerifyHost> B<true>|B<false>
1485 Enable or disable peer host name verification. If enabled, the plugin checks if
1486 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1487 matches the host name provided by the B<URL> option. If this identity check
1488 fails, the connection is aborted. Obviously, only works when connecting to a
1489 SSL enabled server. Enabled by default.
1491 =item B<CACert> I<file>
1493 File that holds one or more SSL certificates. If you want to use HTTPS you will
1494 possibly need this option. What CA certificates come bundled with C<libcurl>
1495 and are checked by default depends on the distribution you use.
1497 =item B<Header> I<Header>
1499 A HTTP header to add to the request. Multiple headers are added if this option
1500 is specified more than once.
1502 =item B<Post> I<Body>
1504 Specifies that the HTTP operation should be a POST instead of a GET. The
1505 complete data to be posted is given as the argument. This option will usually
1506 need to be accompanied by a B<Header> option to set an appropriate
1507 C<Content-Type> for the post body (e.g. to
1508 C<application/x-www-form-urlencoded>).
1510 =item B<MeasureResponseTime> B<true>|B<false>
1512 Measure response time for the request. If this setting is enabled, B<Match>
1513 blocks (see below) are optional. Disabled by default.
1515 Beware that requests will get aborted if they take too long to complete. Adjust
1516 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1519 =item B<MeasureResponseCode> B<true>|B<false>
1521 Measure response code for the request. If this setting is enabled, B<Match>
1522 blocks (see below) are optional. Disabled by default.
1524 =item B<E<lt>MatchE<gt>>
1526 One or more B<Match> blocks that define how to match information in the data
1527 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1528 used by the C<tail> plugin, so please see the documentation of the C<tail>
1529 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1530 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1533 =item B<Timeout> I<Milliseconds>
1535 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1536 milliseconds. By default, the configured B<Interval> is used to set the
1537 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1538 indefinitely. This legacy behaviour can be achieved by setting the value of
1541 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1542 network connection will stall one read thread. Adjust the B<ReadThreads> global
1543 setting accordingly to prevent this from blocking other plugins.
1547 =head2 Plugin C<curl_json>
1549 The B<curl_json plugin> collects values from JSON data to be parsed by
1550 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1551 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1552 unix socket. The former can be used, for example, to collect values
1553 from CouchDB documents (which are stored JSON notation), and the
1554 latter to collect values from a uWSGI stats socket.
1556 The following example will collect several values from the built-in
1557 C<_stats> runtime statistics module of I<CouchDB>
1558 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1561 <URL "http://localhost:5984/_stats">
1563 <Key "httpd/requests/count">
1564 Type "http_requests"
1567 <Key "httpd_request_methods/*/count">
1568 Type "http_request_methods"
1571 <Key "httpd_status_codes/*/count">
1572 Type "http_response_codes"
1577 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1580 <Sock "/var/run/uwsgi.stats.sock">
1582 <Key "workers/*/requests">
1583 Type "http_requests"
1586 <Key "workers/*/apps/*/requests">
1587 Type "http_requests"
1592 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1593 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1594 blocks defining a unix socket to read JSON from directly. Each of
1595 these blocks may have one or more B<Key> blocks.
1597 The B<Key> string argument must be in a path format. Each component is
1598 used to match the key from a JSON map or the index of an JSON
1599 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1600 values for all map keys or array indices will be collectd.
1602 The following options are valid within B<URL> blocks:
1606 =item B<Instance> I<Instance>
1608 Sets the plugin instance to I<Instance>.
1610 =item B<Interval> I<Interval>
1612 Sets the interval (in seconds) in which the values will be collected from this
1613 URL. By default the global B<Interval> setting will be used.
1615 =item B<User> I<Name>
1617 =item B<Password> I<Password>
1619 =item B<Digest> B<true>|B<false>
1621 =item B<VerifyPeer> B<true>|B<false>
1623 =item B<VerifyHost> B<true>|B<false>
1625 =item B<CACert> I<file>
1627 =item B<Header> I<Header>
1629 =item B<Post> I<Body>
1631 =item B<Timeout> I<Milliseconds>
1633 These options behave exactly equivalent to the appropriate options of the
1634 I<cURL> plugin. Please see there for a detailed description.
1638 The following options are valid within B<Key> blocks:
1642 =item B<Type> I<Type>
1644 Sets the type used to dispatch the values to the daemon. Detailed information
1645 about types and their configuration can be found in L<types.db(5)>. This
1646 option is mandatory.
1648 =item B<Instance> I<Instance>
1650 Type-instance to use. Defaults to the current map key or current string array element value.
1654 =head2 Plugin C<curl_xml>
1656 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1657 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1660 <URL "http://localhost/stats.xml">
1662 Instance "some_instance"
1667 CACert "/path/to/ca.crt"
1668 Header "X-Custom-Header: foobar"
1671 <XPath "table[@id=\"magic_level\"]/tr">
1673 #InstancePrefix "prefix-"
1674 InstanceFrom "td[1]"
1675 ValuesFrom "td[2]/span[@class=\"level\"]"
1680 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1681 URL to be fetched using libcurl. Within each B<URL> block there are
1682 options which specify the connection parameters, for example authentication
1683 information, and one or more B<XPath> blocks.
1685 Each B<XPath> block specifies how to get one type of information. The
1686 string argument must be a valid XPath expression which returns a list
1687 of "base elements". One value is dispatched for each "base element". The
1688 I<type instance> and values are looked up using further I<XPath> expressions
1689 that should be relative to the base element.
1691 Within the B<URL> block the following options are accepted:
1695 =item B<Host> I<Name>
1697 Use I<Name> as the host name when submitting values. Defaults to the global
1700 =item B<Instance> I<Instance>
1702 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1703 empty string (no plugin instance).
1705 =item B<Namespace> I<Prefix> I<URL>
1707 If an XPath expression references namespaces, they must be specified
1708 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1709 I<URL> is the "namespace name", an URI reference uniquely identifying the
1710 namespace. The option can be repeated to register multiple namespaces.
1714 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1715 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1717 =item B<User> I<User>
1719 =item B<Password> I<Password>
1721 =item B<Digest> B<true>|B<false>
1723 =item B<VerifyPeer> B<true>|B<false>
1725 =item B<VerifyHost> B<true>|B<false>
1727 =item B<CACert> I<CA Cert File>
1729 =item B<Header> I<Header>
1731 =item B<Post> I<Body>
1733 =item B<Timeout> I<Milliseconds>
1735 These options behave exactly equivalent to the appropriate options of the
1736 I<cURL plugin>. Please see there for a detailed description.
1738 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1740 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1741 B<XPath> block specifies how to get one type of information. The string
1742 argument must be a valid XPath expression which returns a list of "base
1743 elements". One value is dispatched for each "base element".
1745 Within the B<XPath> block the following options are accepted:
1749 =item B<Type> I<Type>
1751 Specifies the I<Type> used for submitting patches. This determines the number
1752 of values that are required / expected and whether the strings are parsed as
1753 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1754 This option is required.
1756 =item B<InstancePrefix> I<InstancePrefix>
1758 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1759 concatenated together without any separator.
1760 This option is optional.
1762 =item B<InstanceFrom> I<InstanceFrom>
1764 Specifies a XPath expression to use for determining the I<type instance>. The
1765 XPath expression must return exactly one element. The element's value is then
1766 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1768 This value is required. As a special exception, if the "base XPath expression"
1769 (the argument to the B<XPath> block) returns exactly one argument, then this
1770 option may be omitted.
1772 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1774 Specifies one or more XPath expression to use for reading the values. The
1775 number of XPath expressions must match the number of data sources in the
1776 I<type> specified with B<Type> (see above). Each XPath expression must return
1777 exactly one element. The element's value is then parsed as a number and used as
1778 value for the appropriate value in the value list dispatched to the daemon.
1784 =head2 Plugin C<dbi>
1786 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1787 connect to various databases, execute I<SQL> statements and read back the
1788 results. I<dbi> is an acronym for "database interface" in case you were
1789 wondering about the name. You can configure how each column is to be
1790 interpreted and the plugin will generate one or more data sets from each row
1791 returned according to these rules.
1793 Because the plugin is very generic, the configuration is a little more complex
1794 than those of other plugins. It usually looks something like this:
1797 <Query "out_of_stock">
1798 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1799 # Use with MySQL 5.0.0 or later
1803 InstancePrefix "out_of_stock"
1804 InstancesFrom "category"
1808 <Database "product_information">
1810 DriverOption "host" "localhost"
1811 DriverOption "username" "collectd"
1812 DriverOption "password" "aZo6daiw"
1813 DriverOption "dbname" "prod_info"
1814 SelectDB "prod_info"
1815 Query "out_of_stock"
1819 The configuration above defines one query with one result and one database. The
1820 query is then linked to the database with the B<Query> option I<within> the
1821 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1822 and you can also use the B<Include> statement to split up the configuration
1823 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1824 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1827 The following is a complete list of options:
1829 =head3 B<Query> blocks
1831 Query blocks define I<SQL> statements and how the returned data should be
1832 interpreted. They are identified by the name that is given in the opening line
1833 of the block. Thus the name needs to be unique. Other than that, the name is
1834 not used in collectd.
1836 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1837 define which column holds which value or instance information. You can use
1838 multiple B<Result> blocks to create multiple values from one returned row. This
1839 is especially useful, when queries take a long time and sending almost the same
1840 query again and again is not desirable.
1844 <Query "environment">
1845 Statement "select station, temperature, humidity from environment"
1848 # InstancePrefix "foo"
1849 InstancesFrom "station"
1850 ValuesFrom "temperature"
1854 InstancesFrom "station"
1855 ValuesFrom "humidity"
1859 The following options are accepted:
1863 =item B<Statement> I<SQL>
1865 Sets the statement that should be executed on the server. This is B<not>
1866 interpreted by collectd, but simply passed to the database server. Therefore,
1867 the SQL dialect that's used depends on the server collectd is connected to.
1869 The query has to return at least two columns, one for the instance and one
1870 value. You cannot omit the instance, even if the statement is guaranteed to
1871 always return exactly one line. In that case, you can usually specify something
1874 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1876 (That works with MySQL but may not be valid SQL according to the spec. If you
1877 use a more strict database server, you may have to select from a dummy table or
1880 Please note that some databases, for example B<Oracle>, will fail if you
1881 include a semicolon at the end of the statement.
1883 =item B<MinVersion> I<Version>
1885 =item B<MaxVersion> I<Value>
1887 Only use this query for the specified database version. You can use these
1888 options to provide multiple queries with the same name but with a slightly
1889 different syntax. The plugin will use only those queries, where the specified
1890 minimum and maximum versions fit the version of the database in use.
1892 The database version is determined by C<dbi_conn_get_engine_version>, see the
1893 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1894 for details. Basically, each part of the version is assumed to be in the range
1895 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1896 "40102", version "5.0.42" becomes "50042".
1898 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1899 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1900 happen. Don't to it! A valid example would be something along these lines:
1911 In the above example, there are three ranges that don't overlap. The last one
1912 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1913 before "4.0.0" are not specified.
1915 =item B<Type> I<Type>
1917 The B<type> that's used for each line returned. See L<types.db(5)> for more
1918 details on how types are defined. In short: A type is a predefined layout of
1919 data and the number of values and type of values has to match the type
1922 If you specify "temperature" here, you need exactly one gauge column. If you
1923 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1926 There must be exactly one B<Type> option inside each B<Result> block.
1928 =item B<InstancePrefix> I<prefix>
1930 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1931 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1932 all strings returned in the appropriate columns are concatenated together,
1933 separated by dashes I<("-")>.
1935 =item B<InstancesFrom> I<column0> [I<column1> ...]
1937 Specifies the columns whose values will be used to create the "type-instance"
1938 for each row. If you specify more than one column, the value of all columns
1939 will be joined together with dashes I<("-")> as separation characters.
1941 The plugin itself does not check whether or not all built instances are
1942 different. It's your responsibility to assure that each is unique. This is
1943 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1944 sure that only one row is returned in this case.
1946 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1949 =item B<ValuesFrom> I<column0> [I<column1> ...]
1951 Names the columns whose content is used as the actual data for the data sets
1952 that are dispatched to the daemon. How many such columns you need is determined
1953 by the B<Type> setting above. If you specify too many or not enough columns,
1954 the plugin will complain about that and no data will be submitted to the
1957 The actual data type in the columns is not that important. The plugin will
1958 automatically cast the values to the right type if it know how to do that. So
1959 it should be able to handle integer an floating point types, as well as strings
1960 (if they include a number at the beginning).
1962 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1964 =item B<MetadataFrom> [I<column0> I<column1> ...]
1966 Names the columns whose content is used as metadata for the data sets
1967 that are dispatched to the daemon.
1969 The actual data type in the columns is not that important. The plugin will
1970 automatically cast the values to the right type if it know how to do that. So
1971 it should be able to handle integer an floating point types, as well as strings
1972 (if they include a number at the beginning).
1976 =head3 B<Database> blocks
1978 Database blocks define a connection to a database and which queries should be
1979 sent to that database. Since the used "dbi" library can handle a wide variety
1980 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1981 documentationE<nbsp>- we stick as close to the terminology used there.
1983 Each database needs a "name" as string argument in the starting tag of the
1984 block. This name will be used as "PluginInstance" in the values submitted to
1985 the daemon. Other than that, that name is not used.
1989 =item B<Driver> I<Driver>
1991 Specifies the driver to use to connect to the database. In many cases those
1992 drivers are named after the database they can connect to, but this is not a
1993 technical necessity. These drivers are sometimes referred to as "DBD",
1994 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1995 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1996 project at L<http://libdbi-drivers.sourceforge.net/>.
1998 You need to give the driver name as expected by the "dbi" library here. You
1999 should be able to find that in the documentation for each driver. If you
2000 mistype the driver name, the plugin will dump a list of all known driver names
2003 =item B<DriverOption> I<Key> I<Value>
2005 Sets driver-specific options. What option a driver supports can be found in the
2006 documentation for each driver, somewhere at
2007 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2008 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2010 DBDs can register two types of options: String options and numeric options. The
2011 plugin will use the C<dbi_conn_set_option> function when the configuration
2012 provides a string and the C<dbi_conn_require_option_numeric> function when the
2013 configuration provides a number. So these two lines will actually result in
2014 different calls being used:
2016 DriverOption "Port" 1234 # numeric
2017 DriverOption "Port" "1234" # string
2019 Unfortunately, drivers are not too keen to report errors when an unknown option
2020 is passed to them, so invalid settings here may go unnoticed. This is not the
2021 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2022 the driver. If a driver complains about an option, the plugin will dump a
2023 complete list of all options understood by that driver to the log. There is no
2024 way to programatically find out if an option expects a string or a numeric
2025 argument, so you will have to refer to the appropriate DBD's documentation to
2026 find this out. Sorry.
2028 =item B<SelectDB> I<Database>
2030 In some cases, the database name you connect with is not the database name you
2031 want to use for querying data. If this option is set, the plugin will "select"
2032 (switch to) that database after the connection is established.
2034 =item B<Query> I<QueryName>
2036 Associates the query named I<QueryName> with this database connection. The
2037 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2038 blocks you want to refer to must be placed above the database block you want to
2041 =item B<Host> I<Hostname>
2043 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2044 values. Defaults to the global hostname setting.
2052 =item B<Device> I<Device>
2054 Select partitions based on the devicename.
2056 =item B<MountPoint> I<Directory>
2058 Select partitions based on the mountpoint.
2060 =item B<FSType> I<FSType>
2062 Select partitions based on the filesystem type.
2064 =item B<IgnoreSelected> B<true>|B<false>
2066 Invert the selection: If set to true, all partitions B<except> the ones that
2067 match any one of the criteria are collected. By default only selected
2068 partitions are collected if a selection is made. If no selection is configured
2069 at all, B<all> partitions are selected.
2071 =item B<ReportByDevice> B<true>|B<false>
2073 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2074 (the default), it will report a disk as "root", but with it I<true>, it will be
2075 "sda1" (or whichever).
2077 =item B<ReportInodes> B<true>|B<false>
2079 Enables or disables reporting of free, reserved and used inodes. Defaults to
2080 inode collection being disabled.
2082 Enable this option if inodes are a scarce resource for you, usually because
2083 many small files are stored on the disk. This is a usual scenario for mail
2084 transfer agents and web caches.
2086 =item B<ValuesAbsolute> B<true>|B<false>
2088 Enables or disables reporting of free and used disk space in 1K-blocks.
2089 Defaults to B<true>.
2091 =item B<ValuesPercentage> B<false>|B<true>
2093 Enables or disables reporting of free and used disk space in percentage.
2094 Defaults to B<false>.
2096 This is useful for deploying I<collectd> on the cloud, where machines with
2097 different disk size may exist. Then it is more practical to configure
2098 thresholds based on relative disk size.
2102 =head2 Plugin C<disk>
2104 The C<disk> plugin collects information about the usage of physical disks and
2105 logical disks (partitions). Values collected are the number of octets written
2106 to and read from a disk or partition, the number of read/write operations
2107 issued to the disk and a rather complex "time" it took for these commands to be
2110 Using the following two options you can ignore some disks or configure the
2111 collection only of specific disks.
2115 =item B<Disk> I<Name>
2117 Select the disk I<Name>. Whether it is collected or ignored depends on the
2118 B<IgnoreSelected> setting, see below. As with other plugins that use the
2119 daemon's ignorelist functionality, a string that starts and ends with a slash
2120 is interpreted as a regular expression. Examples:
2125 =item B<IgnoreSelected> B<true>|B<false>
2127 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2128 statements, are ignored or if all other disks are ignored. The behavior
2129 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2130 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2131 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2132 is set to B<true>, all disks are collected B<except> the ones matched.
2134 =item B<UseBSDName> B<true>|B<false>
2136 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2137 default major/minor numbers. Requires collectd to be built with Apple's
2140 =item B<UdevNameAttr> I<Attribute>
2142 Attempt to override disk instance name with the value of a specified udev
2143 attribute when built with B<libudev>. If the attribute is not defined for the
2144 given device, the default name is used. Example:
2146 UdevNameAttr "DM_NAME"
2150 =head2 Plugin C<dns>
2154 =item B<Interface> I<Interface>
2156 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2157 option sets the interface that should be used. If this option is not set, or
2158 set to "any", the plugin will try to get packets from B<all> interfaces. This
2159 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2161 =item B<IgnoreSource> I<IP-address>
2163 Ignore packets that originate from this address.
2165 =item B<SelectNumericQueryTypes> B<true>|B<false>
2167 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2171 =head2 Plugin C<email>
2175 =item B<SocketFile> I<Path>
2177 Sets the socket-file which is to be created.
2179 =item B<SocketGroup> I<Group>
2181 If running as root change the group of the UNIX-socket after it has been
2182 created. Defaults to B<collectd>.
2184 =item B<SocketPerms> I<Permissions>
2186 Change the file permissions of the UNIX-socket after it has been created. The
2187 permissions must be given as a numeric, octal value as you would pass to
2188 L<chmod(1)>. Defaults to B<0770>.
2190 =item B<MaxConns> I<Number>
2192 Sets the maximum number of connections that can be handled in parallel. Since
2193 this many threads will be started immediately setting this to a very high
2194 value will waste valuable resources. Defaults to B<5> and will be forced to be
2195 at most B<16384> to prevent typos and dumb mistakes.
2199 =head2 Plugin C<ethstat>
2201 The I<ethstat plugin> collects information about network interface cards (NICs)
2202 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2208 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2209 Map "multicast" "if_multicast"
2216 =item B<Interface> I<Name>
2218 Collect statistical information about interface I<Name>.
2220 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2222 By default, the plugin will submit values as type C<derive> and I<type
2223 instance> set to I<Name>, the name of the metric as reported by the driver. If
2224 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2225 I<TypeInstance> will be used.
2227 =item B<MappedOnly> B<true>|B<false>
2229 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2230 collected, all other metrics will be ignored. Defaults to B<false>.
2234 =head2 Plugin C<exec>
2236 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2237 contains valuable information on when the executable is executed and the
2238 output that is expected from it.
2242 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2244 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2246 Execute the executable I<Executable> as user I<User>. If the user name is
2247 followed by a colon and a group name, the effective group is set to that group.
2248 The real group and saved-set group will be set to the default group of that
2249 user. If no group is given the effective group ID will be the same as the real
2252 Please note that in order to change the user and/or group the daemon needs
2253 superuser privileges. If the daemon is run as an unprivileged user you must
2254 specify the same user/group here. If the daemon is run with superuser
2255 privileges, you must supply a non-root user here.
2257 The executable may be followed by optional arguments that are passed to the
2258 program. Please note that due to the configuration parsing numbers and boolean
2259 values may be changed. If you want to be absolutely sure that something is
2260 passed as-is please enclose it in quotes.
2262 The B<Exec> and B<NotificationExec> statements change the semantics of the
2263 programs executed, i.E<nbsp>e. the data passed to them and the response
2264 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2268 =head2 Plugin C<filecount>
2270 The C<filecount> plugin counts the number of files in a certain directory (and
2271 its subdirectories) and their combined size. The configuration is very straight
2274 <Plugin "filecount">
2275 <Directory "/var/qmail/queue/mess">
2276 Instance "qmail-message"
2278 <Directory "/var/qmail/queue/todo">
2279 Instance "qmail-todo"
2281 <Directory "/var/lib/php5">
2282 Instance "php5-sessions"
2287 The example above counts the number of files in QMail's queue directories and
2288 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2289 QMail has not yet looked at, the "message" queue holds the messages that were
2290 classified into "local" and "remote".
2292 As you can see, the configuration consists of one or more C<Directory> blocks,
2293 each of which specifies a directory in which to count the files. Within those
2294 blocks, the following options are recognized:
2298 =item B<Instance> I<Instance>
2300 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2301 it's your responsibility, the plugin doesn't check for that. If not given, the
2302 instance is set to the directory name with all slashes replaced by underscores
2303 and all leading underscores removed.
2305 =item B<Name> I<Pattern>
2307 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2308 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2309 against the pattern, not the entire path. In case this makes it easier for you:
2310 This option has been named after the B<-name> parameter to L<find(1)>.
2312 =item B<MTime> I<Age>
2314 Count only files of a specific age: If I<Age> is greater than zero, only files
2315 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2316 a negative number, this is inversed. For example, if B<-60> is specified, only
2317 files that have been modified in the last minute will be counted.
2319 The number can also be followed by a "multiplier" to easily specify a larger
2320 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2321 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2322 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2323 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2324 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2327 =item B<Size> I<Size>
2329 Count only files of a specific size. When I<Size> is a positive number, only
2330 files that are at least this big are counted. If I<Size> is a negative number,
2331 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2332 I<Size> are counted.
2334 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2335 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2336 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2337 note that there are 1000 bytes in a kilobyte, not 1024.
2339 =item B<Recursive> I<true>|I<false>
2341 Controls whether or not to recurse into subdirectories. Enabled by default.
2343 =item B<IncludeHidden> I<true>|I<false>
2345 Controls whether or not to include "hidden" files and directories in the count.
2346 "Hidden" files and directories are those, whose name begins with a dot.
2347 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2351 =head2 Plugin C<GenericJMX>
2353 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2354 L<collectd-java(5)>.
2356 =head2 Plugin C<gmond>
2358 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2359 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2360 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2365 MCReceiveFrom "239.2.11.71" "8649"
2366 <Metric "swap_total">
2368 TypeInstance "total"
2371 <Metric "swap_free">
2378 The following metrics are built-in:
2384 load_one, load_five, load_fifteen
2388 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2392 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2404 Available configuration options:
2408 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2410 Sets sets the multicast group and UDP port to which to subscribe.
2412 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2414 =item E<lt>B<Metric> I<Name>E<gt>
2416 These blocks add a new metric conversion to the internal table. I<Name>, the
2417 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2421 =item B<Type> I<Type>
2423 Type to map this metric to. Required.
2425 =item B<TypeInstance> I<Instance>
2427 Type-instance to use. Optional.
2429 =item B<DataSource> I<Name>
2431 Data source to map this metric to. If the configured type has exactly one data
2432 source, this is optional. Otherwise the option is required.
2438 =head2 Plugin C<hddtemp>
2440 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2441 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2442 default values, see below. C<hddtemp> has to be running to work correctly. If
2443 C<hddtemp> is not running timeouts may appear which may interfere with other
2446 The B<hddtemp> homepage can be found at
2447 L<http://www.guzu.net/linux/hddtemp.php>.
2451 =item B<Host> I<Hostname>
2453 Hostname to connect to. Defaults to B<127.0.0.1>.
2455 =item B<Port> I<Port>
2457 TCP-Port to connect to. Defaults to B<7634>.
2461 =head2 Plugin C<interface>
2465 =item B<Interface> I<Interface>
2467 Select this interface. By default these interfaces will then be collected. For
2468 a more detailed description see B<IgnoreSelected> below.
2470 =item B<IgnoreSelected> I<true>|I<false>
2472 If no configuration if given, the B<traffic>-plugin will collect data from
2473 all interfaces. This may not be practical, especially for loopback- and
2474 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2475 interfaces you're interested in. Sometimes, however, it's easier/preferred
2476 to collect all interfaces I<except> a few ones. This option enables you to
2477 do that: By setting B<IgnoreSelected> to I<true> the effect of
2478 B<Interface> is inverted: All selected interfaces are ignored and all
2479 other interfaces are collected.
2483 =head2 Plugin C<ipc>
2485 The I<IPC plugin> allows to B<collectd> to gather information about
2486 process IPC mechanims, like used semaphores, size of shared memory
2487 segments and others.
2489 =head2 Plugin C<ipmi>
2493 =item B<Sensor> I<Sensor>
2495 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2497 =item B<IgnoreSelected> I<true>|I<false>
2499 If no configuration if given, the B<ipmi> plugin will collect data from all
2500 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2501 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2502 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2503 all other sensors are collected.
2505 =item B<NotifySensorAdd> I<true>|I<false>
2507 If a sensor appears after initialization time of a minute a notification
2510 =item B<NotifySensorRemove> I<true>|I<false>
2512 If a sensor disappears a notification is sent.
2514 =item B<NotifySensorNotPresent> I<true>|I<false>
2516 If you have for example dual power supply and one of them is (un)plugged then
2517 a notification is sent.
2521 =head2 Plugin C<iptables>
2525 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2527 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2528 will collect the counters of all rules which have a comment-match. The comment
2529 is then used as type-instance.
2531 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2532 the I<n>th rule will be collected. Again, the comment (or the number) will be
2533 used as the type-instance.
2535 If I<Name> is supplied, it will be used as the type-instance instead of the
2536 comment or the number.
2540 =head2 Plugin C<irq>
2546 Select this irq. By default these irqs will then be collected. For a more
2547 detailed description see B<IgnoreSelected> below.
2549 =item B<IgnoreSelected> I<true>|I<false>
2551 If no configuration if given, the B<irq>-plugin will collect data from all
2552 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2553 can use the B<Irq>-option to pick the interrupt you're interested in.
2554 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2555 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2556 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2557 and all other interrupts are collected.
2561 =head2 Plugin C<java>
2563 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2564 This section only discusses the syntax and semantic of the configuration
2565 options. For more in-depth information on the I<Java> plugin, please read
2566 L<collectd-java(5)>.
2571 JVMArg "-verbose:jni"
2572 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2573 LoadPlugin "org.collectd.java.Foobar"
2574 <Plugin "org.collectd.java.Foobar">
2575 # To be parsed by the plugin
2579 Available configuration options:
2583 =item B<JVMArg> I<Argument>
2585 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2586 exactly the way the arguments to the I<java> binary on the command line work.
2587 Execute C<javaE<nbsp>--help> for details.
2589 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2590 any other options! When another option is found, the JVM will be started and
2591 later options will have to be ignored!
2593 =item B<LoadPlugin> I<JavaClass>
2595 Instantiates a new I<JavaClass> object. The constructor of this object very
2596 likely then registers one or more callback methods with the server.
2598 See L<collectd-java(5)> for details.
2600 When the first such option is found, the virtual machine (JVM) is created. This
2601 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2602 B<LoadPlugin> options!
2604 =item B<Plugin> I<Name>
2606 The entire block is passed to the Java plugin as an
2607 I<org.collectd.api.OConfigItem> object.
2609 For this to work, the plugin has to register a configuration callback first,
2610 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2611 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2612 depends on the (Java) plugin registering the callback and is completely
2613 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2617 =head2 Plugin C<load>
2619 The I<Load plugin> collects the system load. These numbers give a rough overview
2620 over the utilization of a machine. The system load is defined as the number of
2621 runnable tasks in the run-queue and is provided by many operating systems as a
2622 one, five or fifteen minute average.
2624 The following configuration options are available:
2628 =item B<ReportRelative> B<false>|B<true>
2630 When enabled, system load divided by number of available CPU cores is reported
2631 for intervals 1 min, 5 min and 15 min. Defaults to false.
2636 =head2 Plugin C<logfile>
2640 =item B<LogLevel> B<debug|info|notice|warning|err>
2642 Sets the log-level. If, for example, set to B<notice>, then all events with
2643 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2645 Please note that B<debug> is only available if collectd has been compiled with
2648 =item B<File> I<File>
2650 Sets the file to write log messages to. The special strings B<stdout> and
2651 B<stderr> can be used to write to the standard output and standard error
2652 channels, respectively. This, of course, only makes much sense when I<collectd>
2653 is running in foreground- or non-daemon-mode.
2655 =item B<Timestamp> B<true>|B<false>
2657 Prefix all lines printed by the current time. Defaults to B<true>.
2659 =item B<PrintSeverity> B<true>|B<false>
2661 When enabled, all lines are prefixed by the severity of the log message, for
2662 example "warning". Defaults to B<false>.
2666 B<Note>: There is no need to notify the daemon after moving or removing the
2667 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2668 for each line it writes.
2670 =head2 Plugin C<log_logstash>
2672 The I<log logstash plugin> behaves like the logfile plugin but formats
2673 messages as JSON events for logstash to parse and input.
2677 =item B<LogLevel> B<debug|info|notice|warning|err>
2679 Sets the log-level. If, for example, set to B<notice>, then all events with
2680 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2682 Please note that B<debug> is only available if collectd has been compiled with
2685 =item B<File> I<File>
2687 Sets the file to write log messages to. The special strings B<stdout> and
2688 B<stderr> can be used to write to the standard output and standard error
2689 channels, respectively. This, of course, only makes much sense when I<collectd>
2690 is running in foreground- or non-daemon-mode.
2694 B<Note>: There is no need to notify the daemon after moving or removing the
2695 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2696 for each line it writes.
2698 =head2 Plugin C<lpar>
2700 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2701 virtualization technique for IBM POWER processors. It takes into account CPU
2702 time stolen from or donated to a partition, in addition to the usual user,
2703 system, I/O statistics.
2705 The following configuration options are available:
2709 =item B<CpuPoolStats> B<false>|B<true>
2711 When enabled, statistics about the processor pool are read, too. The partition
2712 needs to have pool authority in order to be able to acquire this information.
2715 =item B<ReportBySerial> B<false>|B<true>
2717 If enabled, the serial of the physical machine the partition is currently
2718 running on is reported as I<hostname> and the logical hostname of the machine
2719 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2720 used (just like other plugins) and the I<plugin instance> will be empty.
2725 =head2 Plugin C<mbmon>
2727 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2729 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2730 B<Host> and B<Port> options can be used to change these values, see below.
2731 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2732 timeouts may appear which may interfere with other statistics..
2734 C<mbmon> must be run with the -r option ("print TAG and Value format");
2735 Debian's F</etc/init.d/mbmon> script already does this, other people
2736 will need to ensure that this is the case.
2740 =item B<Host> I<Hostname>
2742 Hostname to connect to. Defaults to B<127.0.0.1>.
2744 =item B<Port> I<Port>
2746 TCP-Port to connect to. Defaults to B<411>.
2752 The C<md plugin> collects information from Linux Software-RAID devices (md).
2754 All reported values are of the type C<md_disks>. Reported type instances are
2755 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2756 I<missing> (physically absent) disks.
2760 =item B<Device> I<Device>
2762 Select md devices based on device name. The I<device name> is the basename of
2763 the device, i.e. the name of the block device without the leading C</dev/>.
2764 See B<IgnoreSelected> for more details.
2766 =item B<IgnoreSelected> B<true>|B<false>
2768 Invert device selection: If set to B<true>, all md devices B<except> those
2769 listed using B<Device> are collected. If B<false> (the default), only those
2770 listed are collected. If no configuration is given, the B<md> plugin will
2771 collect data from all md devices.
2775 =head2 Plugin C<memcachec>
2777 The C<memcachec plugin> connects to a memcached server, queries one or more
2778 given I<pages> and parses the returned data according to user specification.
2779 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2782 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2783 library. Please note that there is another library with a very similar name,
2784 libmemcache (notice the missing `d'), which is not applicable.
2786 Synopsis of the configuration:
2788 <Plugin "memcachec">
2789 <Page "plugin_instance">
2793 Regex "(\\d+) bytes sent"
2796 Instance "type_instance"
2801 The configuration options are:
2805 =item E<lt>B<Page> I<Name>E<gt>
2807 Each B<Page> block defines one I<page> to be queried from the memcached server.
2808 The block requires one string argument which is used as I<plugin instance>.
2810 =item B<Server> I<Address>
2812 Sets the server address to connect to when querying the page. Must be inside a
2817 When connected to the memcached server, asks for the page I<Key>.
2819 =item E<lt>B<Match>E<gt>
2821 Match blocks define which strings to look for and how matches substrings are
2822 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2826 =head2 Plugin C<memcached>
2828 The B<memcached plugin> connects to a memcached server and queries statistics
2829 about cache utilization, memory and bandwidth used.
2830 L<http://www.danga.com/memcached/>
2832 <Plugin "memcached">
2834 Host "memcache.example.com"
2839 The plugin configuration consists of one or more B<Instance> blocks which
2840 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2841 following options are allowed:
2845 =item B<Host> I<Hostname>
2847 Hostname to connect to. Defaults to B<127.0.0.1>.
2849 =item B<Port> I<Port>
2851 TCP-Port to connect to. Defaults to B<11211>.
2853 =item B<Socket> I<Path>
2855 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2856 setting is given, the B<Host> and B<Port> settings are ignored.
2860 =head2 Plugin C<mic>
2862 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2863 Intel's Many Integrated Core (MIC) systems.
2872 ShowTemperatures true
2875 IgnoreSelectedTemperature true
2880 IgnoreSelectedPower true
2883 The following options are valid inside the B<PluginE<nbsp>mic> block:
2887 =item B<ShowCPU> B<true>|B<false>
2889 If enabled (the default) a sum of the CPU usage across all cores is reported.
2891 =item B<ShowCPUCores> B<true>|B<false>
2893 If enabled (the default) per-core CPU usage is reported.
2895 =item B<ShowMemory> B<true>|B<false>
2897 If enabled (the default) the physical memory usage of the MIC system is
2900 =item B<ShowTemperatures> B<true>|B<false>
2902 If enabled (the default) various temperatures of the MIC system are reported.
2904 =item B<Temperature> I<Name>
2906 This option controls which temperatures are being reported. Whether matching
2907 temperatures are being ignored or I<only> matching temperatures are reported
2908 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2909 temperatures are reported.
2911 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2913 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2914 (the default) only temperatures matching a B<Temperature> option are reported
2915 or, if no B<Temperature> option is specified, all temperatures are reported. If
2916 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2919 Known temperature names are:
2953 =item B<ShowPower> B<true>|B<false>
2955 If enabled (the default) various temperatures of the MIC system are reported.
2957 =item B<Power> I<Name>
2959 This option controls which power readings are being reported. Whether matching
2960 power readings are being ignored or I<only> matching power readings are reported
2961 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2962 power readings are reported.
2964 =item B<IgnoreSelectedPower> B<false>|B<true>
2966 Controls the behavior of the B<Power> setting above. If set to B<false>
2967 (the default) only power readings matching a B<Power> option are reported
2968 or, if no B<Power> option is specified, all power readings are reported. If
2969 set to B<true>, matching power readings are I<ignored> and all other power readings
2972 Known power names are:
2978 Total power utilization averaged over Time Window 0 (uWatts).
2982 Total power utilization averaged over Time Window 0 (uWatts).
2986 Instantaneous power (uWatts).
2990 Max instantaneous power (uWatts).
2994 PCI-E connector power (uWatts).
2998 2x3 connector power (uWatts).
3002 2x4 connector power (uWatts).
3010 Uncore rail (uVolts).
3014 Memory subsystem rail (uVolts).
3020 =head2 Plugin C<memory>
3022 The I<memory plugin> provides the following configuration options:
3026 =item B<ValuesAbsolute> B<true>|B<false>
3028 Enables or disables reporting of physical memory usage in absolute numbers,
3029 i.e. bytes. Defaults to B<true>.
3031 =item B<ValuesPercentage> B<false>|B<true>
3033 Enables or disables reporting of physical memory usage in percentages, e.g.
3034 percent of physical memory used. Defaults to B<false>.
3036 This is useful for deploying I<collectd> in a heterogeneous environment in
3037 which the sizes of physical memory vary.
3041 =head2 Plugin C<modbus>
3043 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3044 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3045 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3046 values (two registers interpreted as IEEE floats in big endian notation).
3050 <Data "voltage-input-1">
3053 RegisterCmd ReadHolding
3058 <Data "voltage-input-2">
3061 RegisterCmd ReadHolding
3066 <Data "supply-temperature-1">
3069 RegisterCmd ReadHolding
3074 <Host "modbus.example.com">
3075 Address "192.168.0.42"
3080 Instance "power-supply"
3081 Collect "voltage-input-1"
3082 Collect "voltage-input-2"
3087 Device "/dev/ttyUSB0"
3092 Instance "temperature"
3093 Collect "supply-temperature-1"
3099 =item E<lt>B<Data> I<Name>E<gt> blocks
3101 Data blocks define a mapping between register numbers and the "types" used by
3104 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3108 =item B<RegisterBase> I<Number>
3110 Configures the base register to read from the device. If the option
3111 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3112 register will be read (the register number is increased by one).
3114 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3116 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3117 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3118 combined into one value. Defaults to B<Uint16>.
3120 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3122 Specifies register type to be collected from device. Works only with libmodbus
3123 2.9.2 or higher. Defaults to B<ReadHolding>.
3125 =item B<Type> I<Type>
3127 Specifies the "type" (data set) to use when dispatching the value to
3128 I<collectd>. Currently, only data sets with exactly one data source are
3131 =item B<Instance> I<Instance>
3133 Sets the type instance to use when dispatching the value to I<collectd>. If
3134 unset, an empty string (no type instance) is used.
3138 =item E<lt>B<Host> I<Name>E<gt> blocks
3140 Host blocks are used to specify to which hosts to connect and what data to read
3141 from their "slaves". The string argument I<Name> is used as hostname when
3142 dispatching the values to I<collectd>.
3144 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3148 =item B<Address> I<Hostname>
3150 For Modbus/TCP, specifies the node name (the actual network address) used to
3151 connect to the host. This may be an IP address or a hostname. Please note that
3152 the used I<libmodbus> library only supports IPv4 at the moment.
3154 =item B<Port> I<Service>
3156 for Modbus/TCP, specifies the port used to connect to the host. The port can
3157 either be given as a number or as a service name. Please note that the
3158 I<Service> argument must be a string, even if ports are given in their numerical
3159 form. Defaults to "502".
3161 =item B<Device> I<Devicenode>
3163 For Modbus/RTU, specifies the path to the serial device being used.
3165 =item B<Baudrate> I<Baudrate>
3167 For Modbus/RTU, specifies the baud rate of the serial device.
3168 Note, connections currently support only 8/N/1.
3170 =item B<Interval> I<Interval>
3172 Sets the interval (in seconds) in which the values will be collected from this
3173 host. By default the global B<Interval> setting will be used.
3175 =item E<lt>B<Slave> I<ID>E<gt>
3177 Over each connection, multiple Modbus devices may be reached. The slave ID
3178 is used to specify which device should be addressed. For each device you want
3179 to query, one B<Slave> block must be given.
3181 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3185 =item B<Instance> I<Instance>
3187 Specify the plugin instance to use when dispatching the values to I<collectd>.
3188 By default "slave_I<ID>" is used.
3190 =item B<Collect> I<DataName>
3192 Specifies which data to retrieve from the device. I<DataName> must be the same
3193 string as the I<Name> argument passed to a B<Data> block. You can specify this
3194 option multiple times to collect more than one value from a slave. At least one
3195 B<Collect> option is mandatory.
3203 =head2 Plugin C<mysql>
3205 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3206 one or more databases when started and keeps the connection up as long as
3207 possible. When the connection is interrupted for whatever reason it will try
3208 to re-connect. The plugin will complain loudly in case anything goes wrong.
3210 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3211 and collects information about MySQL network traffic, executed statements,
3212 requests, the query cache and threads by evaluating the
3213 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3214 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3215 Status Variables> for an explanation of these values.
3217 Optionally, master and slave statistics may be collected in a MySQL
3218 replication setup. In that case, information about the synchronization state
3219 of the nodes are collected by evaluating the C<Position> return value of the
3220 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3221 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3222 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3223 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3224 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3241 Socket "/var/run/mysql/mysqld.sock"
3243 SlaveNotifications true
3247 A B<Database> block defines one connection to a MySQL database. It accepts a
3248 single argument which specifies the name of the database. None of the other
3249 options are required. MySQL will use default values as documented in the
3250 section "mysql_real_connect()" in the B<MySQL reference manual>.
3254 =item B<Alias> I<Alias>
3256 Alias to use as sender instead of hostname when reporting. This may be useful
3257 when having cryptic hostnames.
3259 =item B<Host> I<Hostname>
3261 Hostname of the database server. Defaults to B<localhost>.
3263 =item B<User> I<Username>
3265 Username to use when connecting to the database. The user does not have to be
3266 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3267 unless you want to collectd replication statistics (see B<MasterStats> and
3268 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3269 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3271 =item B<Password> I<Password>
3273 Password needed to log into the database.
3275 =item B<Database> I<Database>
3277 Select this database. Defaults to I<no database> which is a perfectly reasonable
3278 option for what this plugin does.
3280 =item B<Port> I<Port>
3282 TCP-port to connect to. The port must be specified in its numeric form, but it
3283 must be passed as a string nonetheless. For example:
3287 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3288 See the documentation for the C<mysql_real_connect> function for details.
3290 =item B<Socket> I<Socket>
3292 Specifies the path to the UNIX domain socket of the MySQL server. This option
3293 only has any effect, if B<Host> is set to B<localhost> (the default).
3294 Otherwise, use the B<Port> option above. See the documentation for the
3295 C<mysql_real_connect> function for details.
3297 =item B<InnodbStats> I<true|false>
3299 If enabled, metrics about the InnoDB storage engine are collected.
3300 Disabled by default.
3302 =item B<MasterStats> I<true|false>
3304 =item B<SlaveStats> I<true|false>
3306 Enable the collection of master / slave statistics in a replication setup. In
3307 order to be able to get access to these statistics, the user needs special
3308 privileges. See the B<User> documentation above. Defaults to B<false>.
3310 =item B<SlaveNotifications> I<true|false>
3312 If enabled, the plugin sends a notification if the replication slave I/O and /
3313 or SQL threads are not running. Defaults to B<false>.
3315 =item B<ConnectTimeout> I<Seconds>
3317 Sets the connect timeout for the MySQL client.
3321 =head2 Plugin C<netapp>
3323 The netapp plugin can collect various performance and capacity information
3324 from a NetApp filer using the NetApp API.
3326 Please note that NetApp has a wide line of products and a lot of different
3327 software versions for each of these products. This plugin was developed for a
3328 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3329 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3330 model and software version but it is very hard to test this.
3331 If you have used this plugin with other models and/or software version, feel
3332 free to send us a mail to tell us about the results, even if it's just a short
3335 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3336 basic authentication.
3338 B<Do not use a regular user for this!> Create a special collectd user with just
3339 the minimum of capabilities needed. The user only needs the "login-http-admin"
3340 capability as well as a few more depending on which data will be collected.
3341 Required capabilities are documented below.
3346 <Host "netapp1.example.com">
3370 IgnoreSelectedIO false
3372 IgnoreSelectedOps false
3373 GetLatency "volume0"
3374 IgnoreSelectedLatency false
3381 IgnoreSelectedCapacity false
3384 IgnoreSelectedSnapshot false
3412 The netapp plugin accepts the following configuration options:
3416 =item B<Host> I<Name>
3418 A host block defines one NetApp filer. It will appear in collectd with the name
3419 you specify here which does not have to be its real name nor its hostname (see
3420 the B<Address> option below).
3422 =item B<VFiler> I<Name>
3424 A B<VFiler> block may only be used inside a host block. It accepts all the
3425 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3426 will execute all NetApp API commands in the context of the specified
3427 VFiler(R). It will appear in collectd with the name you specify here which
3428 does not have to be its real name. The VFiler name may be specified using the
3429 B<VFilerName> option. If this is not specified, it will default to the name
3432 The VFiler block inherits all connection related settings from the surrounding
3433 B<Host> block (which appear before the B<VFiler> block) but they may be
3434 overwritten inside the B<VFiler> block.
3436 This feature is useful, for example, when using a VFiler as SnapVault target
3437 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3438 available in the host filer (vfiler0) but only in the respective VFiler
3441 =item B<Protocol> B<httpd>|B<http>
3443 The protocol collectd will use to query this host.
3451 Valid options: http, https
3453 =item B<Address> I<Address>
3455 The hostname or IP address of the host.
3461 Default: The "host" block's name.
3463 =item B<Port> I<Port>
3465 The TCP port to connect to on the host.
3471 Default: 80 for protocol "http", 443 for protocol "https"
3473 =item B<User> I<User>
3475 =item B<Password> I<Password>
3477 The username and password to use to login to the NetApp.
3483 =item B<VFilerName> I<Name>
3485 The name of the VFiler in which context to execute API commands. If not
3486 specified, the name provided to the B<VFiler> block will be used instead.
3492 Default: name of the B<VFiler> block
3494 B<Note:> This option may only be used inside B<VFiler> blocks.
3496 =item B<Interval> I<Interval>
3502 The following options decide what kind of data will be collected. You can
3503 either use them as a block and fine tune various parameters inside this block,
3504 use them as a single statement to just accept all default values, or omit it to
3505 not collect any data.
3507 The following options are valid inside all blocks:
3511 =item B<Interval> I<Seconds>
3513 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3514 host specific setting.
3518 =head3 The System block
3520 This will collect various performance data about the whole system.
3522 B<Note:> To get this data the collectd user needs the
3523 "api-perf-object-get-instances" capability.
3527 =item B<Interval> I<Seconds>
3529 Collect disk statistics every I<Seconds> seconds.
3531 =item B<GetCPULoad> B<true>|B<false>
3533 If you set this option to true the current CPU usage will be read. This will be
3534 the average usage between all CPUs in your NetApp without any information about
3537 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3538 returns in the "CPU" field.
3546 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3548 =item B<GetInterfaces> B<true>|B<false>
3550 If you set this option to true the current traffic of the network interfaces
3551 will be read. This will be the total traffic over all interfaces of your NetApp
3552 without any information about individual interfaces.
3554 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3555 in the "Net kB/s" field.
3565 Result: One value list of type "if_octects".
3567 =item B<GetDiskIO> B<true>|B<false>
3569 If you set this option to true the current IO throughput will be read. This
3570 will be the total IO of your NetApp without any information about individual
3571 disks, volumes or aggregates.
3573 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3574 in the "DiskE<nbsp>kB/s" field.
3582 Result: One value list of type "disk_octets".
3584 =item B<GetDiskOps> B<true>|B<false>
3586 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3587 iSCSI, etc. operations will be read. This will be the total number of
3588 operations on your NetApp without any information about individual volumes or
3591 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3592 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3600 Result: A variable number of value lists of type "disk_ops_complex". Each type
3601 of operation will result in one value list with the name of the operation as
3606 =head3 The WAFL block
3608 This will collect various performance data about the WAFL file system. At the
3609 moment this just means cache performance.
3611 B<Note:> To get this data the collectd user needs the
3612 "api-perf-object-get-instances" capability.
3614 B<Note:> The interface to get these values is classified as "Diagnostics" by
3615 NetApp. This means that it is not guaranteed to be stable even between minor
3620 =item B<Interval> I<Seconds>
3622 Collect disk statistics every I<Seconds> seconds.
3624 =item B<GetNameCache> B<true>|B<false>
3632 Result: One value list of type "cache_ratio" and type instance
3635 =item B<GetDirCache> B<true>|B<false>
3643 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3645 =item B<GetInodeCache> B<true>|B<false>
3653 Result: One value list of type "cache_ratio" and type instance
3656 =item B<GetBufferCache> B<true>|B<false>
3658 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3659 in the "Cache hit" field.
3667 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3671 =head3 The Disks block
3673 This will collect performance data about the individual disks in the NetApp.
3675 B<Note:> To get this data the collectd user needs the
3676 "api-perf-object-get-instances" capability.
3680 =item B<Interval> I<Seconds>
3682 Collect disk statistics every I<Seconds> seconds.
3684 =item B<GetBusy> B<true>|B<false>
3686 If you set this option to true the busy time of all disks will be calculated
3687 and the value of the busiest disk in the system will be written.
3689 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3690 in the "Disk util" field. Probably.
3698 Result: One value list of type "percent" and type instance "disk_busy".
3702 =head3 The VolumePerf block
3704 This will collect various performance data about the individual volumes.
3706 You can select which data to collect about which volume using the following
3707 options. They follow the standard ignorelist semantic.
3709 B<Note:> To get this data the collectd user needs the
3710 I<api-perf-object-get-instances> capability.
3714 =item B<Interval> I<Seconds>
3716 Collect volume performance data every I<Seconds> seconds.
3718 =item B<GetIO> I<Volume>
3720 =item B<GetOps> I<Volume>
3722 =item B<GetLatency> I<Volume>
3724 Select the given volume for IO, operations or latency statistics collection.
3725 The argument is the name of the volume without the C</vol/> prefix.
3727 Since the standard ignorelist functionality is used here, you can use a string
3728 starting and ending with a slash to specify regular expression matching: To
3729 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3732 GetIO "/^vol[027]$/"
3734 If no regular expression is specified, an exact match is required. Both,
3735 regular and exact matching are case sensitive.
3737 If no volume was specified at all for either of the three options, that data
3738 will be collected for all available volumes.
3740 =item B<IgnoreSelectedIO> B<true>|B<false>
3742 =item B<IgnoreSelectedOps> B<true>|B<false>
3744 =item B<IgnoreSelectedLatency> B<true>|B<false>
3746 When set to B<true>, the volumes selected for IO, operations or latency
3747 statistics collection will be ignored and the data will be collected for all
3750 When set to B<false>, data will only be collected for the specified volumes and
3751 all other volumes will be ignored.
3753 If no volumes have been specified with the above B<Get*> options, all volumes
3754 will be collected regardless of the B<IgnoreSelected*> option.
3756 Defaults to B<false>
3760 =head3 The VolumeUsage block
3762 This will collect capacity data about the individual volumes.
3764 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3769 =item B<Interval> I<Seconds>
3771 Collect volume usage statistics every I<Seconds> seconds.
3773 =item B<GetCapacity> I<VolumeName>
3775 The current capacity of the volume will be collected. This will result in two
3776 to four value lists, depending on the configuration of the volume. All data
3777 sources are of type "df_complex" with the name of the volume as
3780 There will be type_instances "used" and "free" for the number of used and
3781 available bytes on the volume. If the volume has some space reserved for
3782 snapshots, a type_instance "snap_reserved" will be available. If the volume
3783 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3784 number of bytes saved by the SIS feature.
3786 B<Note:> The current NetApp API has a bug that results in this value being
3787 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3788 number which works most of the time. If you see strange values here, bug
3789 NetApp support to fix this.
3791 Repeat this option to specify multiple volumes.
3793 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3795 Specify whether to collect only the volumes selected by the B<GetCapacity>
3796 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3797 B<false>. However, if no B<GetCapacity> option is specified at all, all
3798 capacities will be selected anyway.
3800 =item B<GetSnapshot> I<VolumeName>
3802 Select volumes from which to collect snapshot information.
3804 Usually, the space used for snapshots is included in the space reported as
3805 "used". If snapshot information is collected as well, the space used for
3806 snapshots is subtracted from the used space.
3808 To make things even more interesting, it is possible to reserve space to be
3809 used for snapshots. If the space required for snapshots is less than that
3810 reserved space, there is "reserved free" and "reserved used" space in addition
3811 to "free" and "used". If the space required for snapshots exceeds the reserved
3812 space, that part allocated in the normal space is subtracted from the "used"
3815 Repeat this option to specify multiple volumes.
3817 =item B<IgnoreSelectedSnapshot>
3819 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3820 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3821 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3822 capacities will be selected anyway.
3826 =head3 The Quota block
3828 This will collect (tree) quota statistics (used disk space and number of used
3829 files). This mechanism is useful to get usage information for single qtrees.
3830 In case the quotas are not used for any other purpose, an entry similar to the
3831 following in C</etc/quotas> would be sufficient:
3833 /vol/volA/some_qtree tree - - - - -
3835 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3839 =item B<Interval> I<Seconds>
3841 Collect SnapVault(R) statistics every I<Seconds> seconds.
3845 =head3 The SnapVault block
3847 This will collect statistics about the time and traffic of SnapVault(R)
3852 =item B<Interval> I<Seconds>
3854 Collect SnapVault(R) statistics every I<Seconds> seconds.
3858 =head2 Plugin C<netlink>
3860 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3861 statistics of various interface and routing aspects.
3865 =item B<Interface> I<Interface>
3867 =item B<VerboseInterface> I<Interface>
3869 Instruct the plugin to collect interface statistics. This is basically the same
3870 as the statistics provided by the C<interface> plugin (see above) but
3871 potentially much more detailed.
3873 When configuring with B<Interface> only the basic statistics will be collected,
3874 namely octets, packets, and errors. These statistics are collected by
3875 the C<interface> plugin, too, so using both at the same time is no benefit.
3877 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3878 so that no data needs to be collected twice if you use the C<interface> plugin.
3879 This includes dropped packets, received multicast packets, collisions and a
3880 whole zoo of differentiated RX and TX errors. You can try the following command
3881 to get an idea of what awaits you:
3885 If I<Interface> is B<All>, all interfaces will be selected.
3887 =item B<QDisc> I<Interface> [I<QDisc>]
3889 =item B<Class> I<Interface> [I<Class>]
3891 =item B<Filter> I<Interface> [I<Filter>]
3893 Collect the octets and packets that pass a certain qdisc, class or filter.
3895 QDiscs and classes are identified by their type and handle (or classid).
3896 Filters don't necessarily have a handle, therefore the parent's handle is used.
3897 The notation used in collectd differs from that used in tc(1) in that it
3898 doesn't skip the major or minor number if it's zero and doesn't print special
3899 ids by their name. So, for example, a qdisc may be identified by
3900 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3901 thus not displayed by tc(1).
3903 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3904 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3905 associated with that interface will be collected.
3907 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3908 used. This may lead to problems when more than one filter is attached to a
3909 qdisc or class. This isn't nice, but we don't know how this could be done any
3910 better. If you have a idea, please don't hesitate to tell us.
3912 As with the B<Interface> option you can specify B<All> as the interface,
3913 meaning all interfaces.
3915 Here are some examples to help you understand the above text more easily:
3918 VerboseInterface "All"
3919 QDisc "eth0" "pfifo_fast-1:0"
3921 Class "ppp0" "htb-1:10"
3922 Filter "ppp0" "u32-1:0"
3925 =item B<IgnoreSelected>
3927 The behavior is the same as with all other similar plugins: If nothing is
3928 selected at all, everything is collected. If some things are selected using the
3929 options described above, only these statistics are collected. If you set
3930 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3931 specified statistics will not be collected.
3935 =head2 Plugin C<network>
3937 The Network plugin sends data to a remote instance of collectd, receives data
3938 from a remote instance, or both at the same time. Data which has been received
3939 from the network is usually not transmitted again, but this can be activated, see
3940 the B<Forward> option below.
3942 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3943 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3945 Both, B<Server> and B<Listen> can be used as single option or as block. When
3946 used as block, given options are valid for this socket only. The following
3947 example will export the metrics twice: Once to an "internal" server (without
3948 encryption and signing) and one to an external server (with cryptographic
3952 # Export to an internal server
3953 # (demonstrates usage without additional options)
3954 Server "collectd.internal.tld"
3956 # Export to an external server
3957 # (demonstrates usage with signature options)
3958 <Server "collectd.external.tld">
3959 SecurityLevel "sign"
3960 Username "myhostname"
3967 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3969 The B<Server> statement/block sets the server to send datagrams to. The
3970 statement may occur multiple times to send each datagram to multiple
3973 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3974 optional second argument specifies a port number or a service name. If not
3975 given, the default, B<25826>, is used.
3977 The following options are recognized within B<Server> blocks:
3981 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3983 Set the security you require for network communication. When the security level
3984 has been set to B<Encrypt>, data sent over the network will be encrypted using
3985 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3986 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3987 authentication code. When set to B<None>, data is sent without any security.
3989 This feature is only available if the I<network> plugin was linked with
3992 =item B<Username> I<Username>
3994 Sets the username to transmit. This is used by the server to lookup the
3995 password. See B<AuthFile> below. All security levels except B<None> require
3998 This feature is only available if the I<network> plugin was linked with
4001 =item B<Password> I<Password>
4003 Sets a password (shared secret) for this socket. All security levels except
4004 B<None> require this setting.
4006 This feature is only available if the I<network> plugin was linked with
4009 =item B<Interface> I<Interface name>
4011 Set the outgoing interface for IP packets. This applies at least
4012 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4013 undefined or a non-existent interface name is specified, the default
4014 behavior is to let the kernel choose the appropriate interface. Be warned
4015 that the manual selection of an interface for unicast traffic is only
4016 necessary in rare cases.
4018 =item B<ResolveInterval> I<Seconds>
4020 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4021 useful to force a regular DNS lookup to support a high availability setup. If
4022 not specified, re-resolves are never attempted.
4026 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4028 The B<Listen> statement sets the interfaces to bind to. When multiple
4029 statements are found the daemon will bind to multiple interfaces.
4031 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4032 the argument is a multicast address the daemon will join that multicast group.
4033 The optional second argument specifies a port number or a service name. If not
4034 given, the default, B<25826>, is used.
4036 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4040 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4042 Set the security you require for network communication. When the security level
4043 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4044 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4045 signed and encrypted data is accepted. When set to B<None>, all data will be
4046 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4047 decrypted if possible.
4049 This feature is only available if the I<network> plugin was linked with
4052 =item B<AuthFile> I<Filename>
4054 Sets a file in which usernames are mapped to passwords. These passwords are
4055 used to verify signatures and to decrypt encrypted network packets. If
4056 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4057 verified and encrypted packets are decrypted. Otherwise, signed data is
4058 accepted without checking the signature and encrypted data cannot be decrypted.
4059 For the other security levels this option is mandatory.
4061 The file format is very simple: Each line consists of a username followed by a
4062 colon and any number of spaces followed by the password. To demonstrate, an
4063 example file could look like this:
4068 Each time a packet is received, the modification time of the file is checked
4069 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4070 the file is being read, it is locked using L<fcntl(2)>.
4072 =item B<Interface> I<Interface name>
4074 Set the incoming interface for IP packets explicitly. This applies at least
4075 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4076 undefined or a non-existent interface name is specified, the default
4077 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4078 traffic gets only accepted, if it arrives on the given interface.
4082 =item B<TimeToLive> I<1-255>
4084 Set the time-to-live of sent packets. This applies to all, unicast and
4085 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4086 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4089 =item B<MaxPacketSize> I<1024-65535>
4091 Set the maximum size for datagrams received over the network. Packets larger
4092 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4093 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4096 On the server side, this limit should be set to the largest value used on
4097 I<any> client. Likewise, the value on the client must not be larger than the
4098 value on the server, or data will be lost.
4100 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4101 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4102 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4105 =item B<Forward> I<true|false>
4107 If set to I<true>, write packets that were received via the network plugin to
4108 the sending sockets. This should only be activated when the B<Listen>- and
4109 B<Server>-statements differ. Otherwise packets may be send multiple times to
4110 the same multicast group. While this results in more network traffic than
4111 necessary it's not a huge problem since the plugin has a duplicate detection,
4112 so the values will not loop.
4114 =item B<ReportStats> B<true>|B<false>
4116 The network plugin cannot only receive and send statistics, it can also create
4117 statistics about itself. Collected data included the number of received and
4118 sent octets and packets, the length of the receive queue and the number of
4119 values handled. When set to B<true>, the I<Network plugin> will make these
4120 statistics available. Defaults to B<false>.
4124 =head2 Plugin C<nginx>
4126 This plugin collects the number of connections and requests handled by the
4127 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4128 queries the page provided by the C<ngx_http_stub_status_module> module, which
4129 isn't compiled by default. Please refer to
4130 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4131 how to compile and configure nginx and this module.
4133 The following options are accepted by the C<nginx plugin>:
4137 =item B<URL> I<http://host/nginx_status>
4139 Sets the URL of the C<ngx_http_stub_status_module> output.
4141 =item B<User> I<Username>
4143 Optional user name needed for authentication.
4145 =item B<Password> I<Password>
4147 Optional password needed for authentication.
4149 =item B<VerifyPeer> B<true|false>
4151 Enable or disable peer SSL certificate verification. See
4152 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4154 =item B<VerifyHost> B<true|false>
4156 Enable or disable peer host name verification. If enabled, the plugin checks
4157 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4158 certificate matches the host name provided by the B<URL> option. If this
4159 identity check fails, the connection is aborted. Obviously, only works when
4160 connecting to a SSL enabled server. Enabled by default.
4162 =item B<CACert> I<File>
4164 File that holds one or more SSL certificates. If you want to use HTTPS you will
4165 possibly need this option. What CA certificates come bundled with C<libcurl>
4166 and are checked by default depends on the distribution you use.
4168 =item B<Timeout> I<Milliseconds>
4170 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4171 milliseconds. By default, the configured B<Interval> is used to set the
4176 =head2 Plugin C<notify_desktop>
4178 This plugin sends a desktop notification to a notification daemon, as defined
4179 in the Desktop Notification Specification. To actually display the
4180 notifications, B<notification-daemon> is required and B<collectd> has to be
4181 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4182 environment variables have to be set correctly) and the D-Bus message bus.
4184 The Desktop Notification Specification can be found at
4185 L<http://www.galago-project.org/specs/notification/>.
4189 =item B<OkayTimeout> I<timeout>
4191 =item B<WarningTimeout> I<timeout>
4193 =item B<FailureTimeout> I<timeout>
4195 Set the I<timeout>, in milliseconds, after which to expire the notification
4196 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4197 been specified, the displayed notification will not be closed at all - the
4198 user has to do so herself. These options default to 5000. If a negative number
4199 has been specified, the default is used as well.
4203 =head2 Plugin C<notify_email>
4205 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4206 configured email address.
4208 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4210 Available configuration options:
4214 =item B<From> I<Address>
4216 Email address from which the emails should appear to come from.
4218 Default: C<root@localhost>
4220 =item B<Recipient> I<Address>
4222 Configures the email address(es) to which the notifications should be mailed.
4223 May be repeated to send notifications to multiple addresses.
4225 At least one B<Recipient> must be present for the plugin to work correctly.
4227 =item B<SMTPServer> I<Hostname>
4229 Hostname of the SMTP server to connect to.
4231 Default: C<localhost>
4233 =item B<SMTPPort> I<Port>
4235 TCP port to connect to.
4239 =item B<SMTPUser> I<Username>
4241 Username for ASMTP authentication. Optional.
4243 =item B<SMTPPassword> I<Password>
4245 Password for ASMTP authentication. Optional.
4247 =item B<Subject> I<Subject>
4249 Subject-template to use when sending emails. There must be exactly two
4250 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4251 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4254 Default: C<Collectd notify: %s@%s>
4258 =head2 Plugin C<ntpd>
4262 =item B<Host> I<Hostname>
4264 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4266 =item B<Port> I<Port>
4268 UDP-Port to connect to. Defaults to B<123>.
4270 =item B<ReverseLookups> B<true>|B<false>
4272 Sets whether or not to perform reverse lookups on peers. Since the name or
4273 IP-address may be used in a filename it is recommended to disable reverse
4274 lookups. The default is to do reverse lookups to preserve backwards
4275 compatibility, though.
4277 =item B<IncludeUnitID> B<true>|B<false>
4279 When a peer is a refclock, include the unit ID in the I<type instance>.
4280 Defaults to B<false> for backward compatibility.
4282 If two refclock peers use the same driver and this is B<false>, the plugin will
4283 try to write simultaneous measurements from both to the same type instance.
4284 This will result in error messages in the log and only one set of measurements
4289 =head2 Plugin C<nut>
4293 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4295 Add a UPS to collect data from. The format is identical to the one accepted by
4300 =head2 Plugin C<olsrd>
4302 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4303 the Optimized Link State Routing daemon and reads information about the current
4304 state of the meshed network.
4306 The following configuration options are understood:
4310 =item B<Host> I<Host>
4312 Connect to I<Host>. Defaults to B<"localhost">.
4314 =item B<Port> I<Port>
4316 Specifies the port to connect to. This must be a string, even if you give the
4317 port as a number rather than a service name. Defaults to B<"2006">.
4319 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4321 Specifies what information to collect about links, i.E<nbsp>e. direct
4322 connections of the daemon queried. If set to B<No>, no information is
4323 collected. If set to B<Summary>, the number of links and the average of all
4324 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4325 If set to B<Detail> LQ and NLQ are collected per link.
4327 Defaults to B<Detail>.
4329 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4331 Specifies what information to collect about routes of the daemon queried. If
4332 set to B<No>, no information is collected. If set to B<Summary>, the number of
4333 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4334 metric and ETX are collected per route.
4336 Defaults to B<Summary>.
4338 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4340 Specifies what information to collect about the global topology. If set to
4341 B<No>, no information is collected. If set to B<Summary>, the number of links
4342 in the entire topology and the average I<link quality> (LQ) is calculated.
4343 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4345 Defaults to B<Summary>.
4349 =head2 Plugin C<onewire>
4351 B<EXPERIMENTAL!> See notes below.
4353 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4354 L<http://owfs.org/> to read sensors connected via the onewire bus.
4356 It can be used in two possible modes - standard or advanced.
4358 In the standard mode only temperature sensors (sensors with the family code
4359 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4360 other sensors you would like to have included, please send a sort request to
4361 the mailing list. You can select sensors to be read or to be ignored depending
4362 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4363 walked and all sensors are read.
4365 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4366 experimental, below.
4368 In the advanced mode you can configure any sensor to be read (only numerical
4369 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4370 In this mode you have to list all the sensors. Neither default bus walk nor
4371 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4372 the path automatically and should produce compatible structure with the "standard"
4373 mode (basically the path is expected as for example
4374 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4375 "F10FCA000800" and the rest after the slash is considered the type - here
4377 There are two advantages to this mode - you can access virtually any sensor
4378 (not just temperature), select whether to use cached or directly read values
4379 and it is slighlty faster. The downside is more complex configuration.
4381 The two modes are distinguished automatically by the format of the address.
4382 It is not possible to mix the two modes. Once a full path is detected in any
4383 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4384 (and as standard addresses will fail parsing they will be ignored).
4388 =item B<Device> I<Device>
4390 Sets the device to read the values from. This can either be a "real" hardware
4391 device, such as a serial port or an USB port, or the address of the
4392 L<owserver(1)> socket, usually B<localhost:4304>.
4394 Though the documentation claims to automatically recognize the given address
4395 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4396 with that version, the following configuration worked for us:
4399 Device "-s localhost:4304"
4402 This directive is B<required> and does not have a default value.
4404 =item B<Sensor> I<Sensor>
4406 In the standard mode selects sensors to collect or to ignore
4407 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4408 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4409 and B<not> include the leading C<10.> family byte and point.
4410 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4411 sensors (see above) are read.
4413 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4414 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4415 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4417 As there can be multiple devices on the bus you can list multiple sensor (use
4418 multiple B<Sensor> elements).
4420 =item B<IgnoreSelected> I<true>|I<false>
4422 If no configuration is given, the B<onewire> plugin will collect data from all
4423 sensors found. This may not be practical, especially if sensors are added and
4424 removed regularly. Sometimes, however, it's easier/preferred to collect only
4425 specific sensors or all sensors I<except> a few specified ones. This option
4426 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4427 B<Sensor> is inverted: All selected interfaces are ignored and all other
4428 interfaces are collected.
4430 Used only in the standard mode - see above.
4432 =item B<Interval> I<Seconds>
4434 Sets the interval in which all sensors should be read. If not specified, the
4435 global B<Interval> setting is used.
4439 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4440 work with big setups. It works with one sensor being attached to one
4441 controller, but as soon as you throw in a couple more senors and maybe a hub
4442 or two, reading all values will take more than ten seconds (the default
4443 interval). We will probably add some separate thread for reading the sensors
4444 and some cache or something like that, but it's not done yet. We will try to
4445 maintain backwards compatibility in the future, but we can't promise. So in
4446 short: If it works for you: Great! But keep in mind that the config I<might>
4447 change, though this is unlikely. Oh, and if you want to help improving this
4448 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4450 =head2 Plugin C<openldap>
4452 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4453 server correctly. The backend database C<monitor> needs to be loaded and
4454 working. See slapd-monitor(5) for the details.
4456 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4457 blocks. Each block requires one string argument as the instance name. For
4462 URL "ldap://localhost/"
4465 URL "ldaps://localhost/"
4469 The instance name will be used as the I<plugin instance>. To emulate the old
4470 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4471 plugin to work correctly, each instance name must be unique. This is not
4472 enforced by the plugin and it is your responsibility to ensure it is.
4474 The following options are accepted within each B<Instance> block:
4478 =item B<URL> I<ldap://host/binddn>
4480 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4483 =item B<StartTLS> B<true|false>
4485 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4486 Disabled by default.
4488 =item B<VerifyHost> B<true|false>
4490 Enables or disables peer host name verification. If enabled, the plugin checks
4491 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4492 certificate matches the host name provided by the B<URL> option. If this
4493 identity check fails, the connection is aborted. Enabled by default.
4495 =item B<CACert> I<File>
4497 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4498 may possibly need this option. What CA certificates are checked by default
4499 depends on the distribution you use and can be changed with the usual ldap
4500 client configuration mechanisms. See ldap.conf(5) for the details.
4502 =item B<Timeout> I<Seconds>
4504 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4505 an infinite timeout.
4507 =item B<Version> I<Version>
4509 An integer which sets the LDAP protocol version number to use when connecting
4510 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4514 =head2 Plugin C<openvpn>
4516 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4517 traffic statistics about connected clients.
4519 To set up OpenVPN to write to the status file periodically, use the
4520 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4521 you need to set the required format, too. This is done by setting
4522 B<--status-version> to B<2>.
4524 So, in a nutshell you need:
4526 openvpn $OTHER_OPTIONS \
4527 --status "/var/run/openvpn-status" 10 \
4534 =item B<StatusFile> I<File>
4536 Specifies the location of the status file.
4538 =item B<ImprovedNamingSchema> B<true>|B<false>
4540 When enabled, the filename of the status file will be used as plugin instance
4541 and the client's "common name" will be used as type instance. This is required
4542 when reading multiple status files. Enabling this option is recommended, but to
4543 maintain backwards compatibility this option is disabled by default.
4545 =item B<CollectCompression> B<true>|B<false>
4547 Sets whether or not statistics about the compression used by OpenVPN should be
4548 collected. This information is only available in I<single> mode. Enabled by
4551 =item B<CollectIndividualUsers> B<true>|B<false>
4553 Sets whether or not traffic information is collected for each connected client
4554 individually. If set to false, currently no traffic data is collected at all
4555 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4557 =item B<CollectUserCount> B<true>|B<false>
4559 When enabled, the number of currently connected clients or users is collected.
4560 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4561 can be configured independently from that option. Defaults to B<false>.
4565 =head2 Plugin C<oracle>
4567 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4568 Oracle® Database and lets you execute SQL statements there. It is very similar
4569 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4570 plugin's documentation above for details.
4573 <Query "out_of_stock">
4574 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4577 # InstancePrefix "foo"
4578 InstancesFrom "category"
4582 <Database "product_information">
4586 Query "out_of_stock"
4590 =head3 B<Query> blocks
4592 The Query blocks are handled identically to the Query blocks of the "dbi"
4593 plugin. Please see its documentation above for details on how to specify
4596 =head3 B<Database> blocks
4598 Database blocks define a connection to a database and which queries should be
4599 sent to that database. Each database needs a "name" as string argument in the
4600 starting tag of the block. This name will be used as "PluginInstance" in the
4601 values submitted to the daemon. Other than that, that name is not used.
4605 =item B<ConnectID> I<ID>
4607 Defines the "database alias" or "service name" to connect to. Usually, these
4608 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4610 =item B<Host> I<Host>
4612 Hostname to use when dispatching values for this database. Defaults to using
4613 the global hostname of the I<collectd> instance.
4615 =item B<Username> I<Username>
4617 Username used for authentication.
4619 =item B<Password> I<Password>
4621 Password used for authentication.
4623 =item B<Query> I<QueryName>
4625 Associates the query named I<QueryName> with this database connection. The
4626 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4627 blocks you want to refer to must be placed above the database block you want to
4632 =head2 Plugin C<perl>
4634 This plugin embeds a Perl-interpreter into collectd and provides an interface
4635 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4637 =head2 Plugin C<pinba>
4639 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4640 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4641 PHP-based webpage has been delivered, the extension will send a UDP packet
4642 containing timing information, peak memory usage and so on. The plugin will
4643 wait for such packets, parse them and account the provided information, which
4644 is then dispatched to the daemon once per interval.
4651 # Overall statistics for the website.
4653 Server "www.example.com"
4655 # Statistics for www-a only
4657 Host "www-a.example.com"
4658 Server "www.example.com"
4660 # Statistics for www-b only
4662 Host "www-b.example.com"
4663 Server "www.example.com"
4667 The plugin provides the following configuration options:
4671 =item B<Address> I<Node>
4673 Configures the address used to open a listening socket. By default, plugin will
4674 bind to the I<any> address C<::0>.
4676 =item B<Port> I<Service>
4678 Configures the port (service) to bind to. By default the default Pinba port
4679 "30002" will be used. The option accepts service names in addition to port
4680 numbers and thus requires a I<string> argument.
4682 =item E<lt>B<View> I<Name>E<gt> block
4684 The packets sent by the Pinba extension include the hostname of the server, the
4685 server name (the name of the virtual host) and the script that was executed.
4686 Using B<View> blocks it is possible to separate the data into multiple groups
4687 to get more meaningful statistics. Each packet is added to all matching groups,
4688 so that a packet may be accounted for more than once.
4692 =item B<Host> I<Host>
4694 Matches the hostname of the system the webserver / script is running on. This
4695 will contain the result of the L<gethostname(2)> system call. If not
4696 configured, all hostnames will be accepted.
4698 =item B<Server> I<Server>
4700 Matches the name of the I<virtual host>, i.e. the contents of the
4701 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4702 server names will be accepted.
4704 =item B<Script> I<Script>
4706 Matches the name of the I<script name>, i.e. the contents of the
4707 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4708 script names will be accepted.
4714 =head2 Plugin C<ping>
4716 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4717 configured hosts periodically and measures the network latency. Whenever the
4718 C<read> function of the plugin is called, it submits the average latency, the
4719 standard deviation and the drop rate for each host.
4721 Available configuration options:
4725 =item B<Host> I<IP-address>
4727 Host to ping periodically. This option may be repeated several times to ping
4730 =item B<Interval> I<Seconds>
4732 Sets the interval in which to send ICMP echo packets to the configured hosts.
4733 This is B<not> the interval in which statistics are queries from the plugin but
4734 the interval in which the hosts are "pinged". Therefore, the setting here
4735 should be smaller than or equal to the global B<Interval> setting. Fractional
4736 times, such as "1.24" are allowed.
4740 =item B<Timeout> I<Seconds>
4742 Time to wait for a response from the host to which an ICMP packet had been
4743 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4744 to be down or the packet to be dropped. This setting must be smaller than the
4745 B<Interval> setting above for the plugin to work correctly. Fractional
4746 arguments are accepted.
4750 =item B<TTL> I<0-255>
4752 Sets the Time-To-Live of generated ICMP packets.
4754 =item B<SourceAddress> I<host>
4756 Sets the source address to use. I<host> may either be a numerical network
4757 address or a network hostname.
4759 =item B<Device> I<name>
4761 Sets the outgoing network device to be used. I<name> has to specify an
4762 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4765 =item B<MaxMissed> I<Packets>
4767 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4768 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4770 Default: B<-1> (disabled)
4774 =head2 Plugin C<postgresql>
4776 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4777 keeps a persistent connection to all configured databases and tries to
4778 reconnect if the connection has been interrupted. A database is configured by
4779 specifying a B<Database> block as described below. The default statistics are
4780 collected from PostgreSQL's B<statistics collector> which thus has to be
4781 enabled for this plugin to work correctly. This should usually be the case by
4782 default. See the section "The Statistics Collector" of the B<PostgreSQL
4783 Documentation> for details.
4785 By specifying custom database queries using a B<Query> block as described
4786 below, you may collect any data that is available from some PostgreSQL
4787 database. This way, you are able to access statistics of external daemons
4788 which are available in a PostgreSQL database or use future or special
4789 statistics provided by PostgreSQL without the need to upgrade your collectd
4792 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4793 PostgreSQL databases as well. This has been implemented in a generic way. You
4794 need to specify an SQL statement which will then be executed by collectd in
4795 order to write the data (see below for details). The benefit of that approach
4796 is that there is no fixed database layout. Rather, the layout may be optimized
4797 for the current setup.
4799 The B<PostgreSQL Documentation> manual can be found at
4800 L<http://www.postgresql.org/docs/manuals/>.
4804 Statement "SELECT magic FROM wizard WHERE host = $1;"
4808 InstancePrefix "magic"
4813 <Query rt36_tickets>
4814 Statement "SELECT COUNT(type) AS count, type \
4816 WHEN resolved = 'epoch' THEN 'open' \
4817 ELSE 'resolved' END AS type \
4818 FROM tickets) type \
4822 InstancePrefix "rt36_tickets"
4823 InstancesFrom "type"
4829 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4839 KRBSrvName "kerberos_service_name"
4845 Service "service_name"
4846 Query backend # predefined
4857 The B<Query> block defines one database query which may later be used by a
4858 database definition. It accepts a single mandatory argument which specifies
4859 the name of the query. The names of all queries have to be unique (see the
4860 B<MinVersion> and B<MaxVersion> options below for an exception to this
4861 rule). The following configuration options are available to define the query:
4863 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4864 blocks define how to handle the values returned from the query. They define
4865 which column holds which value and how to dispatch that value to the daemon.
4866 Multiple B<Result> blocks may be used to extract multiple values from a single
4871 =item B<Statement> I<sql query statement>
4873 Specify the I<sql query statement> which the plugin should execute. The string
4874 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4875 first, second, etc. parameter. The value of the parameters is specified by the
4876 B<Param> configuration option - see below for details. To include a literal
4877 B<$> character followed by a number, surround it with single quotes (B<'>).
4879 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4880 allowed. Note, however, that only a single command may be used. Semicolons are
4881 allowed as long as a single non-empty command has been specified only.
4883 The returned lines will be handled separately one after another.
4885 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4887 Specify the parameters which should be passed to the SQL query. The parameters
4888 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4889 they appear in the configuration file. The value of the parameter is
4890 determined depending on the value of the B<Param> option as follows:
4896 The configured hostname of the database connection. If a UNIX domain socket is
4897 used, the parameter expands to "localhost".
4901 The name of the database of the current connection.
4905 The name of the database plugin instance. See the B<Instance> option of the
4906 database specification below for details.
4910 The username used to connect to the database.
4914 The interval with which this database is queried (as specified by the database
4915 specific or global B<Interval> options).
4919 Please note that parameters are only supported by PostgreSQL's protocol
4920 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4922 =item B<Type> I<type>
4924 The I<type> name to be used when dispatching the values. The type describes
4925 how to handle the data and where to store it. See L<types.db(5)> for more
4926 details on types and their configuration. The number and type of values (as
4927 selected by the B<ValuesFrom> option) has to match the type of the given name.
4929 This option is required inside a B<Result> block.
4931 =item B<InstancePrefix> I<prefix>
4933 =item B<InstancesFrom> I<column0> [I<column1> ...]
4935 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4936 B<InstancePrefix> defines a static prefix that will be prepended to all type
4937 instances. B<InstancesFrom> defines the column names whose values will be used
4938 to create the type instance. Multiple values will be joined together using the
4939 hyphen (C<->) as separation character.
4941 The plugin itself does not check whether or not all built instances are
4942 different. It is your responsibility to assure that each is unique.
4944 Both options are optional. If none is specified, the type instance will be
4947 =item B<ValuesFrom> I<column0> [I<column1> ...]
4949 Names the columns whose content is used as the actual data for the data sets
4950 that are dispatched to the daemon. How many such columns you need is
4951 determined by the B<Type> setting as explained above. If you specify too many
4952 or not enough columns, the plugin will complain about that and no data will be
4953 submitted to the daemon.
4955 The actual data type, as seen by PostgreSQL, is not that important as long as
4956 it represents numbers. The plugin will automatically cast the values to the
4957 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4958 L<strtod(3)> functions, so anything supported by those functions is supported
4959 by the plugin as well.
4961 This option is required inside a B<Result> block and may be specified multiple
4962 times. If multiple B<ValuesFrom> options are specified, the columns are read
4965 =item B<MinVersion> I<version>
4967 =item B<MaxVersion> I<version>
4969 Specify the minimum or maximum version of PostgreSQL that this query should be
4970 used with. Some statistics might only be available with certain versions of
4971 PostgreSQL. This allows you to specify multiple queries with the same name but
4972 which apply to different versions, thus allowing you to use the same
4973 configuration in a heterogeneous environment.
4975 The I<version> has to be specified as the concatenation of the major, minor
4976 and patch-level versions, each represented as two-decimal-digit numbers. For
4977 example, version 8.2.3 will become 80203.
4981 The following predefined queries are available (the definitions can be found
4982 in the F<postgresql_default.conf> file which, by default, is available at
4983 C<I<prefix>/share/collectd/>):
4989 This query collects the number of backends, i.E<nbsp>e. the number of
4992 =item B<transactions>
4994 This query collects the numbers of committed and rolled-back transactions of
4999 This query collects the numbers of various table modifications (i.E<nbsp>e.
5000 insertions, updates, deletions) of the user tables.
5002 =item B<query_plans>
5004 This query collects the numbers of various table scans and returned tuples of
5007 =item B<table_states>
5009 This query collects the numbers of live and dead rows in the user tables.
5013 This query collects disk block access counts for user tables.
5017 This query collects the on-disk size of the database in bytes.
5021 In addition, the following detailed queries are available by default. Please
5022 note that each of those queries collects information B<by table>, thus,
5023 potentially producing B<a lot> of data. For details see the description of the
5024 non-by_table queries above.
5028 =item B<queries_by_table>
5030 =item B<query_plans_by_table>
5032 =item B<table_states_by_table>
5034 =item B<disk_io_by_table>
5038 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5039 mandatory argument specifying the name of the writer. This will then be used
5040 in the B<Database> specification in order to activate the writer instance. The
5041 names of all writers have to be unique. The following options may be
5046 =item B<Statement> I<sql statement>
5048 This mandatory option specifies the SQL statement that will be executed for
5049 each submitted value. A single SQL statement is allowed only. Anything after
5050 the first semicolon will be ignored.
5052 Nine parameters will be passed to the statement and should be specified as
5053 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5054 values are made available through those parameters:
5060 The timestamp of the queried value as a floating point number.
5064 The hostname of the queried value.
5068 The plugin name of the queried value.
5072 The plugin instance of the queried value. This value may be B<NULL> if there
5073 is no plugin instance.
5077 The type of the queried value (cf. L<types.db(5)>).
5081 The type instance of the queried value. This value may be B<NULL> if there is
5086 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5087 sources of the submitted value-list).
5091 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5092 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5093 B<StoreRates> is enabled (which is the default, see below), all types will be
5098 An array of the submitted values. The dimensions of the value name and value
5103 In general, it is advisable to create and call a custom function in the
5104 PostgreSQL database for this purpose. Any procedural language supported by
5105 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5108 =item B<StoreRates> B<false>|B<true>
5110 If set to B<true> (the default), convert counter values to rates. If set to
5111 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5116 The B<Database> block defines one PostgreSQL database for which to collect
5117 statistics. It accepts a single mandatory argument which specifies the
5118 database name. None of the other options are required. PostgreSQL will use
5119 default values as documented in the section "CONNECTING TO A DATABASE" in the
5120 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5121 the user collectd is run as and special environment variables. See the manpage
5126 =item B<Interval> I<seconds>
5128 Specify the interval with which the database should be queried. The default is
5129 to use the global B<Interval> setting.
5131 =item B<CommitInterval> I<seconds>
5133 This option may be used for database connections which have "writers" assigned
5134 (see above). If specified, it causes a writer to put several updates into a
5135 single transaction. This transaction will last for the specified amount of
5136 time. By default, each update will be executed in a separate transaction. Each
5137 transaction generates a fair amount of overhead which can, thus, be reduced by
5138 activating this option. The draw-back is, that data covering the specified
5139 amount of time will be lost, for example, if a single statement within the
5140 transaction fails or if the database server crashes.
5142 =item B<Host> I<hostname>
5144 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5145 value begins with a slash, it is interpreted as the directory name in which to
5146 look for the UNIX domain socket.
5148 This option is also used to determine the hostname that is associated with a
5149 collected data set. If it has been omitted or either begins with with a slash
5150 or equals B<localhost> it will be replaced with the global hostname definition
5151 of collectd. Any other value will be passed literally to collectd when
5152 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5154 =item B<Port> I<port>
5156 Specify the TCP port or the local UNIX domain socket file extension of the
5159 =item B<User> I<username>
5161 Specify the username to be used when connecting to the server.
5163 =item B<Password> I<password>
5165 Specify the password to be used when connecting to the server.
5167 =item B<ExpireDelay> I<delay>
5169 Skip expired values in query output.
5171 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5173 Specify whether to use an SSL connection when contacting the server. The
5174 following modes are supported:
5180 Do not use SSL at all.
5184 First, try to connect without using SSL. If that fails, try using SSL.
5186 =item I<prefer> (default)
5188 First, try to connect using SSL. If that fails, try without using SSL.
5196 =item B<Instance> I<name>
5198 Specify the plugin instance name that should be used instead of the database
5199 name (which is the default, if this option has not been specified). This
5200 allows to query multiple databases of the same name on the same host (e.g.
5201 when running multiple database server versions in parallel).
5203 =item B<KRBSrvName> I<kerberos_service_name>
5205 Specify the Kerberos service name to use when authenticating with Kerberos 5
5206 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5207 B<PostgreSQL Documentation> for details.
5209 =item B<Service> I<service_name>
5211 Specify the PostgreSQL service name to use for additional parameters. That
5212 service has to be defined in F<pg_service.conf> and holds additional
5213 connection parameters. See the section "The Connection Service File" in the
5214 B<PostgreSQL Documentation> for details.
5216 =item B<Query> I<query>
5218 Specifies a I<query> which should be executed in the context of the database
5219 connection. This may be any of the predefined or user-defined queries. If no
5220 such option is given, it defaults to "backends", "transactions", "queries",
5221 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5222 has been specified). Else, the specified queries are used only.
5224 =item B<Writer> I<writer>
5226 Assigns the specified I<writer> backend to the database connection. This
5227 causes all collected data to be send to the database using the settings
5228 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5229 below for details on how to selectively send data to certain plugins).
5231 Each writer will register a flush callback which may be used when having long
5232 transactions enabled (see the B<CommitInterval> option above). When issuing
5233 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5234 transaction will be committed right away. Two different kinds of flush
5235 callbacks are available with the C<postgresql> plugin:
5241 Flush all writer backends.
5243 =item B<postgresql->I<database>
5245 Flush all writers of the specified I<database> only.
5251 =head2 Plugin C<powerdns>
5253 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5254 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5255 values, many of which are probably meaningless to most users, but may be useful
5256 for some. So you may chose which values to collect, but if you don't, some
5257 reasonable defaults will be collected.
5260 <Server "server_name">
5262 Collect "udp-answers" "udp-queries"
5263 Socket "/var/run/pdns.controlsocket"
5265 <Recursor "recursor_name">
5267 Collect "cache-hits" "cache-misses"
5268 Socket "/var/run/pdns_recursor.controlsocket"
5270 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5275 =item B<Server> and B<Recursor> block
5277 The B<Server> block defines one authoritative server to query, the B<Recursor>
5278 does the same for an recursing server. The possible options in both blocks are
5279 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5284 =item B<Collect> I<Field>
5286 Using the B<Collect> statement you can select which values to collect. Here,
5287 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5288 C<dlg-only-drops>, C<answers10-100>.
5290 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5291 When querying the server a C<SHOW *> command is issued in any case, because
5292 that's the only way of getting multiple values out of the server at once.
5293 collectd then picks out the values you have selected. When querying the
5294 recursor, a command is generated to query exactly these values. So if you
5295 specify invalid fields when querying the recursor, a syntax error may be
5296 returned by the daemon and collectd may not collect any values at all.
5298 If no B<Collect> statement is given, the following B<Server> values will be
5305 =item packetcache-hit
5307 =item packetcache-miss
5309 =item packetcache-size
5311 =item query-cache-hit
5313 =item query-cache-miss
5315 =item recursing-answers
5317 =item recursing-questions
5329 The following B<Recursor> values will be collected by default:
5333 =item noerror-answers
5335 =item nxdomain-answers
5337 =item servfail-answers
5355 Please note that up to that point collectd doesn't know what values are
5356 available on the server and values that are added do not need a change of the
5357 mechanism so far. However, the values must be mapped to collectd's naming
5358 scheme, which is done using a lookup table that lists all known values. If
5359 values are added in the future and collectd does not know about them, you will
5360 get an error much like this:
5362 powerdns plugin: submit: Not found in lookup table: foobar = 42
5364 In this case please file a bug report with the collectd team.
5366 =item B<Socket> I<Path>
5368 Configures the path to the UNIX domain socket to be used when connecting to the
5369 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5370 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5371 will be used for the recursor.
5375 =item B<LocalSocket> I<Path>
5377 Querying the recursor is done using UDP. When using UDP over UNIX domain
5378 sockets, the client socket needs a name in the file system, too. You can set
5379 this local name to I<Path> using the B<LocalSocket> option. The default is
5380 C<I<prefix>/var/run/collectd-powerdns>.
5384 =head2 Plugin C<processes>
5388 =item B<Process> I<Name>
5390 Select more detailed statistics of processes matching this name. The statistics
5391 collected for these selected processes are size of the resident segment size
5392 (RSS), user- and system-time used, number of processes and number of threads,
5393 io data (where available) and minor and major pagefaults.
5395 =item B<ProcessMatch> I<name> I<regex>
5397 Similar to the B<Process> option this allows to select more detailed
5398 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5399 details). The statistics of all matching processes are summed up and
5400 dispatched to the daemon using the specified I<name> as an identifier. This
5401 allows to "group" several processes together. I<name> must not contain
5406 =head2 Plugin C<protocols>
5408 Collects a lot of information about various network protocols, such as I<IP>,
5409 I<TCP>, I<UDP>, etc.
5411 Available configuration options:
5415 =item B<Value> I<Selector>
5417 Selects whether or not to select a specific value. The string being matched is
5418 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5419 plugin instance and I<ValueName> will be used as type instance. An example of
5420 the string being used would be C<Tcp:RetransSegs>.
5422 You can use regular expressions to match a large number of values with just one
5423 configuration option. To select all "extended" I<TCP> values, you could use the
5424 following statement:
5428 Whether only matched values are selected or all matched values are ignored
5429 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5430 If no value is configured at all, all values will be selected.
5432 =item B<IgnoreSelected> B<true>|B<false>
5434 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5435 matching values will be ignored.
5439 =head2 Plugin C<python>
5441 This plugin embeds a Python-interpreter into collectd and provides an interface
5442 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5444 =head2 Plugin C<routeros>
5446 The C<routeros> plugin connects to a device running I<RouterOS>, the
5447 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5448 I<librouteros> to connect and reads information about the interfaces and
5449 wireless connections of the device. The configuration supports querying
5454 Host "router0.example.com"
5457 CollectInterface true
5462 Host "router1.example.com"
5465 CollectInterface true
5466 CollectRegistrationTable true
5472 As you can see above, the configuration of the I<routeros> plugin consists of
5473 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5474 options are understood:
5478 =item B<Host> I<Host>
5480 Hostname or IP-address of the router to connect to.
5482 =item B<Port> I<Port>
5484 Port name or port number used when connecting. If left unspecified, the default
5485 will be chosen by I<librouteros>, currently "8728". This option expects a
5486 string argument, even when a numeric port number is given.
5488 =item B<User> I<User>
5490 Use the user name I<User> to authenticate. Defaults to "admin".
5492 =item B<Password> I<Password>
5494 Set the password used to authenticate.
5496 =item B<CollectInterface> B<true>|B<false>
5498 When set to B<true>, interface statistics will be collected for all interfaces
5499 present on the device. Defaults to B<false>.
5501 =item B<CollectRegistrationTable> B<true>|B<false>
5503 When set to B<true>, information about wireless LAN connections will be
5504 collected. Defaults to B<false>.
5506 =item B<CollectCPULoad> B<true>|B<false>
5508 When set to B<true>, information about the CPU usage will be collected. The
5509 number is a dimensionless value where zero indicates no CPU usage at all.
5510 Defaults to B<false>.
5512 =item B<CollectMemory> B<true>|B<false>
5514 When enabled, the amount of used and free memory will be collected. How used
5515 memory is calculated is unknown, for example whether or not caches are counted
5517 Defaults to B<false>.
5519 =item B<CollectDF> B<true>|B<false>
5521 When enabled, the amount of used and free disk space will be collected.
5522 Defaults to B<false>.
5524 =item B<CollectDisk> B<true>|B<false>
5526 When enabled, the number of sectors written and bad blocks will be collected.
5527 Defaults to B<false>.
5531 =head2 Plugin C<redis>
5533 The I<Redis plugin> connects to one or more Redis servers and gathers
5534 information about each server's state. For each server there is a I<Node> block
5535 which configures the connection parameters for this node.
5542 <Query "LLEN myqueue">
5549 The information shown in the synopsis above is the I<default configuration>
5550 which is used by the plugin if no configuration is present.
5554 =item B<Node> I<Nodename>
5556 The B<Node> block identifies a new Redis node, that is a new Redis instance
5557 running in an specified host and port. The name for node is a canonical
5558 identifier which is used as I<plugin instance>. It is limited to
5559 64E<nbsp>characters in length.
5561 =item B<Host> I<Hostname>
5563 The B<Host> option is the hostname or IP-address where the Redis instance is
5566 =item B<Port> I<Port>
5568 The B<Port> option is the TCP port on which the Redis instance accepts
5569 connections. Either a service name of a port number may be given. Please note
5570 that numerical port numbers must be given as a string, too.
5572 =item B<Password> I<Password>
5574 Use I<Password> to authenticate when connecting to I<Redis>.
5576 =item B<Timeout> I<Timeout in miliseconds>
5578 The B<Timeout> option set the socket timeout for node response. Since the Redis
5579 read function is blocking, you should keep this value as low as possible. Keep
5580 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5581 than B<Interval> defined globally.
5583 =item B<Query> I<Querystring>
5585 The B<Query> block identifies a query to execute against the redis server.
5586 There may be an arbitrary number of queries to execute.
5588 =item B<Type> I<Collectd type>
5590 Within a query definition, a valid collectd type to use as when submitting
5591 the result of the query. When not supplied, will default to B<gauge>.
5593 =item B<Instance> I<Type instance>
5595 Within a query definition, an optional type instance to use when submitting
5596 the result of the query. When not supplied will default to the escaped
5597 command, up to 64 chars.
5601 =head2 Plugin C<rrdcached>
5603 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5604 to store values to RRD files in an efficient manner. The combination of the
5605 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5606 way the C<rrdtool> plugin works (see below). The added abstraction layer
5607 provides a number of benefits, though: Because the cache is not within
5608 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5609 restarted. This results in much shorter (if any) gaps in graphs, especially
5610 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5611 daemon so that it can flush values to disk automatically when needed. This
5612 allows to integrate automated flushing of values into graphing solutions much
5615 There are disadvantages, though: The daemon may reside on a different host, so
5616 it may not be possible for C<collectd> to create the appropriate RRD files
5617 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5618 different base directory, so relative paths may do weird stuff if you're not
5621 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5622 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5623 setting should be set to an absolute path, so that a changed base directory
5624 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5628 =item B<DaemonAddress> I<Address>
5630 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5631 library. See L<rrdcached(1)> for details. Example:
5633 <Plugin "rrdcached">
5634 DaemonAddress "unix:/var/run/rrdcached.sock"
5637 =item B<DataDir> I<Directory>
5639 Set the base directory in which the RRD files reside. If this is a relative
5640 path, it is relative to the working base directory of the C<rrdcached> daemon!
5641 Use of an absolute path is recommended.
5643 =item B<CreateFiles> B<true>|B<false>
5645 Enables or disables the creation of RRD files. If the daemon is not running
5646 locally, or B<DataDir> is set to a relative path, this will not work as
5647 expected. Default is B<true>.
5649 =item B<CreateFilesAsync> B<false>|B<true>
5651 When enabled, new RRD files are enabled asynchronously, using a separate thread
5652 that runs in the background. This prevents writes to block, which is a problem
5653 especially when many hundreds of files need to be created at once. However,
5654 since the purpose of creating the files asynchronously is I<not> to block until
5655 the file is available, values before the file is available will be discarded.
5656 When disabled (the default) files are created synchronously, blocking for a
5657 short while, while the file is being written.
5659 =item B<StepSize> I<Seconds>
5661 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5662 this setting is unset and the stepsize is set to the interval in which the data
5663 is collected. Do not use this option unless you absolutely have to for some
5664 reason. Setting this option may cause problems with the C<snmp plugin>, the
5665 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5667 =item B<HeartBeat> I<Seconds>
5669 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5670 in which case the heartbeat is set to twice the B<StepSize> which should equal
5671 the interval in which data is collected. Do not set this option unless you have
5672 a very good reason to do so.
5674 =item B<RRARows> I<NumRows>
5676 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5677 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5678 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5679 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5680 week, one month, and one year.
5682 So for each timespan, it calculates how many PDPs need to be consolidated into
5683 one CDP by calculating:
5684 number of PDPs = timespan / (stepsize * rrarows)
5686 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5689 =item B<RRATimespan> I<Seconds>
5691 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5692 more then one RRA. If this option is never used, the built-in default of (3600,
5693 86400, 604800, 2678400, 31622400) is used.
5695 For more information on how RRA-sizes are calculated see B<RRARows> above.
5697 =item B<XFF> I<Factor>
5699 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5700 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5703 =item B<CollectStatistics> B<false>|B<true>
5705 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5706 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5708 Statistics are read via I<rrdcached>s socket using the STATS command.
5709 See L<rrdcached(1)> for details.
5713 =head2 Plugin C<rrdtool>
5715 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5716 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5717 using these settings. If you don't want to dive into the depths of RRDtool, you
5718 can safely ignore these settings.
5722 =item B<DataDir> I<Directory>
5724 Set the directory to store RRD files under. By default RRD files are generated
5725 beneath the daemon's working directory, i.e. the B<BaseDir>.
5727 =item B<CreateFilesAsync> B<false>|B<true>
5729 When enabled, new RRD files are enabled asynchronously, using a separate thread
5730 that runs in the background. This prevents writes to block, which is a problem
5731 especially when many hundreds of files need to be created at once. However,
5732 since the purpose of creating the files asynchronously is I<not> to block until
5733 the file is available, values before the file is available will be discarded.
5734 When disabled (the default) files are created synchronously, blocking for a
5735 short while, while the file is being written.
5737 =item B<StepSize> I<Seconds>
5739 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5740 this setting is unset and the stepsize is set to the interval in which the data
5741 is collected. Do not use this option unless you absolutely have to for some
5742 reason. Setting this option may cause problems with the C<snmp plugin>, the
5743 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5745 =item B<HeartBeat> I<Seconds>
5747 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5748 in which case the heartbeat is set to twice the B<StepSize> which should equal
5749 the interval in which data is collected. Do not set this option unless you have
5750 a very good reason to do so.
5752 =item B<RRARows> I<NumRows>
5754 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5755 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5756 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5757 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5758 week, one month, and one year.
5760 So for each timespan, it calculates how many PDPs need to be consolidated into
5761 one CDP by calculating:
5762 number of PDPs = timespan / (stepsize * rrarows)
5764 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5767 =item B<RRATimespan> I<Seconds>
5769 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5770 more then one RRA. If this option is never used, the built-in default of (3600,
5771 86400, 604800, 2678400, 31622400) is used.
5773 For more information on how RRA-sizes are calculated see B<RRARows> above.
5775 =item B<XFF> I<Factor>
5777 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5778 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5781 =item B<CacheFlush> I<Seconds>
5783 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5784 it writes all values for a certain RRD-file if the oldest value is older than
5785 (or equal to) the number of seconds specified. If some RRD-file is not updated
5786 anymore for some reason (the computer was shut down, the network is broken,
5787 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5788 entire cache is searched for entries older than B<CacheTimeout> seconds and
5789 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5790 does nothing under normal circumstances, this value should not be too small.
5791 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5792 normally do much harm either.
5794 =item B<CacheTimeout> I<Seconds>
5796 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5797 save values in a cache, as described above. Writing multiple values at once
5798 reduces IO-operations and thus lessens the load produced by updating the files.
5799 The trade off is that the graphs kind of "drag behind" and that more memory is
5802 =item B<WritesPerSecond> I<Updates>
5804 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5805 will run serious performance problems. The B<CacheFlush> setting and the
5806 internal update queue assert that collectd continues to work just fine even
5807 under heavy load, but the system may become very unresponsive and slow. This is
5808 a problem especially if you create graphs from the RRD files on the same
5809 machine, for example using the C<graph.cgi> script included in the
5810 C<contrib/collection3/> directory.
5812 This setting is designed for very large setups. Setting this option to a value
5813 between 25 and 80 updates per second, depending on your hardware, will leave
5814 the server responsive enough to draw graphs even while all the cached values
5815 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5816 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5817 written as fast as possible, so that web frontends have up to date data when
5820 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5821 updates per second, writing all values to disk will take approximately
5822 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5823 "collection3" you'll end up with a responsive and fast system, up to date
5824 graphs and basically a "backup" of your values every hour.
5826 =item B<RandomTimeout> I<Seconds>
5828 When set, the actual timeout for each value is chosen randomly between
5829 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5830 intention is to avoid high load situations that appear when many values timeout
5831 at the same time. This is especially a problem shortly after the daemon starts,
5832 because all values were added to the internal cache at roughly the same time.
5836 =head2 Plugin C<sensors>
5838 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5839 that all the needed modules have to be loaded and lm_sensors has to be
5840 configured (most likely by editing F</etc/sensors.conf>. Read
5841 L<sensors.conf(5)> for details.
5843 The B<lm_sensors> homepage can be found at
5844 L<http://secure.netroedge.com/~lm78/>.
5848 =item B<SensorConfigFile> I<File>
5850 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5851 the library's default will be used.
5853 =item B<Sensor> I<chip-bus-address/type-feature>
5855 Selects the name of the sensor which you want to collect or ignore, depending
5856 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5857 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5858 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5860 =item B<IgnoreSelected> I<true>|I<false>
5862 If no configuration if given, the B<sensors>-plugin will collect data from all
5863 sensors. This may not be practical, especially for uninteresting sensors.
5864 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5865 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5866 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5867 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5868 and all other sensors are collected.
5872 =head2 Plugin C<sigrok>
5874 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5875 supported by the L<sigrok|http://sigrok.org/> project.
5881 <Device "AC Voltage">
5886 <Device "Sound Level">
5887 Driver "cem-dt-885x"
5894 =item B<LogLevel> B<0-5>
5896 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5897 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5898 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5899 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5900 their level, are always submitted to I<collectd> at its INFO log level.
5902 =item E<lt>B<Device> I<Name>E<gt>
5904 A sigrok-supported device, uniquely identified by this section's options. The
5905 I<Name> is passed to I<collectd> as the I<plugin instance>.
5907 =item B<Driver> I<DriverName>
5909 The sigrok driver to use for this device.
5911 =item B<Conn> I<ConnectionSpec>
5913 If the device cannot be auto-discovered, or more than one might be discovered
5914 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5915 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5916 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5917 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5918 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5920 =item B<SerialComm> I<SerialSpec>
5922 For serial devices with non-standard port settings, this option can be used
5923 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5924 This should not be necessary; drivers know how to communicate with devices they
5927 =item B<MinimumInterval> I<Seconds>
5929 Specifies the minimum time between measurement dispatches to I<collectd>, in
5930 seconds. Since some I<sigrok> supported devices can acquire measurements many
5931 times per second, it may be necessary to throttle these. For example, the
5932 I<RRD plugin> cannot process writes more than once per second.
5934 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5935 device are always dispatched to I<collectd>. When throttled, unused
5936 measurements are discarded.
5940 =head2 Plugin C<smart>
5942 The C<smart> plugin collects SMART information from physical
5943 disks. Values collectd include temperature, power cycle count, poweron
5944 time and bad sectors. Also, all SMART attributes are collected along
5945 with the normalized current value, the worst value, the threshold and
5946 a human readable value.
5948 Using the following two options you can ignore some disks or configure the
5949 collection only of specific disks.
5953 =item B<Disk> I<Name>
5955 Select the disk I<Name>. Whether it is collected or ignored depends on the
5956 B<IgnoreSelected> setting, see below. As with other plugins that use the
5957 daemon's ignorelist functionality, a string that starts and ends with a slash
5958 is interpreted as a regular expression. Examples:
5963 =item B<IgnoreSelected> B<true>|B<false>
5965 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
5966 statements, are ignored or if all other disks are ignored. The behavior
5967 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
5968 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
5969 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
5970 is set to B<true>, all disks are collected B<except> the ones matched.
5974 =head2 Plugin C<snmp>
5976 Since the configuration of the C<snmp plugin> is a little more complicated than
5977 other plugins, its documentation has been moved to an own manpage,
5978 L<collectd-snmp(5)>. Please see there for details.
5980 =head2 Plugin C<statsd>
5982 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5983 protocol and dispatches rates or other aggregates of these numbers
5986 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5987 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5988 C<objects> respectively.
5990 The following configuration options are valid:
5994 =item B<Host> I<Host>
5996 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5997 "any" address, i.e. accept packets sent to any of the hosts addresses.
5999 =item B<Port> I<Port>
6001 UDP port to listen to. This can be either a service name or a port number.
6002 Defaults to C<8125>.
6004 =item B<DeleteCounters> B<false>|B<true>
6006 =item B<DeleteTimers> B<false>|B<true>
6008 =item B<DeleteGauges> B<false>|B<true>
6010 =item B<DeleteSets> B<false>|B<true>
6012 These options control what happens if metrics are not updated in an interval.
6013 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6014 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6015 are unchanged. If set to B<True>, the such metrics are not dispatched and
6016 removed from the internal cache.
6018 =item B<TimerPercentile> I<Percent>
6020 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6021 that I<Percent> of all reported timers are smaller than or equal to the
6022 computed latency. This is useful for cutting off the long tail latency, as it's
6023 often done in I<Service Level Agreements> (SLAs).
6025 Different percentiles can be calculated by setting this option several times.
6026 If none are specified, no percentiles are calculated / dispatched.
6028 =item B<TimerLower> B<false>|B<true>
6030 =item B<TimerUpper> B<false>|B<true>
6032 =item B<TimerSum> B<false>|B<true>
6034 =item B<TimerCount> B<false>|B<true>
6036 Calculate and dispatch various values out of I<Timer> metrics received during
6037 an interval. If set to B<False>, the default, these values aren't calculated /
6042 =head2 Plugin C<swap>
6044 The I<Swap plugin> collects information about used and available swap space. On
6045 I<Linux> and I<Solaris>, the following options are available:
6049 =item B<ReportByDevice> B<false>|B<true>
6051 Configures how to report physical swap devices. If set to B<false> (the
6052 default), the summary over all swap devices is reported only, i.e. the globally
6053 used and available space over all devices. If B<true> is configured, the used
6054 and available space of each device will be reported separately.
6056 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6057 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6059 =item B<ReportBytes> B<false>|B<true>
6061 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6062 I<swap I/O> is reported in pages. This option is available under Linux only.
6064 =item B<ValuesAbsolute> B<true>|B<false>
6066 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6067 available and used. Defaults to B<true>.
6069 =item B<ValuesPercentage> B<false>|B<true>
6071 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6072 available and free. Defaults to B<false>.
6074 This is useful for deploying I<collectd> in a heterogeneous environment, where
6075 swap sizes differ and you want to specify generic thresholds or similar.
6079 =head2 Plugin C<syslog>
6083 =item B<LogLevel> B<debug|info|notice|warning|err>
6085 Sets the log-level. If, for example, set to B<notice>, then all events with
6086 severity B<notice>, B<warning>, or B<err> will be submitted to the
6089 Please note that B<debug> is only available if collectd has been compiled with
6092 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6094 Controls which notifications should be sent to syslog. The default behaviour is
6095 not to send any. Less severe notifications always imply logging more severe
6096 notifications: Setting this to B<OKAY> means all notifications will be sent to
6097 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6098 notifications but will dismiss B<OKAY> notifications. Setting this option to
6099 B<FAILURE> will only send failures to syslog.
6103 =head2 Plugin C<table>
6105 The C<table plugin> provides generic means to parse tabular data and dispatch
6106 user specified values. Values are selected based on column numbers. For
6107 example, this plugin may be used to get values from the Linux L<proc(5)>
6108 filesystem or CSV (comma separated values) files.
6111 <Table "/proc/slabinfo">
6116 InstancePrefix "active_objs"
6122 InstancePrefix "objperslab"
6129 The configuration consists of one or more B<Table> blocks, each of which
6130 configures one file to parse. Within each B<Table> block, there are one or
6131 more B<Result> blocks, which configure which data to select and how to
6134 The following options are available inside a B<Table> block:
6138 =item B<Instance> I<instance>
6140 If specified, I<instance> is used as the plugin instance. So, in the above
6141 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6142 filename of the table is used instead, with all special characters replaced
6143 with an underscore (C<_>).
6145 =item B<Separator> I<string>
6147 Any character of I<string> is interpreted as a delimiter between the different
6148 columns of the table. A sequence of two or more contiguous delimiters in the
6149 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6150 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6151 of a table - see its documentation for more details. This option is mandatory.
6153 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6154 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6155 required because of collectd's config parsing.
6159 The following options are available inside a B<Result> block:
6163 =item B<Type> I<type>
6165 Sets the type used to dispatch the values to the daemon. Detailed information
6166 about types and their configuration can be found in L<types.db(5)>. This
6167 option is mandatory.
6169 =item B<InstancePrefix> I<prefix>
6171 If specified, prepend I<prefix> to the type instance. If omitted, only the
6172 B<InstancesFrom> option is considered for the type instance.
6174 =item B<InstancesFrom> I<column0> [I<column1> ...]
6176 If specified, the content of the given columns (identified by the column
6177 number starting at zero) will be used to create the type instance for each
6178 row. Multiple values (and the instance prefix) will be joined together with
6179 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6180 option is considered for the type instance.
6182 The plugin itself does not check whether or not all built instances are
6183 different. It’s your responsibility to assure that each is unique. This is
6184 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6185 sure that the table only contains one row.
6187 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6190 =item B<ValuesFrom> I<column0> [I<column1> ...]
6192 Specifies the columns (identified by the column numbers starting at zero)
6193 whose content is used as the actual data for the data sets that are dispatched
6194 to the daemon. How many such columns you need is determined by the B<Type>
6195 setting above. If you specify too many or not enough columns, the plugin will
6196 complain about that and no data will be submitted to the daemon. The plugin
6197 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6198 respectively, so anything supported by those functions is supported by the
6199 plugin as well. This option is mandatory.
6203 =head2 Plugin C<tail>
6205 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6206 each line and dispatches found values. What is matched can be configured by the
6207 user using (extended) regular expressions, as described in L<regex(7)>.
6210 <File "/var/log/exim4/mainlog">
6214 Regex "S=([1-9][0-9]*)"
6220 Regex "\\<R=local_user\\>"
6221 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6224 Instance "local_user"
6229 The config consists of one or more B<File> blocks, each of which configures one
6230 logfile to parse. Within each B<File> block, there are one or more B<Match>
6231 blocks, which configure a regular expression to search for.
6233 The B<Instance> option in the B<File> block may be used to set the plugin
6234 instance. So in the above example the plugin name C<tail-foo> would be used.
6235 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6236 next B<Instance> option. This way you can extract several plugin instances from
6237 one logfile, handy when parsing syslog and the like.
6239 The B<Interval> option allows you to define the length of time between reads. If
6240 this is not set, the default Interval will be used.
6242 Each B<Match> block has the following options to describe how the match should
6247 =item B<Regex> I<regex>
6249 Sets the regular expression to use for matching against a line. The first
6250 subexpression has to match something that can be turned into a number by
6251 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6252 below. Because B<extended> regular expressions are used, you do not need to use
6253 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6254 collectd's config parsing you need to escape backslashes, though. So if you
6255 want to match literal parentheses you need to do the following:
6257 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6259 =item B<ExcludeRegex> I<regex>
6261 Sets an optional regular expression to use for excluding lines from the match.
6262 An example which excludes all connections from localhost from the match:
6264 ExcludeRegex "127\\.0\\.0\\.1"
6266 =item B<DSType> I<Type>
6268 Sets how the values are cumulated. I<Type> is one of:
6272 =item B<GaugeAverage>
6274 Calculate the average.
6278 Use the smallest number only.
6282 Use the greatest number only.
6286 Use the last number found.
6292 =item B<AbsoluteSet>
6294 The matched number is a counter. Simply I<sets> the internal counter to this
6295 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6303 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6304 matched number may be negative, which will effectively subtract from the
6313 Increase the internal counter by one. These B<DSType> are the only ones that do
6314 not use the matched subexpression, but simply count the number of matched
6315 lines. Thus, you may use a regular expression without submatch in this case.
6319 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6320 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6321 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6322 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6323 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6326 =item B<Type> I<Type>
6328 Sets the type used to dispatch this value. Detailed information about types and
6329 their configuration can be found in L<types.db(5)>.
6331 =item B<Instance> I<TypeInstance>
6333 This optional setting sets the type instance to use.
6337 =head2 Plugin C<tail_csv>
6339 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6340 written by I<Snort>.
6345 <Metric "snort-dropped">
6350 <File "/var/log/snort/snort.stats">
6351 Instance "snort-eth0"
6353 Collect "snort-dropped"
6357 The configuration consists of one or more B<Metric> blocks that define an index
6358 into the line of the CSV file and how this value is mapped to I<collectd's>
6359 internal representation. These are followed by one or more B<Instance> blocks
6360 which configure which file to read, in which interval and which metrics to
6365 =item E<lt>B<Metric> I<Name>E<gt>
6367 The B<Metric> block configures a new metric to be extracted from the statistics
6368 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6369 only used inside the B<Instance> blocks to refer to this block, so you can use
6370 one B<Metric> block for multiple CSV files.
6374 =item B<Type> I<Type>
6376 Configures which I<Type> to use when dispatching this metric. Types are defined
6377 in the L<types.db(5)> file, see the appropriate manual page for more
6378 information on specifying types. Only types with a single I<data source> are
6379 supported by the I<tail_csv plugin>. The information whether the value is an
6380 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6381 I<Type's> definition.
6383 =item B<Instance> I<TypeInstance>
6385 If set, I<TypeInstance> is used to populate the type instance field of the
6386 created value lists. Otherwise, no type instance is used.
6388 =item B<ValueFrom> I<Index>
6390 Configure to read the value from the field with the zero-based index I<Index>.
6391 If the value is parsed as signed integer, unsigned integer or double depends on
6392 the B<Type> setting, see above.
6396 =item E<lt>B<File> I<Path>E<gt>
6398 Each B<File> block represents one CSV file to read. There must be at least one
6399 I<File> block but there can be multiple if you have multiple CSV files.
6403 =item B<Instance> I<PluginInstance>
6405 Sets the I<plugin instance> used when dispatching the values.
6407 =item B<Collect> I<Metric>
6409 Specifies which I<Metric> to collect. This option must be specified at least
6410 once, and you can use this option multiple times to specify more than one
6411 metric to be extracted from this statistic file.
6413 =item B<Interval> I<Seconds>
6415 Configures the interval in which to read values from this instance / file.
6416 Defaults to the plugin's default interval.
6418 =item B<TimeFrom> I<Index>
6420 Rather than using the local time when dispatching a value, read the timestamp
6421 from the field with the zero-based index I<Index>. The value is interpreted as
6422 seconds since epoch. The value is parsed as a double and may be factional.
6428 =head2 Plugin C<teamspeak2>
6430 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6431 polls interesting global and virtual server data. The plugin can query only one
6432 physical server but unlimited virtual servers. You can use the following
6433 options to configure it:
6437 =item B<Host> I<hostname/ip>
6439 The hostname or ip which identifies the physical server.
6442 =item B<Port> I<port>
6444 The query port of the physical server. This needs to be a string.
6447 =item B<Server> I<port>
6449 This option has to be added once for every virtual server the plugin should
6450 query. If you want to query the virtual server on port 8767 this is what the
6451 option would look like:
6455 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6456 use quotes around it! If no such statement is given only global information
6461 =head2 Plugin C<ted>
6463 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6464 measure power consumption. These devices are usually connected to a serial
6465 (RS232) or USB port. The plugin opens a configured device and tries to read the
6466 current energy readings. For more information on TED, visit
6467 L<http://www.theenergydetective.com/>.
6469 Available configuration options:
6473 =item B<Device> I<Path>
6475 Path to the device on which TED is connected. collectd will need read and write
6476 permissions on that file.
6478 Default: B</dev/ttyUSB0>
6480 =item B<Retries> I<Num>
6482 Apparently reading from TED is not that reliable. You can therefore configure a
6483 number of retries here. You only configure the I<retries> here, to if you
6484 specify zero, one reading will be performed (but no retries if that fails); if
6485 you specify three, a maximum of four readings are performed. Negative values
6492 =head2 Plugin C<tcpconns>
6494 The C<tcpconns plugin> counts the number of currently established TCP
6495 connections based on the local port and/or the remote port. Since there may be
6496 a lot of connections the default if to count all connections with a local port,
6497 for which a listening socket is opened. You can use the following options to
6498 fine-tune the ports you are interested in:
6502 =item B<ListeningPorts> I<true>|I<false>
6504 If this option is set to I<true>, statistics for all local ports for which a
6505 listening socket exists are collected. The default depends on B<LocalPort> and
6506 B<RemotePort> (see below): If no port at all is specifically selected, the
6507 default is to collect listening ports. If specific ports (no matter if local or
6508 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6509 the selected ports will be collected unless this option is set to I<true>
6512 =item B<LocalPort> I<Port>
6514 Count the connections to a specific local port. This can be used to see how
6515 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6516 You have to specify the port in numeric form, so for the mailserver example
6517 you'd need to set B<25>.
6519 =item B<RemotePort> I<Port>
6521 Count the connections to a specific remote port. This is useful to see how
6522 much a remote service is used. This is most useful if you want to know how many
6523 connections a local service has opened to remote services, e.E<nbsp>g. how many
6524 connections a mail server or news server has to other mail or news servers, or
6525 how many connections a web proxy holds to web servers. You have to give the
6526 port in numeric form.
6528 =item B<AllPortsSummary> I<true>|I<false>
6530 If this option is set to I<true> a summary of statistics from all connections
6531 are collectd. This option defaults to I<false>.
6535 =head2 Plugin C<thermal>
6539 =item B<ForceUseProcfs> I<true>|I<false>
6541 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6542 C<sysfs> interface. If that is not available, the plugin falls back to the
6543 C<procfs> interface. By setting this option to I<true>, you can force the
6544 plugin to use the latter. This option defaults to I<false>.
6546 =item B<Device> I<Device>
6548 Selects the name of the thermal device that you want to collect or ignore,
6549 depending on the value of the B<IgnoreSelected> option. This option may be
6550 used multiple times to specify a list of devices.
6552 =item B<IgnoreSelected> I<true>|I<false>
6554 Invert the selection: If set to true, all devices B<except> the ones that
6555 match the device names specified by the B<Device> option are collected. By
6556 default only selected devices are collected if a selection is made. If no
6557 selection is configured at all, B<all> devices are selected.
6561 =head2 Plugin C<threshold>
6563 The I<Threshold plugin> checks values collected or received by I<collectd>
6564 against a configurable I<threshold> and issues I<notifications> if values are
6567 Documentation for this plugin is available in the L<collectd-threshold(5)>
6570 =head2 Plugin C<tokyotyrant>
6572 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6573 couple metrics: number of records, and database size on disk.
6577 =item B<Host> I<Hostname/IP>
6579 The hostname or ip which identifies the server.
6580 Default: B<127.0.0.1>
6582 =item B<Port> I<Service/Port>
6584 The query port of the server. This needs to be a string, even if the port is
6585 given in its numeric form.
6590 =head2 Plugin C<unixsock>
6594 =item B<SocketFile> I<Path>
6596 Sets the socket-file which is to be created.
6598 =item B<SocketGroup> I<Group>
6600 If running as root change the group of the UNIX-socket after it has been
6601 created. Defaults to B<collectd>.
6603 =item B<SocketPerms> I<Permissions>
6605 Change the file permissions of the UNIX-socket after it has been created. The
6606 permissions must be given as a numeric, octal value as you would pass to
6607 L<chmod(1)>. Defaults to B<0770>.
6609 =item B<DeleteSocket> B<false>|B<true>
6611 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6612 with the given name already exists. If I<collectd> crashes a socket file may be
6613 left over, preventing the daemon from opening a new socket when restarted.
6614 Since this is potentially dangerous, this defaults to B<false>.
6618 =head2 Plugin C<uuid>
6620 This plugin, if loaded, causes the Hostname to be taken from the machine's
6621 UUID. The UUID is a universally unique designation for the machine, usually
6622 taken from the machine's BIOS. This is most useful if the machine is running in
6623 a virtual environment such as Xen, in which case the UUID is preserved across
6624 shutdowns and migration.
6626 The following methods are used to find the machine's UUID, in order:
6632 Check I</etc/uuid> (or I<UUIDFile>).
6636 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6641 Check for UUID from C<dmidecode> / SMBIOS.
6645 Check for UUID from Xen hypervisor.
6649 If no UUID can be found then the hostname is not modified.
6653 =item B<UUIDFile> I<Path>
6655 Take the UUID from the given file (default I</etc/uuid>).
6659 =head2 Plugin C<varnish>
6661 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6662 It collects a subset of the values displayed by L<varnishstat(1)>, and
6663 organizes them in categories which can be enabled or disabled. Currently only
6664 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6665 meaning of each metric can be found in L<varnish-counters(7)>.
6670 <Instance "example">
6674 CollectConnections true
6675 CollectDirectorDNS false
6679 CollectObjects false
6681 CollectSession false
6691 CollectWorkers false
6695 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6696 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6697 will collectd statistics from the default "varnishd" instance (this should work
6698 fine in most cases).
6700 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6704 =item B<CollectBackend> B<true>|B<false>
6706 Back-end connection statistics, such as successful, reused,
6707 and closed connections. True by default.
6709 =item B<CollectBan> B<true>|B<false>
6711 Statistics about ban operations, such as number of bans added, retired, and
6712 number of objects tested against ban operations. Only available with Varnish
6713 3.x and above. False by default.
6715 =item B<CollectCache> B<true>|B<false>
6717 Cache hits and misses. True by default.
6719 =item B<CollectConnections> B<true>|B<false>
6721 Number of client connections received, accepted and dropped. True by default.
6723 =item B<CollectDirectorDNS> B<true>|B<false>
6725 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6728 =item B<CollectESI> B<true>|B<false>
6730 Edge Side Includes (ESI) parse statistics. False by default.
6732 =item B<CollectFetch> B<true>|B<false>
6734 Statistics about fetches (HTTP requests sent to the backend). False by default.
6736 =item B<CollectHCB> B<true>|B<false>
6738 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6739 divided into locked and unlocked look-ups. False by default.
6741 =item B<CollectObjects> B<true>|B<false>
6743 Statistics on cached objects: number of objects expired, nuked (prematurely
6744 expired), saved, moved, etc. False by default.
6746 =item B<CollectPurge> B<true>|B<false>
6748 Statistics about purge operations, such as number of purges added, retired, and
6749 number of objects tested against purge operations. Only available with Varnish
6750 2.x. False by default.
6752 =item B<CollectSession> B<true>|B<false>
6754 Client session statistics. Number of past and current sessions, session herd and
6755 linger counters, etc. False by default. Note that if using Varnish 4.x, some
6756 metrics found in the Connections and Threads sections with previous versions of
6757 Varnish have been moved here.
6759 =item B<CollectSHM> B<true>|B<false>
6761 Statistics about the shared memory log, a memory region to store
6762 log messages which is flushed to disk when full. True by default.
6764 =item B<CollectSMA> B<true>|B<false>
6766 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6767 component is Solaris specific. Only available with Varnish 2.x. False by
6770 =item B<CollectSMS> B<true>|B<false>
6772 synth (synthetic content) storage statistics. This storage
6773 component is used internally only. False by default.
6775 =item B<CollectSM> B<true>|B<false>
6777 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6780 =item B<CollectStruct> B<true>|B<false>
6782 Current varnish internal state statistics. Number of current sessions, objects
6783 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6786 =item B<CollectTotals> B<true>|B<false>
6788 Collects overview counters, such as the number of sessions created,
6789 the number of requests and bytes transferred. False by default.
6791 =item B<CollectUptime> B<true>|B<false>
6793 Varnish uptime. Only available with Varnish 3.x and above. False by default.
6795 =item B<CollectVCL> B<true>|B<false>
6797 Number of total (available + discarded) VCL (config files). False by default.
6799 =item B<CollectVSM> B<true>|B<false>
6801 Collect statistics about Varnish's shared memory usage (used by the logging and
6802 statistics subsystems). Only available with Varnish 4.x. False by default.
6804 =item B<CollectWorkers> B<true>|B<false>
6806 Collect statistics about worker threads. False by default.
6810 =head2 Plugin C<virt>
6812 This plugin allows CPU, disk and network load to be collected for virtualized
6813 guests on the machine. This means that these metrics can be collected for guest
6814 systems without installing any software on them - I<collectd> only runs on the
6815 host system. The statistics are collected through libvirt
6816 (L<http://libvirt.org/>).
6818 Only I<Connection> is required.
6822 =item B<Connection> I<uri>
6824 Connect to the hypervisor given by I<uri>. For example if using Xen use:
6826 Connection "xen:///"
6828 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
6830 =item B<RefreshInterval> I<seconds>
6832 Refresh the list of domains and devices every I<seconds>. The default is 60
6833 seconds. Setting this to be the same or smaller than the I<Interval> will cause
6834 the list of domains and devices to be refreshed on every iteration.
6836 Refreshing the devices in particular is quite a costly operation, so if your
6837 virtualization setup is static you might consider increasing this. If this
6838 option is set to 0, refreshing is disabled completely.
6840 =item B<Domain> I<name>
6842 =item B<BlockDevice> I<name:dev>
6844 =item B<InterfaceDevice> I<name:dev>
6846 =item B<IgnoreSelected> B<true>|B<false>
6848 Select which domains and devices are collected.
6850 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
6851 disk/network devices are collected.
6853 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
6854 domains and disk/network devices are ignored, while the rest are collected.
6856 The domain name and device names may use a regular expression, if the name is
6857 surrounded by I</.../> and collectd was compiled with support for regexps.
6859 The default is to collect statistics for all domains and all their devices.
6863 BlockDevice "/:hdb/"
6864 IgnoreSelected "true"
6866 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
6869 =item B<HostnameFormat> B<name|uuid|hostname|...>
6871 When the virt plugin logs data, it sets the hostname of the collected data
6872 according to this setting. The default is to use the guest name as provided by
6873 the hypervisor, which is equal to setting B<name>.
6875 B<uuid> means use the guest's UUID. This is useful if you want to track the
6876 same guest across migrations.
6878 B<hostname> means to use the global B<Hostname> setting, which is probably not
6879 useful on its own because all guests will appear to have the same name.
6881 You can also specify combinations of these fields. For example B<name uuid>
6882 means to concatenate the guest name and UUID (with a literal colon character
6883 between, thus I<"foo:1234-1234-1234-1234">).
6885 =item B<InterfaceFormat> B<name>|B<address>
6887 When the virt plugin logs interface data, it sets the name of the collected
6888 data according to this setting. The default is to use the path as provided by
6889 the hypervisor (the "dev" property of the target node), which is equal to
6892 B<address> means use the interface's mac address. This is useful since the
6893 interface path might change between reboots of a guest or across migrations.
6895 =item B<PluginInstanceFormat> B<name|uuid>
6897 When the virt plugin logs data, it sets the plugin_instance of the collected
6898 data according to this setting. The default is to use the guest name as provided
6899 by the hypervisor, which is equal to setting B<name>.
6901 B<uuid> means use the guest's UUID.
6905 =head2 Plugin C<vmem>
6907 The C<vmem> plugin collects information about the usage of virtual memory.
6908 Since the statistics provided by the Linux kernel are very detailed, they are
6909 collected very detailed. However, to get all the details, you have to switch
6910 them on manually. Most people just want an overview over, such as the number of
6911 pages read from swap space.
6915 =item B<Verbose> B<true>|B<false>
6917 Enables verbose collection of information. This will start collecting page
6918 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6919 Part of these statistics are collected on a "per zone" basis.
6923 =head2 Plugin C<vserver>
6925 This plugin doesn't have any options. B<VServer> support is only available for
6926 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6927 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6928 need to apply the patches and compile your own kernel, which will then provide
6929 the F</proc/virtual> filesystem that is required by this plugin.
6931 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6933 B<Note>: The traffic collected by this plugin accounts for the amount of
6934 traffic passing a socket which might be a lot less than the actual on-wire
6935 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6936 collect on-wire traffic you could, for example, use the logging facilities of
6937 iptables to feed data for the guest IPs into the iptables plugin.
6939 =head2 Plugin C<write_graphite>
6941 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6942 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6943 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6944 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6945 of at most 1428 bytes to minimize the number of network packets.
6949 <Plugin write_graphite>
6959 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6960 blocks. Inside the B<Node> blocks, the following options are recognized:
6964 =item B<Host> I<Address>
6966 Hostname or address to connect to. Defaults to C<localhost>.
6968 =item B<Port> I<Service>
6970 Service name or port number to connect to. Defaults to C<2003>.
6972 =item B<Protocol> I<String>
6974 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6976 =item B<LogSendErrors> B<false>|B<true>
6978 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6979 If set to B<false>, it will not log the errors. This is especially useful when
6980 using Protocol UDP since many times we want to use the "fire-and-forget"
6981 approach and logging errors fills syslog with unneeded messages.
6983 =item B<Prefix> I<String>
6985 When set, I<String> is added in front of the host name. Dots and whitespace are
6986 I<not> escaped in this string (see B<EscapeCharacter> below).
6988 =item B<Postfix> I<String>
6990 When set, I<String> is appended to the host name. Dots and whitespace are
6991 I<not> escaped in this string (see B<EscapeCharacter> below).
6993 =item B<EscapeCharacter> I<Char>
6995 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6996 in the identifier. The B<EscapeCharacter> option determines which character
6997 dots, whitespace and control characters are replaced with. Defaults to
7000 =item B<StoreRates> B<false>|B<true>
7002 If set to B<true> (the default), convert counter values to rates. If set to
7003 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7006 =item B<SeparateInstances> B<false>|B<true>
7008 If set to B<true>, the plugin instance and type instance will be in their own
7009 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7010 default), the plugin and plugin instance (and likewise the type and type
7011 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7013 =item B<AlwaysAppendDS> B<false>|B<true>
7015 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7016 identifier. If set to B<false> (the default), this is only done when there is
7021 =head2 Plugin C<write_tsdb>
7023 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7024 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7025 state daemon that ingests metrics and stores them in HBase. The plugin uses
7026 I<TCP> over the "line based" protocol with a default port 4242. The data will
7027 be sent in blocks of at most 1428 bytes to minimize the number of network
7034 Host "tsd-1.my.domain"
7036 HostTags "status=production"
7040 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7041 blocks. Inside the B<Node> blocks, the following options are recognized:
7045 =item B<Host> I<Address>
7047 Hostname or address to connect to. Defaults to C<localhost>.
7049 =item B<Port> I<Service>
7051 Service name or port number to connect to. Defaults to C<4242>.
7054 =item B<HostTags> I<String>
7056 When set, I<HostTags> is added to the end of the metric. It is intended to be
7057 used for name=value pairs that the TSD will tag the metric with. Dots and
7058 whitespace are I<not> escaped in this string.
7060 =item B<StoreRates> B<false>|B<true>
7062 If set to B<true>, convert counter values to rates. If set to B<false>
7063 (the default) counter values are stored as is, as an increasing
7066 =item B<AlwaysAppendDS> B<false>|B<true>
7068 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7069 identifier. If set to B<false> (the default), this is only done when there is
7074 =head2 Plugin C<write_mongodb>
7076 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7081 <Plugin "write_mongodb">
7090 The plugin can send values to multiple instances of I<MongoDB> by specifying
7091 one B<Node> block for each instance. Within the B<Node> blocks, the following
7092 options are available:
7096 =item B<Host> I<Address>
7098 Hostname or address to connect to. Defaults to C<localhost>.
7100 =item B<Port> I<Service>
7102 Service name or port number to connect to. Defaults to C<27017>.
7104 =item B<Timeout> I<Timeout>
7106 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7107 Setting this option to zero means no timeout, which is the default.
7109 =item B<StoreRates> B<false>|B<true>
7111 If set to B<true> (the default), convert counter values to rates. If set to
7112 B<false> counter values are stored as is, i.e. as an increasing integer
7115 =item B<Database> I<Database>
7117 =item B<User> I<User>
7119 =item B<Password> I<Password>
7121 Sets the information used when authenticating to a I<MongoDB> database. The
7122 fields are optional (in which case no authentication is attempted), but if you
7123 want to use authentication all three fields must be set.
7127 =head2 Plugin C<write_http>
7129 This output plugin submits values to an HTTP server using POST requests and
7130 encoding metrics with JSON or using the C<PUTVAL> command described in
7131 L<collectd-unixsock(5)>.
7135 <Plugin "write_http">
7137 URL "http://example.com/post-collectd"
7144 The plugin can send values to multiple HTTP servers by specifying one
7145 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7146 block, the following options are available:
7152 URL to which the values are submitted to. Mandatory.
7154 =item B<User> I<Username>
7156 Optional user name needed for authentication.
7158 =item B<Password> I<Password>
7160 Optional password needed for authentication.
7162 =item B<VerifyPeer> B<true>|B<false>
7164 Enable or disable peer SSL certificate verification. See
7165 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7167 =item B<VerifyHost> B<true|false>
7169 Enable or disable peer host name verification. If enabled, the plugin checks if
7170 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7171 matches the host name provided by the B<URL> option. If this identity check
7172 fails, the connection is aborted. Obviously, only works when connecting to a
7173 SSL enabled server. Enabled by default.
7175 =item B<CACert> I<File>
7177 File that holds one or more SSL certificates. If you want to use HTTPS you will
7178 possibly need this option. What CA certificates come bundled with C<libcurl>
7179 and are checked by default depends on the distribution you use.
7181 =item B<CAPath> I<Directory>
7183 Directory holding one or more CA certificate files. You can use this if for
7184 some reason all the needed CA certificates aren't in the same file and can't be
7185 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7188 =item B<ClientKey> I<File>
7190 File that holds the private key in PEM format to be used for certificate-based
7193 =item B<ClientCert> I<File>
7195 File that holds the SSL certificate to be used for certificate-based
7198 =item B<ClientKeyPass> I<Password>
7200 Password required to load the private key in B<ClientKey>.
7202 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7204 Define which SSL protocol version must be used. By default C<libcurl> will
7205 attempt to figure out the remote SSL protocol version. See
7206 L<curl_easy_setopt(3)> for more details.
7208 =item B<Format> B<Command>|B<JSON>
7210 Format of the output to generate. If set to B<Command>, will create output that
7211 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7212 create output in the I<JavaScript Object Notation> (JSON).
7214 Defaults to B<Command>.
7216 =item B<StoreRates> B<true|false>
7218 If set to B<true>, convert counter values to rates. If set to B<false> (the
7219 default) counter values are stored as is, i.e. as an increasing integer number.
7221 =item B<BufferSize> I<Bytes>
7223 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7224 requests will be generated, but more metrics will be batched / metrics are
7225 cached for longer before being sent, introducing additional delay until they
7226 are available on the server side. I<Bytes> must be at least 1024 and cannot
7227 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7228 Defaults to C<4096>.
7230 =item B<LowSpeedLimit> I<Bytes per Second>
7232 Sets the minimal transfer rate in I<Bytes per Second> below which the
7233 connection with the HTTP server will be considered too slow and aborted. All
7234 the data submitted over this connection will probably be lost. Defaults to 0,
7235 which means no minimum transfer rate is enforced.
7237 =item B<Timeout> I<Timeout>
7239 Sets the maximum time in milliseconds given for HTTP POST operations to
7240 complete. When this limit is reached, the POST operation will be aborted, and
7241 all the data in the current send buffer will probably be lost. Defaults to 0,
7242 which means the connection never times out.
7244 The C<write_http> plugin regularly submits the collected values to the HTTP
7245 server. How frequently this happens depends on how much data you are collecting
7246 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
7247 slightly below this interval, which you can estimate by monitoring the network
7248 traffic between collectd and the HTTP server.
7252 =head2 Plugin C<write_kafka>
7254 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7258 <Plugin "write_kafka">
7259 Property "metadata.broker.list" "broker1:9092,broker2:9092"
7265 The following options are understood by the I<write_kafka plugin>:
7269 =item E<lt>B<Topic> I<Name>E<gt>
7271 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7272 is given a unique I<Name> and specifies one kafka producer.
7273 Inside the B<Topic> block, the following per-topic options are
7278 =item B<Property> I<String> I<String>
7280 Configure the named property for the current topic. Properties are
7281 forwarded to the kafka producer library B<librdkafka>.
7283 =item B<Key> I<String>
7285 Use the specified string as a partioning key for the topic. Kafka breaks
7286 topic into partitions and guarantees that for a given topology, the same
7287 consumer will be used for a specific key. The special (case insensitive)
7288 string B<Random> can be used to specify that an arbitrary partition should
7291 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7293 Selects the format in which messages are sent to the broker. If set to
7294 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7295 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7297 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7298 an easy and straight forward exchange format.
7300 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7301 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7303 =item B<StoreRates> B<true>|B<false>
7305 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7306 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7307 default), no conversion is performed. Otherwise the conversion is performed
7308 using the internal value cache.
7310 Please note that currently this option is only used if the B<Format> option has
7311 been set to B<JSON>.
7313 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7315 A prefix can be added in the metric name when outputting in the I<Graphite>
7316 format. It's added before the I<Host> name.
7318 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>>
7320 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7322 A postfix can be added in the metric name when outputting in the I<Graphite>
7323 format. It's added after the I<Host> name.
7325 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>>
7327 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7329 Specify a character to replace dots (.) in the host part of the metric name.
7330 In I<Graphite> metric name, dots are used as separators between different
7331 metric parts (host, plugin, type).
7332 Default is C<_> (I<Underscore>).
7334 =item B<GraphiteSeparateInstances> B<false>|B<true>
7336 If set to B<true>, the plugin instance and type instance will be in their own
7337 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7338 default), the plugin and plugin instance (and likewise the type and type
7339 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7341 =item B<StoreRates> B<true>|B<false>
7343 If set to B<true> (the default), convert counter values to rates. If set to
7344 B<false> counter values are stored as is, i.e. as an increasing integer number.
7346 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7347 converted values will have "rate" appended to the data source type, e.g.
7348 C<ds_type:derive:rate>.
7352 =item B<Property> I<String> I<String>
7354 Configure the kafka producer through properties, you almost always will
7355 want to set B<metadata.broker.list> to your Kafka broker list.
7359 =head2 Plugin C<write_redis>
7361 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7365 <Plugin "write_redis">
7373 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7374 the timestamp as the score. Retrieving a date range can then be done using the
7375 C<ZRANGEBYSCORE> I<Redis> command. Additionnally, all the identifiers of these
7376 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
7377 retrieved using the C<SMEMBERS> I<Redis> command. See
7378 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7381 The information shown in the synopsis above is the I<default configuration>
7382 which is used by the plugin if no configuration is present.
7384 The plugin can send values to multiple instances of I<Redis> by specifying
7385 one B<Node> block for each instance. Within the B<Node> blocks, the following
7386 options are available:
7390 =item B<Node> I<Nodename>
7392 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7393 instance running in an specified host and port. The name for node is a
7394 canonical identifier which is used as I<plugin instance>. It is limited to
7395 64E<nbsp>characters in length.
7397 =item B<Host> I<Hostname>
7399 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7402 =item B<Port> I<Port>
7404 The B<Port> option is the TCP port on which the Redis instance accepts
7405 connections. Either a service name of a port number may be given. Please note
7406 that numerical port numbers must be given as a string, too.
7408 =item B<Timeout> I<Timeout in miliseconds>
7410 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7414 =head2 Plugin C<write_riemann>
7416 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7417 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7418 I<Riemann> using UDP packets.
7422 <Plugin "write_riemann">
7428 AlwaysAppendDS false
7432 Attribute "foo" "bar"
7435 The following options are understood by the I<write_riemann plugin>:
7439 =item E<lt>B<Node> I<Name>E<gt>
7441 The plugin's configuration consists of one or more B<Node> blocks. Each block
7442 is given a unique I<Name> and specifies one connection to an instance of
7443 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7448 =item B<Host> I<Address>
7450 Hostname or address to connect to. Defaults to C<localhost>.
7452 =item B<Port> I<Service>
7454 Service name or port number to connect to. Defaults to C<5555>.
7456 =item B<Protocol> B<UDP>|B<TCP>
7458 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7461 =item B<Batch> B<true>|B<false>
7463 If set to B<true> and B<Protocol> is set to B<TCP>,
7464 events will be batched in memory and flushed at
7465 regular intervals or when B<BatchMaxSize> is exceeded.
7467 Notifications are not batched and sent as soon as possible.
7469 When enabled, it can occur that events get processed by the Riemann server
7470 close to or after their expiration time. Tune the B<TTLFactor> and
7471 B<BatchMaxSize> settings according to the amount of values collected, if this
7476 =item B<BatchMaxSize> I<size>
7478 Maximum payload size for a riemann packet. Defaults to 8192
7480 =item B<StoreRates> B<true>|B<false>
7482 If set to B<true> (the default), convert counter values to rates. If set to
7483 B<false> counter values are stored as is, i.e. as an increasing integer number.
7485 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7486 converted values will have "rate" appended to the data source type, e.g.
7487 C<ds_type:derive:rate>.
7489 =item B<AlwaysAppendDS> B<false>|B<true>
7491 If set the B<true>, append the name of the I<Data Source> (DS) to the
7492 "service", i.e. the field that, together with the "host" field, uniquely
7493 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7494 only done when there is more than one DS.
7496 =item B<TTLFactor> I<Factor>
7498 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7499 event is considered active. I<collectd> populates this field based on the
7500 metrics interval setting. This setting controls the factor with which the
7501 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7502 know exactly what you're doing, you should only increase this setting from its
7505 =item B<Notifications> B<false>|B<true>
7507 If set to B<true>, create riemann events for notifications. This is B<true>
7508 by default. When processing thresholds from write_riemann, it might prove
7509 useful to avoid getting notification events.
7511 =item B<CheckThresholds> B<false>|B<true>
7513 If set to B<true>, attach state to events based on thresholds defined
7514 in the B<Threshold> plugin. Defaults to B<false>.
7516 =item B<EventServicePrefix> I<String>
7518 Add the given string as a prefix to the event service name.
7519 If B<EventServicePrefix> not set or set to an empty string (""),
7520 no prefix will be used.
7524 =item B<Tag> I<String>
7526 Add the given string as an additional tag to the metric being sent to
7529 =item B<Attribute> I<String> I<String>
7531 Consider the two given strings to be the key and value of an additional
7532 attribute for each metric being sent out to I<Riemann>.
7536 =head2 Plugin C<write_sensu>
7538 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
7539 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
7540 a local I<Sensu> client using a TCP socket.
7542 At the moment, the I<write_sensu plugin> does not send over a collectd_host
7543 parameter so it is not possible to use one collectd instance as a gateway for
7544 others. Each collectd host must pair with one I<Sensu> client.
7548 <Plugin "write_sensu">
7553 AlwaysAppendDS false
7554 MetricHandler "influx"
7555 MetricHandler "default"
7556 NotificationHandler "flapjack"
7557 NotificationHandler "howling_monkey"
7561 Attribute "foo" "bar"
7564 The following options are understood by the I<write_sensu plugin>:
7568 =item E<lt>B<Node> I<Name>E<gt>
7570 The plugin's configuration consists of one or more B<Node> blocks. Each block
7571 is given a unique I<Name> and specifies one connection to an instance of
7572 I<Sensu>. Inside the B<Node> block, the following per-connection options are
7577 =item B<Host> I<Address>
7579 Hostname or address to connect to. Defaults to C<localhost>.
7581 =item B<Port> I<Service>
7583 Service name or port number to connect to. Defaults to C<3030>.
7585 =item B<StoreRates> B<true>|B<false>
7587 If set to B<true> (the default), convert counter values to rates. If set to
7588 B<false> counter values are stored as is, i.e. as an increasing integer number.
7590 This will be reflected in the C<collectd_data_source_type> tag: If
7591 B<StoreRates> is enabled, converted values will have "rate" appended to the
7592 data source type, e.g. C<collectd_data_source_type:derive:rate>.
7594 =item B<AlwaysAppendDS> B<false>|B<true>
7596 If set the B<true>, append the name of the I<Data Source> (DS) to the
7597 "service", i.e. the field that, together with the "host" field, uniquely
7598 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
7599 only done when there is more than one DS.
7601 =item B<Notifications> B<false>|B<true>
7603 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
7604 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7606 =item B<Metrics> B<false>|B<true>
7608 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
7609 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7612 =item B<Separator> I<String>
7614 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
7616 =item B<MetricHandler> I<String>
7618 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
7619 several of them, one per line. Defaults to no handler.
7621 =item B<NotificationHandler> I<String>
7623 Add a handler that will be set when notifications are sent to I<Sensu>. You can
7624 add several of them, one per line. Defaults to no handler.
7626 =item B<EventServicePrefix> I<String>
7628 Add the given string as a prefix to the event service name.
7629 If B<EventServicePrefix> not set or set to an empty string (""),
7630 no prefix will be used.
7634 =item B<Tag> I<String>
7636 Add the given string as an additional tag to the metric being sent to
7639 =item B<Attribute> I<String> I<String>
7641 Consider the two given strings to be the key and value of an additional
7642 attribute for each metric being sent out to I<Sensu>.
7646 =head2 Plugin C<zookeeper>
7648 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
7649 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
7654 <Plugin "zookeeper">
7661 =item B<Host> I<Address>
7663 Hostname or address to connect to. Defaults to C<localhost>.
7665 =item B<Port> I<Service>
7667 Service name or port number to connect to. Defaults to C<2181>.
7671 =head1 THRESHOLD CONFIGURATION
7673 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7674 we mean that the values are not only stored or sent somewhere, but that they
7675 are judged and, if a problem is recognized, acted upon. The only action
7676 collectd takes itself is to generate and dispatch a "notification". Plugins can
7677 register to receive notifications and perform appropriate further actions.
7679 Since systems and what you expect them to do differ a lot, you can configure
7680 B<thresholds> for your values freely. This gives you a lot of flexibility but
7681 also a lot of responsibility.
7683 Every time a value is out of range a notification is dispatched. This means
7684 that the idle percentage of your CPU needs to be less then the configured
7685 threshold only once for a notification to be generated. There's no such thing
7686 as a moving average or similar - at least not now.
7688 Also, all values that match a threshold are considered to be relevant or
7689 "interesting". As a consequence collectd will issue a notification if they are
7690 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7691 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7692 "2" (the default) and some hosts sends it's CPU statistics to the server every
7693 60 seconds, a notification will be dispatched after about 120 seconds. It may
7694 take a little longer because the timeout is checked only once each B<Interval>
7697 When a value comes within range again or is received after it was missing, an
7698 "OKAY-notification" is dispatched.
7700 Here is a configuration example to get you started. Read below for more
7713 <Plugin "interface">
7730 WarningMin 100000000
7736 There are basically two types of configuration statements: The C<Host>,
7737 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7738 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7739 C<Instance> option. You can combine the block by nesting the blocks, though
7740 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7741 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7742 C<Type> may not contain other blocks. If multiple blocks apply to the same
7743 value the most specific block is used.
7745 The other statements specify the threshold to configure. They B<must> be
7746 included in a C<Type> block. Currently the following statements are recognized:
7750 =item B<FailureMax> I<Value>
7752 =item B<WarningMax> I<Value>
7754 Sets the upper bound of acceptable values. If unset defaults to positive
7755 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7756 will be created. If the value is greater than B<WarningMax> but less than (or
7757 equal to) B<FailureMax> a B<WARNING> notification will be created.
7759 =item B<FailureMin> I<Value>
7761 =item B<WarningMin> I<Value>
7763 Sets the lower bound of acceptable values. If unset defaults to negative
7764 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7765 be created. If the value is less than B<WarningMin> but greater than (or equal
7766 to) B<FailureMin> a B<WARNING> notification will be created.
7768 =item B<DataSource> I<DSName>
7770 Some data sets have more than one "data source". Interesting examples are the
7771 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7772 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7773 system load data set, C<load>, even has three data sources: C<shortterm>,
7774 C<midterm>, and C<longterm>.
7776 Normally, all data sources are checked against a configured threshold. If this
7777 is undesirable, or if you want to specify different limits for each data
7778 source, you can use the B<DataSource> option to have a threshold apply only to
7781 =item B<Invert> B<true>|B<false>
7783 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7784 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7785 B<WarningMax>) are not okay. Defaults to B<false>.
7787 =item B<Persist> B<true>|B<false>
7789 Sets how often notifications are generated. If set to B<true> one notification
7790 will be generated for each value that is out of the acceptable range. If set to
7791 B<false> (the default) then a notification is only generated if a value is out
7792 of range but the previous value was okay.
7794 This applies to missing values, too: If set to B<true> a notification about a
7795 missing value is generated once every B<Interval> seconds. If set to B<false>
7796 only one such notification is generated until the value appears again.
7798 =item B<Percentage> B<true>|B<false>
7800 If set to B<true>, the minimum and maximum values given are interpreted as
7801 percentage value, relative to the other data sources. This is helpful for
7802 example for the "df" type, where you may want to issue a warning when less than
7803 5E<nbsp>% of the total space is available. Defaults to B<false>.
7805 =item B<Hits> I<Number>
7807 Delay creating the notification until the threshold has been passed I<Number>
7808 times. When a notification has been generated, or when a subsequent value is
7809 inside the threshold, the counter is reset. If, for example, a value is
7810 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7811 will be dispatched at most once every 30E<nbsp>seconds.
7813 This is useful when short bursts are not a problem. If, for example, 100% CPU
7814 usage for up to a minute is normal (and data is collected every
7815 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7817 =item B<Hysteresis> I<Number>
7819 When set to non-zero, a hysteresis value is applied when checking minimum and
7820 maximum bounds. This is useful for values that increase slowly and fluctuate a
7821 bit while doing so. When these values come close to the threshold, they may
7822 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7824 If, for example, the threshold is configures as
7829 then a I<Warning> notification is created when the value exceeds I<101> and the
7830 corresponding I<Okay> notification is only created once the value falls below
7831 I<99>, thus avoiding the "flapping".
7835 =head1 FILTER CONFIGURATION
7837 Starting with collectd 4.6 there is a powerful filtering infrastructure
7838 implemented in the daemon. The concept has mostly been copied from
7839 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7840 terminology, so that users that are familiar with iptables feel right at home.
7844 The following are the terms used in the remainder of the filter configuration
7845 documentation. For an ASCII-art schema of the mechanism, see
7846 L<"General structure"> below.
7852 A I<match> is a criteria to select specific values. Examples are, of course, the
7853 name of the value or it's current value.
7855 Matches are implemented in plugins which you have to load prior to using the
7856 match. The name of such plugins starts with the "match_" prefix.
7860 A I<target> is some action that is to be performed with data. Such actions
7861 could, for example, be to change part of the value's identifier or to ignore
7862 the value completely.
7864 Some of these targets are built into the daemon, see L<"Built-in targets">
7865 below. Other targets are implemented in plugins which you have to load prior to
7866 using the target. The name of such plugins starts with the "target_" prefix.
7870 The combination of any number of matches and at least one target is called a
7871 I<rule>. The target actions will be performed for all values for which B<all>
7872 matches apply. If the rule does not have any matches associated with it, the
7873 target action will be performed for all values.
7877 A I<chain> is a list of rules and possibly default targets. The rules are tried
7878 in order and if one matches, the associated target will be called. If a value
7879 is handled by a rule, it depends on the target whether or not any subsequent
7880 rules are considered or if traversal of the chain is aborted, see
7881 L<"Flow control"> below. After all rules have been checked, the default targets
7886 =head2 General structure
7888 The following shows the resulting structure:
7895 +---------+ +---------+ +---------+ +---------+
7896 ! Rule !->! Match !->! Match !->! Target !
7897 +---------+ +---------+ +---------+ +---------+
7900 +---------+ +---------+ +---------+
7901 ! Rule !->! Target !->! Target !
7902 +---------+ +---------+ +---------+
7909 +---------+ +---------+ +---------+
7910 ! Rule !->! Match !->! Target !
7911 +---------+ +---------+ +---------+
7921 There are four ways to control which way a value takes through the filter
7928 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7929 process the value with another chain. When the called chain finishes, usually
7930 the next target or rule after the jump is executed.
7934 The stop condition, signaled for example by the built-in target B<stop>, causes
7935 all processing of the value to be stopped immediately.
7939 Causes processing in the current chain to be aborted, but processing of the
7940 value generally will continue. This means that if the chain was called via
7941 B<Jump>, the next target or rule after the jump will be executed. If the chain
7942 was not called by another chain, control will be returned to the daemon and it
7943 may pass the value to another chain.
7947 Most targets will signal the B<continue> condition, meaning that processing
7948 should continue normally. There is no special built-in target for this
7955 The configuration reflects this structure directly:
7957 PostCacheChain "PostCache"
7959 <Rule "ignore_mysql_show">
7962 Type "^mysql_command$"
7963 TypeInstance "^show_"
7973 The above configuration example will ignore all values where the plugin field
7974 is "mysql", the type is "mysql_command" and the type instance begins with
7975 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7976 default target of the chain. Since this chain is run after the value has been
7977 added to the cache, the MySQL C<show_*> command statistics will be available
7978 via the C<unixsock> plugin.
7980 =head2 List of configuration options
7984 =item B<PreCacheChain> I<ChainName>
7986 =item B<PostCacheChain> I<ChainName>
7988 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7989 argument is the name of a I<chain> that should be executed before and/or after
7990 the values have been added to the cache.
7992 To understand the implications, it's important you know what is going on inside
7993 I<collectd>. The following diagram shows how values are passed from the
7994 read-plugins to the write-plugins:
8000 + - - - - V - - - - +
8001 : +---------------+ :
8004 : +-------+-------+ :
8007 : +-------+-------+ : +---------------+
8008 : ! Cache !--->! Value Cache !
8009 : ! insert ! : +---+---+-------+
8010 : +-------+-------+ : ! !
8011 : ! ,------------' !
8013 : +-------+---+---+ : +-------+-------+
8014 : ! Post-Cache +--->! Write-Plugins !
8015 : ! Chain ! : +---------------+
8016 : +---------------+ :
8019 + - - - - - - - - - +
8021 After the values are passed from the "read" plugins to the dispatch functions,
8022 the pre-cache chain is run first. The values are added to the internal cache
8023 afterwards. The post-cache chain is run after the values have been added to the
8024 cache. So why is it such a huge deal if chains are run before or after the
8025 values have been added to this cache?
8027 Targets that change the identifier of a value list should be executed before
8028 the values are added to the cache, so that the name in the cache matches the
8029 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
8030 this cache to receive a list of all available values. If you change the
8031 identifier after the value list has been added to the cache, this may easily
8032 lead to confusion, but it's not forbidden of course.
8034 The cache is also used to convert counter values to rates. These rates are, for
8035 example, used by the C<value> match (see below). If you use the rate stored in
8036 the cache B<before> the new value is added, you will use the old, B<previous>
8037 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
8038 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
8041 Last but not last, the B<stop> target makes a difference: If the pre-cache
8042 chain returns the stop condition, the value will not be added to the cache and
8043 the post-cache chain will not be run.
8045 =item B<Chain> I<Name>
8047 Adds a new chain with a certain name. This name can be used to refer to a
8048 specific chain, for example to jump to it.
8050 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
8052 =item B<Rule> [I<Name>]
8054 Adds a new rule to the current chain. The name of the rule is optional and
8055 currently has no meaning for the daemon.
8057 Within the B<Rule> block, there may be any number of B<Match> blocks and there
8058 must be at least one B<Target> block.
8060 =item B<Match> I<Name>
8062 Adds a match to a B<Rule> block. The name specifies what kind of match should
8063 be performed. Available matches depend on the plugins that have been loaded.
8065 The arguments inside the B<Match> block are passed to the plugin implementing
8066 the match, so which arguments are valid here depends on the plugin being used.
8067 If you do not need any to pass any arguments to a match, you can use the
8072 Which is equivalent to:
8077 =item B<Target> I<Name>
8079 Add a target to a rule or a default target to a chain. The name specifies what
8080 kind of target is to be added. Which targets are available depends on the
8081 plugins being loaded.
8083 The arguments inside the B<Target> block are passed to the plugin implementing
8084 the target, so which arguments are valid here depends on the plugin being used.
8085 If you do not need any to pass any arguments to a target, you can use the
8090 This is the same as writing:
8097 =head2 Built-in targets
8099 The following targets are built into the core daemon and therefore need no
8100 plugins to be loaded:
8106 Signals the "return" condition, see the L<"Flow control"> section above. This
8107 causes the current chain to stop processing the value and returns control to
8108 the calling chain. The calling chain will continue processing targets and rules
8109 just after the B<jump> target (see below). This is very similar to the
8110 B<RETURN> target of iptables, see L<iptables(8)>.
8112 This target does not have any options.
8120 Signals the "stop" condition, see the L<"Flow control"> section above. This
8121 causes processing of the value to be aborted immediately. This is similar to
8122 the B<DROP> target of iptables, see L<iptables(8)>.
8124 This target does not have any options.
8132 Sends the value to "write" plugins.
8138 =item B<Plugin> I<Name>
8140 Name of the write plugin to which the data should be sent. This option may be
8141 given multiple times to send the data to more than one write plugin. If the
8142 plugin supports multiple instances, the plugin's instance(s) must also be
8147 If no plugin is explicitly specified, the values will be sent to all available
8150 Single-instance plugin example:
8156 Multi-instance plugin example:
8158 <Plugin "write_graphite">
8168 Plugin "write_graphite/foo"
8173 Starts processing the rules of another chain, see L<"Flow control"> above. If
8174 the end of that chain is reached, or a stop condition is encountered,
8175 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
8176 next target or the next rule. This is similar to the B<-j> command line option
8177 of iptables, see L<iptables(8)>.
8183 =item B<Chain> I<Name>
8185 Jumps to the chain I<Name>. This argument is required and may appear only once.
8197 =head2 Available matches
8203 Matches a value using regular expressions.
8209 =item B<Host> I<Regex>
8211 =item B<Plugin> I<Regex>
8213 =item B<PluginInstance> I<Regex>
8215 =item B<Type> I<Regex>
8217 =item B<TypeInstance> I<Regex>
8219 Match values where the given regular expressions match the various fields of
8220 the identifier of a value. If multiple regular expressions are given, B<all>
8221 regexen must match for a value to match.
8223 =item B<Invert> B<false>|B<true>
8225 When set to B<true>, the result of the match is inverted, i.e. all value lists
8226 where all regular expressions apply are not matched, all other value lists are
8227 matched. Defaults to B<false>.
8234 Host "customer[0-9]+"
8240 Matches values that have a time which differs from the time on the server.
8242 This match is mainly intended for servers that receive values over the
8243 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8244 is very sensitive to the timestamp used when updating the RRD files. In
8245 particular, the time must be ever increasing. If a misbehaving client sends one
8246 packet with a timestamp far in the future, all further packets with a correct
8247 time will be ignored because of that one packet. What's worse, such corrupted
8248 RRD files are hard to fix.
8250 This match lets one match all values B<outside> a specified time range
8251 (relative to the server's time), so you can use the B<stop> target (see below)
8252 to ignore the value, for example.
8258 =item B<Future> I<Seconds>
8260 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8261 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8264 =item B<Past> I<Seconds>
8266 Matches all values that are I<behind> of the server's time by I<Seconds> or
8267 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8279 This example matches all values that are five minutes or more ahead of the
8280 server or one hour (or more) lagging behind.
8284 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8285 values. If a data-set consists of more than one data-source, all data-sources
8286 must match the specified ranges for a positive match.
8292 =item B<Min> I<Value>
8294 Sets the smallest value which still results in a match. If unset, behaves like
8297 =item B<Max> I<Value>
8299 Sets the largest value which still results in a match. If unset, behaves like
8302 =item B<Invert> B<true>|B<false>
8304 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8305 no-match is returned and vice versa. Please note that the B<Invert> setting
8306 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8307 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8309 =item B<DataSource> I<DSName> [I<DSName> ...]
8311 Select one or more of the data sources. If no data source is configured, all
8312 data sources will be checked. If the type handled by the match does not have a
8313 data source of the specified name(s), this will always result in no match
8314 (independent of the B<Invert> setting).
8316 =item B<Satisfy> B<Any>|B<All>
8318 Specifies how checking with several data sources is performed. If set to
8319 B<Any>, the match succeeds if one of the data sources is in the configured
8320 range. If set to B<All> the match only succeeds if all data sources are within
8321 the configured range. Default is B<All>.
8323 Usually B<All> is used for positive matches, B<Any> is used for negative
8324 matches. This means that with B<All> you usually check that all values are in a
8325 "good" range, while with B<Any> you check if any value is within a "bad" range
8326 (or outside the "good" range).
8330 Either B<Min> or B<Max>, but not both, may be unset.
8334 # Match all values smaller than or equal to 100. Matches only if all data
8335 # sources are below 100.
8341 # Match if the value of any data source is outside the range of 0 - 100.
8349 =item B<empty_counter>
8351 Matches all values with one or more data sources of type B<COUNTER> and where
8352 all counter values are zero. These counters usually I<never> increased since
8353 they started existing (and are therefore uninteresting), or got reset recently
8354 or overflowed and you had really, I<really> bad luck.
8356 Please keep in mind that ignoring such counters can result in confusing
8357 behavior: Counters which hardly ever increase will be zero for long periods of
8358 time. If the counter is reset for some reason (machine or service restarted,
8359 usually), the graph will be empty (NAN) for a long time. People may not
8364 Calculates a hash value of the host name and matches values according to that
8365 hash value. This makes it possible to divide all hosts into groups and match
8366 only values that are in a specific group. The intended use is in load
8367 balancing, where you want to handle only part of all data and leave the rest
8370 The hashing function used tries to distribute the hosts evenly. First, it
8371 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8374 for (i = 0; host[i] != 0; i++)
8375 hash_value = (hash_value * 251) + host[i];
8377 The constant 251 is a prime number which is supposed to make this hash value
8378 more random. The code then checks the group for this host according to the
8379 I<Total> and I<Match> arguments:
8381 if ((hash_value % Total) == Match)
8386 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8387 groups), then the least significant bit of the hash value will be the XOR of
8388 all least significant bits in the host name. One consequence is that when you
8389 have two hosts, "server0.example.com" and "server1.example.com", where the host
8390 name differs in one digit only and the digits differ by one, those hosts will
8391 never end up in the same group.
8397 =item B<Match> I<Match> I<Total>
8399 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8400 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8401 be smaller than I<Total>. I<Total> must be at least one, although only values
8402 greater than one really do make any sense.
8404 You can repeat this option to match multiple groups, for example:
8409 The above config will divide the data into seven groups and match groups three
8410 and five. One use would be to keep every value on two hosts so that if one
8411 fails the missing data can later be reconstructed from the second host.
8417 # Operate on the pre-cache chain, so that ignored values are not even in the
8422 # Divide all received hosts in seven groups and accept all hosts in
8426 # If matched: Return and continue.
8429 # If not matched: Return and stop.
8435 =head2 Available targets
8439 =item B<notification>
8441 Creates and dispatches a notification.
8447 =item B<Message> I<String>
8449 This required option sets the message of the notification. The following
8450 placeholders will be replaced by an appropriate value:
8458 =item B<%{plugin_instance}>
8462 =item B<%{type_instance}>
8464 These placeholders are replaced by the identifier field of the same name.
8466 =item B<%{ds:>I<name>B<}>
8468 These placeholders are replaced by a (hopefully) human readable representation
8469 of the current rate of this data source. If you changed the instance name
8470 (using the B<set> or B<replace> targets, see below), it may not be possible to
8471 convert counter values to rates.
8475 Please note that these placeholders are B<case sensitive>!
8477 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8479 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8486 <Target "notification">
8487 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8493 Replaces parts of the identifier using regular expressions.
8499 =item B<Host> I<Regex> I<Replacement>
8501 =item B<Plugin> I<Regex> I<Replacement>
8503 =item B<PluginInstance> I<Regex> I<Replacement>
8505 =item B<TypeInstance> I<Regex> I<Replacement>
8507 Match the appropriate field with the given regular expression I<Regex>. If the
8508 regular expression matches, that part that matches is replaced with
8509 I<Replacement>. If multiple places of the input buffer match a given regular
8510 expression, only the first occurrence will be replaced.
8512 You can specify each option multiple times to use multiple regular expressions
8520 # Replace "example.net" with "example.com"
8521 Host "\\<example.net\\>" "example.com"
8523 # Strip "www." from hostnames
8529 Sets part of the identifier of a value to a given string.
8535 =item B<Host> I<String>
8537 =item B<Plugin> I<String>
8539 =item B<PluginInstance> I<String>
8541 =item B<TypeInstance> I<String>
8543 Set the appropriate field to the given string. The strings for plugin instance
8544 and type instance may be empty, the strings for host and plugin may not be
8545 empty. It's currently not possible to set the type of a value this way.
8552 PluginInstance "coretemp"
8553 TypeInstance "core3"
8558 =head2 Backwards compatibility
8560 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8561 B<Chain> block, it will behave as it used to. This is equivalent to the
8562 following configuration:
8568 If you specify a B<PostCacheChain>, the B<write> target will not be added
8569 anywhere and you will have to make sure that it is called where appropriate. We
8570 suggest to add the above snippet as default target to your "PostCache" chain.
8574 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8590 L<collectd-exec(5)>,
8591 L<collectd-perl(5)>,
8592 L<collectd-unixsock(5)>,
8605 Florian Forster E<lt>octo@collectd.orgE<gt>