5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/var/lib/collectd"
10 PIDFile "/run/collectd.pid"
31 This config file controls how the system statistics collection daemon
32 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
33 controls which plugins to load. These plugins ultimately define collectd's
34 behavior. If the B<AutoLoadPlugin> option has been enabled, the explicit
35 B<LoadPlugin> lines may be omitted for all plugins with a configuration block,
36 i.e. a C<E<lt>PluginE<nbsp>...E<gt>> block.
38 The syntax of this config file is similar to the config file of the famous
39 I<Apache> webserver. Each line contains either an option (a key and a list of
40 one or more values) or a section-start or -end. Empty lines and everything
41 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
43 character. Keys are handled case insensitive by I<collectd> itself and all
44 plugins included with it. I<Values> can either be an I<unquoted string>, a
45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
46 expression. I<Unquoted strings> consist of only alphanumeric characters and
47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
49 to include double quotes as part of the string. I<Numbers> can be specified in
50 decimal and floating point format (using a dot C<.> as decimal separator),
51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
52 I<Boolean> values are either B<true> or B<false>.
54 Lines may be wrapped by using C<\> as the last character before the newline.
55 This allows long lines to be split into multiple lines. Quoted strings may be
56 wrapped as well. However, those are treated special in that whitespace at the
57 beginning of the following lines will be ignored, which allows for nicely
58 indenting the wrapped lines.
60 The configuration is read and processed in order, i.e. from top to bottom. So
61 the plugins are loaded in the order listed in this config file. It is a good
62 idea to load any logging plugins first in order to catch messages from plugins
63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
64 B<LoadPlugin> option I<must> occur I<before> the appropriate
65 C<E<lt>B<Plugin> ...E<gt>> block.
71 =item B<BaseDir> I<Directory>
73 Sets the base directory. This is the directory beneath all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
77 =item B<LoadPlugin> I<Plugin>
79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
81 I<collectd> will be mostly useless.
83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
84 effect. This is useful when you want to split up the configuration into smaller
85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
86 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
93 statement looks like this:
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
105 The following options are valid inside B<LoadPlugin> blocks:
109 =item B<Globals> B<true|false>
111 If enabled, collectd will export all global symbols of the plugin (and of all
112 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
113 available for resolving unresolved symbols in subsequently loaded plugins if
114 that is supported by your system.
116 This is useful (or possibly even required), e.g., when loading a plugin that
117 embeds some scripting language into the daemon (e.g. the I<Perl> and
118 I<Python plugins>). Scripting languages usually provide means to load
119 extensions written in C. Those extensions require symbols provided by the
120 interpreter, which is loaded as a dependency of the respective collectd plugin.
121 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
122 L<collectd-python(5)>) for details.
124 By default, this is disabled. As a special exception, if the plugin name is
125 either C<perl> or C<python>, the default is changed to enabled in order to keep
126 the average user from ever having to deal with this low level linking stuff.
128 =item B<Interval> I<Seconds>
130 Sets a plugin-specific interval for collecting metrics. This overrides the
131 global B<Interval> setting. If a plugin provides own support for specifying an
132 interval, that setting will take precedence.
136 =item B<AutoLoadPlugin> B<false>|B<true>
138 When set to B<false> (the default), each plugin needs to be loaded explicitly,
139 using the B<LoadPlugin> statement documented above. If a
140 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
141 handling callback for this plugin has been registered, a warning is logged and
142 the block is ignored.
144 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
145 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
146 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
147 plugins that don't provide any configuration, e.g. the I<Load plugin>.
149 =item B<CollectInternalStats> B<false>|B<true>
151 When set to B<true>, various statistics about the I<collectd> daemon will be
152 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
154 The "write_queue" I<plugin instance> reports the number of elements currently
155 queued and the number of elements dropped off the queue by the
156 B<WriteQueueLimitLow>/B<WriteQueueLimitHigh> mechanism.
158 The "cache" I<plugin instance> reports the number of elements in the value list
159 cache (the cache you can interact with using L<collectd-unixsock(5)>).
161 =item B<Include> I<Path> [I<pattern>]
163 If I<Path> points to a file, includes that file. If I<Path> points to a
164 directory, recursively includes all files within that directory and its
165 subdirectories. If the C<wordexp> function is available on your system,
166 shell-like wildcards are expanded before files are included. This means you can
167 use statements like the following:
169 Include "/etc/collectd.d/*.conf"
171 Starting with version 5.3, this may also be a block in which further options
172 affecting the behavior of B<Include> may be specified. The following option is
175 <Include "/etc/collectd.d">
181 =item B<Filter> I<pattern>
183 If the C<fnmatch> function is available on your system, a shell-like wildcard
184 I<pattern> may be specified to filter which files to include. This may be used
185 in combination with recursively including a directory to easily be able to
186 arbitrarily mix configuration files and other documents (e.g. README files).
187 The given example is similar to the first example above but includes all files
188 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
190 Include "/etc/collectd.d" "*.conf"
194 If more than one files are included by a single B<Include> option, the files
195 will be included in lexicographical order (as defined by the C<strcmp>
196 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
197 order in which the files are loaded.
199 To prevent loops and shooting yourself in the foot in interesting ways the
200 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
201 most uses. Since symlinks are followed it is still possible to crash the daemon
202 by looping symlinks. In our opinion significant stupidity should result in an
203 appropriate amount of pain.
205 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
206 file, but you cannot include files from within blocks.
208 =item B<PIDFile> I<File>
210 Sets where to write the PID file to. This file is overwritten when it exists
211 and deleted when the program is stopped. Some init-scripts might override this
212 setting using the B<-P> command-line option.
214 =item B<PluginDir> I<Directory>
216 Path to the plugins (shared objects) of collectd.
218 =item B<TypesDB> I<File> [I<File> ...]
220 Set one or more files that contain the data-set descriptions. See
221 L<types.db(5)> for a description of the format of this file.
223 =item B<Interval> I<Seconds>
225 Configures the interval in which to query the read plugins. Obviously smaller
226 values lead to a higher system load produced by collectd, while higher values
227 lead to more coarse statistics.
229 B<Warning:> You should set this once and then never touch it again. If you do,
230 I<you will have to delete all your RRD files> or know some serious RRDtool
231 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
233 =item B<MaxReadInterval> I<Seconds>
235 Read plugin doubles interval between queries after each failed attempt
238 This options limits the maximum value of the interval. The default value is
241 =item B<Timeout> I<Iterations>
243 Consider a value list "missing" when no update has been read or received for
244 I<Iterations> iterations. By default, I<collectd> considers a value list
245 missing when no update has been received for twice the update interval. Since
246 this setting uses iterations, the maximum allowed time without update depends
247 on the I<Interval> information contained in each value list. This is used in
248 the I<Threshold> configuration to dispatch notifications about missing values,
249 see L<collectd-threshold(5)> for details.
251 =item B<ReadThreads> I<Num>
253 Number of threads to start for reading plugins. The default value is B<5>, but
254 you may want to increase this if you have more than five plugins that take a
255 long time to read. Mostly those are plugins that do network-IO. Setting this to
256 a value higher than the number of registered read callbacks is not recommended.
258 =item B<WriteThreads> I<Num>
260 Number of threads to start for dispatching value lists to write plugins. The
261 default value is B<5>, but you may want to increase this if you have more than
262 five plugins that may take relatively long to write to.
264 =item B<WriteQueueLimitHigh> I<HighNum>
266 =item B<WriteQueueLimitLow> I<LowNum>
268 Metrics are read by the I<read threads> and then put into a queue to be handled
269 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
270 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
271 running into memory issues in such a case, you can limit the size of this
274 By default, there is no limit and memory may grow indefinitely. This is most
275 likely not an issue for clients, i.e. instances that only handle the local
276 metrics. For servers it is recommended to set this to a non-zero value, though.
278 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
279 Each of them takes a numerical argument which is the number of metrics in the
280 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
281 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
282 I<will> be enqueued. If the number of metrics currently in the queue is between
283 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
284 proportional to the number of metrics in the queue (i.e. it increases linearly
285 until it reaches 100%.)
287 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
288 unset, the latter will default to half of B<WriteQueueLimitHigh>.
290 If you do not want to randomly drop values when the queue size is between
291 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
294 Enabling the B<CollectInternalStats> option is of great help to figure out the
295 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
297 =item B<Hostname> I<Name>
299 Sets the hostname that identifies a host. If you omit this setting, the
300 hostname will be determined using the L<gethostname(2)> system call.
302 =item B<FQDNLookup> B<true|false>
304 If B<Hostname> is determined automatically this setting controls whether or not
305 the daemon should try to figure out the "fully qualified domain name", FQDN.
306 This is done using a lookup of the name returned by C<gethostname>. This option
307 is enabled by default.
309 =item B<PreCacheChain> I<ChainName>
311 =item B<PostCacheChain> I<ChainName>
313 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
314 see L<FILTER CONFIGURATION> below on information on chains and how these
315 setting change the daemon's behavior.
319 =head1 PLUGIN OPTIONS
321 Some plugins may register own options. These options must be enclosed in a
322 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
323 require external configuration, too. The C<apache plugin>, for example,
324 required C<mod_status> to be configured in the webserver you're going to
325 collect data from. These plugins are listed below as well, even if they don't
326 require any configuration within collectd's configuration file.
328 A list of all plugins and a short summary for each plugin can be found in the
329 F<README> file shipped with the sourcecode and hopefully binary packets as
332 =head2 Plugin C<aggregation>
334 The I<Aggregation plugin> makes it possible to aggregate several values into
335 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
336 This can be put to a wide variety of uses, e.g. average and total CPU
337 statistics for your entire fleet.
339 The grouping is powerful but, as with many powerful tools, may be a bit
340 difficult to wrap your head around. The grouping will therefore be
341 demonstrated using an example: The average and sum of the CPU usage across
342 all CPUs of each host is to be calculated.
344 To select all the affected values for our example, set C<Plugin cpu> and
345 C<Type cpu>. The other values are left unspecified, meaning "all values". The
346 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
347 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
353 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
354 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
355 example, the intention is to have a new value for each host / type instance
356 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
357 It can be specified multiple times to group by more than one field.
360 GroupBy "TypeInstance"
362 We do neither specify nor group by I<plugin instance> (the CPU number), so all
363 metrics that differ in the CPU number only will be aggregated. Each
364 aggregation needs I<at least one> such field, otherwise no aggregation would
367 The full example configuration looks like this:
369 <Plugin "aggregation">
375 GroupBy "TypeInstance"
378 CalculateAverage true
382 There are a couple of limitations you should be aware of:
388 The I<Type> cannot be left unspecified, because it is not reasonable to add
389 apples to oranges. Also, the internal lookup structure won't work if you try
394 There must be at least one unspecified, ungrouped field. Otherwise nothing
399 As you can see in the example above, each aggregation has its own
400 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
401 blocks may match the same values, i.e. one value list can update multiple
402 aggregations. The following options are valid inside B<Aggregation> blocks:
406 =item B<Host> I<Host>
408 =item B<Plugin> I<Plugin>
410 =item B<PluginInstance> I<PluginInstance>
412 =item B<Type> I<Type>
414 =item B<TypeInstance> I<TypeInstance>
416 Selects the value lists to be added to this aggregation. B<Type> must be a
417 valid data set name, see L<types.db(5)> for details.
419 If the string starts with and ends with a slash (C</>), the string is
420 interpreted as a I<regular expression>. The regex flavor used are POSIX
421 extended regular expressions as described in L<regex(7)>. Example usage:
423 Host "/^db[0-9]\\.example\\.com$/"
425 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
427 Group valued by the specified field. The B<GroupBy> option may be repeated to
428 group by multiple fields.
430 =item B<SetHost> I<Host>
432 =item B<SetPlugin> I<Plugin>
434 =item B<SetPluginInstance> I<PluginInstance>
436 =item B<SetTypeInstance> I<TypeInstance>
438 Sets the appropriate part of the identifier to the provided string.
440 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
441 will be replaced with the aggregation function, e.g. "average". Not including
442 the placeholder will result in duplication warnings and/or messed up values if
443 more than one aggregation function are enabled.
445 The following example calculates the average usage of all "even" CPUs:
447 <Plugin "aggregation">
450 PluginInstance "/[0,2,4,6,8]$/"
454 SetPluginInstance "even-%{aggregation}"
457 GroupBy "TypeInstance"
459 CalculateAverage true
463 This will create the files:
469 foo.example.com/cpu-even-average/cpu-idle
473 foo.example.com/cpu-even-average/cpu-system
477 foo.example.com/cpu-even-average/cpu-user
485 =item B<CalculateNum> B<true>|B<false>
487 =item B<CalculateSum> B<true>|B<false>
489 =item B<CalculateAverage> B<true>|B<false>
491 =item B<CalculateMinimum> B<true>|B<false>
493 =item B<CalculateMaximum> B<true>|B<false>
495 =item B<CalculateStddev> B<true>|B<false>
497 Boolean options for enabling calculation of the number of value lists, their
498 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
499 are disabled by default.
503 =head2 Plugin C<amqp>
505 The I<AMQMP plugin> can be used to communicate with other instances of
506 I<collectd> or third party applications using an AMQP message broker. Values
507 are sent to or received from the broker, which handles routing, queueing and
508 possibly filtering or messages.
511 # Send values to an AMQP broker
512 <Publish "some_name">
518 Exchange "amq.fanout"
519 # ExchangeType "fanout"
520 # RoutingKey "collectd"
522 # ConnectionRetryDelay 0
525 # GraphitePrefix "collectd."
526 # GraphiteEscapeChar "_"
527 # GraphiteSeparateInstances false
528 # GraphiteAlwaysAppendDS false
531 # Receive values from an AMQP broker
532 <Subscribe "some_name">
538 Exchange "amq.fanout"
539 # ExchangeType "fanout"
542 # QueueAutoDelete true
543 # RoutingKey "collectd.#"
544 # ConnectionRetryDelay 0
548 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
549 blocks, which configure sending and receiving of values respectively. The two
550 blocks are very similar, so unless otherwise noted, an option can be used in
551 either block. The name given in the blocks starting tag is only used for
552 reporting messages, but may be used to support I<flushing> of certain
553 I<Publish> blocks in the future.
557 =item B<Host> I<Host>
559 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
560 the underlying communications library, I<rabbitmq-c>, which is "localhost".
562 =item B<Port> I<Port>
564 Service name or port number on which the AMQP broker accepts connections. This
565 argument must be a string, even if the numeric form is used. Defaults to
568 =item B<VHost> I<VHost>
570 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
572 =item B<User> I<User>
574 =item B<Password> I<Password>
576 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
579 =item B<Exchange> I<Exchange>
581 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
582 By default, "amq.fanout" will be used.
584 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
585 the given exchange and the I<queue> is created, using the I<routing key> if
586 configured. See the B<Queue> and B<RoutingKey> options below.
588 =item B<ExchangeType> I<Type>
590 If given, the plugin will try to create the configured I<exchange> with this
591 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
592 be bound to this exchange.
594 =item B<Queue> I<Queue> (Subscribe only)
596 Configures the I<queue> name to subscribe to. If no queue name was configured
597 explicitly, a unique queue name will be created by the broker.
599 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
601 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
602 or transient (will disappear if the AMQP broker is restarted). Defaults to
605 This option should be used in conjunction with the I<Persistent> option on the
608 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
610 Defines if the I<queue> subscribed to will be deleted once the last consumer
611 unsubscribes. Defaults to "true".
613 =item B<RoutingKey> I<Key>
615 In I<Publish> blocks, this configures the routing key to set on all outgoing
616 messages. If not given, the routing key will be computed from the I<identifier>
617 of the value. The host, plugin, type and the two instances are concatenated
618 together using dots as the separator and all containing dots replaced with
619 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
620 possible to receive only specific values using a "topic" exchange.
622 In I<Subscribe> blocks, configures the I<routing key> used when creating a
623 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
624 used to filter messages when using a "topic" exchange. If you're only
625 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
628 =item B<Persistent> B<true>|B<false> (Publish only)
630 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
631 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
632 default), the I<transient> delivery mode will be used, i.e. messages may be
633 lost due to high load, overflowing queues or similar issues.
635 =item B<ConnectionRetryDelay> I<Delay>
637 When the connection to the AMQP broker is lost, defines the time in seconds to
638 wait before attempting to reconnect. Defaults to 0, which implies collectd will
639 attempt to reconnect at each read interval (in Subscribe mode) or each time
640 values are ready for submission (in Publish mode).
642 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
644 Selects the format in which messages are sent to the broker. If set to
645 B<Command> (the default), values are sent as C<PUTVAL> commands which are
646 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
647 case, the C<Content-Type> header field will be set to C<text/collectd>.
649 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
650 an easy and straight forward exchange format. The C<Content-Type> header field
651 will be set to C<application/json>.
653 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
654 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
657 A subscribing client I<should> use the C<Content-Type> header field to
658 determine how to decode the values. Currently, the I<AMQP plugin> itself can
659 only decode the B<Command> format.
661 =item B<StoreRates> B<true>|B<false> (Publish only)
663 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
664 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
665 default), no conversion is performed. Otherwise the conversion is performed
666 using the internal value cache.
668 Please note that currently this option is only used if the B<Format> option has
671 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
673 A prefix can be added in the metric name when outputting in the I<Graphite> format.
674 It's added before the I<Host> name.
675 Metric name will be "<prefix><host><postfix><plugin><type><name>"
677 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
679 A postfix can be added in the metric name when outputting in the I<Graphite> format.
680 It's added after the I<Host> name.
681 Metric name will be "<prefix><host><postfix><plugin><type><name>"
683 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
685 Specify a character to replace dots (.) in the host part of the metric name.
686 In I<Graphite> metric name, dots are used as separators between different
687 metric parts (host, plugin, type).
688 Default is "_" (I<Underscore>).
690 =item B<GraphiteSeparateInstances> B<true>|B<false>
692 If set to B<true>, the plugin instance and type instance will be in their own
693 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
694 default), the plugin and plugin instance (and likewise the type and type
695 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
697 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
699 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
700 identifier. If set to B<false> (the default), this is only done when there is
705 =head2 Plugin C<apache>
707 To configure the C<apache>-plugin you first need to configure the Apache
708 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
709 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
710 the following snipped to base your Apache config upon:
713 <IfModule mod_status.c>
714 <Location /mod_status>
715 SetHandler server-status
719 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
720 also supported. It introduces a new field, called C<BusyServers>, to count the
721 number of currently connected clients. This field is also supported.
723 The configuration of the I<Apache> plugin consists of one or more
724 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
725 as the instance name. For example:
729 URL "http://www1.example.com/mod_status?auto"
732 URL "http://www2.example.com/mod_status?auto"
736 The instance name will be used as the I<plugin instance>. To emulate the old
737 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
738 plugin to work correctly, each instance name must be unique. This is not
739 enforced by the plugin and it is your responsibility to ensure it.
741 The following options are accepted within each I<Instance> block:
745 =item B<URL> I<http://host/mod_status?auto>
747 Sets the URL of the C<mod_status> output. This needs to be the output generated
748 by C<ExtendedStatus on> and it needs to be the machine readable output
749 generated by appending the C<?auto> argument. This option is I<mandatory>.
751 =item B<User> I<Username>
753 Optional user name needed for authentication.
755 =item B<Password> I<Password>
757 Optional password needed for authentication.
759 =item B<VerifyPeer> B<true|false>
761 Enable or disable peer SSL certificate verification. See
762 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
764 =item B<VerifyHost> B<true|false>
766 Enable or disable peer host name verification. If enabled, the plugin checks
767 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
768 certificate matches the host name provided by the B<URL> option. If this
769 identity check fails, the connection is aborted. Obviously, only works when
770 connecting to a SSL enabled server. Enabled by default.
772 =item B<CACert> I<File>
774 File that holds one or more SSL certificates. If you want to use HTTPS you will
775 possibly need this option. What CA certificates come bundled with C<libcurl>
776 and are checked by default depends on the distribution you use.
778 =item B<Timeout> I<Milliseconds>
780 The B<Timeout> option sets the overall timeout for HTTP requests, in
781 milliseconds. By default, the configured B<Interval> is used to set the
786 =head2 Plugin C<apcups>
790 =item B<Host> I<Hostname>
792 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
793 that IPv6 support has been disabled unless someone can confirm or decline that
794 B<apcupsd> can handle it.
796 =item B<Port> I<Port>
798 TCP-Port to connect to. Defaults to B<3551>.
800 =item B<ReportSeconds> B<true|false>
802 If set to B<true>, the time reported in the C<timeleft> metric will be
803 converted to seconds. This is the recommended setting. If set to B<false>, the
804 default for backwards compatibility, the time will be reported in minutes.
808 =head2 Plugin C<aquaero>
810 This plugin collects the value of the available sensors in an
811 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
812 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
813 connection for monitoring and configuration. The board can handle multiple
814 temperature sensors, fans, water pumps and water level sensors and adjust the
815 output settings such as fan voltage or power used by the water pump based on
816 the available inputs using a configurable controller included in the board.
817 This plugin collects all the available inputs as well as some of the output
818 values chosen by this controller. The plugin is based on the I<libaquaero5>
819 library provided by I<aquatools-ng>.
823 =item B<Device> I<DevicePath>
825 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
826 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
827 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
831 =head2 Plugin C<ascent>
833 This plugin collects information about an Ascent server, a free server for the
834 "World of Warcraft" game. This plugin gathers the information by fetching the
835 XML status page using C<libcurl> and parses it using C<libxml2>.
837 The configuration options are the same as for the C<apache> plugin above:
841 =item B<URL> I<http://localhost/ascent/status/>
843 Sets the URL of the XML status output.
845 =item B<User> I<Username>
847 Optional user name needed for authentication.
849 =item B<Password> I<Password>
851 Optional password needed for authentication.
853 =item B<VerifyPeer> B<true|false>
855 Enable or disable peer SSL certificate verification. See
856 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
858 =item B<VerifyHost> B<true|false>
860 Enable or disable peer host name verification. If enabled, the plugin checks
861 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
862 certificate matches the host name provided by the B<URL> option. If this
863 identity check fails, the connection is aborted. Obviously, only works when
864 connecting to a SSL enabled server. Enabled by default.
866 =item B<CACert> I<File>
868 File that holds one or more SSL certificates. If you want to use HTTPS you will
869 possibly need this option. What CA certificates come bundled with C<libcurl>
870 and are checked by default depends on the distribution you use.
874 =head2 Plugin C<barometer>
876 This plugin reads absolute air pressure using digital barometer sensor MPL115A2
877 or MPL3115 from Freescale (sensor attached to any I2C bus available in
878 the computer, for HW details see
879 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A> or
880 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>).
881 The sensor type - one fo these two - is detected automatically by the plugin
882 and indicated in the plugin_instance (typically you will see subdirectory
883 "barometer-mpl115" or "barometer-mpl3115").
885 The plugin provides absolute barometric pressure, air pressure reduced to sea
886 level (several possible approximations) and as an auxiliary value also internal
887 sensor temperature. It uses (expects/provides) typical metric units - pressure
888 in [hPa], temperature in [C], altitude in [m].
890 It was developed and tested under Linux only. The only platform dependency is
891 the standard Linux i2c-dev interface (the particular bus driver has to
892 support the SM Bus command subset).
894 The reduction or normalization to mean sea level pressure requires (depedning on
895 selected method/approximation) also altitude and reference to temperature sensor(s).
896 When multiple temperature sensors are configured the minumum of their values is
897 always used (expecting that the warmer ones are affected by e.g. direct sun light
906 TemperatureOffset 0.0
909 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
914 =item B<Device> I<device>
916 Device name of the I2C bus to which the sensor is connected. Note that typically
917 you need to have loaded the i2c-dev module.
918 Using i2c-tools you can check/list i2c buses available on your system by:
922 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
926 This way you should be able to verify that the pressure sensor (either type) is
927 connected and detected on address 0x60.
929 =item B<Oversampling> I<value>
931 For MPL115 this is the size of the averaging window. To filter out sensor noise
932 a simple averaging using floating window of configurable size is used. The plugin
933 will use average of the last C<value> measurements (value of 1 means no averaging).
934 Minimal size is 1, maximal 1024.
936 For MPL3115 this is the oversampling value. The actual oversampling is performed
937 by the sensor and the higher value the higher accuracy and longer conversion time
938 (although nothing to worry about in the collectd context). Supported values are:
939 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
940 the closest supported one. Default is 128.
942 =item B<PressureOffset> I<offset>
944 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
945 This is added to the measured/caclulated value (i.e. if the measured value is too high
946 then use negative offset).
947 In hPa, default is 0.0.
949 =item B<TemperatureOffset> I<offset>
951 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
952 This is added to the measured/caclulated value (i.e. if the measured value is too high
953 then use negative offset).
954 In C, default is 0.0.
956 =item B<Normalization> I<method>
958 Normalization method - what approximation/model is used to compute mean sea
959 level pressure from the air absolute pressure.
961 Supported values of the C<method> (integer between from 0 to 2) are:
965 =item B<0> - no conversion, absolute pressrure is simply copied over. For this method you
966 do not need to configure C<Altitude> or C<TemperatureSensor>.
968 =item B<1> - international formula for conversion ,
969 See I<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
970 For this method you have to configure C<Altitude> but do not need C<TemperatureSensor>
971 (uses fixed global temperature average instead).
973 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
974 Meteorological Service).
975 See I<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
976 For this method you have to configure both C<Altitude> and C<TemperatureSensor>.
981 =item B<Altitude> I<altitude>
983 The altitude (in meters) of the location where you meassure the pressure.
985 =item B<TemperatureSensor> I<reference>
987 Temperature sensor which should be used as a reference when normalizing the pressure.
988 When specified more sensors a minumum is found and uses each time.
989 The temperature reading directly from this pressure sensor/plugin
990 is typically not suitable as the pressure sensor
991 will be probably inside while we want outside temperature.
992 The collectd reference name is something like
993 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
994 (<type_instance> is usually omitted when there is just single value type).
995 Or you can figure it out from the path of the output data files.
999 =head2 Plugin C<battery>
1001 The I<battery plugin> reports the remaining capacity, power and voltage of
1006 =item B<ValuesPercentage> B<false>|B<true>
1008 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1009 capacity remaining". Otherwise the capacity is stored as reported by the
1010 battery, most likely in "Wh". This option does not work with all input methods,
1011 in particular when only C</proc/pmu> is available on an old Linux system.
1012 Defaults to B<false>.
1014 =item B<ReportDegraded> B<false>|B<true>
1016 Typical laptop batteries degrade over time, meaning the capacity decreases with
1017 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1018 "last full capacity" and used to determine that a battery is "fully charged".
1020 When this option is set to B<false>, the default, the I<battery plugin> will
1021 only report the remaining capacity. If the B<ValuesPercentage> option is
1022 enabled, the relative remaining capacity is calculated as the ratio of the
1023 "remaining capacity" and the "last full capacity". This is what most tools,
1024 such as the status bar of desktop environments, also do.
1026 When set to B<true>, the battery plugin will report three values: B<charged>
1027 (remaining capacity), B<discharged> (difference between "last full capacity"
1028 and "remaining capacity") and B<degraded> (difference between "design capacity"
1029 and "last full capacity").
1033 =head2 Plugin C<bind>
1035 Starting with BIND 9.5.0, the most widely used DNS server software provides
1036 extensive statistics about queries, responses and lots of other information.
1037 The bind plugin retrieves this information that's encoded in XML and provided
1038 via HTTP and submits the values to collectd.
1040 To use this plugin, you first need to tell BIND to make this information
1041 available. This is done with the C<statistics-channels> configuration option:
1043 statistics-channels {
1044 inet localhost port 8053;
1047 The configuration follows the grouping that can be seen when looking at the
1048 data with an XSLT compatible viewer, such as a modern web browser. It's
1049 probably a good idea to make yourself familiar with the provided values, so you
1050 can understand what the collected statistics actually mean.
1055 URL "http://localhost:8053/"
1070 Zone "127.in-addr.arpa/IN"
1074 The bind plugin accepts the following configuration options:
1080 URL from which to retrieve the XML data. If not specified,
1081 C<http://localhost:8053/> will be used.
1083 =item B<ParseTime> B<true>|B<false>
1085 When set to B<true>, the time provided by BIND will be parsed and used to
1086 dispatch the values. When set to B<false>, the local time source is queried.
1088 This setting is set to B<true> by default for backwards compatibility; setting
1089 this to B<false> is I<recommended> to avoid problems with timezones and
1092 =item B<OpCodes> B<true>|B<false>
1094 When enabled, statistics about the I<"OpCodes">, for example the number of
1095 C<QUERY> packets, are collected.
1099 =item B<QTypes> B<true>|B<false>
1101 When enabled, the number of I<incoming> queries by query types (for example
1102 C<A>, C<MX>, C<AAAA>) is collected.
1106 =item B<ServerStats> B<true>|B<false>
1108 Collect global server statistics, such as requests received over IPv4 and IPv6,
1109 successful queries, and failed updates.
1113 =item B<ZoneMaintStats> B<true>|B<false>
1115 Collect zone maintenance statistics, mostly information about notifications
1116 (zone updates) and zone transfers.
1120 =item B<ResolverStats> B<true>|B<false>
1122 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1123 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1124 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1125 default. Use the B<ResolverStats> option within a B<View "_default"> block
1126 instead for the same functionality.
1130 =item B<MemoryStats>
1132 Collect global memory statistics.
1136 =item B<Timeout> I<Milliseconds>
1138 The B<Timeout> option sets the overall timeout for HTTP requests, in
1139 milliseconds. By default, the configured B<Interval> is used to set the
1142 =item B<View> I<Name>
1144 Collect statistics about a specific I<"view">. BIND can behave different,
1145 mostly depending on the source IP-address of the request. These different
1146 configurations are called "views". If you don't use this feature, you most
1147 likely are only interested in the C<_default> view.
1149 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1150 information you want to collect about a view. If no B<View> block is
1151 configured, no detailed view statistics will be collected.
1155 =item B<QTypes> B<true>|B<false>
1157 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1158 C<MX>) is collected.
1162 =item B<ResolverStats> B<true>|B<false>
1164 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1165 (e.E<nbsp>g. queries over IPv4, lame servers).
1169 =item B<CacheRRSets> B<true>|B<false>
1171 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1172 type is collected. Negative entries (queries which resulted in an error, for
1173 example names that do not exist) are reported with a leading exclamation mark,
1178 =item B<Zone> I<Name>
1180 When given, collect detailed information about the given zone in the view. The
1181 information collected if very similar to the global B<ServerStats> information
1184 You can repeat this option to collect detailed information about multiple
1187 By default no detailed zone information is collected.
1193 =head2 Plugin C<ceph>
1195 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1196 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1198 A separate B<Daemon> block must be configured for each ceph daemon to be
1199 monitored. The following example will read daemon statistics from four
1200 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1203 LongRunAvgLatency false
1204 ConvertSpecialMetricTypes true
1206 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1209 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1212 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1215 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1219 The ceph plugin accepts the following configuration options:
1223 =item B<LongRunAvgLatency> B<true>|B<false>
1225 If enabled, latency values(sum,count pairs) are calculated as the long run
1226 average - average since the ceph daemon was started = (sum / count).
1227 When disabled, latency values are calculated as the average since the last
1228 collection = (sum_now - sum_last) / (count_now - count_last).
1232 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1234 If enabled, special metrics (metrics that differ in type from similar counters)
1235 are converted to the type of those similar counters. This currently only
1236 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1237 ceph schema reports this metric type as a sum,count pair while similar counters
1238 are treated as derive types. When converted, the sum is used as the counter
1239 value and is treated as a derive type.
1240 When disabled, all metrics are treated as the types received from the ceph schema.
1246 Each B<Daemon> block must have a string argument for the plugin instance name.
1247 A B<SocketPath> is also required for each B<Daemon> block:
1251 =item B<Daemon> I<DaemonName>
1253 Name to be used as the instance name for this daemon.
1255 =item B<SocketPath> I<SocketPath>
1257 Specifies the path to the UNIX admin socket of the ceph daemon.
1261 =head2 Plugin C<cgroups>
1263 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1264 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1265 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1269 =item B<CGroup> I<Directory>
1271 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1272 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1275 =item B<IgnoreSelected> B<true>|B<false>
1277 Invert the selection: If set to true, all cgroups I<except> the ones that
1278 match any one of the criteria are collected. By default only selected
1279 cgroups are collected if a selection is made. If no selection is configured
1280 at all, B<all> cgroups are selected.
1284 =head2 Plugin C<conntrack>
1286 This plugin collects IP conntrack statistics.
1292 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1293 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1297 =head2 Plugin C<cpu>
1299 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1300 as Jiffies, using the C<cpu> type. Two aggregations are available:
1306 Sum, per-state, over all CPUs installed in the system; and
1310 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1314 The two aggregations can be combined, leading to I<collectd> only emitting a
1315 single "active" metric for the entire system. As soon as one of these
1316 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1317 rather than Jiffies. In addition, you can request individual, per-state,
1318 per-CPU metrics to be reported as percentage.
1320 The following configuration options are available:
1324 =item B<ReportByState> B<true>|B<false>
1326 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1328 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1331 =item B<ReportByCpu> B<true>|B<false>
1333 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1334 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1335 global sum of CPU states is emitted.
1337 =item B<ValuesPercentage> B<false>|B<true>
1339 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1340 are set to B<true>. In this case, by default, metrics will be reported as
1341 Jiffies. By setting this option to B<true>, you can request percentage values
1342 in the un-aggregated (per-CPU, per-state) mode as well.
1346 =head2 Plugin C<cpufreq>
1348 This plugin doesn't have any options. It reads
1349 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1350 installed) to get the current CPU frequency. If this file does not exist make
1351 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1352 installed and an "cpu governor" (that's a kernel module) is loaded.
1354 =head2 Plugin C<csv>
1358 =item B<DataDir> I<Directory>
1360 Set the directory to store CSV-files under. Per default CSV-files are generated
1361 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1362 The special strings B<stdout> and B<stderr> can be used to write to the standard
1363 output and standard error channels, respectively. This, of course, only makes
1364 much sense when collectd is running in foreground- or non-daemon-mode.
1366 =item B<StoreRates> B<true|false>
1368 If set to B<true>, convert counter values to rates. If set to B<false> (the
1369 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1374 =head2 Plugin C<curl>
1376 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1377 and the match infrastructure (the same code used by the tail plugin) to use
1378 regular expressions with the received data.
1380 The following example will read the current value of AMD stock from Google's
1381 finance page and dispatch the value to collectd.
1384 <Page "stock_quotes">
1385 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1391 CACert "/path/to/ca.crt"
1392 Header "X-Custom-Header: foobar"
1395 MeasureResponseTime false
1396 MeasureResponseCode false
1399 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1400 DSType "GaugeAverage"
1401 # Note: `stock_value' is not a standard type.
1408 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1409 a web page and one or more "matches" to be performed on the returned data. The
1410 string argument to the B<Page> block is used as plugin instance.
1412 The following options are valid within B<Page> blocks:
1418 URL of the web site to retrieve. Since a regular expression will be used to
1419 extract information from this data, non-binary data is a big plus here ;)
1421 =item B<User> I<Name>
1423 Username to use if authorization is required to read the page.
1425 =item B<Password> I<Password>
1427 Password to use if authorization is required to read the page.
1429 =item B<Digest> B<true>|B<false>
1431 Enable HTTP digest authentication.
1433 =item B<VerifyPeer> B<true>|B<false>
1435 Enable or disable peer SSL certificate verification. See
1436 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1438 =item B<VerifyHost> B<true>|B<false>
1440 Enable or disable peer host name verification. If enabled, the plugin checks if
1441 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1442 matches the host name provided by the B<URL> option. If this identity check
1443 fails, the connection is aborted. Obviously, only works when connecting to a
1444 SSL enabled server. Enabled by default.
1446 =item B<CACert> I<file>
1448 File that holds one or more SSL certificates. If you want to use HTTPS you will
1449 possibly need this option. What CA certificates come bundled with C<libcurl>
1450 and are checked by default depends on the distribution you use.
1452 =item B<Header> I<Header>
1454 A HTTP header to add to the request. Multiple headers are added if this option
1455 is specified more than once.
1457 =item B<Post> I<Body>
1459 Specifies that the HTTP operation should be a POST instead of a GET. The
1460 complete data to be posted is given as the argument. This option will usually
1461 need to be accompanied by a B<Header> option to set an appropriate
1462 C<Content-Type> for the post body (e.g. to
1463 C<application/x-www-form-urlencoded>).
1465 =item B<MeasureResponseTime> B<true>|B<false>
1467 Measure response time for the request. If this setting is enabled, B<Match>
1468 blocks (see below) are optional. Disabled by default.
1470 Beware that requests will get aborted if they take too long to complete. Adjust
1471 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1474 =item B<MeasureResponseCode> B<true>|B<false>
1476 Measure response code for the request. If this setting is enabled, B<Match>
1477 blocks (see below) are optional. Disabled by default.
1479 =item B<E<lt>MatchE<gt>>
1481 One or more B<Match> blocks that define how to match information in the data
1482 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1483 used by the C<tail> plugin, so please see the documentation of the C<tail>
1484 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1485 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1488 =item B<Timeout> I<Milliseconds>
1490 The B<Timeout> option sets the overall timeout for HTTP requests, in
1491 milliseconds. By default, the configured B<Interval> is used to set the
1492 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1493 indefinitely. This legacy behaviour can be achieved by setting the value of
1496 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1497 network connection will stall one read thread. Adjust the B<ReadThreads> global
1498 setting accordingly to prevent this from blocking other plugins.
1502 =head2 Plugin C<curl_json>
1504 The B<curl_json plugin> collects values from JSON data to be parsed by
1505 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1506 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1507 unix socket. The former can be used, for example, to collect values
1508 from CouchDB documents (which are stored JSON notation), and the
1509 latter to collect values from a uWSGI stats socket.
1511 The following example will collect several values from the built-in
1512 C<_stats> runtime statistics module of I<CouchDB>
1513 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1516 <URL "http://localhost:5984/_stats">
1518 <Key "httpd/requests/count">
1519 Type "http_requests"
1522 <Key "httpd_request_methods/*/count">
1523 Type "http_request_methods"
1526 <Key "httpd_status_codes/*/count">
1527 Type "http_response_codes"
1532 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1535 <Sock "/var/run/uwsgi.stats.sock">
1537 <Key "workers/*/requests">
1538 Type "http_requests"
1541 <Key "workers/*/apps/*/requests">
1542 Type "http_requests"
1547 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1548 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1549 blocks defining a unix socket to read JSON from directly. Each of
1550 these blocks may have one or more B<Key> blocks.
1552 The B<Key> string argument must be in a path format. Each component is
1553 used to match the key from a JSON map or the index of an JSON
1554 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1555 values for all map keys or array indices will be collectd.
1557 The following options are valid within B<URL> blocks:
1561 =item B<Instance> I<Instance>
1563 Sets the plugin instance to I<Instance>.
1565 =item B<Interval> I<Interval>
1567 Sets the interval (in seconds) in which the values will be collected from this
1568 URL. By default the global B<Interval> setting will be used.
1570 =item B<User> I<Name>
1572 =item B<Password> I<Password>
1574 =item B<Digest> B<true>|B<false>
1576 =item B<VerifyPeer> B<true>|B<false>
1578 =item B<VerifyHost> B<true>|B<false>
1580 =item B<CACert> I<file>
1582 =item B<Header> I<Header>
1584 =item B<Post> I<Body>
1586 =item B<Timeout> I<Milliseconds>
1588 These options behave exactly equivalent to the appropriate options of the
1589 I<cURL> plugin. Please see there for a detailed description.
1593 The following options are valid within B<Key> blocks:
1597 =item B<Type> I<Type>
1599 Sets the type used to dispatch the values to the daemon. Detailed information
1600 about types and their configuration can be found in L<types.db(5)>. This
1601 option is mandatory.
1603 =item B<Instance> I<Instance>
1605 Type-instance to use. Defaults to the current map key or current string array element value.
1609 =head2 Plugin C<curl_xml>
1611 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1612 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1615 <URL "http://localhost/stats.xml">
1617 Instance "some_instance"
1622 CACert "/path/to/ca.crt"
1623 Header "X-Custom-Header: foobar"
1626 <XPath "table[@id=\"magic_level\"]/tr">
1628 #InstancePrefix "prefix-"
1629 InstanceFrom "td[1]"
1630 ValuesFrom "td[2]/span[@class=\"level\"]"
1635 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1636 URL to be fetched using libcurl. Within each B<URL> block there are
1637 options which specify the connection parameters, for example authentication
1638 information, and one or more B<XPath> blocks.
1640 Each B<XPath> block specifies how to get one type of information. The
1641 string argument must be a valid XPath expression which returns a list
1642 of "base elements". One value is dispatched for each "base element". The
1643 I<type instance> and values are looked up using further I<XPath> expressions
1644 that should be relative to the base element.
1646 Within the B<URL> block the following options are accepted:
1650 =item B<Host> I<Name>
1652 Use I<Name> as the host name when submitting values. Defaults to the global
1655 =item B<Instance> I<Instance>
1657 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1658 empty string (no plugin instance).
1660 =item B<Namespace> I<Prefix> I<URL>
1662 If an XPath expression references namespaces, they must be specified
1663 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1664 I<URL> is the "namespace name", an URI reference uniquely identifying the
1665 namespace. The option can be repeated to register multiple namespaces.
1669 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1670 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1672 =item B<User> I<User>
1674 =item B<Password> I<Password>
1676 =item B<Digest> B<true>|B<false>
1678 =item B<VerifyPeer> B<true>|B<false>
1680 =item B<VerifyHost> B<true>|B<false>
1682 =item B<CACert> I<CA Cert File>
1684 =item B<Header> I<Header>
1686 =item B<Post> I<Body>
1688 =item B<Timeout> I<Milliseconds>
1690 These options behave exactly equivalent to the appropriate options of the
1691 I<cURL plugin>. Please see there for a detailed description.
1693 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1695 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1696 B<XPath> block specifies how to get one type of information. The string
1697 argument must be a valid XPath expression which returns a list of "base
1698 elements". One value is dispatched for each "base element".
1700 Within the B<XPath> block the following options are accepted:
1704 =item B<Type> I<Type>
1706 Specifies the I<Type> used for submitting patches. This determines the number
1707 of values that are required / expected and whether the strings are parsed as
1708 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1709 This option is required.
1711 =item B<InstancePrefix> I<InstancePrefix>
1713 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1714 concatenated together without any separator.
1715 This option is optional.
1717 =item B<InstanceFrom> I<InstanceFrom>
1719 Specifies a XPath expression to use for determining the I<type instance>. The
1720 XPath expression must return exactly one element. The element's value is then
1721 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1723 This value is required. As a special exception, if the "base XPath expression"
1724 (the argument to the B<XPath> block) returns exactly one argument, then this
1725 option may be omitted.
1727 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1729 Specifies one or more XPath expression to use for reading the values. The
1730 number of XPath expressions must match the number of data sources in the
1731 I<type> specified with B<Type> (see above). Each XPath expression must return
1732 exactly one element. The element's value is then parsed as a number and used as
1733 value for the appropriate value in the value list dispatched to the daemon.
1739 =head2 Plugin C<dbi>
1741 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1742 connect to various databases, execute I<SQL> statements and read back the
1743 results. I<dbi> is an acronym for "database interface" in case you were
1744 wondering about the name. You can configure how each column is to be
1745 interpreted and the plugin will generate one or more data sets from each row
1746 returned according to these rules.
1748 Because the plugin is very generic, the configuration is a little more complex
1749 than those of other plugins. It usually looks something like this:
1752 <Query "out_of_stock">
1753 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1754 # Use with MySQL 5.0.0 or later
1758 InstancePrefix "out_of_stock"
1759 InstancesFrom "category"
1763 <Database "product_information">
1765 DriverOption "host" "localhost"
1766 DriverOption "username" "collectd"
1767 DriverOption "password" "aZo6daiw"
1768 DriverOption "dbname" "prod_info"
1769 SelectDB "prod_info"
1770 Query "out_of_stock"
1774 The configuration above defines one query with one result and one database. The
1775 query is then linked to the database with the B<Query> option I<within> the
1776 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1777 and you can also use the B<Include> statement to split up the configuration
1778 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1779 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1782 The following is a complete list of options:
1784 =head3 B<Query> blocks
1786 Query blocks define I<SQL> statements and how the returned data should be
1787 interpreted. They are identified by the name that is given in the opening line
1788 of the block. Thus the name needs to be unique. Other than that, the name is
1789 not used in collectd.
1791 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1792 define which column holds which value or instance information. You can use
1793 multiple B<Result> blocks to create multiple values from one returned row. This
1794 is especially useful, when queries take a long time and sending almost the same
1795 query again and again is not desirable.
1799 <Query "environment">
1800 Statement "select station, temperature, humidity from environment"
1803 # InstancePrefix "foo"
1804 InstancesFrom "station"
1805 ValuesFrom "temperature"
1809 InstancesFrom "station"
1810 ValuesFrom "humidity"
1814 The following options are accepted:
1818 =item B<Statement> I<SQL>
1820 Sets the statement that should be executed on the server. This is B<not>
1821 interpreted by collectd, but simply passed to the database server. Therefore,
1822 the SQL dialect that's used depends on the server collectd is connected to.
1824 The query has to return at least two columns, one for the instance and one
1825 value. You cannot omit the instance, even if the statement is guaranteed to
1826 always return exactly one line. In that case, you can usually specify something
1829 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1831 (That works with MySQL but may not be valid SQL according to the spec. If you
1832 use a more strict database server, you may have to select from a dummy table or
1835 Please note that some databases, for example B<Oracle>, will fail if you
1836 include a semicolon at the end of the statement.
1838 =item B<MinVersion> I<Version>
1840 =item B<MaxVersion> I<Value>
1842 Only use this query for the specified database version. You can use these
1843 options to provide multiple queries with the same name but with a slightly
1844 different syntax. The plugin will use only those queries, where the specified
1845 minimum and maximum versions fit the version of the database in use.
1847 The database version is determined by C<dbi_conn_get_engine_version>, see the
1848 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1849 for details. Basically, each part of the version is assumed to be in the range
1850 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1851 "40102", version "5.0.42" becomes "50042".
1853 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1854 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1855 happen. Don't to it! A valid example would be something along these lines:
1866 In the above example, there are three ranges that don't overlap. The last one
1867 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1868 before "4.0.0" are not specified.
1870 =item B<Type> I<Type>
1872 The B<type> that's used for each line returned. See L<types.db(5)> for more
1873 details on how types are defined. In short: A type is a predefined layout of
1874 data and the number of values and type of values has to match the type
1877 If you specify "temperature" here, you need exactly one gauge column. If you
1878 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1881 There must be exactly one B<Type> option inside each B<Result> block.
1883 =item B<InstancePrefix> I<prefix>
1885 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1886 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1887 all strings returned in the appropriate columns are concatenated together,
1888 separated by dashes I<("-")>.
1890 =item B<InstancesFrom> I<column0> [I<column1> ...]
1892 Specifies the columns whose values will be used to create the "type-instance"
1893 for each row. If you specify more than one column, the value of all columns
1894 will be joined together with dashes I<("-")> as separation characters.
1896 The plugin itself does not check whether or not all built instances are
1897 different. It's your responsibility to assure that each is unique. This is
1898 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1899 sure that only one row is returned in this case.
1901 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1904 =item B<ValuesFrom> I<column0> [I<column1> ...]
1906 Names the columns whose content is used as the actual data for the data sets
1907 that are dispatched to the daemon. How many such columns you need is determined
1908 by the B<Type> setting above. If you specify too many or not enough columns,
1909 the plugin will complain about that and no data will be submitted to the
1912 The actual data type in the columns is not that important. The plugin will
1913 automatically cast the values to the right type if it know how to do that. So
1914 it should be able to handle integer an floating point types, as well as strings
1915 (if they include a number at the beginning).
1917 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1919 =item B<MetadataFrom> [I<column0> I<column1> ...]
1921 Names the columns whose content is used as metadata for the data sets
1922 that are dispatched to the daemon.
1924 The actual data type in the columns is not that important. The plugin will
1925 automatically cast the values to the right type if it know how to do that. So
1926 it should be able to handle integer an floating point types, as well as strings
1927 (if they include a number at the beginning).
1931 =head3 B<Database> blocks
1933 Database blocks define a connection to a database and which queries should be
1934 sent to that database. Since the used "dbi" library can handle a wide variety
1935 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1936 documentationE<nbsp>- we stick as close to the terminology used there.
1938 Each database needs a "name" as string argument in the starting tag of the
1939 block. This name will be used as "PluginInstance" in the values submitted to
1940 the daemon. Other than that, that name is not used.
1944 =item B<Driver> I<Driver>
1946 Specifies the driver to use to connect to the database. In many cases those
1947 drivers are named after the database they can connect to, but this is not a
1948 technical necessity. These drivers are sometimes referred to as "DBD",
1949 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1950 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1951 project at L<http://libdbi-drivers.sourceforge.net/>.
1953 You need to give the driver name as expected by the "dbi" library here. You
1954 should be able to find that in the documentation for each driver. If you
1955 mistype the driver name, the plugin will dump a list of all known driver names
1958 =item B<DriverOption> I<Key> I<Value>
1960 Sets driver-specific options. What option a driver supports can be found in the
1961 documentation for each driver, somewhere at
1962 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1963 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1965 DBDs can register two types of options: String options and numeric options. The
1966 plugin will use the C<dbi_conn_set_option> function when the configuration
1967 provides a string and the C<dbi_conn_require_option_numeric> function when the
1968 configuration provides a number. So these two lines will actually result in
1969 different calls being used:
1971 DriverOption "Port" 1234 # numeric
1972 DriverOption "Port" "1234" # string
1974 Unfortunately, drivers are not too keen to report errors when an unknown option
1975 is passed to them, so invalid settings here may go unnoticed. This is not the
1976 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1977 the driver. If a driver complains about an option, the plugin will dump a
1978 complete list of all options understood by that driver to the log. There is no
1979 way to programatically find out if an option expects a string or a numeric
1980 argument, so you will have to refer to the appropriate DBD's documentation to
1981 find this out. Sorry.
1983 =item B<SelectDB> I<Database>
1985 In some cases, the database name you connect with is not the database name you
1986 want to use for querying data. If this option is set, the plugin will "select"
1987 (switch to) that database after the connection is established.
1989 =item B<Query> I<QueryName>
1991 Associates the query named I<QueryName> with this database connection. The
1992 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1993 blocks you want to refer to must be placed above the database block you want to
1996 =item B<Host> I<Hostname>
1998 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1999 values. Defaults to the global hostname setting.
2007 =item B<Device> I<Device>
2009 Select partitions based on the devicename.
2011 =item B<MountPoint> I<Directory>
2013 Select partitions based on the mountpoint.
2015 =item B<FSType> I<FSType>
2017 Select partitions based on the filesystem type.
2019 =item B<IgnoreSelected> B<true>|B<false>
2021 Invert the selection: If set to true, all partitions B<except> the ones that
2022 match any one of the criteria are collected. By default only selected
2023 partitions are collected if a selection is made. If no selection is configured
2024 at all, B<all> partitions are selected.
2026 =item B<ReportByDevice> B<true>|B<false>
2028 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2029 (the default), it will report a disk as "root", but with it I<true>, it will be
2030 "sda1" (or whichever).
2032 =item B<ReportInodes> B<true>|B<false>
2034 Enables or disables reporting of free, reserved and used inodes. Defaults to
2035 inode collection being disabled.
2037 Enable this option if inodes are a scarce resource for you, usually because
2038 many small files are stored on the disk. This is a usual scenario for mail
2039 transfer agents and web caches.
2041 =item B<ValuesAbsolute> B<true>|B<false>
2043 Enables or disables reporting of free and used disk space in 1K-blocks.
2044 Defaults to B<true>.
2046 =item B<ValuesPercentage> B<false>|B<true>
2048 Enables or disables reporting of free and used disk space in percentage.
2049 Defaults to B<false>.
2051 This is useful for deploying I<collectd> on the cloud, where machines with
2052 different disk size may exist. Then it is more practical to configure
2053 thresholds based on relative disk size.
2057 =head2 Plugin C<disk>
2059 The C<disk> plugin collects information about the usage of physical disks and
2060 logical disks (partitions). Values collected are the number of octets written
2061 to and read from a disk or partition, the number of read/write operations
2062 issued to the disk and a rather complex "time" it took for these commands to be
2065 Using the following two options you can ignore some disks or configure the
2066 collection only of specific disks.
2070 =item B<Disk> I<Name>
2072 Select the disk I<Name>. Whether it is collected or ignored depends on the
2073 B<IgnoreSelected> setting, see below. As with other plugins that use the
2074 daemon's ignorelist functionality, a string that starts and ends with a slash
2075 is interpreted as a regular expression. Examples:
2080 =item B<IgnoreSelected> B<true>|B<false>
2082 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2083 statements, are ignored or if all other disks are ignored. The behavior
2084 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2085 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2086 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2087 is set to B<true>, all disks are collected B<except> the ones matched.
2089 =item B<UseBSDName> B<true>|B<false>
2091 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2092 default major/minor numbers. Requires collectd to be built with Apple's
2095 =item B<UdevNameAttr> I<Attribute>
2097 Attempt to override disk instance name with the value of a specified udev
2098 attribute when built with B<libudev>. If the attribute is not defined for the
2099 given device, the default name is used. Example:
2101 UdevNameAttr "DM_NAME"
2105 =head2 Plugin C<dns>
2109 =item B<Interface> I<Interface>
2111 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2112 option sets the interface that should be used. If this option is not set, or
2113 set to "any", the plugin will try to get packets from B<all> interfaces. This
2114 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2116 =item B<IgnoreSource> I<IP-address>
2118 Ignore packets that originate from this address.
2120 =item B<SelectNumericQueryTypes> B<true>|B<false>
2122 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2126 =head2 Plugin C<email>
2130 =item B<SocketFile> I<Path>
2132 Sets the socket-file which is to be created.
2134 =item B<SocketGroup> I<Group>
2136 If running as root change the group of the UNIX-socket after it has been
2137 created. Defaults to B<collectd>.
2139 =item B<SocketPerms> I<Permissions>
2141 Change the file permissions of the UNIX-socket after it has been created. The
2142 permissions must be given as a numeric, octal value as you would pass to
2143 L<chmod(1)>. Defaults to B<0770>.
2145 =item B<MaxConns> I<Number>
2147 Sets the maximum number of connections that can be handled in parallel. Since
2148 this many threads will be started immediately setting this to a very high
2149 value will waste valuable resources. Defaults to B<5> and will be forced to be
2150 at most B<16384> to prevent typos and dumb mistakes.
2154 =head2 Plugin C<ethstat>
2156 The I<ethstat plugin> collects information about network interface cards (NICs)
2157 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2163 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2164 Map "multicast" "if_multicast"
2171 =item B<Interface> I<Name>
2173 Collect statistical information about interface I<Name>.
2175 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2177 By default, the plugin will submit values as type C<derive> and I<type
2178 instance> set to I<Name>, the name of the metric as reported by the driver. If
2179 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2180 I<TypeInstance> will be used.
2182 =item B<MappedOnly> B<true>|B<false>
2184 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2185 collected, all other metrics will be ignored. Defaults to B<false>.
2189 =head2 Plugin C<exec>
2191 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2192 contains valuable information on when the executable is executed and the
2193 output that is expected from it.
2197 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2199 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2201 Execute the executable I<Executable> as user I<User>. If the user name is
2202 followed by a colon and a group name, the effective group is set to that group.
2203 The real group and saved-set group will be set to the default group of that
2204 user. If no group is given the effective group ID will be the same as the real
2207 Please note that in order to change the user and/or group the daemon needs
2208 superuser privileges. If the daemon is run as an unprivileged user you must
2209 specify the same user/group here. If the daemon is run with superuser
2210 privileges, you must supply a non-root user here.
2212 The executable may be followed by optional arguments that are passed to the
2213 program. Please note that due to the configuration parsing numbers and boolean
2214 values may be changed. If you want to be absolutely sure that something is
2215 passed as-is please enclose it in quotes.
2217 The B<Exec> and B<NotificationExec> statements change the semantics of the
2218 programs executed, i.E<nbsp>e. the data passed to them and the response
2219 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2223 =head2 Plugin C<filecount>
2225 The C<filecount> plugin counts the number of files in a certain directory (and
2226 its subdirectories) and their combined size. The configuration is very straight
2229 <Plugin "filecount">
2230 <Directory "/var/qmail/queue/mess">
2231 Instance "qmail-message"
2233 <Directory "/var/qmail/queue/todo">
2234 Instance "qmail-todo"
2236 <Directory "/var/lib/php5">
2237 Instance "php5-sessions"
2242 The example above counts the number of files in QMail's queue directories and
2243 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2244 QMail has not yet looked at, the "message" queue holds the messages that were
2245 classified into "local" and "remote".
2247 As you can see, the configuration consists of one or more C<Directory> blocks,
2248 each of which specifies a directory in which to count the files. Within those
2249 blocks, the following options are recognized:
2253 =item B<Instance> I<Instance>
2255 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2256 it's your responsibility, the plugin doesn't check for that. If not given, the
2257 instance is set to the directory name with all slashes replaced by underscores
2258 and all leading underscores removed.
2260 =item B<Name> I<Pattern>
2262 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2263 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2264 against the pattern, not the entire path. In case this makes it easier for you:
2265 This option has been named after the B<-name> parameter to L<find(1)>.
2267 =item B<MTime> I<Age>
2269 Count only files of a specific age: If I<Age> is greater than zero, only files
2270 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2271 a negative number, this is inversed. For example, if B<-60> is specified, only
2272 files that have been modified in the last minute will be counted.
2274 The number can also be followed by a "multiplier" to easily specify a larger
2275 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2276 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2277 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2278 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2279 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2282 =item B<Size> I<Size>
2284 Count only files of a specific size. When I<Size> is a positive number, only
2285 files that are at least this big are counted. If I<Size> is a negative number,
2286 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2287 I<Size> are counted.
2289 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2290 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2291 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2292 note that there are 1000 bytes in a kilobyte, not 1024.
2294 =item B<Recursive> I<true>|I<false>
2296 Controls whether or not to recurse into subdirectories. Enabled by default.
2298 =item B<IncludeHidden> I<true>|I<false>
2300 Controls whether or not to include "hidden" files and directories in the count.
2301 "Hidden" files and directories are those, whose name begins with a dot.
2302 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2306 =head2 Plugin C<GenericJMX>
2308 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2309 L<collectd-java(5)>.
2311 =head2 Plugin C<gmond>
2313 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2314 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2315 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2320 MCReceiveFrom "239.2.11.71" "8649"
2321 <Metric "swap_total">
2323 TypeInstance "total"
2326 <Metric "swap_free">
2333 The following metrics are built-in:
2339 load_one, load_five, load_fifteen
2343 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2347 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2359 Available configuration options:
2363 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2365 Sets sets the multicast group and UDP port to which to subscribe.
2367 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2369 =item E<lt>B<Metric> I<Name>E<gt>
2371 These blocks add a new metric conversion to the internal table. I<Name>, the
2372 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2376 =item B<Type> I<Type>
2378 Type to map this metric to. Required.
2380 =item B<TypeInstance> I<Instance>
2382 Type-instance to use. Optional.
2384 =item B<DataSource> I<Name>
2386 Data source to map this metric to. If the configured type has exactly one data
2387 source, this is optional. Otherwise the option is required.
2393 =head2 Plugin C<hddtemp>
2395 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2396 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2397 default values, see below. C<hddtemp> has to be running to work correctly. If
2398 C<hddtemp> is not running timeouts may appear which may interfere with other
2401 The B<hddtemp> homepage can be found at
2402 L<http://www.guzu.net/linux/hddtemp.php>.
2406 =item B<Host> I<Hostname>
2408 Hostname to connect to. Defaults to B<127.0.0.1>.
2410 =item B<Port> I<Port>
2412 TCP-Port to connect to. Defaults to B<7634>.
2416 =head2 Plugin C<interface>
2420 =item B<Interface> I<Interface>
2422 Select this interface. By default these interfaces will then be collected. For
2423 a more detailed description see B<IgnoreSelected> below.
2425 =item B<IgnoreSelected> I<true>|I<false>
2427 If no configuration if given, the B<traffic>-plugin will collect data from
2428 all interfaces. This may not be practical, especially for loopback- and
2429 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2430 interfaces you're interested in. Sometimes, however, it's easier/preferred
2431 to collect all interfaces I<except> a few ones. This option enables you to
2432 do that: By setting B<IgnoreSelected> to I<true> the effect of
2433 B<Interface> is inverted: All selected interfaces are ignored and all
2434 other interfaces are collected.
2438 =head2 Plugin C<ipmi>
2442 =item B<Sensor> I<Sensor>
2444 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2446 =item B<IgnoreSelected> I<true>|I<false>
2448 If no configuration if given, the B<ipmi> plugin will collect data from all
2449 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2450 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2451 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2452 all other sensors are collected.
2454 =item B<NotifySensorAdd> I<true>|I<false>
2456 If a sensor appears after initialization time of a minute a notification
2459 =item B<NotifySensorRemove> I<true>|I<false>
2461 If a sensor disappears a notification is sent.
2463 =item B<NotifySensorNotPresent> I<true>|I<false>
2465 If you have for example dual power supply and one of them is (un)plugged then
2466 a notification is sent.
2470 =head2 Plugin C<iptables>
2474 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2476 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2477 will collect the counters of all rules which have a comment-match. The comment
2478 is then used as type-instance.
2480 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2481 the I<n>th rule will be collected. Again, the comment (or the number) will be
2482 used as the type-instance.
2484 If I<Name> is supplied, it will be used as the type-instance instead of the
2485 comment or the number.
2489 =head2 Plugin C<irq>
2495 Select this irq. By default these irqs will then be collected. For a more
2496 detailed description see B<IgnoreSelected> below.
2498 =item B<IgnoreSelected> I<true>|I<false>
2500 If no configuration if given, the B<irq>-plugin will collect data from all
2501 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2502 can use the B<Irq>-option to pick the interrupt you're interested in.
2503 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2504 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2505 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2506 and all other interrupts are collected.
2510 =head2 Plugin C<java>
2512 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2513 This section only discusses the syntax and semantic of the configuration
2514 options. For more in-depth information on the I<Java> plugin, please read
2515 L<collectd-java(5)>.
2520 JVMArg "-verbose:jni"
2521 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2522 LoadPlugin "org.collectd.java.Foobar"
2523 <Plugin "org.collectd.java.Foobar">
2524 # To be parsed by the plugin
2528 Available configuration options:
2532 =item B<JVMArg> I<Argument>
2534 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2535 exactly the way the arguments to the I<java> binary on the command line work.
2536 Execute C<javaE<nbsp>--help> for details.
2538 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2539 any other options! When another option is found, the JVM will be started and
2540 later options will have to be ignored!
2542 =item B<LoadPlugin> I<JavaClass>
2544 Instantiates a new I<JavaClass> object. The constructor of this object very
2545 likely then registers one or more callback methods with the server.
2547 See L<collectd-java(5)> for details.
2549 When the first such option is found, the virtual machine (JVM) is created. This
2550 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2551 B<LoadPlugin> options!
2553 =item B<Plugin> I<Name>
2555 The entire block is passed to the Java plugin as an
2556 I<org.collectd.api.OConfigItem> object.
2558 For this to work, the plugin has to register a configuration callback first,
2559 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2560 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2561 depends on the (Java) plugin registering the callback and is completely
2562 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2566 =head2 Plugin C<load>
2568 The I<Load plugin> collects the system load. These numbers give a rough overview
2569 over the utilization of a machine. The system load is defined as the number of
2570 runnable tasks in the run-queue and is provided by many operating systems as a
2571 one, five or fifteen minute average.
2573 The following configuration options are available:
2577 =item B<ReportRelative> B<false>|B<true>
2579 When enabled, system load divided by number of available CPU cores is reported
2580 for intervals 1 min, 5 min and 15 min. Defaults to false.
2585 =head2 Plugin C<logfile>
2589 =item B<LogLevel> B<debug|info|notice|warning|err>
2591 Sets the log-level. If, for example, set to B<notice>, then all events with
2592 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2594 Please note that B<debug> is only available if collectd has been compiled with
2597 =item B<File> I<File>
2599 Sets the file to write log messages to. The special strings B<stdout> and
2600 B<stderr> can be used to write to the standard output and standard error
2601 channels, respectively. This, of course, only makes much sense when I<collectd>
2602 is running in foreground- or non-daemon-mode.
2604 =item B<Timestamp> B<true>|B<false>
2606 Prefix all lines printed by the current time. Defaults to B<true>.
2608 =item B<PrintSeverity> B<true>|B<false>
2610 When enabled, all lines are prefixed by the severity of the log message, for
2611 example "warning". Defaults to B<false>.
2615 B<Note>: There is no need to notify the daemon after moving or removing the
2616 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2617 for each line it writes.
2619 =head2 Plugin C<log_logstash>
2621 The I<log logstash plugin> behaves like the logfile plugin but formats
2622 messages as JSON events for logstash to parse and input.
2626 =item B<LogLevel> B<debug|info|notice|warning|err>
2628 Sets the log-level. If, for example, set to B<notice>, then all events with
2629 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2631 Please note that B<debug> is only available if collectd has been compiled with
2634 =item B<File> I<File>
2636 Sets the file to write log messages to. The special strings B<stdout> and
2637 B<stderr> can be used to write to the standard output and standard error
2638 channels, respectively. This, of course, only makes much sense when I<collectd>
2639 is running in foreground- or non-daemon-mode.
2643 B<Note>: There is no need to notify the daemon after moving or removing the
2644 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2645 for each line it writes.
2647 =head2 Plugin C<lpar>
2649 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2650 virtualization technique for IBM POWER processors. It takes into account CPU
2651 time stolen from or donated to a partition, in addition to the usual user,
2652 system, I/O statistics.
2654 The following configuration options are available:
2658 =item B<CpuPoolStats> B<false>|B<true>
2660 When enabled, statistics about the processor pool are read, too. The partition
2661 needs to have pool authority in order to be able to acquire this information.
2664 =item B<ReportBySerial> B<false>|B<true>
2666 If enabled, the serial of the physical machine the partition is currently
2667 running on is reported as I<hostname> and the logical hostname of the machine
2668 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2669 used (just like other plugins) and the I<plugin instance> will be empty.
2674 =head2 Plugin C<mbmon>
2676 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2678 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2679 B<Host> and B<Port> options can be used to change these values, see below.
2680 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2681 timeouts may appear which may interfere with other statistics..
2683 C<mbmon> must be run with the -r option ("print TAG and Value format");
2684 Debian's F</etc/init.d/mbmon> script already does this, other people
2685 will need to ensure that this is the case.
2689 =item B<Host> I<Hostname>
2691 Hostname to connect to. Defaults to B<127.0.0.1>.
2693 =item B<Port> I<Port>
2695 TCP-Port to connect to. Defaults to B<411>.
2701 The C<md plugin> collects information from Linux Software-RAID devices (md).
2703 All reported values are of the type C<md_disks>. Reported type instances are
2704 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2705 I<missing> (physically absent) disks.
2709 =item B<Device> I<Device>
2711 Select md devices based on device name. The I<device name> is the basename of
2712 the device, i.e. the name of the block device without the leading C</dev/>.
2713 See B<IgnoreSelected> for more details.
2715 =item B<IgnoreSelected> B<true>|B<false>
2717 Invert device selection: If set to B<true>, all md devices B<except> those
2718 listed using B<Device> are collected. If B<false> (the default), only those
2719 listed are collected. If no configuration is given, the B<md> plugin will
2720 collect data from all md devices.
2724 =head2 Plugin C<memcachec>
2726 The C<memcachec plugin> connects to a memcached server, queries one or more
2727 given I<pages> and parses the returned data according to user specification.
2728 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2731 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2732 library. Please note that there is another library with a very similar name,
2733 libmemcache (notice the missing `d'), which is not applicable.
2735 Synopsis of the configuration:
2737 <Plugin "memcachec">
2738 <Page "plugin_instance">
2742 Regex "(\\d+) bytes sent"
2745 Instance "type_instance"
2750 The configuration options are:
2754 =item E<lt>B<Page> I<Name>E<gt>
2756 Each B<Page> block defines one I<page> to be queried from the memcached server.
2757 The block requires one string argument which is used as I<plugin instance>.
2759 =item B<Server> I<Address>
2761 Sets the server address to connect to when querying the page. Must be inside a
2766 When connected to the memcached server, asks for the page I<Key>.
2768 =item E<lt>B<Match>E<gt>
2770 Match blocks define which strings to look for and how matches substrings are
2771 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2775 =head2 Plugin C<memcached>
2777 The B<memcached plugin> connects to a memcached server and queries statistics
2778 about cache utilization, memory and bandwidth used.
2779 L<http://www.danga.com/memcached/>
2781 <Plugin "memcached">
2783 Host "memcache.example.com"
2788 The plugin configuration consists of one or more B<Instance> blocks which
2789 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2790 following options are allowed:
2794 =item B<Host> I<Hostname>
2796 Hostname to connect to. Defaults to B<127.0.0.1>.
2798 =item B<Port> I<Port>
2800 TCP-Port to connect to. Defaults to B<11211>.
2802 =item B<Socket> I<Path>
2804 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2805 setting is given, the B<Host> and B<Port> settings are ignored.
2809 =head2 Plugin C<mic>
2811 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2812 Intel's Many Integrated Core (MIC) systems.
2821 ShowTemperatures true
2824 IgnoreSelectedTemperature true
2829 IgnoreSelectedPower true
2832 The following options are valid inside the B<PluginE<nbsp>mic> block:
2836 =item B<ShowCPU> B<true>|B<false>
2838 If enabled (the default) a sum of the CPU usage across all cores is reported.
2840 =item B<ShowCPUCores> B<true>|B<false>
2842 If enabled (the default) per-core CPU usage is reported.
2844 =item B<ShowMemory> B<true>|B<false>
2846 If enabled (the default) the physical memory usage of the MIC system is
2849 =item B<ShowTemperatures> B<true>|B<false>
2851 If enabled (the default) various temperatures of the MIC system are reported.
2853 =item B<Temperature> I<Name>
2855 This option controls which temperatures are being reported. Whether matching
2856 temperatures are being ignored or I<only> matching temperatures are reported
2857 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2858 temperatures are reported.
2860 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2862 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2863 (the default) only temperatures matching a B<Temperature> option are reported
2864 or, if no B<Temperature> option is specified, all temperatures are reported. If
2865 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2868 Known temperature names are:
2902 =item B<ShowPower> B<true>|B<false>
2904 If enabled (the default) various temperatures of the MIC system are reported.
2906 =item B<Power> I<Name>
2908 This option controls which power readings are being reported. Whether matching
2909 power readings are being ignored or I<only> matching power readings are reported
2910 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2911 power readings are reported.
2913 =item B<IgnoreSelectedPower> B<false>|B<true>
2915 Controls the behavior of the B<Power> setting above. If set to B<false>
2916 (the default) only power readings matching a B<Power> option are reported
2917 or, if no B<Power> option is specified, all power readings are reported. If
2918 set to B<true>, matching power readings are I<ignored> and all other power readings
2921 Known power names are:
2927 Total power utilization averaged over Time Window 0 (uWatts).
2931 Total power utilization averaged over Time Window 0 (uWatts).
2935 Instantaneous power (uWatts).
2939 Max instantaneous power (uWatts).
2943 PCI-E connector power (uWatts).
2947 2x3 connector power (uWatts).
2951 2x4 connector power (uWatts).
2959 Uncore rail (uVolts).
2963 Memory subsystem rail (uVolts).
2969 =head2 Plugin C<memory>
2971 The I<memory plugin> provides the following configuration options:
2975 =item B<ValuesAbsolute> B<true>|B<false>
2977 Enables or disables reporting of physical memory usage in absolute numbers,
2978 i.e. bytes. Defaults to B<true>.
2980 =item B<ValuesPercentage> B<false>|B<true>
2982 Enables or disables reporting of physical memory usage in percentages, e.g.
2983 percent of physical memory used. Defaults to B<false>.
2985 This is useful for deploying I<collectd> in a heterogeneous environment in
2986 which the sizes of physical memory vary.
2990 =head2 Plugin C<modbus>
2992 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
2993 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
2994 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2995 values (two registers interpreted as IEEE floats in big endian notation).
2999 <Data "voltage-input-1">
3002 RegisterCmd ReadHolding
3007 <Data "voltage-input-2">
3010 RegisterCmd ReadHolding
3015 <Data "supply-temperature-1">
3018 RegisterCmd ReadHolding
3023 <Host "modbus.example.com">
3024 Address "192.168.0.42"
3029 Instance "power-supply"
3030 Collect "voltage-input-1"
3031 Collect "voltage-input-2"
3036 Device "/dev/ttyUSB0"
3041 Instance "temperature"
3042 Collect "supply-temperature-1"
3048 =item E<lt>B<Data> I<Name>E<gt> blocks
3050 Data blocks define a mapping between register numbers and the "types" used by
3053 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3057 =item B<RegisterBase> I<Number>
3059 Configures the base register to read from the device. If the option
3060 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3061 register will be read (the register number is increased by one).
3063 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3065 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3066 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3067 combined into one value. Defaults to B<Uint16>.
3069 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3071 Specifies register type to be collected from device. Works only with libmodbus
3072 2.9.2 or higher. Defaults to B<ReadHolding>.
3074 =item B<Type> I<Type>
3076 Specifies the "type" (data set) to use when dispatching the value to
3077 I<collectd>. Currently, only data sets with exactly one data source are
3080 =item B<Instance> I<Instance>
3082 Sets the type instance to use when dispatching the value to I<collectd>. If
3083 unset, an empty string (no type instance) is used.
3087 =item E<lt>B<Host> I<Name>E<gt> blocks
3089 Host blocks are used to specify to which hosts to connect and what data to read
3090 from their "slaves". The string argument I<Name> is used as hostname when
3091 dispatching the values to I<collectd>.
3093 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3097 =item B<Address> I<Hostname>
3099 For Modbus/TCP, specifies the node name (the actual network address) used to
3100 connect to the host. This may be an IP address or a hostname. Please note that
3101 the used I<libmodbus> library only supports IPv4 at the moment.
3103 =item B<Port> I<Service>
3105 for Modbus/TCP, specifies the port used to connect to the host. The port can
3106 either be given as a number or as a service name. Please note that the
3107 I<Service> argument must be a string, even if ports are given in their numerical
3108 form. Defaults to "502".
3110 =item B<Device> I<Devicenode>
3112 For Modbus/RTU, specifies the path to the serial device being used.
3114 =item B<Baudrate> I<Baudrate>
3116 For Modbus/RTU, specifies the baud rate of the serial device.
3117 Note, connections currently support only 8/N/1.
3119 =item B<Interval> I<Interval>
3121 Sets the interval (in seconds) in which the values will be collected from this
3122 host. By default the global B<Interval> setting will be used.
3124 =item E<lt>B<Slave> I<ID>E<gt>
3126 Over each connection, multiple Modbus devices may be reached. The slave ID
3127 is used to specify which device should be addressed. For each device you want
3128 to query, one B<Slave> block must be given.
3130 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3134 =item B<Instance> I<Instance>
3136 Specify the plugin instance to use when dispatching the values to I<collectd>.
3137 By default "slave_I<ID>" is used.
3139 =item B<Collect> I<DataName>
3141 Specifies which data to retrieve from the device. I<DataName> must be the same
3142 string as the I<Name> argument passed to a B<Data> block. You can specify this
3143 option multiple times to collect more than one value from a slave. At least one
3144 B<Collect> option is mandatory.
3152 =head2 Plugin C<mysql>
3154 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3155 one or more databases when started and keeps the connection up as long as
3156 possible. When the connection is interrupted for whatever reason it will try
3157 to re-connect. The plugin will complain loudly in case anything goes wrong.
3159 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3160 and collects information about MySQL network traffic, executed statements,
3161 requests, the query cache and threads by evaluating the
3162 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3163 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3164 Status Variables> for an explanation of these values.
3166 Optionally, master and slave statistics may be collected in a MySQL
3167 replication setup. In that case, information about the synchronization state
3168 of the nodes are collected by evaluating the C<Position> return value of the
3169 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3170 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3171 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3172 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3173 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3190 Socket "/var/run/mysql/mysqld.sock"
3192 SlaveNotifications true
3196 A B<Database> block defines one connection to a MySQL database. It accepts a
3197 single argument which specifies the name of the database. None of the other
3198 options are required. MySQL will use default values as documented in the
3199 section "mysql_real_connect()" in the B<MySQL reference manual>.
3203 =item B<Alias> I<Alias>
3205 Alias to use as sender instead of hostname when reporting. This may be useful
3206 when having cryptic hostnames.
3208 =item B<Host> I<Hostname>
3210 Hostname of the database server. Defaults to B<localhost>.
3212 =item B<User> I<Username>
3214 Username to use when connecting to the database. The user does not have to be
3215 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3216 unless you want to collectd replication statistics (see B<MasterStats> and
3217 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3218 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3220 =item B<Password> I<Password>
3222 Password needed to log into the database.
3224 =item B<Database> I<Database>
3226 Select this database. Defaults to I<no database> which is a perfectly reasonable
3227 option for what this plugin does.
3229 =item B<Port> I<Port>
3231 TCP-port to connect to. The port must be specified in its numeric form, but it
3232 must be passed as a string nonetheless. For example:
3236 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3237 See the documentation for the C<mysql_real_connect> function for details.
3239 =item B<Socket> I<Socket>
3241 Specifies the path to the UNIX domain socket of the MySQL server. This option
3242 only has any effect, if B<Host> is set to B<localhost> (the default).
3243 Otherwise, use the B<Port> option above. See the documentation for the
3244 C<mysql_real_connect> function for details.
3246 =item B<InnodbStats> I<true|false>
3248 If enabled, metrics about the InnoDB storage engine are collected.
3249 Disabled by default.
3251 =item B<MasterStats> I<true|false>
3253 =item B<SlaveStats> I<true|false>
3255 Enable the collection of master / slave statistics in a replication setup. In
3256 order to be able to get access to these statistics, the user needs special
3257 privileges. See the B<User> documentation above. Defaults to B<false>.
3259 =item B<SlaveNotifications> I<true|false>
3261 If enabled, the plugin sends a notification if the replication slave I/O and /
3262 or SQL threads are not running. Defaults to B<false>.
3264 =item B<ConnectTimeout> I<Seconds>
3266 Sets the connect timeout for the MySQL client.
3270 =head2 Plugin C<netapp>
3272 The netapp plugin can collect various performance and capacity information
3273 from a NetApp filer using the NetApp API.
3275 Please note that NetApp has a wide line of products and a lot of different
3276 software versions for each of these products. This plugin was developed for a
3277 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3278 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3279 model and software version but it is very hard to test this.
3280 If you have used this plugin with other models and/or software version, feel
3281 free to send us a mail to tell us about the results, even if it's just a short
3284 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3285 basic authentication.
3287 B<Do not use a regular user for this!> Create a special collectd user with just
3288 the minimum of capabilities needed. The user only needs the "login-http-admin"
3289 capability as well as a few more depending on which data will be collected.
3290 Required capabilities are documented below.
3295 <Host "netapp1.example.com">
3319 IgnoreSelectedIO false
3321 IgnoreSelectedOps false
3322 GetLatency "volume0"
3323 IgnoreSelectedLatency false
3330 IgnoreSelectedCapacity false
3333 IgnoreSelectedSnapshot false
3361 The netapp plugin accepts the following configuration options:
3365 =item B<Host> I<Name>
3367 A host block defines one NetApp filer. It will appear in collectd with the name
3368 you specify here which does not have to be its real name nor its hostname (see
3369 the B<Address> option below).
3371 =item B<VFiler> I<Name>
3373 A B<VFiler> block may only be used inside a host block. It accepts all the
3374 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3375 will execute all NetApp API commands in the context of the specified
3376 VFiler(R). It will appear in collectd with the name you specify here which
3377 does not have to be its real name. The VFiler name may be specified using the
3378 B<VFilerName> option. If this is not specified, it will default to the name
3381 The VFiler block inherits all connection related settings from the surrounding
3382 B<Host> block (which appear before the B<VFiler> block) but they may be
3383 overwritten inside the B<VFiler> block.
3385 This feature is useful, for example, when using a VFiler as SnapVault target
3386 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3387 available in the host filer (vfiler0) but only in the respective VFiler
3390 =item B<Protocol> B<httpd>|B<http>
3392 The protocol collectd will use to query this host.
3400 Valid options: http, https
3402 =item B<Address> I<Address>
3404 The hostname or IP address of the host.
3410 Default: The "host" block's name.
3412 =item B<Port> I<Port>
3414 The TCP port to connect to on the host.
3420 Default: 80 for protocol "http", 443 for protocol "https"
3422 =item B<User> I<User>
3424 =item B<Password> I<Password>
3426 The username and password to use to login to the NetApp.
3432 =item B<VFilerName> I<Name>
3434 The name of the VFiler in which context to execute API commands. If not
3435 specified, the name provided to the B<VFiler> block will be used instead.
3441 Default: name of the B<VFiler> block
3443 B<Note:> This option may only be used inside B<VFiler> blocks.
3445 =item B<Interval> I<Interval>
3451 The following options decide what kind of data will be collected. You can
3452 either use them as a block and fine tune various parameters inside this block,
3453 use them as a single statement to just accept all default values, or omit it to
3454 not collect any data.
3456 The following options are valid inside all blocks:
3460 =item B<Interval> I<Seconds>
3462 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3463 host specific setting.
3467 =head3 The System block
3469 This will collect various performance data about the whole system.
3471 B<Note:> To get this data the collectd user needs the
3472 "api-perf-object-get-instances" capability.
3476 =item B<Interval> I<Seconds>
3478 Collect disk statistics every I<Seconds> seconds.
3480 =item B<GetCPULoad> B<true>|B<false>
3482 If you set this option to true the current CPU usage will be read. This will be
3483 the average usage between all CPUs in your NetApp without any information about
3486 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3487 returns in the "CPU" field.
3495 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3497 =item B<GetInterfaces> B<true>|B<false>
3499 If you set this option to true the current traffic of the network interfaces
3500 will be read. This will be the total traffic over all interfaces of your NetApp
3501 without any information about individual interfaces.
3503 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3504 in the "Net kB/s" field.
3514 Result: One value list of type "if_octects".
3516 =item B<GetDiskIO> B<true>|B<false>
3518 If you set this option to true the current IO throughput will be read. This
3519 will be the total IO of your NetApp without any information about individual
3520 disks, volumes or aggregates.
3522 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3523 in the "DiskE<nbsp>kB/s" field.
3531 Result: One value list of type "disk_octets".
3533 =item B<GetDiskOps> B<true>|B<false>
3535 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3536 iSCSI, etc. operations will be read. This will be the total number of
3537 operations on your NetApp without any information about individual volumes or
3540 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3541 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3549 Result: A variable number of value lists of type "disk_ops_complex". Each type
3550 of operation will result in one value list with the name of the operation as
3555 =head3 The WAFL block
3557 This will collect various performance data about the WAFL file system. At the
3558 moment this just means cache performance.
3560 B<Note:> To get this data the collectd user needs the
3561 "api-perf-object-get-instances" capability.
3563 B<Note:> The interface to get these values is classified as "Diagnostics" by
3564 NetApp. This means that it is not guaranteed to be stable even between minor
3569 =item B<Interval> I<Seconds>
3571 Collect disk statistics every I<Seconds> seconds.
3573 =item B<GetNameCache> B<true>|B<false>
3581 Result: One value list of type "cache_ratio" and type instance
3584 =item B<GetDirCache> B<true>|B<false>
3592 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3594 =item B<GetInodeCache> B<true>|B<false>
3602 Result: One value list of type "cache_ratio" and type instance
3605 =item B<GetBufferCache> B<true>|B<false>
3607 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3608 in the "Cache hit" field.
3616 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3620 =head3 The Disks block
3622 This will collect performance data about the individual disks in the NetApp.
3624 B<Note:> To get this data the collectd user needs the
3625 "api-perf-object-get-instances" capability.
3629 =item B<Interval> I<Seconds>
3631 Collect disk statistics every I<Seconds> seconds.
3633 =item B<GetBusy> B<true>|B<false>
3635 If you set this option to true the busy time of all disks will be calculated
3636 and the value of the busiest disk in the system will be written.
3638 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3639 in the "Disk util" field. Probably.
3647 Result: One value list of type "percent" and type instance "disk_busy".
3651 =head3 The VolumePerf block
3653 This will collect various performance data about the individual volumes.
3655 You can select which data to collect about which volume using the following
3656 options. They follow the standard ignorelist semantic.
3658 B<Note:> To get this data the collectd user needs the
3659 I<api-perf-object-get-instances> capability.
3663 =item B<Interval> I<Seconds>
3665 Collect volume performance data every I<Seconds> seconds.
3667 =item B<GetIO> I<Volume>
3669 =item B<GetOps> I<Volume>
3671 =item B<GetLatency> I<Volume>
3673 Select the given volume for IO, operations or latency statistics collection.
3674 The argument is the name of the volume without the C</vol/> prefix.
3676 Since the standard ignorelist functionality is used here, you can use a string
3677 starting and ending with a slash to specify regular expression matching: To
3678 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3681 GetIO "/^vol[027]$/"
3683 If no regular expression is specified, an exact match is required. Both,
3684 regular and exact matching are case sensitive.
3686 If no volume was specified at all for either of the three options, that data
3687 will be collected for all available volumes.
3689 =item B<IgnoreSelectedIO> B<true>|B<false>
3691 =item B<IgnoreSelectedOps> B<true>|B<false>
3693 =item B<IgnoreSelectedLatency> B<true>|B<false>
3695 When set to B<true>, the volumes selected for IO, operations or latency
3696 statistics collection will be ignored and the data will be collected for all
3699 When set to B<false>, data will only be collected for the specified volumes and
3700 all other volumes will be ignored.
3702 If no volumes have been specified with the above B<Get*> options, all volumes
3703 will be collected regardless of the B<IgnoreSelected*> option.
3705 Defaults to B<false>
3709 =head3 The VolumeUsage block
3711 This will collect capacity data about the individual volumes.
3713 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3718 =item B<Interval> I<Seconds>
3720 Collect volume usage statistics every I<Seconds> seconds.
3722 =item B<GetCapacity> I<VolumeName>
3724 The current capacity of the volume will be collected. This will result in two
3725 to four value lists, depending on the configuration of the volume. All data
3726 sources are of type "df_complex" with the name of the volume as
3729 There will be type_instances "used" and "free" for the number of used and
3730 available bytes on the volume. If the volume has some space reserved for
3731 snapshots, a type_instance "snap_reserved" will be available. If the volume
3732 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3733 number of bytes saved by the SIS feature.
3735 B<Note:> The current NetApp API has a bug that results in this value being
3736 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3737 number which works most of the time. If you see strange values here, bug
3738 NetApp support to fix this.
3740 Repeat this option to specify multiple volumes.
3742 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3744 Specify whether to collect only the volumes selected by the B<GetCapacity>
3745 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3746 B<false>. However, if no B<GetCapacity> option is specified at all, all
3747 capacities will be selected anyway.
3749 =item B<GetSnapshot> I<VolumeName>
3751 Select volumes from which to collect snapshot information.
3753 Usually, the space used for snapshots is included in the space reported as
3754 "used". If snapshot information is collected as well, the space used for
3755 snapshots is subtracted from the used space.
3757 To make things even more interesting, it is possible to reserve space to be
3758 used for snapshots. If the space required for snapshots is less than that
3759 reserved space, there is "reserved free" and "reserved used" space in addition
3760 to "free" and "used". If the space required for snapshots exceeds the reserved
3761 space, that part allocated in the normal space is subtracted from the "used"
3764 Repeat this option to specify multiple volumes.
3766 =item B<IgnoreSelectedSnapshot>
3768 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3769 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3770 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3771 capacities will be selected anyway.
3775 =head3 The Quota block
3777 This will collect (tree) quota statistics (used disk space and number of used
3778 files). This mechanism is useful to get usage information for single qtrees.
3779 In case the quotas are not used for any other purpose, an entry similar to the
3780 following in C</etc/quotas> would be sufficient:
3782 /vol/volA/some_qtree tree - - - - -
3784 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3788 =item B<Interval> I<Seconds>
3790 Collect SnapVault(R) statistics every I<Seconds> seconds.
3794 =head3 The SnapVault block
3796 This will collect statistics about the time and traffic of SnapVault(R)
3801 =item B<Interval> I<Seconds>
3803 Collect SnapVault(R) statistics every I<Seconds> seconds.
3807 =head2 Plugin C<netlink>
3809 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3810 statistics of various interface and routing aspects.
3814 =item B<Interface> I<Interface>
3816 =item B<VerboseInterface> I<Interface>
3818 Instruct the plugin to collect interface statistics. This is basically the same
3819 as the statistics provided by the C<interface> plugin (see above) but
3820 potentially much more detailed.
3822 When configuring with B<Interface> only the basic statistics will be collected,
3823 namely octets, packets, and errors. These statistics are collected by
3824 the C<interface> plugin, too, so using both at the same time is no benefit.
3826 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3827 so that no data needs to be collected twice if you use the C<interface> plugin.
3828 This includes dropped packets, received multicast packets, collisions and a
3829 whole zoo of differentiated RX and TX errors. You can try the following command
3830 to get an idea of what awaits you:
3834 If I<Interface> is B<All>, all interfaces will be selected.
3836 =item B<QDisc> I<Interface> [I<QDisc>]
3838 =item B<Class> I<Interface> [I<Class>]
3840 =item B<Filter> I<Interface> [I<Filter>]
3842 Collect the octets and packets that pass a certain qdisc, class or filter.
3844 QDiscs and classes are identified by their type and handle (or classid).
3845 Filters don't necessarily have a handle, therefore the parent's handle is used.
3846 The notation used in collectd differs from that used in tc(1) in that it
3847 doesn't skip the major or minor number if it's zero and doesn't print special
3848 ids by their name. So, for example, a qdisc may be identified by
3849 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3850 thus not displayed by tc(1).
3852 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3853 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3854 associated with that interface will be collected.
3856 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3857 used. This may lead to problems when more than one filter is attached to a
3858 qdisc or class. This isn't nice, but we don't know how this could be done any
3859 better. If you have a idea, please don't hesitate to tell us.
3861 As with the B<Interface> option you can specify B<All> as the interface,
3862 meaning all interfaces.
3864 Here are some examples to help you understand the above text more easily:
3867 VerboseInterface "All"
3868 QDisc "eth0" "pfifo_fast-1:0"
3870 Class "ppp0" "htb-1:10"
3871 Filter "ppp0" "u32-1:0"
3874 =item B<IgnoreSelected>
3876 The behavior is the same as with all other similar plugins: If nothing is
3877 selected at all, everything is collected. If some things are selected using the
3878 options described above, only these statistics are collected. If you set
3879 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3880 specified statistics will not be collected.
3884 =head2 Plugin C<network>
3886 The Network plugin sends data to a remote instance of collectd, receives data
3887 from a remote instance, or both at the same time. Data which has been received
3888 from the network is usually not transmitted again, but this can be activated, see
3889 the B<Forward> option below.
3891 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3892 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3894 Both, B<Server> and B<Listen> can be used as single option or as block. When
3895 used as block, given options are valid for this socket only. The following
3896 example will export the metrics twice: Once to an "internal" server (without
3897 encryption and signing) and one to an external server (with cryptographic
3901 # Export to an internal server
3902 # (demonstrates usage without additional options)
3903 Server "collectd.internal.tld"
3905 # Export to an external server
3906 # (demonstrates usage with signature options)
3907 <Server "collectd.external.tld">
3908 SecurityLevel "sign"
3909 Username "myhostname"
3916 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3918 The B<Server> statement/block sets the server to send datagrams to. The
3919 statement may occur multiple times to send each datagram to multiple
3922 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3923 optional second argument specifies a port number or a service name. If not
3924 given, the default, B<25826>, is used.
3926 The following options are recognized within B<Server> blocks:
3930 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3932 Set the security you require for network communication. When the security level
3933 has been set to B<Encrypt>, data sent over the network will be encrypted using
3934 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3935 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3936 authentication code. When set to B<None>, data is sent without any security.
3938 This feature is only available if the I<network> plugin was linked with
3941 =item B<Username> I<Username>
3943 Sets the username to transmit. This is used by the server to lookup the
3944 password. See B<AuthFile> below. All security levels except B<None> require
3947 This feature is only available if the I<network> plugin was linked with
3950 =item B<Password> I<Password>
3952 Sets a password (shared secret) for this socket. All security levels except
3953 B<None> require this setting.
3955 This feature is only available if the I<network> plugin was linked with
3958 =item B<Interface> I<Interface name>
3960 Set the outgoing interface for IP packets. This applies at least
3961 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3962 undefined or a non-existent interface name is specified, the default
3963 behavior is to let the kernel choose the appropriate interface. Be warned
3964 that the manual selection of an interface for unicast traffic is only
3965 necessary in rare cases.
3967 =item B<ResolveInterval> I<Seconds>
3969 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
3970 useful to force a regular DNS lookup to support a high availability setup. If
3971 not specified, re-resolves are never attempted.
3975 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3977 The B<Listen> statement sets the interfaces to bind to. When multiple
3978 statements are found the daemon will bind to multiple interfaces.
3980 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3981 the argument is a multicast address the daemon will join that multicast group.
3982 The optional second argument specifies a port number or a service name. If not
3983 given, the default, B<25826>, is used.
3985 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3989 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3991 Set the security you require for network communication. When the security level
3992 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3993 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3994 signed and encrypted data is accepted. When set to B<None>, all data will be
3995 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3996 decrypted if possible.
3998 This feature is only available if the I<network> plugin was linked with
4001 =item B<AuthFile> I<Filename>
4003 Sets a file in which usernames are mapped to passwords. These passwords are
4004 used to verify signatures and to decrypt encrypted network packets. If
4005 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4006 verified and encrypted packets are decrypted. Otherwise, signed data is
4007 accepted without checking the signature and encrypted data cannot be decrypted.
4008 For the other security levels this option is mandatory.
4010 The file format is very simple: Each line consists of a username followed by a
4011 colon and any number of spaces followed by the password. To demonstrate, an
4012 example file could look like this:
4017 Each time a packet is received, the modification time of the file is checked
4018 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4019 the file is being read, it is locked using L<fcntl(2)>.
4021 =item B<Interface> I<Interface name>
4023 Set the incoming interface for IP packets explicitly. This applies at least
4024 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4025 undefined or a non-existent interface name is specified, the default
4026 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4027 traffic gets only accepted, if it arrives on the given interface.
4031 =item B<TimeToLive> I<1-255>
4033 Set the time-to-live of sent packets. This applies to all, unicast and
4034 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4035 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4038 =item B<MaxPacketSize> I<1024-65535>
4040 Set the maximum size for datagrams received over the network. Packets larger
4041 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4042 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4045 On the server side, this limit should be set to the largest value used on
4046 I<any> client. Likewise, the value on the client must not be larger than the
4047 value on the server, or data will be lost.
4049 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4050 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4051 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4054 =item B<Forward> I<true|false>
4056 If set to I<true>, write packets that were received via the network plugin to
4057 the sending sockets. This should only be activated when the B<Listen>- and
4058 B<Server>-statements differ. Otherwise packets may be send multiple times to
4059 the same multicast group. While this results in more network traffic than
4060 necessary it's not a huge problem since the plugin has a duplicate detection,
4061 so the values will not loop.
4063 =item B<ReportStats> B<true>|B<false>
4065 The network plugin cannot only receive and send statistics, it can also create
4066 statistics about itself. Collected data included the number of received and
4067 sent octets and packets, the length of the receive queue and the number of
4068 values handled. When set to B<true>, the I<Network plugin> will make these
4069 statistics available. Defaults to B<false>.
4073 =head2 Plugin C<nginx>
4075 This plugin collects the number of connections and requests handled by the
4076 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4077 queries the page provided by the C<ngx_http_stub_status_module> module, which
4078 isn't compiled by default. Please refer to
4079 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4080 how to compile and configure nginx and this module.
4082 The following options are accepted by the C<nginx plugin>:
4086 =item B<URL> I<http://host/nginx_status>
4088 Sets the URL of the C<ngx_http_stub_status_module> output.
4090 =item B<User> I<Username>
4092 Optional user name needed for authentication.
4094 =item B<Password> I<Password>
4096 Optional password needed for authentication.
4098 =item B<VerifyPeer> B<true|false>
4100 Enable or disable peer SSL certificate verification. See
4101 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4103 =item B<VerifyHost> B<true|false>
4105 Enable or disable peer host name verification. If enabled, the plugin checks
4106 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4107 certificate matches the host name provided by the B<URL> option. If this
4108 identity check fails, the connection is aborted. Obviously, only works when
4109 connecting to a SSL enabled server. Enabled by default.
4111 =item B<CACert> I<File>
4113 File that holds one or more SSL certificates. If you want to use HTTPS you will
4114 possibly need this option. What CA certificates come bundled with C<libcurl>
4115 and are checked by default depends on the distribution you use.
4117 =item B<Timeout> I<Milliseconds>
4119 The B<Timeout> option sets the overall timeout for HTTP requests, in
4120 milliseconds. By default, the configured B<Interval> is used to set the
4125 =head2 Plugin C<notify_desktop>
4127 This plugin sends a desktop notification to a notification daemon, as defined
4128 in the Desktop Notification Specification. To actually display the
4129 notifications, B<notification-daemon> is required and B<collectd> has to be
4130 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4131 environment variables have to be set correctly) and the D-Bus message bus.
4133 The Desktop Notification Specification can be found at
4134 L<http://www.galago-project.org/specs/notification/>.
4138 =item B<OkayTimeout> I<timeout>
4140 =item B<WarningTimeout> I<timeout>
4142 =item B<FailureTimeout> I<timeout>
4144 Set the I<timeout>, in milliseconds, after which to expire the notification
4145 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4146 been specified, the displayed notification will not be closed at all - the
4147 user has to do so herself. These options default to 5000. If a negative number
4148 has been specified, the default is used as well.
4152 =head2 Plugin C<notify_email>
4154 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4155 configured email address.
4157 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4159 Available configuration options:
4163 =item B<From> I<Address>
4165 Email address from which the emails should appear to come from.
4167 Default: C<root@localhost>
4169 =item B<Recipient> I<Address>
4171 Configures the email address(es) to which the notifications should be mailed.
4172 May be repeated to send notifications to multiple addresses.
4174 At least one B<Recipient> must be present for the plugin to work correctly.
4176 =item B<SMTPServer> I<Hostname>
4178 Hostname of the SMTP server to connect to.
4180 Default: C<localhost>
4182 =item B<SMTPPort> I<Port>
4184 TCP port to connect to.
4188 =item B<SMTPUser> I<Username>
4190 Username for ASMTP authentication. Optional.
4192 =item B<SMTPPassword> I<Password>
4194 Password for ASMTP authentication. Optional.
4196 =item B<Subject> I<Subject>
4198 Subject-template to use when sending emails. There must be exactly two
4199 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4200 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4203 Default: C<Collectd notify: %s@%s>
4207 =head2 Plugin C<ntpd>
4211 =item B<Host> I<Hostname>
4213 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4215 =item B<Port> I<Port>
4217 UDP-Port to connect to. Defaults to B<123>.
4219 =item B<ReverseLookups> B<true>|B<false>
4221 Sets whether or not to perform reverse lookups on peers. Since the name or
4222 IP-address may be used in a filename it is recommended to disable reverse
4223 lookups. The default is to do reverse lookups to preserve backwards
4224 compatibility, though.
4226 =item B<IncludeUnitID> B<true>|B<false>
4228 When a peer is a refclock, include the unit ID in the I<type instance>.
4229 Defaults to B<false> for backward compatibility.
4231 If two refclock peers use the same driver and this is B<false>, the plugin will
4232 try to write simultaneous measurements from both to the same type instance.
4233 This will result in error messages in the log and only one set of measurements
4238 =head2 Plugin C<nut>
4242 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4244 Add a UPS to collect data from. The format is identical to the one accepted by
4249 =head2 Plugin C<olsrd>
4251 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4252 the Optimized Link State Routing daemon and reads information about the current
4253 state of the meshed network.
4255 The following configuration options are understood:
4259 =item B<Host> I<Host>
4261 Connect to I<Host>. Defaults to B<"localhost">.
4263 =item B<Port> I<Port>
4265 Specifies the port to connect to. This must be a string, even if you give the
4266 port as a number rather than a service name. Defaults to B<"2006">.
4268 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4270 Specifies what information to collect about links, i.E<nbsp>e. direct
4271 connections of the daemon queried. If set to B<No>, no information is
4272 collected. If set to B<Summary>, the number of links and the average of all
4273 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4274 If set to B<Detail> LQ and NLQ are collected per link.
4276 Defaults to B<Detail>.
4278 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4280 Specifies what information to collect about routes of the daemon queried. If
4281 set to B<No>, no information is collected. If set to B<Summary>, the number of
4282 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4283 metric and ETX are collected per route.
4285 Defaults to B<Summary>.
4287 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4289 Specifies what information to collect about the global topology. If set to
4290 B<No>, no information is collected. If set to B<Summary>, the number of links
4291 in the entire topology and the average I<link quality> (LQ) is calculated.
4292 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4294 Defaults to B<Summary>.
4298 =head2 Plugin C<onewire>
4300 B<EXPERIMENTAL!> See notes below.
4302 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4303 L<http://owfs.org/> to read sensors connected via the onewire bus.
4305 It can be used in two possible modes - standard or advanced.
4307 In the standard mode only temperature sensors (sensors with the family code
4308 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4309 other sensors you would like to have included, please send a sort request to
4310 the mailing list. You can select sensors to be read or to be ignored depending
4311 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4312 walked and all sensors are read.
4314 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4315 experimental, below.
4317 In the advanced mode you can configure any sensor to be read (only numerical
4318 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4319 In this mode you have to list all the sensors. Neither default bus walk nor
4320 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4321 the path automatically and should produce compatible structure with the "standard"
4322 mode (basically the path is expected as for example
4323 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4324 "F10FCA000800" and the rest after the slash is considered the type - here
4326 There are two advantages to this mode - you can access virtually any sensor
4327 (not just temperature), select whether to use cached or directly read values
4328 and it is slighlty faster. The downside is more complex configuration.
4330 The two modes are distinguished automatically by the format of the address.
4331 It is not possible to mix the two modes. Once a full path is detected in any
4332 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4333 (and as standard addresses will fail parsing they will be ignored).
4337 =item B<Device> I<Device>
4339 Sets the device to read the values from. This can either be a "real" hardware
4340 device, such as a serial port or an USB port, or the address of the
4341 L<owserver(1)> socket, usually B<localhost:4304>.
4343 Though the documentation claims to automatically recognize the given address
4344 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4345 with that version, the following configuration worked for us:
4348 Device "-s localhost:4304"
4351 This directive is B<required> and does not have a default value.
4353 =item B<Sensor> I<Sensor>
4355 In the standard mode selects sensors to collect or to ignore
4356 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4357 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4358 and B<not> include the leading C<10.> family byte and point.
4359 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4360 sensors (see above) are read.
4362 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4363 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4364 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4366 As there can be multiple devices on the bus you can list multiple sensor (use
4367 multiple B<Sensor> elements).
4369 =item B<IgnoreSelected> I<true>|I<false>
4371 If no configuration is given, the B<onewire> plugin will collect data from all
4372 sensors found. This may not be practical, especially if sensors are added and
4373 removed regularly. Sometimes, however, it's easier/preferred to collect only
4374 specific sensors or all sensors I<except> a few specified ones. This option
4375 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4376 B<Sensor> is inverted: All selected interfaces are ignored and all other
4377 interfaces are collected.
4379 Used only in the standard mode - see above.
4381 =item B<Interval> I<Seconds>
4383 Sets the interval in which all sensors should be read. If not specified, the
4384 global B<Interval> setting is used.
4388 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4389 work with big setups. It works with one sensor being attached to one
4390 controller, but as soon as you throw in a couple more senors and maybe a hub
4391 or two, reading all values will take more than ten seconds (the default
4392 interval). We will probably add some separate thread for reading the sensors
4393 and some cache or something like that, but it's not done yet. We will try to
4394 maintain backwards compatibility in the future, but we can't promise. So in
4395 short: If it works for you: Great! But keep in mind that the config I<might>
4396 change, though this is unlikely. Oh, and if you want to help improving this
4397 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4399 =head2 Plugin C<openldap>
4401 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4402 server correctly. The backend database C<monitor> needs to be loaded and
4403 working. See slapd-monitor(5) for the details.
4405 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4406 blocks. Each block requires one string argument as the instance name. For
4411 URL "ldap://localhost/"
4414 URL "ldaps://localhost/"
4418 The instance name will be used as the I<plugin instance>. To emulate the old
4419 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4420 plugin to work correctly, each instance name must be unique. This is not
4421 enforced by the plugin and it is your responsibility to ensure it is.
4423 The following options are accepted within each B<Instance> block:
4427 =item B<URL> I<ldap://host/binddn>
4429 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4432 =item B<StartTLS> B<true|false>
4434 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4435 Disabled by default.
4437 =item B<VerifyHost> B<true|false>
4439 Enables or disables peer host name verification. If enabled, the plugin checks
4440 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4441 certificate matches the host name provided by the B<URL> option. If this
4442 identity check fails, the connection is aborted. Enabled by default.
4444 =item B<CACert> I<File>
4446 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4447 may possibly need this option. What CA certificates are checked by default
4448 depends on the distribution you use and can be changed with the usual ldap
4449 client configuration mechanisms. See ldap.conf(5) for the details.
4451 =item B<Timeout> I<Seconds>
4453 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4454 an infinite timeout.
4456 =item B<Version> I<Version>
4458 An integer which sets the LDAP protocol version number to use when connecting
4459 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4463 =head2 Plugin C<openvpn>
4465 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4466 traffic statistics about connected clients.
4468 To set up OpenVPN to write to the status file periodically, use the
4469 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4470 you need to set the required format, too. This is done by setting
4471 B<--status-version> to B<2>.
4473 So, in a nutshell you need:
4475 openvpn $OTHER_OPTIONS \
4476 --status "/var/run/openvpn-status" 10 \
4483 =item B<StatusFile> I<File>
4485 Specifies the location of the status file.
4487 =item B<ImprovedNamingSchema> B<true>|B<false>
4489 When enabled, the filename of the status file will be used as plugin instance
4490 and the client's "common name" will be used as type instance. This is required
4491 when reading multiple status files. Enabling this option is recommended, but to
4492 maintain backwards compatibility this option is disabled by default.
4494 =item B<CollectCompression> B<true>|B<false>
4496 Sets whether or not statistics about the compression used by OpenVPN should be
4497 collected. This information is only available in I<single> mode. Enabled by
4500 =item B<CollectIndividualUsers> B<true>|B<false>
4502 Sets whether or not traffic information is collected for each connected client
4503 individually. If set to false, currently no traffic data is collected at all
4504 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4506 =item B<CollectUserCount> B<true>|B<false>
4508 When enabled, the number of currently connected clients or users is collected.
4509 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4510 can be configured independently from that option. Defaults to B<false>.
4514 =head2 Plugin C<oracle>
4516 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4517 Oracle® Database and lets you execute SQL statements there. It is very similar
4518 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4519 plugin's documentation above for details.
4522 <Query "out_of_stock">
4523 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4526 # InstancePrefix "foo"
4527 InstancesFrom "category"
4531 <Database "product_information">
4535 Query "out_of_stock"
4539 =head3 B<Query> blocks
4541 The Query blocks are handled identically to the Query blocks of the "dbi"
4542 plugin. Please see its documentation above for details on how to specify
4545 =head3 B<Database> blocks
4547 Database blocks define a connection to a database and which queries should be
4548 sent to that database. Each database needs a "name" as string argument in the
4549 starting tag of the block. This name will be used as "PluginInstance" in the
4550 values submitted to the daemon. Other than that, that name is not used.
4554 =item B<ConnectID> I<ID>
4556 Defines the "database alias" or "service name" to connect to. Usually, these
4557 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4559 =item B<Host> I<Host>
4561 Hostname to use when dispatching values for this database. Defaults to using
4562 the global hostname of the I<collectd> instance.
4564 =item B<Username> I<Username>
4566 Username used for authentication.
4568 =item B<Password> I<Password>
4570 Password used for authentication.
4572 =item B<Query> I<QueryName>
4574 Associates the query named I<QueryName> with this database connection. The
4575 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4576 blocks you want to refer to must be placed above the database block you want to
4581 =head2 Plugin C<perl>
4583 This plugin embeds a Perl-interpreter into collectd and provides an interface
4584 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4586 =head2 Plugin C<pinba>
4588 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4589 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4590 PHP-based webpage has been delivered, the extension will send a UDP packet
4591 containing timing information, peak memory usage and so on. The plugin will
4592 wait for such packets, parse them and account the provided information, which
4593 is then dispatched to the daemon once per interval.
4600 # Overall statistics for the website.
4602 Server "www.example.com"
4604 # Statistics for www-a only
4606 Host "www-a.example.com"
4607 Server "www.example.com"
4609 # Statistics for www-b only
4611 Host "www-b.example.com"
4612 Server "www.example.com"
4616 The plugin provides the following configuration options:
4620 =item B<Address> I<Node>
4622 Configures the address used to open a listening socket. By default, plugin will
4623 bind to the I<any> address C<::0>.
4625 =item B<Port> I<Service>
4627 Configures the port (service) to bind to. By default the default Pinba port
4628 "30002" will be used. The option accepts service names in addition to port
4629 numbers and thus requires a I<string> argument.
4631 =item E<lt>B<View> I<Name>E<gt> block
4633 The packets sent by the Pinba extension include the hostname of the server, the
4634 server name (the name of the virtual host) and the script that was executed.
4635 Using B<View> blocks it is possible to separate the data into multiple groups
4636 to get more meaningful statistics. Each packet is added to all matching groups,
4637 so that a packet may be accounted for more than once.
4641 =item B<Host> I<Host>
4643 Matches the hostname of the system the webserver / script is running on. This
4644 will contain the result of the L<gethostname(2)> system call. If not
4645 configured, all hostnames will be accepted.
4647 =item B<Server> I<Server>
4649 Matches the name of the I<virtual host>, i.e. the contents of the
4650 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4651 server names will be accepted.
4653 =item B<Script> I<Script>
4655 Matches the name of the I<script name>, i.e. the contents of the
4656 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4657 script names will be accepted.
4663 =head2 Plugin C<ping>
4665 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4666 configured hosts periodically and measures the network latency. Whenever the
4667 C<read> function of the plugin is called, it submits the average latency, the
4668 standard deviation and the drop rate for each host.
4670 Available configuration options:
4674 =item B<Host> I<IP-address>
4676 Host to ping periodically. This option may be repeated several times to ping
4679 =item B<Interval> I<Seconds>
4681 Sets the interval in which to send ICMP echo packets to the configured hosts.
4682 This is B<not> the interval in which statistics are queries from the plugin but
4683 the interval in which the hosts are "pinged". Therefore, the setting here
4684 should be smaller than or equal to the global B<Interval> setting. Fractional
4685 times, such as "1.24" are allowed.
4689 =item B<Timeout> I<Seconds>
4691 Time to wait for a response from the host to which an ICMP packet had been
4692 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4693 to be down or the packet to be dropped. This setting must be smaller than the
4694 B<Interval> setting above for the plugin to work correctly. Fractional
4695 arguments are accepted.
4699 =item B<TTL> I<0-255>
4701 Sets the Time-To-Live of generated ICMP packets.
4703 =item B<SourceAddress> I<host>
4705 Sets the source address to use. I<host> may either be a numerical network
4706 address or a network hostname.
4708 =item B<Device> I<name>
4710 Sets the outgoing network device to be used. I<name> has to specify an
4711 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4714 =item B<MaxMissed> I<Packets>
4716 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4717 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4719 Default: B<-1> (disabled)
4723 =head2 Plugin C<postgresql>
4725 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4726 keeps a persistent connection to all configured databases and tries to
4727 reconnect if the connection has been interrupted. A database is configured by
4728 specifying a B<Database> block as described below. The default statistics are
4729 collected from PostgreSQL's B<statistics collector> which thus has to be
4730 enabled for this plugin to work correctly. This should usually be the case by
4731 default. See the section "The Statistics Collector" of the B<PostgreSQL
4732 Documentation> for details.
4734 By specifying custom database queries using a B<Query> block as described
4735 below, you may collect any data that is available from some PostgreSQL
4736 database. This way, you are able to access statistics of external daemons
4737 which are available in a PostgreSQL database or use future or special
4738 statistics provided by PostgreSQL without the need to upgrade your collectd
4741 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4742 PostgreSQL databases as well. This has been implemented in a generic way. You
4743 need to specify an SQL statement which will then be executed by collectd in
4744 order to write the data (see below for details). The benefit of that approach
4745 is that there is no fixed database layout. Rather, the layout may be optimized
4746 for the current setup.
4748 The B<PostgreSQL Documentation> manual can be found at
4749 L<http://www.postgresql.org/docs/manuals/>.
4753 Statement "SELECT magic FROM wizard WHERE host = $1;"
4757 InstancePrefix "magic"
4762 <Query rt36_tickets>
4763 Statement "SELECT COUNT(type) AS count, type \
4765 WHEN resolved = 'epoch' THEN 'open' \
4766 ELSE 'resolved' END AS type \
4767 FROM tickets) type \
4771 InstancePrefix "rt36_tickets"
4772 InstancesFrom "type"
4778 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4788 KRBSrvName "kerberos_service_name"
4794 Service "service_name"
4795 Query backend # predefined
4806 The B<Query> block defines one database query which may later be used by a
4807 database definition. It accepts a single mandatory argument which specifies
4808 the name of the query. The names of all queries have to be unique (see the
4809 B<MinVersion> and B<MaxVersion> options below for an exception to this
4810 rule). The following configuration options are available to define the query:
4812 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4813 blocks define how to handle the values returned from the query. They define
4814 which column holds which value and how to dispatch that value to the daemon.
4815 Multiple B<Result> blocks may be used to extract multiple values from a single
4820 =item B<Statement> I<sql query statement>
4822 Specify the I<sql query statement> which the plugin should execute. The string
4823 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4824 first, second, etc. parameter. The value of the parameters is specified by the
4825 B<Param> configuration option - see below for details. To include a literal
4826 B<$> character followed by a number, surround it with single quotes (B<'>).
4828 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4829 allowed. Note, however, that only a single command may be used. Semicolons are
4830 allowed as long as a single non-empty command has been specified only.
4832 The returned lines will be handled separately one after another.
4834 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4836 Specify the parameters which should be passed to the SQL query. The parameters
4837 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4838 they appear in the configuration file. The value of the parameter is
4839 determined depending on the value of the B<Param> option as follows:
4845 The configured hostname of the database connection. If a UNIX domain socket is
4846 used, the parameter expands to "localhost".
4850 The name of the database of the current connection.
4854 The name of the database plugin instance. See the B<Instance> option of the
4855 database specification below for details.
4859 The username used to connect to the database.
4863 The interval with which this database is queried (as specified by the database
4864 specific or global B<Interval> options).
4868 Please note that parameters are only supported by PostgreSQL's protocol
4869 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4871 =item B<Type> I<type>
4873 The I<type> name to be used when dispatching the values. The type describes
4874 how to handle the data and where to store it. See L<types.db(5)> for more
4875 details on types and their configuration. The number and type of values (as
4876 selected by the B<ValuesFrom> option) has to match the type of the given name.
4878 This option is required inside a B<Result> block.
4880 =item B<InstancePrefix> I<prefix>
4882 =item B<InstancesFrom> I<column0> [I<column1> ...]
4884 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4885 B<InstancePrefix> defines a static prefix that will be prepended to all type
4886 instances. B<InstancesFrom> defines the column names whose values will be used
4887 to create the type instance. Multiple values will be joined together using the
4888 hyphen (C<->) as separation character.
4890 The plugin itself does not check whether or not all built instances are
4891 different. It is your responsibility to assure that each is unique.
4893 Both options are optional. If none is specified, the type instance will be
4896 =item B<ValuesFrom> I<column0> [I<column1> ...]
4898 Names the columns whose content is used as the actual data for the data sets
4899 that are dispatched to the daemon. How many such columns you need is
4900 determined by the B<Type> setting as explained above. If you specify too many
4901 or not enough columns, the plugin will complain about that and no data will be
4902 submitted to the daemon.
4904 The actual data type, as seen by PostgreSQL, is not that important as long as
4905 it represents numbers. The plugin will automatically cast the values to the
4906 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4907 L<strtod(3)> functions, so anything supported by those functions is supported
4908 by the plugin as well.
4910 This option is required inside a B<Result> block and may be specified multiple
4911 times. If multiple B<ValuesFrom> options are specified, the columns are read
4914 =item B<MinVersion> I<version>
4916 =item B<MaxVersion> I<version>
4918 Specify the minimum or maximum version of PostgreSQL that this query should be
4919 used with. Some statistics might only be available with certain versions of
4920 PostgreSQL. This allows you to specify multiple queries with the same name but
4921 which apply to different versions, thus allowing you to use the same
4922 configuration in a heterogeneous environment.
4924 The I<version> has to be specified as the concatenation of the major, minor
4925 and patch-level versions, each represented as two-decimal-digit numbers. For
4926 example, version 8.2.3 will become 80203.
4930 The following predefined queries are available (the definitions can be found
4931 in the F<postgresql_default.conf> file which, by default, is available at
4932 C<I<prefix>/share/collectd/>):
4938 This query collects the number of backends, i.E<nbsp>e. the number of
4941 =item B<transactions>
4943 This query collects the numbers of committed and rolled-back transactions of
4948 This query collects the numbers of various table modifications (i.E<nbsp>e.
4949 insertions, updates, deletions) of the user tables.
4951 =item B<query_plans>
4953 This query collects the numbers of various table scans and returned tuples of
4956 =item B<table_states>
4958 This query collects the numbers of live and dead rows in the user tables.
4962 This query collects disk block access counts for user tables.
4966 This query collects the on-disk size of the database in bytes.
4970 In addition, the following detailed queries are available by default. Please
4971 note that each of those queries collects information B<by table>, thus,
4972 potentially producing B<a lot> of data. For details see the description of the
4973 non-by_table queries above.
4977 =item B<queries_by_table>
4979 =item B<query_plans_by_table>
4981 =item B<table_states_by_table>
4983 =item B<disk_io_by_table>
4987 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4988 mandatory argument specifying the name of the writer. This will then be used
4989 in the B<Database> specification in order to activate the writer instance. The
4990 names of all writers have to be unique. The following options may be
4995 =item B<Statement> I<sql statement>
4997 This mandatory option specifies the SQL statement that will be executed for
4998 each submitted value. A single SQL statement is allowed only. Anything after
4999 the first semicolon will be ignored.
5001 Nine parameters will be passed to the statement and should be specified as
5002 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5003 values are made available through those parameters:
5009 The timestamp of the queried value as a floating point number.
5013 The hostname of the queried value.
5017 The plugin name of the queried value.
5021 The plugin instance of the queried value. This value may be B<NULL> if there
5022 is no plugin instance.
5026 The type of the queried value (cf. L<types.db(5)>).
5030 The type instance of the queried value. This value may be B<NULL> if there is
5035 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5036 sources of the submitted value-list).
5040 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5041 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5042 B<StoreRates> is enabled (which is the default, see below), all types will be
5047 An array of the submitted values. The dimensions of the value name and value
5052 In general, it is advisable to create and call a custom function in the
5053 PostgreSQL database for this purpose. Any procedural language supported by
5054 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5057 =item B<StoreRates> B<false>|B<true>
5059 If set to B<true> (the default), convert counter values to rates. If set to
5060 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5065 The B<Database> block defines one PostgreSQL database for which to collect
5066 statistics. It accepts a single mandatory argument which specifies the
5067 database name. None of the other options are required. PostgreSQL will use
5068 default values as documented in the section "CONNECTING TO A DATABASE" in the
5069 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5070 the user collectd is run as and special environment variables. See the manpage
5075 =item B<Interval> I<seconds>
5077 Specify the interval with which the database should be queried. The default is
5078 to use the global B<Interval> setting.
5080 =item B<CommitInterval> I<seconds>
5082 This option may be used for database connections which have "writers" assigned
5083 (see above). If specified, it causes a writer to put several updates into a
5084 single transaction. This transaction will last for the specified amount of
5085 time. By default, each update will be executed in a separate transaction. Each
5086 transaction generates a fair amount of overhead which can, thus, be reduced by
5087 activating this option. The draw-back is, that data covering the specified
5088 amount of time will be lost, for example, if a single statement within the
5089 transaction fails or if the database server crashes.
5091 =item B<Host> I<hostname>
5093 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5094 value begins with a slash, it is interpreted as the directory name in which to
5095 look for the UNIX domain socket.
5097 This option is also used to determine the hostname that is associated with a
5098 collected data set. If it has been omitted or either begins with with a slash
5099 or equals B<localhost> it will be replaced with the global hostname definition
5100 of collectd. Any other value will be passed literally to collectd when
5101 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5103 =item B<Port> I<port>
5105 Specify the TCP port or the local UNIX domain socket file extension of the
5108 =item B<User> I<username>
5110 Specify the username to be used when connecting to the server.
5112 =item B<Password> I<password>
5114 Specify the password to be used when connecting to the server.
5116 =item B<ExpireDelay> I<delay>
5118 Skip expired values in query output.
5120 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5122 Specify whether to use an SSL connection when contacting the server. The
5123 following modes are supported:
5129 Do not use SSL at all.
5133 First, try to connect without using SSL. If that fails, try using SSL.
5135 =item I<prefer> (default)
5137 First, try to connect using SSL. If that fails, try without using SSL.
5145 =item B<Instance> I<name>
5147 Specify the plugin instance name that should be used instead of the database
5148 name (which is the default, if this option has not been specified). This
5149 allows to query multiple databases of the same name on the same host (e.g.
5150 when running multiple database server versions in parallel).
5152 =item B<KRBSrvName> I<kerberos_service_name>
5154 Specify the Kerberos service name to use when authenticating with Kerberos 5
5155 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5156 B<PostgreSQL Documentation> for details.
5158 =item B<Service> I<service_name>
5160 Specify the PostgreSQL service name to use for additional parameters. That
5161 service has to be defined in F<pg_service.conf> and holds additional
5162 connection parameters. See the section "The Connection Service File" in the
5163 B<PostgreSQL Documentation> for details.
5165 =item B<Query> I<query>
5167 Specifies a I<query> which should be executed in the context of the database
5168 connection. This may be any of the predefined or user-defined queries. If no
5169 such option is given, it defaults to "backends", "transactions", "queries",
5170 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5171 has been specified). Else, the specified queries are used only.
5173 =item B<Writer> I<writer>
5175 Assigns the specified I<writer> backend to the database connection. This
5176 causes all collected data to be send to the database using the settings
5177 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5178 below for details on how to selectively send data to certain plugins).
5180 Each writer will register a flush callback which may be used when having long
5181 transactions enabled (see the B<CommitInterval> option above). When issuing
5182 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5183 transaction will be committed right away. Two different kinds of flush
5184 callbacks are available with the C<postgresql> plugin:
5190 Flush all writer backends.
5192 =item B<postgresql->I<database>
5194 Flush all writers of the specified I<database> only.
5200 =head2 Plugin C<powerdns>
5202 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5203 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5204 values, many of which are probably meaningless to most users, but may be useful
5205 for some. So you may chose which values to collect, but if you don't, some
5206 reasonable defaults will be collected.
5209 <Server "server_name">
5211 Collect "udp-answers" "udp-queries"
5212 Socket "/var/run/pdns.controlsocket"
5214 <Recursor "recursor_name">
5216 Collect "cache-hits" "cache-misses"
5217 Socket "/var/run/pdns_recursor.controlsocket"
5219 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5224 =item B<Server> and B<Recursor> block
5226 The B<Server> block defines one authoritative server to query, the B<Recursor>
5227 does the same for an recursing server. The possible options in both blocks are
5228 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5233 =item B<Collect> I<Field>
5235 Using the B<Collect> statement you can select which values to collect. Here,
5236 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5237 C<dlg-only-drops>, C<answers10-100>.
5239 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5240 When querying the server a C<SHOW *> command is issued in any case, because
5241 that's the only way of getting multiple values out of the server at once.
5242 collectd then picks out the values you have selected. When querying the
5243 recursor, a command is generated to query exactly these values. So if you
5244 specify invalid fields when querying the recursor, a syntax error may be
5245 returned by the daemon and collectd may not collect any values at all.
5247 If no B<Collect> statement is given, the following B<Server> values will be
5254 =item packetcache-hit
5256 =item packetcache-miss
5258 =item packetcache-size
5260 =item query-cache-hit
5262 =item query-cache-miss
5264 =item recursing-answers
5266 =item recursing-questions
5278 The following B<Recursor> values will be collected by default:
5282 =item noerror-answers
5284 =item nxdomain-answers
5286 =item servfail-answers
5304 Please note that up to that point collectd doesn't know what values are
5305 available on the server and values that are added do not need a change of the
5306 mechanism so far. However, the values must be mapped to collectd's naming
5307 scheme, which is done using a lookup table that lists all known values. If
5308 values are added in the future and collectd does not know about them, you will
5309 get an error much like this:
5311 powerdns plugin: submit: Not found in lookup table: foobar = 42
5313 In this case please file a bug report with the collectd team.
5315 =item B<Socket> I<Path>
5317 Configures the path to the UNIX domain socket to be used when connecting to the
5318 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5319 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5320 will be used for the recursor.
5324 =item B<LocalSocket> I<Path>
5326 Querying the recursor is done using UDP. When using UDP over UNIX domain
5327 sockets, the client socket needs a name in the file system, too. You can set
5328 this local name to I<Path> using the B<LocalSocket> option. The default is
5329 C<I<prefix>/var/run/collectd-powerdns>.
5333 =head2 Plugin C<processes>
5337 =item B<Process> I<Name>
5339 Select more detailed statistics of processes matching this name. The statistics
5340 collected for these selected processes are size of the resident segment size
5341 (RSS), user- and system-time used, number of processes and number of threads,
5342 io data (where available) and minor and major pagefaults.
5344 =item B<ProcessMatch> I<name> I<regex>
5346 Similar to the B<Process> option this allows to select more detailed
5347 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5348 details). The statistics of all matching processes are summed up and
5349 dispatched to the daemon using the specified I<name> as an identifier. This
5350 allows to "group" several processes together. I<name> must not contain
5355 =head2 Plugin C<protocols>
5357 Collects a lot of information about various network protocols, such as I<IP>,
5358 I<TCP>, I<UDP>, etc.
5360 Available configuration options:
5364 =item B<Value> I<Selector>
5366 Selects whether or not to select a specific value. The string being matched is
5367 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5368 plugin instance and I<ValueName> will be used as type instance. An example of
5369 the string being used would be C<Tcp:RetransSegs>.
5371 You can use regular expressions to match a large number of values with just one
5372 configuration option. To select all "extended" I<TCP> values, you could use the
5373 following statement:
5377 Whether only matched values are selected or all matched values are ignored
5378 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5379 If no value is configured at all, all values will be selected.
5381 =item B<IgnoreSelected> B<true>|B<false>
5383 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5384 matching values will be ignored.
5388 =head2 Plugin C<python>
5390 This plugin embeds a Python-interpreter into collectd and provides an interface
5391 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5393 =head2 Plugin C<routeros>
5395 The C<routeros> plugin connects to a device running I<RouterOS>, the
5396 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5397 I<librouteros> to connect and reads information about the interfaces and
5398 wireless connections of the device. The configuration supports querying
5403 Host "router0.example.com"
5406 CollectInterface true
5411 Host "router1.example.com"
5414 CollectInterface true
5415 CollectRegistrationTable true
5421 As you can see above, the configuration of the I<routeros> plugin consists of
5422 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5423 options are understood:
5427 =item B<Host> I<Host>
5429 Hostname or IP-address of the router to connect to.
5431 =item B<Port> I<Port>
5433 Port name or port number used when connecting. If left unspecified, the default
5434 will be chosen by I<librouteros>, currently "8728". This option expects a
5435 string argument, even when a numeric port number is given.
5437 =item B<User> I<User>
5439 Use the user name I<User> to authenticate. Defaults to "admin".
5441 =item B<Password> I<Password>
5443 Set the password used to authenticate.
5445 =item B<CollectInterface> B<true>|B<false>
5447 When set to B<true>, interface statistics will be collected for all interfaces
5448 present on the device. Defaults to B<false>.
5450 =item B<CollectRegistrationTable> B<true>|B<false>
5452 When set to B<true>, information about wireless LAN connections will be
5453 collected. Defaults to B<false>.
5455 =item B<CollectCPULoad> B<true>|B<false>
5457 When set to B<true>, information about the CPU usage will be collected. The
5458 number is a dimensionless value where zero indicates no CPU usage at all.
5459 Defaults to B<false>.
5461 =item B<CollectMemory> B<true>|B<false>
5463 When enabled, the amount of used and free memory will be collected. How used
5464 memory is calculated is unknown, for example whether or not caches are counted
5466 Defaults to B<false>.
5468 =item B<CollectDF> B<true>|B<false>
5470 When enabled, the amount of used and free disk space will be collected.
5471 Defaults to B<false>.
5473 =item B<CollectDisk> B<true>|B<false>
5475 When enabled, the number of sectors written and bad blocks will be collected.
5476 Defaults to B<false>.
5480 =head2 Plugin C<redis>
5482 The I<Redis plugin> connects to one or more Redis servers and gathers
5483 information about each server's state. For each server there is a I<Node> block
5484 which configures the connection parameters for this node.
5491 <Query "LLEN myqueue">
5498 The information shown in the synopsis above is the I<default configuration>
5499 which is used by the plugin if no configuration is present.
5503 =item B<Node> I<Nodename>
5505 The B<Node> block identifies a new Redis node, that is a new Redis instance
5506 running in an specified host and port. The name for node is a canonical
5507 identifier which is used as I<plugin instance>. It is limited to
5508 64E<nbsp>characters in length.
5510 =item B<Host> I<Hostname>
5512 The B<Host> option is the hostname or IP-address where the Redis instance is
5515 =item B<Port> I<Port>
5517 The B<Port> option is the TCP port on which the Redis instance accepts
5518 connections. Either a service name of a port number may be given. Please note
5519 that numerical port numbers must be given as a string, too.
5521 =item B<Password> I<Password>
5523 Use I<Password> to authenticate when connecting to I<Redis>.
5525 =item B<Timeout> I<Timeout in miliseconds>
5527 The B<Timeout> option set the socket timeout for node response. Since the Redis
5528 read function is blocking, you should keep this value as low as possible. Keep
5529 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5530 than B<Interval> defined globally.
5532 =item B<Query> I<Querystring>
5534 The B<Query> block identifies a query to execute against the redis server.
5535 There may be an arbitrary number of queries to execute.
5537 =item B<Type> I<Collectd type>
5539 Within a query definition, a valid collectd type to use as when submitting
5540 the result of the query. When not supplied, will default to B<gauge>.
5542 =item B<Instance> I<Type instance>
5544 Within a query definition, an optional type instance to use when submitting
5545 the result of the query. When not supplied will default to the escaped
5546 command, up to 64 chars.
5550 =head2 Plugin C<rrdcached>
5552 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5553 to store values to RRD files in an efficient manner. The combination of the
5554 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5555 way the C<rrdtool> plugin works (see below). The added abstraction layer
5556 provides a number of benefits, though: Because the cache is not within
5557 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5558 restarted. This results in much shorter (if any) gaps in graphs, especially
5559 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5560 daemon so that it can flush values to disk automatically when needed. This
5561 allows to integrate automated flushing of values into graphing solutions much
5564 There are disadvantages, though: The daemon may reside on a different host, so
5565 it may not be possible for C<collectd> to create the appropriate RRD files
5566 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5567 different base directory, so relative paths may do weird stuff if you're not
5570 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5571 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5572 setting should be set to an absolute path, so that a changed base directory
5573 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5577 =item B<DaemonAddress> I<Address>
5579 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5580 library. See L<rrdcached(1)> for details. Example:
5582 <Plugin "rrdcached">
5583 DaemonAddress "unix:/var/run/rrdcached.sock"
5586 =item B<DataDir> I<Directory>
5588 Set the base directory in which the RRD files reside. If this is a relative
5589 path, it is relative to the working base directory of the C<rrdcached> daemon!
5590 Use of an absolute path is recommended.
5592 =item B<CreateFiles> B<true>|B<false>
5594 Enables or disables the creation of RRD files. If the daemon is not running
5595 locally, or B<DataDir> is set to a relative path, this will not work as
5596 expected. Default is B<true>.
5598 =item B<CreateFilesAsync> B<false>|B<true>
5600 When enabled, new RRD files are enabled asynchronously, using a separate thread
5601 that runs in the background. This prevents writes to block, which is a problem
5602 especially when many hundreds of files need to be created at once. However,
5603 since the purpose of creating the files asynchronously is I<not> to block until
5604 the file is available, values before the file is available will be discarded.
5605 When disabled (the default) files are created synchronously, blocking for a
5606 short while, while the file is being written.
5608 =item B<StepSize> I<Seconds>
5610 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5611 this setting is unset and the stepsize is set to the interval in which the data
5612 is collected. Do not use this option unless you absolutely have to for some
5613 reason. Setting this option may cause problems with the C<snmp plugin>, the
5614 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5616 =item B<HeartBeat> I<Seconds>
5618 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5619 in which case the heartbeat is set to twice the B<StepSize> which should equal
5620 the interval in which data is collected. Do not set this option unless you have
5621 a very good reason to do so.
5623 =item B<RRARows> I<NumRows>
5625 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5626 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5627 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5628 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5629 week, one month, and one year.
5631 So for each timespan, it calculates how many PDPs need to be consolidated into
5632 one CDP by calculating:
5633 number of PDPs = timespan / (stepsize * rrarows)
5635 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5638 =item B<RRATimespan> I<Seconds>
5640 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5641 more then one RRA. If this option is never used, the built-in default of (3600,
5642 86400, 604800, 2678400, 31622400) is used.
5644 For more information on how RRA-sizes are calculated see B<RRARows> above.
5646 =item B<XFF> I<Factor>
5648 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5649 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5652 =item B<CollectStatistics> B<false>|B<true>
5654 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5655 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5657 Statistics are read via I<rrdcached>s socket using the STATS command.
5658 See L<rrdcached(1)> for details.
5662 =head2 Plugin C<rrdtool>
5664 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5665 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5666 using these settings. If you don't want to dive into the depths of RRDtool, you
5667 can safely ignore these settings.
5671 =item B<DataDir> I<Directory>
5673 Set the directory to store RRD files under. By default RRD files are generated
5674 beneath the daemon's working directory, i.e. the B<BaseDir>.
5676 =item B<CreateFilesAsync> B<false>|B<true>
5678 When enabled, new RRD files are enabled asynchronously, using a separate thread
5679 that runs in the background. This prevents writes to block, which is a problem
5680 especially when many hundreds of files need to be created at once. However,
5681 since the purpose of creating the files asynchronously is I<not> to block until
5682 the file is available, values before the file is available will be discarded.
5683 When disabled (the default) files are created synchronously, blocking for a
5684 short while, while the file is being written.
5686 =item B<StepSize> I<Seconds>
5688 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5689 this setting is unset and the stepsize is set to the interval in which the data
5690 is collected. Do not use this option unless you absolutely have to for some
5691 reason. Setting this option may cause problems with the C<snmp plugin>, the
5692 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5694 =item B<HeartBeat> I<Seconds>
5696 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5697 in which case the heartbeat is set to twice the B<StepSize> which should equal
5698 the interval in which data is collected. Do not set this option unless you have
5699 a very good reason to do so.
5701 =item B<RRARows> I<NumRows>
5703 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5704 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5705 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5706 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5707 week, one month, and one year.
5709 So for each timespan, it calculates how many PDPs need to be consolidated into
5710 one CDP by calculating:
5711 number of PDPs = timespan / (stepsize * rrarows)
5713 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5716 =item B<RRATimespan> I<Seconds>
5718 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5719 more then one RRA. If this option is never used, the built-in default of (3600,
5720 86400, 604800, 2678400, 31622400) is used.
5722 For more information on how RRA-sizes are calculated see B<RRARows> above.
5724 =item B<XFF> I<Factor>
5726 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5727 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5730 =item B<CacheFlush> I<Seconds>
5732 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5733 it writes all values for a certain RRD-file if the oldest value is older than
5734 (or equal to) the number of seconds specified. If some RRD-file is not updated
5735 anymore for some reason (the computer was shut down, the network is broken,
5736 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5737 entire cache is searched for entries older than B<CacheTimeout> seconds and
5738 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5739 does nothing under normal circumstances, this value should not be too small.
5740 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5741 normally do much harm either.
5743 =item B<CacheTimeout> I<Seconds>
5745 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5746 save values in a cache, as described above. Writing multiple values at once
5747 reduces IO-operations and thus lessens the load produced by updating the files.
5748 The trade off is that the graphs kind of "drag behind" and that more memory is
5751 =item B<WritesPerSecond> I<Updates>
5753 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5754 will run serious performance problems. The B<CacheFlush> setting and the
5755 internal update queue assert that collectd continues to work just fine even
5756 under heavy load, but the system may become very unresponsive and slow. This is
5757 a problem especially if you create graphs from the RRD files on the same
5758 machine, for example using the C<graph.cgi> script included in the
5759 C<contrib/collection3/> directory.
5761 This setting is designed for very large setups. Setting this option to a value
5762 between 25 and 80 updates per second, depending on your hardware, will leave
5763 the server responsive enough to draw graphs even while all the cached values
5764 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5765 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5766 written as fast as possible, so that web frontends have up to date data when
5769 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5770 updates per second, writing all values to disk will take approximately
5771 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5772 "collection3" you'll end up with a responsive and fast system, up to date
5773 graphs and basically a "backup" of your values every hour.
5775 =item B<RandomTimeout> I<Seconds>
5777 When set, the actual timeout for each value is chosen randomly between
5778 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5779 intention is to avoid high load situations that appear when many values timeout
5780 at the same time. This is especially a problem shortly after the daemon starts,
5781 because all values were added to the internal cache at roughly the same time.
5785 =head2 Plugin C<sensors>
5787 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5788 that all the needed modules have to be loaded and lm_sensors has to be
5789 configured (most likely by editing F</etc/sensors.conf>. Read
5790 L<sensors.conf(5)> for details.
5792 The B<lm_sensors> homepage can be found at
5793 L<http://secure.netroedge.com/~lm78/>.
5797 =item B<SensorConfigFile> I<File>
5799 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5800 the library's default will be used.
5802 =item B<Sensor> I<chip-bus-address/type-feature>
5804 Selects the name of the sensor which you want to collect or ignore, depending
5805 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5806 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5807 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5809 =item B<IgnoreSelected> I<true>|I<false>
5811 If no configuration if given, the B<sensors>-plugin will collect data from all
5812 sensors. This may not be practical, especially for uninteresting sensors.
5813 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5814 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5815 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5816 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5817 and all other sensors are collected.
5821 =head2 Plugin C<sigrok>
5823 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5824 supported by the L<sigrok|http://sigrok.org/> project.
5830 <Device "AC Voltage">
5835 <Device "Sound Level">
5836 Driver "cem-dt-885x"
5843 =item B<LogLevel> B<0-5>
5845 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5846 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5847 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5848 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5849 their level, are always submitted to I<collectd> at its INFO log level.
5851 =item E<lt>B<Device> I<Name>E<gt>
5853 A sigrok-supported device, uniquely identified by this section's options. The
5854 I<Name> is passed to I<collectd> as the I<plugin instance>.
5856 =item B<Driver> I<DriverName>
5858 The sigrok driver to use for this device.
5860 =item B<Conn> I<ConnectionSpec>
5862 If the device cannot be auto-discovered, or more than one might be discovered
5863 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5864 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5865 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5866 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5867 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5869 =item B<SerialComm> I<SerialSpec>
5871 For serial devices with non-standard port settings, this option can be used
5872 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5873 This should not be necessary; drivers know how to communicate with devices they
5876 =item B<MinimumInterval> I<Seconds>
5878 Specifies the minimum time between measurement dispatches to I<collectd>, in
5879 seconds. Since some I<sigrok> supported devices can acquire measurements many
5880 times per second, it may be necessary to throttle these. For example, the
5881 I<RRD plugin> cannot process writes more than once per second.
5883 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5884 device are always dispatched to I<collectd>. When throttled, unused
5885 measurements are discarded.
5889 =head2 Plugin C<smart>
5891 The C<smart> plugin collects SMART information from physical
5892 disks. Values collectd include temperature, power cycle count, poweron
5893 time and bad sectors. Also, all SMART attributes are collected along
5894 with the normalized current value, the worst value, the threshold and
5895 a human readable value.
5897 Using the following two options you can ignore some disks or configure the
5898 collection only of specific disks.
5902 =item B<Disk> I<Name>
5904 Select the disk I<Name>. Whether it is collected or ignored depends on the
5905 B<IgnoreSelected> setting, see below. As with other plugins that use the
5906 daemon's ignorelist functionality, a string that starts and ends with a slash
5907 is interpreted as a regular expression. Examples:
5912 =item B<IgnoreSelected> B<true>|B<false>
5914 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
5915 statements, are ignored or if all other disks are ignored. The behavior
5916 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
5917 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
5918 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
5919 is set to B<true>, all disks are collected B<except> the ones matched.
5923 =head2 Plugin C<snmp>
5925 Since the configuration of the C<snmp plugin> is a little more complicated than
5926 other plugins, its documentation has been moved to an own manpage,
5927 L<collectd-snmp(5)>. Please see there for details.
5929 =head2 Plugin C<statsd>
5931 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5932 protocol and dispatches rates or other aggregates of these numbers
5935 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5936 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5937 C<objects> respectively.
5939 The following configuration options are valid:
5943 =item B<Host> I<Host>
5945 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5946 "any" address, i.e. accept packets sent to any of the hosts addresses.
5948 =item B<Port> I<Port>
5950 UDP port to listen to. This can be either a service name or a port number.
5951 Defaults to C<8125>.
5953 =item B<DeleteCounters> B<false>|B<true>
5955 =item B<DeleteTimers> B<false>|B<true>
5957 =item B<DeleteGauges> B<false>|B<true>
5959 =item B<DeleteSets> B<false>|B<true>
5961 These options control what happens if metrics are not updated in an interval.
5962 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5963 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5964 are unchanged. If set to B<True>, the such metrics are not dispatched and
5965 removed from the internal cache.
5967 =item B<TimerPercentile> I<Percent>
5969 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5970 that I<Percent> of all reported timers are smaller than or equal to the
5971 computed latency. This is useful for cutting off the long tail latency, as it's
5972 often done in I<Service Level Agreements> (SLAs).
5974 Different percentiles can be calculated by setting this option several times.
5975 If none are specified, no percentiles are calculated / dispatched.
5977 =item B<TimerLower> B<false>|B<true>
5979 =item B<TimerUpper> B<false>|B<true>
5981 =item B<TimerSum> B<false>|B<true>
5983 =item B<TimerCount> B<false>|B<true>
5985 Calculate and dispatch various values out of I<Timer> metrics received during
5986 an interval. If set to B<False>, the default, these values aren't calculated /
5991 =head2 Plugin C<swap>
5993 The I<Swap plugin> collects information about used and available swap space. On
5994 I<Linux> and I<Solaris>, the following options are available:
5998 =item B<ReportByDevice> B<false>|B<true>
6000 Configures how to report physical swap devices. If set to B<false> (the
6001 default), the summary over all swap devices is reported only, i.e. the globally
6002 used and available space over all devices. If B<true> is configured, the used
6003 and available space of each device will be reported separately.
6005 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6006 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6008 =item B<ReportBytes> B<false>|B<true>
6010 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6011 I<swap I/O> is reported in pages. This option is available under Linux only.
6013 =item B<ValuesAbsolute> B<true>|B<false>
6015 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6016 available and used. Defaults to B<true>.
6018 =item B<ValuesPercentage> B<false>|B<true>
6020 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6021 available and free. Defaults to B<false>.
6023 This is useful for deploying I<collectd> in a heterogeneous environment, where
6024 swap sizes differ and you want to specify generic thresholds or similar.
6028 =head2 Plugin C<syslog>
6032 =item B<LogLevel> B<debug|info|notice|warning|err>
6034 Sets the log-level. If, for example, set to B<notice>, then all events with
6035 severity B<notice>, B<warning>, or B<err> will be submitted to the
6038 Please note that B<debug> is only available if collectd has been compiled with
6041 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6043 Controls which notifications should be sent to syslog. The default behaviour is
6044 not to send any. Less severe notifications always imply logging more severe
6045 notifications: Setting this to B<OKAY> means all notifications will be sent to
6046 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6047 notifications but will dismiss B<OKAY> notifications. Setting this option to
6048 B<FAILURE> will only send failures to syslog.
6052 =head2 Plugin C<table>
6054 The C<table plugin> provides generic means to parse tabular data and dispatch
6055 user specified values. Values are selected based on column numbers. For
6056 example, this plugin may be used to get values from the Linux L<proc(5)>
6057 filesystem or CSV (comma separated values) files.
6060 <Table "/proc/slabinfo">
6065 InstancePrefix "active_objs"
6071 InstancePrefix "objperslab"
6078 The configuration consists of one or more B<Table> blocks, each of which
6079 configures one file to parse. Within each B<Table> block, there are one or
6080 more B<Result> blocks, which configure which data to select and how to
6083 The following options are available inside a B<Table> block:
6087 =item B<Instance> I<instance>
6089 If specified, I<instance> is used as the plugin instance. So, in the above
6090 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6091 filename of the table is used instead, with all special characters replaced
6092 with an underscore (C<_>).
6094 =item B<Separator> I<string>
6096 Any character of I<string> is interpreted as a delimiter between the different
6097 columns of the table. A sequence of two or more contiguous delimiters in the
6098 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6099 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6100 of a table - see its documentation for more details. This option is mandatory.
6102 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6103 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6104 required because of collectd's config parsing.
6108 The following options are available inside a B<Result> block:
6112 =item B<Type> I<type>
6114 Sets the type used to dispatch the values to the daemon. Detailed information
6115 about types and their configuration can be found in L<types.db(5)>. This
6116 option is mandatory.
6118 =item B<InstancePrefix> I<prefix>
6120 If specified, prepend I<prefix> to the type instance. If omitted, only the
6121 B<InstancesFrom> option is considered for the type instance.
6123 =item B<InstancesFrom> I<column0> [I<column1> ...]
6125 If specified, the content of the given columns (identified by the column
6126 number starting at zero) will be used to create the type instance for each
6127 row. Multiple values (and the instance prefix) will be joined together with
6128 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6129 option is considered for the type instance.
6131 The plugin itself does not check whether or not all built instances are
6132 different. It’s your responsibility to assure that each is unique. This is
6133 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6134 sure that the table only contains one row.
6136 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6139 =item B<ValuesFrom> I<column0> [I<column1> ...]
6141 Specifies the columns (identified by the column numbers starting at zero)
6142 whose content is used as the actual data for the data sets that are dispatched
6143 to the daemon. How many such columns you need is determined by the B<Type>
6144 setting above. If you specify too many or not enough columns, the plugin will
6145 complain about that and no data will be submitted to the daemon. The plugin
6146 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6147 respectively, so anything supported by those functions is supported by the
6148 plugin as well. This option is mandatory.
6152 =head2 Plugin C<tail>
6154 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6155 each line and dispatches found values. What is matched can be configured by the
6156 user using (extended) regular expressions, as described in L<regex(7)>.
6159 <File "/var/log/exim4/mainlog">
6163 Regex "S=([1-9][0-9]*)"
6169 Regex "\\<R=local_user\\>"
6170 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6173 Instance "local_user"
6178 The config consists of one or more B<File> blocks, each of which configures one
6179 logfile to parse. Within each B<File> block, there are one or more B<Match>
6180 blocks, which configure a regular expression to search for.
6182 The B<Instance> option in the B<File> block may be used to set the plugin
6183 instance. So in the above example the plugin name C<tail-foo> would be used.
6184 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6185 next B<Instance> option. This way you can extract several plugin instances from
6186 one logfile, handy when parsing syslog and the like.
6188 The B<Interval> option allows you to define the length of time between reads. If
6189 this is not set, the default Interval will be used.
6191 Each B<Match> block has the following options to describe how the match should
6196 =item B<Regex> I<regex>
6198 Sets the regular expression to use for matching against a line. The first
6199 subexpression has to match something that can be turned into a number by
6200 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6201 below. Because B<extended> regular expressions are used, you do not need to use
6202 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6203 collectd's config parsing you need to escape backslashes, though. So if you
6204 want to match literal parentheses you need to do the following:
6206 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6208 =item B<ExcludeRegex> I<regex>
6210 Sets an optional regular expression to use for excluding lines from the match.
6211 An example which excludes all connections from localhost from the match:
6213 ExcludeRegex "127\\.0\\.0\\.1"
6215 =item B<DSType> I<Type>
6217 Sets how the values are cumulated. I<Type> is one of:
6221 =item B<GaugeAverage>
6223 Calculate the average.
6227 Use the smallest number only.
6231 Use the greatest number only.
6235 Use the last number found.
6241 =item B<AbsoluteSet>
6243 The matched number is a counter. Simply I<sets> the internal counter to this
6244 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6252 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6253 matched number may be negative, which will effectively subtract from the
6262 Increase the internal counter by one. These B<DSType> are the only ones that do
6263 not use the matched subexpression, but simply count the number of matched
6264 lines. Thus, you may use a regular expression without submatch in this case.
6268 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6269 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6270 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6271 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6272 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6275 =item B<Type> I<Type>
6277 Sets the type used to dispatch this value. Detailed information about types and
6278 their configuration can be found in L<types.db(5)>.
6280 =item B<Instance> I<TypeInstance>
6282 This optional setting sets the type instance to use.
6286 =head2 Plugin C<tail_csv>
6288 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6289 written by I<Snort>.
6294 <Metric "snort-dropped">
6299 <File "/var/log/snort/snort.stats">
6300 Instance "snort-eth0"
6302 Collect "snort-dropped"
6306 The configuration consists of one or more B<Metric> blocks that define an index
6307 into the line of the CSV file and how this value is mapped to I<collectd's>
6308 internal representation. These are followed by one or more B<Instance> blocks
6309 which configure which file to read, in which interval and which metrics to
6314 =item E<lt>B<Metric> I<Name>E<gt>
6316 The B<Metric> block configures a new metric to be extracted from the statistics
6317 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6318 only used inside the B<Instance> blocks to refer to this block, so you can use
6319 one B<Metric> block for multiple CSV files.
6323 =item B<Type> I<Type>
6325 Configures which I<Type> to use when dispatching this metric. Types are defined
6326 in the L<types.db(5)> file, see the appropriate manual page for more
6327 information on specifying types. Only types with a single I<data source> are
6328 supported by the I<tail_csv plugin>. The information whether the value is an
6329 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6330 I<Type's> definition.
6332 =item B<Instance> I<TypeInstance>
6334 If set, I<TypeInstance> is used to populate the type instance field of the
6335 created value lists. Otherwise, no type instance is used.
6337 =item B<ValueFrom> I<Index>
6339 Configure to read the value from the field with the zero-based index I<Index>.
6340 If the value is parsed as signed integer, unsigned integer or double depends on
6341 the B<Type> setting, see above.
6345 =item E<lt>B<File> I<Path>E<gt>
6347 Each B<File> block represents one CSV file to read. There must be at least one
6348 I<File> block but there can be multiple if you have multiple CSV files.
6352 =item B<Instance> I<PluginInstance>
6354 Sets the I<plugin instance> used when dispatching the values.
6356 =item B<Collect> I<Metric>
6358 Specifies which I<Metric> to collect. This option must be specified at least
6359 once, and you can use this option multiple times to specify more than one
6360 metric to be extracted from this statistic file.
6362 =item B<Interval> I<Seconds>
6364 Configures the interval in which to read values from this instance / file.
6365 Defaults to the plugin's default interval.
6367 =item B<TimeFrom> I<Index>
6369 Rather than using the local time when dispatching a value, read the timestamp
6370 from the field with the zero-based index I<Index>. The value is interpreted as
6371 seconds since epoch. The value is parsed as a double and may be factional.
6377 =head2 Plugin C<teamspeak2>
6379 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6380 polls interesting global and virtual server data. The plugin can query only one
6381 physical server but unlimited virtual servers. You can use the following
6382 options to configure it:
6386 =item B<Host> I<hostname/ip>
6388 The hostname or ip which identifies the physical server.
6391 =item B<Port> I<port>
6393 The query port of the physical server. This needs to be a string.
6396 =item B<Server> I<port>
6398 This option has to be added once for every virtual server the plugin should
6399 query. If you want to query the virtual server on port 8767 this is what the
6400 option would look like:
6404 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6405 use quotes around it! If no such statement is given only global information
6410 =head2 Plugin C<ted>
6412 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6413 measure power consumption. These devices are usually connected to a serial
6414 (RS232) or USB port. The plugin opens a configured device and tries to read the
6415 current energy readings. For more information on TED, visit
6416 L<http://www.theenergydetective.com/>.
6418 Available configuration options:
6422 =item B<Device> I<Path>
6424 Path to the device on which TED is connected. collectd will need read and write
6425 permissions on that file.
6427 Default: B</dev/ttyUSB0>
6429 =item B<Retries> I<Num>
6431 Apparently reading from TED is not that reliable. You can therefore configure a
6432 number of retries here. You only configure the I<retries> here, to if you
6433 specify zero, one reading will be performed (but no retries if that fails); if
6434 you specify three, a maximum of four readings are performed. Negative values
6441 =head2 Plugin C<tcpconns>
6443 The C<tcpconns plugin> counts the number of currently established TCP
6444 connections based on the local port and/or the remote port. Since there may be
6445 a lot of connections the default if to count all connections with a local port,
6446 for which a listening socket is opened. You can use the following options to
6447 fine-tune the ports you are interested in:
6451 =item B<ListeningPorts> I<true>|I<false>
6453 If this option is set to I<true>, statistics for all local ports for which a
6454 listening socket exists are collected. The default depends on B<LocalPort> and
6455 B<RemotePort> (see below): If no port at all is specifically selected, the
6456 default is to collect listening ports. If specific ports (no matter if local or
6457 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6458 the selected ports will be collected unless this option is set to I<true>
6461 =item B<LocalPort> I<Port>
6463 Count the connections to a specific local port. This can be used to see how
6464 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6465 You have to specify the port in numeric form, so for the mailserver example
6466 you'd need to set B<25>.
6468 =item B<RemotePort> I<Port>
6470 Count the connections to a specific remote port. This is useful to see how
6471 much a remote service is used. This is most useful if you want to know how many
6472 connections a local service has opened to remote services, e.E<nbsp>g. how many
6473 connections a mail server or news server has to other mail or news servers, or
6474 how many connections a web proxy holds to web servers. You have to give the
6475 port in numeric form.
6477 =item B<AllPortsSummary> I<true>|I<false>
6479 If this option is set to I<true> a summary of statistics from all connections
6480 are collectd. This option defaults to I<false>.
6484 =head2 Plugin C<thermal>
6488 =item B<ForceUseProcfs> I<true>|I<false>
6490 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6491 C<sysfs> interface. If that is not available, the plugin falls back to the
6492 C<procfs> interface. By setting this option to I<true>, you can force the
6493 plugin to use the latter. This option defaults to I<false>.
6495 =item B<Device> I<Device>
6497 Selects the name of the thermal device that you want to collect or ignore,
6498 depending on the value of the B<IgnoreSelected> option. This option may be
6499 used multiple times to specify a list of devices.
6501 =item B<IgnoreSelected> I<true>|I<false>
6503 Invert the selection: If set to true, all devices B<except> the ones that
6504 match the device names specified by the B<Device> option are collected. By
6505 default only selected devices are collected if a selection is made. If no
6506 selection is configured at all, B<all> devices are selected.
6510 =head2 Plugin C<threshold>
6512 The I<Threshold plugin> checks values collected or received by I<collectd>
6513 against a configurable I<threshold> and issues I<notifications> if values are
6516 Documentation for this plugin is available in the L<collectd-threshold(5)>
6519 =head2 Plugin C<tokyotyrant>
6521 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6522 couple metrics: number of records, and database size on disk.
6526 =item B<Host> I<Hostname/IP>
6528 The hostname or ip which identifies the server.
6529 Default: B<127.0.0.1>
6531 =item B<Port> I<Service/Port>
6533 The query port of the server. This needs to be a string, even if the port is
6534 given in its numeric form.
6539 =head2 Plugin C<unixsock>
6543 =item B<SocketFile> I<Path>
6545 Sets the socket-file which is to be created.
6547 =item B<SocketGroup> I<Group>
6549 If running as root change the group of the UNIX-socket after it has been
6550 created. Defaults to B<collectd>.
6552 =item B<SocketPerms> I<Permissions>
6554 Change the file permissions of the UNIX-socket after it has been created. The
6555 permissions must be given as a numeric, octal value as you would pass to
6556 L<chmod(1)>. Defaults to B<0770>.
6558 =item B<DeleteSocket> B<false>|B<true>
6560 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6561 with the given name already exists. If I<collectd> crashes a socket file may be
6562 left over, preventing the daemon from opening a new socket when restarted.
6563 Since this is potentially dangerous, this defaults to B<false>.
6567 =head2 Plugin C<uuid>
6569 This plugin, if loaded, causes the Hostname to be taken from the machine's
6570 UUID. The UUID is a universally unique designation for the machine, usually
6571 taken from the machine's BIOS. This is most useful if the machine is running in
6572 a virtual environment such as Xen, in which case the UUID is preserved across
6573 shutdowns and migration.
6575 The following methods are used to find the machine's UUID, in order:
6581 Check I</etc/uuid> (or I<UUIDFile>).
6585 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6590 Check for UUID from C<dmidecode> / SMBIOS.
6594 Check for UUID from Xen hypervisor.
6598 If no UUID can be found then the hostname is not modified.
6602 =item B<UUIDFile> I<Path>
6604 Take the UUID from the given file (default I</etc/uuid>).
6608 =head2 Plugin C<varnish>
6610 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6611 It collects a subset of the values displayed by L<varnishstat(1)>, and
6612 organizes them in categories which can be enabled or disabled. Currently only
6613 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6614 meaning of each metric can be found in L<varnish-counters(7)>.
6619 <Instance "example">
6623 CollectConnections true
6624 CollectDirectorDNS false
6628 CollectObjects false
6630 CollectSession false
6640 CollectWorkers false
6644 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6645 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6646 will collectd statistics from the default "varnishd" instance (this should work
6647 fine in most cases).
6649 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6653 =item B<CollectBackend> B<true>|B<false>
6655 Back-end connection statistics, such as successful, reused,
6656 and closed connections. True by default.
6658 =item B<CollectBan> B<true>|B<false>
6660 Statistics about ban operations, such as number of bans added, retired, and
6661 number of objects tested against ban operations. Only available with Varnish
6662 3.x and above. False by default.
6664 =item B<CollectCache> B<true>|B<false>
6666 Cache hits and misses. True by default.
6668 =item B<CollectConnections> B<true>|B<false>
6670 Number of client connections received, accepted and dropped. True by default.
6672 =item B<CollectDirectorDNS> B<true>|B<false>
6674 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6677 =item B<CollectESI> B<true>|B<false>
6679 Edge Side Includes (ESI) parse statistics. False by default.
6681 =item B<CollectFetch> B<true>|B<false>
6683 Statistics about fetches (HTTP requests sent to the backend). False by default.
6685 =item B<CollectHCB> B<true>|B<false>
6687 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6688 divided into locked and unlocked look-ups. False by default.
6690 =item B<CollectObjects> B<true>|B<false>
6692 Statistics on cached objects: number of objects expired, nuked (prematurely
6693 expired), saved, moved, etc. False by default.
6695 =item B<CollectPurge> B<true>|B<false>
6697 Statistics about purge operations, such as number of purges added, retired, and
6698 number of objects tested against purge operations. Only available with Varnish
6699 2.x. False by default.
6701 =item B<CollectSession> B<true>|B<false>
6703 Client session statistics. Number of past and current sessions, session herd and
6704 linger counters, etc. False by default. Note that if using Varnish 4.x, some
6705 metrics found in the Connections and Threads sections with previous versions of
6706 Varnish have been moved here.
6708 =item B<CollectSHM> B<true>|B<false>
6710 Statistics about the shared memory log, a memory region to store
6711 log messages which is flushed to disk when full. True by default.
6713 =item B<CollectSMA> B<true>|B<false>
6715 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6716 component is Solaris specific. Only available with Varnish 2.x. False by
6719 =item B<CollectSMS> B<true>|B<false>
6721 synth (synthetic content) storage statistics. This storage
6722 component is used internally only. False by default.
6724 =item B<CollectSM> B<true>|B<false>
6726 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6729 =item B<CollectStruct> B<true>|B<false>
6731 Current varnish internal state statistics. Number of current sessions, objects
6732 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6735 =item B<CollectTotals> B<true>|B<false>
6737 Collects overview counters, such as the number of sessions created,
6738 the number of requests and bytes transferred. False by default.
6740 =item B<CollectUptime> B<true>|B<false>
6742 Varnish uptime. Only available with Varnish 3.x and above. False by default.
6744 =item B<CollectVCL> B<true>|B<false>
6746 Number of total (available + discarded) VCL (config files). False by default.
6748 =item B<CollectVSM> B<true>|B<false>
6750 Collect statistics about Varnish's shared memory usage (used by the logging and
6751 statistics subsystems). Only available with Varnish 4.x. False by default.
6753 =item B<CollectWorkers> B<true>|B<false>
6755 Collect statistics about worker threads. False by default.
6759 =head2 Plugin C<virt>
6761 This plugin allows CPU, disk and network load to be collected for virtualized
6762 guests on the machine. This means that these metrics can be collected for guest
6763 systems without installing any software on them - I<collectd> only runs on the
6764 host system. The statistics are collected through libvirt
6765 (L<http://libvirt.org/>).
6767 Only I<Connection> is required.
6771 =item B<Connection> I<uri>
6773 Connect to the hypervisor given by I<uri>. For example if using Xen use:
6775 Connection "xen:///"
6777 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
6779 =item B<RefreshInterval> I<seconds>
6781 Refresh the list of domains and devices every I<seconds>. The default is 60
6782 seconds. Setting this to be the same or smaller than the I<Interval> will cause
6783 the list of domains and devices to be refreshed on every iteration.
6785 Refreshing the devices in particular is quite a costly operation, so if your
6786 virtualization setup is static you might consider increasing this. If this
6787 option is set to 0, refreshing is disabled completely.
6789 =item B<Domain> I<name>
6791 =item B<BlockDevice> I<name:dev>
6793 =item B<InterfaceDevice> I<name:dev>
6795 =item B<IgnoreSelected> B<true>|B<false>
6797 Select which domains and devices are collected.
6799 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
6800 disk/network devices are collected.
6802 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
6803 domains and disk/network devices are ignored, while the rest are collected.
6805 The domain name and device names may use a regular expression, if the name is
6806 surrounded by I</.../> and collectd was compiled with support for regexps.
6808 The default is to collect statistics for all domains and all their devices.
6812 BlockDevice "/:hdb/"
6813 IgnoreSelected "true"
6815 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
6818 =item B<HostnameFormat> B<name|uuid|hostname|...>
6820 When the virt plugin logs data, it sets the hostname of the collected data
6821 according to this setting. The default is to use the guest name as provided by
6822 the hypervisor, which is equal to setting B<name>.
6824 B<uuid> means use the guest's UUID. This is useful if you want to track the
6825 same guest across migrations.
6827 B<hostname> means to use the global B<Hostname> setting, which is probably not
6828 useful on its own because all guests will appear to have the same name.
6830 You can also specify combinations of these fields. For example B<name uuid>
6831 means to concatenate the guest name and UUID (with a literal colon character
6832 between, thus I<"foo:1234-1234-1234-1234">).
6834 =item B<InterfaceFormat> B<name>|B<address>
6836 When the virt plugin logs interface data, it sets the name of the collected
6837 data according to this setting. The default is to use the path as provided by
6838 the hypervisor (the "dev" property of the target node), which is equal to
6841 B<address> means use the interface's mac address. This is useful since the
6842 interface path might change between reboots of a guest or across migrations.
6844 =item B<PluginInstanceFormat> B<name|uuid>
6846 When the virt plugin logs data, it sets the plugin_instance of the collected
6847 data according to this setting. The default is to use the guest name as provided
6848 by the hypervisor, which is equal to setting B<name>.
6850 B<uuid> means use the guest's UUID.
6854 =head2 Plugin C<vmem>
6856 The C<vmem> plugin collects information about the usage of virtual memory.
6857 Since the statistics provided by the Linux kernel are very detailed, they are
6858 collected very detailed. However, to get all the details, you have to switch
6859 them on manually. Most people just want an overview over, such as the number of
6860 pages read from swap space.
6864 =item B<Verbose> B<true>|B<false>
6866 Enables verbose collection of information. This will start collecting page
6867 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6868 Part of these statistics are collected on a "per zone" basis.
6872 =head2 Plugin C<vserver>
6874 This plugin doesn't have any options. B<VServer> support is only available for
6875 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6876 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6877 need to apply the patches and compile your own kernel, which will then provide
6878 the F</proc/virtual> filesystem that is required by this plugin.
6880 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6882 B<Note>: The traffic collected by this plugin accounts for the amount of
6883 traffic passing a socket which might be a lot less than the actual on-wire
6884 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6885 collect on-wire traffic you could, for example, use the logging facilities of
6886 iptables to feed data for the guest IPs into the iptables plugin.
6888 =head2 Plugin C<write_graphite>
6890 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6891 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6892 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6893 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6894 of at most 1428 bytes to minimize the number of network packets.
6898 <Plugin write_graphite>
6908 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6909 blocks. Inside the B<Node> blocks, the following options are recognized:
6913 =item B<Host> I<Address>
6915 Hostname or address to connect to. Defaults to C<localhost>.
6917 =item B<Port> I<Service>
6919 Service name or port number to connect to. Defaults to C<2003>.
6921 =item B<Protocol> I<String>
6923 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6925 =item B<LogSendErrors> B<false>|B<true>
6927 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6928 If set to B<false>, it will not log the errors. This is especially useful when
6929 using Protocol UDP since many times we want to use the "fire-and-forget"
6930 approach and logging errors fills syslog with unneeded messages.
6932 =item B<Prefix> I<String>
6934 When set, I<String> is added in front of the host name. Dots and whitespace are
6935 I<not> escaped in this string (see B<EscapeCharacter> below).
6937 =item B<Postfix> I<String>
6939 When set, I<String> is appended to the host name. Dots and whitespace are
6940 I<not> escaped in this string (see B<EscapeCharacter> below).
6942 =item B<EscapeCharacter> I<Char>
6944 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6945 in the identifier. The B<EscapeCharacter> option determines which character
6946 dots, whitespace and control characters are replaced with. Defaults to
6949 =item B<StoreRates> B<false>|B<true>
6951 If set to B<true> (the default), convert counter values to rates. If set to
6952 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6955 =item B<SeparateInstances> B<false>|B<true>
6957 If set to B<true>, the plugin instance and type instance will be in their own
6958 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6959 default), the plugin and plugin instance (and likewise the type and type
6960 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6962 =item B<AlwaysAppendDS> B<false>|B<true>
6964 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6965 identifier. If set to B<false> (the default), this is only done when there is
6970 =head2 Plugin C<write_tsdb>
6972 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6973 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6974 state daemon that ingests metrics and stores them in HBase. The plugin uses
6975 I<TCP> over the "line based" protocol with a default port 4242. The data will
6976 be sent in blocks of at most 1428 bytes to minimize the number of network
6983 Host "tsd-1.my.domain"
6985 HostTags "status=production"
6989 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6990 blocks. Inside the B<Node> blocks, the following options are recognized:
6994 =item B<Host> I<Address>
6996 Hostname or address to connect to. Defaults to C<localhost>.
6998 =item B<Port> I<Service>
7000 Service name or port number to connect to. Defaults to C<4242>.
7003 =item B<HostTags> I<String>
7005 When set, I<HostTags> is added to the end of the metric. It is intended to be
7006 used for name=value pairs that the TSD will tag the metric with. Dots and
7007 whitespace are I<not> escaped in this string.
7009 =item B<StoreRates> B<false>|B<true>
7011 If set to B<true>, convert counter values to rates. If set to B<false>
7012 (the default) counter values are stored as is, as an increasing
7015 =item B<AlwaysAppendDS> B<false>|B<true>
7017 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7018 identifier. If set to B<false> (the default), this is only done when there is
7023 =head2 Plugin C<write_mongodb>
7025 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7030 <Plugin "write_mongodb">
7039 The plugin can send values to multiple instances of I<MongoDB> by specifying
7040 one B<Node> block for each instance. Within the B<Node> blocks, the following
7041 options are available:
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<27017>.
7053 =item B<Timeout> I<Timeout>
7055 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7056 Setting this option to zero means no timeout, which is the default.
7058 =item B<StoreRates> B<false>|B<true>
7060 If set to B<true> (the default), convert counter values to rates. If set to
7061 B<false> counter values are stored as is, i.e. as an increasing integer
7064 =item B<Database> I<Database>
7066 =item B<User> I<User>
7068 =item B<Password> I<Password>
7070 Sets the information used when authenticating to a I<MongoDB> database. The
7071 fields are optional (in which case no authentication is attempted), but if you
7072 want to use authentication all three fields must be set.
7076 =head2 Plugin C<write_http>
7078 This output plugin submits values to an HTTP server using POST requests and
7079 encoding metrics with JSON or using the C<PUTVAL> command described in
7080 L<collectd-unixsock(5)>.
7084 <Plugin "write_http">
7086 URL "http://example.com/post-collectd"
7093 The plugin can send values to multiple HTTP servers by specifying one
7094 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7095 block, the following options are available:
7101 URL to which the values are submitted to. Mandatory.
7103 =item B<User> I<Username>
7105 Optional user name needed for authentication.
7107 =item B<Password> I<Password>
7109 Optional password needed for authentication.
7111 =item B<VerifyPeer> B<true>|B<false>
7113 Enable or disable peer SSL certificate verification. See
7114 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7116 =item B<VerifyHost> B<true|false>
7118 Enable or disable peer host name verification. If enabled, the plugin checks if
7119 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7120 matches the host name provided by the B<URL> option. If this identity check
7121 fails, the connection is aborted. Obviously, only works when connecting to a
7122 SSL enabled server. Enabled by default.
7124 =item B<CACert> I<File>
7126 File that holds one or more SSL certificates. If you want to use HTTPS you will
7127 possibly need this option. What CA certificates come bundled with C<libcurl>
7128 and are checked by default depends on the distribution you use.
7130 =item B<CAPath> I<Directory>
7132 Directory holding one or more CA certificate files. You can use this if for
7133 some reason all the needed CA certificates aren't in the same file and can't be
7134 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7137 =item B<ClientKey> I<File>
7139 File that holds the private key in PEM format to be used for certificate-based
7142 =item B<ClientCert> I<File>
7144 File that holds the SSL certificate to be used for certificate-based
7147 =item B<ClientKeyPass> I<Password>
7149 Password required to load the private key in B<ClientKey>.
7151 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7153 Define which SSL protocol version must be used. By default C<libcurl> will
7154 attempt to figure out the remote SSL protocol version. See
7155 L<curl_easy_setopt(3)> for more details.
7157 =item B<Format> B<Command>|B<JSON>
7159 Format of the output to generate. If set to B<Command>, will create output that
7160 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7161 create output in the I<JavaScript Object Notation> (JSON).
7163 Defaults to B<Command>.
7165 =item B<StoreRates> B<true|false>
7167 If set to B<true>, convert counter values to rates. If set to B<false> (the
7168 default) counter values are stored as is, i.e. as an increasing integer number.
7170 =item B<BufferSize> I<Bytes>
7172 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7173 requests will be generated, but more metrics will be batched / metrics are
7174 cached for longer before being sent, introducing additional delay until they
7175 are available on the server side. I<Bytes> must be at least 1024 and cannot
7176 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7177 Defaults to C<4096>.
7181 =head2 Plugin C<write_kafka>
7183 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7187 <Plugin "write_kafka">
7188 Property "metadata.broker.list" "broker1:9092,broker2:9092"
7194 The following options are understood by the I<write_kafka plugin>:
7198 =item E<lt>B<Topic> I<Name>E<gt>
7200 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7201 is given a unique I<Name> and specifies one kafka producer.
7202 Inside the B<Topic> block, the following per-topic options are
7207 =item B<Property> I<String> I<String>
7209 Configure the named property for the current topic. Properties are
7210 forwarded to the kafka producer library B<librdkafka>.
7212 =item B<Key> I<String>
7214 Use the specified string as a partioning key for the topic. Kafka breaks
7215 topic into partitions and guarantees that for a given topology, the same
7216 consumer will be used for a specific key. The special (case insensitive)
7217 string B<Random> can be used to specify that an arbitrary partition should
7220 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7222 Selects the format in which messages are sent to the broker. If set to
7223 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7224 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7226 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7227 an easy and straight forward exchange format.
7229 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7230 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7232 =item B<StoreRates> B<true>|B<false>
7234 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7235 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7236 default), no conversion is performed. Otherwise the conversion is performed
7237 using the internal value cache.
7239 Please note that currently this option is only used if the B<Format> option has
7240 been set to B<JSON>.
7242 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7244 A prefix can be added in the metric name when outputting in the I<Graphite>
7245 format. It's added before the I<Host> name.
7247 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>>
7249 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7251 A postfix can be added in the metric name when outputting in the I<Graphite>
7252 format. It's added after the I<Host> name.
7254 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>>
7256 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7258 Specify a character to replace dots (.) in the host part of the metric name.
7259 In I<Graphite> metric name, dots are used as separators between different
7260 metric parts (host, plugin, type).
7261 Default is C<_> (I<Underscore>).
7263 =item B<GraphiteSeparateInstances> B<false>|B<true>
7265 If set to B<true>, the plugin instance and type instance will be in their own
7266 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7267 default), the plugin and plugin instance (and likewise the type and type
7268 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7270 =item B<StoreRates> B<true>|B<false>
7272 If set to B<true> (the default), convert counter values to rates. If set to
7273 B<false> counter values are stored as is, i.e. as an increasing integer number.
7275 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7276 converted values will have "rate" appended to the data source type, e.g.
7277 C<ds_type:derive:rate>.
7281 =item B<Property> I<String> I<String>
7283 Configure the kafka producer through properties, you almost always will
7284 want to set B<metadata.broker.list> to your Kafka broker list.
7288 =head2 Plugin C<write_redis>
7290 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7294 <Plugin "write_redis">
7302 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7303 the timestamp as the score. Retrieving a date range can then be done using the
7304 C<ZRANGEBYSCORE> I<Redis> command. Additionnally, all the identifiers of these
7305 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
7306 retrieved using the C<SMEMBERS> I<Redis> command. See
7307 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7310 The information shown in the synopsis above is the I<default configuration>
7311 which is used by the plugin if no configuration is present.
7313 The plugin can send values to multiple instances of I<Redis> by specifying
7314 one B<Node> block for each instance. Within the B<Node> blocks, the following
7315 options are available:
7319 =item B<Node> I<Nodename>
7321 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7322 instance running in an specified host and port. The name for node is a
7323 canonical identifier which is used as I<plugin instance>. It is limited to
7324 64E<nbsp>characters in length.
7326 =item B<Host> I<Hostname>
7328 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7331 =item B<Port> I<Port>
7333 The B<Port> option is the TCP port on which the Redis instance accepts
7334 connections. Either a service name of a port number may be given. Please note
7335 that numerical port numbers must be given as a string, too.
7337 =item B<Timeout> I<Timeout in miliseconds>
7339 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7343 =head2 Plugin C<write_riemann>
7345 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7346 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7347 I<Riemann> using UDP packets.
7351 <Plugin "write_riemann">
7357 AlwaysAppendDS false
7361 Attribute "foo" "bar"
7364 The following options are understood by the I<write_riemann plugin>:
7368 =item E<lt>B<Node> I<Name>E<gt>
7370 The plugin's configuration consists of one or more B<Node> blocks. Each block
7371 is given a unique I<Name> and specifies one connection to an instance of
7372 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7377 =item B<Host> I<Address>
7379 Hostname or address to connect to. Defaults to C<localhost>.
7381 =item B<Port> I<Service>
7383 Service name or port number to connect to. Defaults to C<5555>.
7385 =item B<Protocol> B<UDP>|B<TCP>
7387 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7390 =item B<Batch> B<true>|B<false>
7392 If set to B<true> and B<Protocol> is set to B<TCP>,
7393 events will be batched in memory and flushed at
7394 regular intervals or when B<BatchMaxSize> is exceeded.
7396 Notifications are not batched and sent as soon as possible.
7398 When enabled, it can occur that events get processed by the Riemann server
7399 close to or after their expiration time. Tune the B<TTLFactor> and
7400 B<BatchMaxSize> settings according to the amount of values collected, if this
7405 =item B<BatchMaxSize> I<size>
7407 Maximum payload size for a riemann packet. Defaults to 8192
7409 =item B<StoreRates> B<true>|B<false>
7411 If set to B<true> (the default), convert counter values to rates. If set to
7412 B<false> counter values are stored as is, i.e. as an increasing integer number.
7414 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7415 converted values will have "rate" appended to the data source type, e.g.
7416 C<ds_type:derive:rate>.
7418 =item B<AlwaysAppendDS> B<false>|B<true>
7420 If set the B<true>, append the name of the I<Data Source> (DS) to the
7421 "service", i.e. the field that, together with the "host" field, uniquely
7422 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7423 only done when there is more than one DS.
7425 =item B<TTLFactor> I<Factor>
7427 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7428 event is considered active. I<collectd> populates this field based on the
7429 metrics interval setting. This setting controls the factor with which the
7430 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7431 know exactly what you're doing, you should only increase this setting from its
7434 =item B<Notifications> B<false>|B<true>
7436 If set to B<true>, create riemann events for notifications. This is B<true>
7437 by default. When processing thresholds from write_riemann, it might prove
7438 useful to avoid getting notification events.
7440 =item B<CheckThresholds> B<false>|B<true>
7442 If set to B<true>, attach state to events based on thresholds defined
7443 in the B<Threshold> plugin. Defaults to B<false>.
7445 =item B<EventServicePrefix> I<String>
7447 Add the given string as a prefix to the event service name.
7448 If B<EventServicePrefix> not set or set to an empty string (""),
7449 no prefix will be used.
7453 =item B<Tag> I<String>
7455 Add the given string as an additional tag to the metric being sent to
7458 =item B<Attribute> I<String> I<String>
7460 Consider the two given strings to be the key and value of an additional
7461 attribute for each metric being sent out to I<Riemann>.
7465 =head2 Plugin C<zookeeper>
7467 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
7468 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
7473 <Plugin "zookeeper">
7480 =item B<Host> I<Address>
7482 Hostname or address to connect to. Defaults to C<localhost>.
7484 =item B<Port> I<Service>
7486 Service name or port number to connect to. Defaults to C<2181>.
7490 =head1 THRESHOLD CONFIGURATION
7492 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7493 we mean that the values are not only stored or sent somewhere, but that they
7494 are judged and, if a problem is recognized, acted upon. The only action
7495 collectd takes itself is to generate and dispatch a "notification". Plugins can
7496 register to receive notifications and perform appropriate further actions.
7498 Since systems and what you expect them to do differ a lot, you can configure
7499 B<thresholds> for your values freely. This gives you a lot of flexibility but
7500 also a lot of responsibility.
7502 Every time a value is out of range a notification is dispatched. This means
7503 that the idle percentage of your CPU needs to be less then the configured
7504 threshold only once for a notification to be generated. There's no such thing
7505 as a moving average or similar - at least not now.
7507 Also, all values that match a threshold are considered to be relevant or
7508 "interesting". As a consequence collectd will issue a notification if they are
7509 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7510 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7511 "2" (the default) and some hosts sends it's CPU statistics to the server every
7512 60 seconds, a notification will be dispatched after about 120 seconds. It may
7513 take a little longer because the timeout is checked only once each B<Interval>
7516 When a value comes within range again or is received after it was missing, an
7517 "OKAY-notification" is dispatched.
7519 Here is a configuration example to get you started. Read below for more
7532 <Plugin "interface">
7549 WarningMin 100000000
7555 There are basically two types of configuration statements: The C<Host>,
7556 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7557 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7558 C<Instance> option. You can combine the block by nesting the blocks, though
7559 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7560 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7561 C<Type> may not contain other blocks. If multiple blocks apply to the same
7562 value the most specific block is used.
7564 The other statements specify the threshold to configure. They B<must> be
7565 included in a C<Type> block. Currently the following statements are recognized:
7569 =item B<FailureMax> I<Value>
7571 =item B<WarningMax> I<Value>
7573 Sets the upper bound of acceptable values. If unset defaults to positive
7574 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7575 will be created. If the value is greater than B<WarningMax> but less than (or
7576 equal to) B<FailureMax> a B<WARNING> notification will be created.
7578 =item B<FailureMin> I<Value>
7580 =item B<WarningMin> I<Value>
7582 Sets the lower bound of acceptable values. If unset defaults to negative
7583 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7584 be created. If the value is less than B<WarningMin> but greater than (or equal
7585 to) B<FailureMin> a B<WARNING> notification will be created.
7587 =item B<DataSource> I<DSName>
7589 Some data sets have more than one "data source". Interesting examples are the
7590 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7591 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7592 system load data set, C<load>, even has three data sources: C<shortterm>,
7593 C<midterm>, and C<longterm>.
7595 Normally, all data sources are checked against a configured threshold. If this
7596 is undesirable, or if you want to specify different limits for each data
7597 source, you can use the B<DataSource> option to have a threshold apply only to
7600 =item B<Invert> B<true>|B<false>
7602 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7603 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7604 B<WarningMax>) are not okay. Defaults to B<false>.
7606 =item B<Persist> B<true>|B<false>
7608 Sets how often notifications are generated. If set to B<true> one notification
7609 will be generated for each value that is out of the acceptable range. If set to
7610 B<false> (the default) then a notification is only generated if a value is out
7611 of range but the previous value was okay.
7613 This applies to missing values, too: If set to B<true> a notification about a
7614 missing value is generated once every B<Interval> seconds. If set to B<false>
7615 only one such notification is generated until the value appears again.
7617 =item B<Percentage> B<true>|B<false>
7619 If set to B<true>, the minimum and maximum values given are interpreted as
7620 percentage value, relative to the other data sources. This is helpful for
7621 example for the "df" type, where you may want to issue a warning when less than
7622 5E<nbsp>% of the total space is available. Defaults to B<false>.
7624 =item B<Hits> I<Number>
7626 Delay creating the notification until the threshold has been passed I<Number>
7627 times. When a notification has been generated, or when a subsequent value is
7628 inside the threshold, the counter is reset. If, for example, a value is
7629 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7630 will be dispatched at most once every 30E<nbsp>seconds.
7632 This is useful when short bursts are not a problem. If, for example, 100% CPU
7633 usage for up to a minute is normal (and data is collected every
7634 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7636 =item B<Hysteresis> I<Number>
7638 When set to non-zero, a hysteresis value is applied when checking minimum and
7639 maximum bounds. This is useful for values that increase slowly and fluctuate a
7640 bit while doing so. When these values come close to the threshold, they may
7641 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7643 If, for example, the threshold is configures as
7648 then a I<Warning> notification is created when the value exceeds I<101> and the
7649 corresponding I<Okay> notification is only created once the value falls below
7650 I<99>, thus avoiding the "flapping".
7654 =head1 FILTER CONFIGURATION
7656 Starting with collectd 4.6 there is a powerful filtering infrastructure
7657 implemented in the daemon. The concept has mostly been copied from
7658 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7659 terminology, so that users that are familiar with iptables feel right at home.
7663 The following are the terms used in the remainder of the filter configuration
7664 documentation. For an ASCII-art schema of the mechanism, see
7665 L<"General structure"> below.
7671 A I<match> is a criteria to select specific values. Examples are, of course, the
7672 name of the value or it's current value.
7674 Matches are implemented in plugins which you have to load prior to using the
7675 match. The name of such plugins starts with the "match_" prefix.
7679 A I<target> is some action that is to be performed with data. Such actions
7680 could, for example, be to change part of the value's identifier or to ignore
7681 the value completely.
7683 Some of these targets are built into the daemon, see L<"Built-in targets">
7684 below. Other targets are implemented in plugins which you have to load prior to
7685 using the target. The name of such plugins starts with the "target_" prefix.
7689 The combination of any number of matches and at least one target is called a
7690 I<rule>. The target actions will be performed for all values for which B<all>
7691 matches apply. If the rule does not have any matches associated with it, the
7692 target action will be performed for all values.
7696 A I<chain> is a list of rules and possibly default targets. The rules are tried
7697 in order and if one matches, the associated target will be called. If a value
7698 is handled by a rule, it depends on the target whether or not any subsequent
7699 rules are considered or if traversal of the chain is aborted, see
7700 L<"Flow control"> below. After all rules have been checked, the default targets
7705 =head2 General structure
7707 The following shows the resulting structure:
7714 +---------+ +---------+ +---------+ +---------+
7715 ! Rule !->! Match !->! Match !->! Target !
7716 +---------+ +---------+ +---------+ +---------+
7719 +---------+ +---------+ +---------+
7720 ! Rule !->! Target !->! Target !
7721 +---------+ +---------+ +---------+
7728 +---------+ +---------+ +---------+
7729 ! Rule !->! Match !->! Target !
7730 +---------+ +---------+ +---------+
7740 There are four ways to control which way a value takes through the filter
7747 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7748 process the value with another chain. When the called chain finishes, usually
7749 the next target or rule after the jump is executed.
7753 The stop condition, signaled for example by the built-in target B<stop>, causes
7754 all processing of the value to be stopped immediately.
7758 Causes processing in the current chain to be aborted, but processing of the
7759 value generally will continue. This means that if the chain was called via
7760 B<Jump>, the next target or rule after the jump will be executed. If the chain
7761 was not called by another chain, control will be returned to the daemon and it
7762 may pass the value to another chain.
7766 Most targets will signal the B<continue> condition, meaning that processing
7767 should continue normally. There is no special built-in target for this
7774 The configuration reflects this structure directly:
7776 PostCacheChain "PostCache"
7778 <Rule "ignore_mysql_show">
7781 Type "^mysql_command$"
7782 TypeInstance "^show_"
7792 The above configuration example will ignore all values where the plugin field
7793 is "mysql", the type is "mysql_command" and the type instance begins with
7794 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7795 default target of the chain. Since this chain is run after the value has been
7796 added to the cache, the MySQL C<show_*> command statistics will be available
7797 via the C<unixsock> plugin.
7799 =head2 List of configuration options
7803 =item B<PreCacheChain> I<ChainName>
7805 =item B<PostCacheChain> I<ChainName>
7807 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7808 argument is the name of a I<chain> that should be executed before and/or after
7809 the values have been added to the cache.
7811 To understand the implications, it's important you know what is going on inside
7812 I<collectd>. The following diagram shows how values are passed from the
7813 read-plugins to the write-plugins:
7819 + - - - - V - - - - +
7820 : +---------------+ :
7823 : +-------+-------+ :
7826 : +-------+-------+ : +---------------+
7827 : ! Cache !--->! Value Cache !
7828 : ! insert ! : +---+---+-------+
7829 : +-------+-------+ : ! !
7830 : ! ,------------' !
7832 : +-------+---+---+ : +-------+-------+
7833 : ! Post-Cache +--->! Write-Plugins !
7834 : ! Chain ! : +---------------+
7835 : +---------------+ :
7838 + - - - - - - - - - +
7840 After the values are passed from the "read" plugins to the dispatch functions,
7841 the pre-cache chain is run first. The values are added to the internal cache
7842 afterwards. The post-cache chain is run after the values have been added to the
7843 cache. So why is it such a huge deal if chains are run before or after the
7844 values have been added to this cache?
7846 Targets that change the identifier of a value list should be executed before
7847 the values are added to the cache, so that the name in the cache matches the
7848 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7849 this cache to receive a list of all available values. If you change the
7850 identifier after the value list has been added to the cache, this may easily
7851 lead to confusion, but it's not forbidden of course.
7853 The cache is also used to convert counter values to rates. These rates are, for
7854 example, used by the C<value> match (see below). If you use the rate stored in
7855 the cache B<before> the new value is added, you will use the old, B<previous>
7856 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7857 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7860 Last but not last, the B<stop> target makes a difference: If the pre-cache
7861 chain returns the stop condition, the value will not be added to the cache and
7862 the post-cache chain will not be run.
7864 =item B<Chain> I<Name>
7866 Adds a new chain with a certain name. This name can be used to refer to a
7867 specific chain, for example to jump to it.
7869 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7871 =item B<Rule> [I<Name>]
7873 Adds a new rule to the current chain. The name of the rule is optional and
7874 currently has no meaning for the daemon.
7876 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7877 must be at least one B<Target> block.
7879 =item B<Match> I<Name>
7881 Adds a match to a B<Rule> block. The name specifies what kind of match should
7882 be performed. Available matches depend on the plugins that have been loaded.
7884 The arguments inside the B<Match> block are passed to the plugin implementing
7885 the match, so which arguments are valid here depends on the plugin being used.
7886 If you do not need any to pass any arguments to a match, you can use the
7891 Which is equivalent to:
7896 =item B<Target> I<Name>
7898 Add a target to a rule or a default target to a chain. The name specifies what
7899 kind of target is to be added. Which targets are available depends on the
7900 plugins being loaded.
7902 The arguments inside the B<Target> block are passed to the plugin implementing
7903 the target, so which arguments are valid here depends on the plugin being used.
7904 If you do not need any to pass any arguments to a target, you can use the
7909 This is the same as writing:
7916 =head2 Built-in targets
7918 The following targets are built into the core daemon and therefore need no
7919 plugins to be loaded:
7925 Signals the "return" condition, see the L<"Flow control"> section above. This
7926 causes the current chain to stop processing the value and returns control to
7927 the calling chain. The calling chain will continue processing targets and rules
7928 just after the B<jump> target (see below). This is very similar to the
7929 B<RETURN> target of iptables, see L<iptables(8)>.
7931 This target does not have any options.
7939 Signals the "stop" condition, see the L<"Flow control"> section above. This
7940 causes processing of the value to be aborted immediately. This is similar to
7941 the B<DROP> target of iptables, see L<iptables(8)>.
7943 This target does not have any options.
7951 Sends the value to "write" plugins.
7957 =item B<Plugin> I<Name>
7959 Name of the write plugin to which the data should be sent. This option may be
7960 given multiple times to send the data to more than one write plugin. If the
7961 plugin supports multiple instances, the plugin's instance(s) must also be
7966 If no plugin is explicitly specified, the values will be sent to all available
7969 Single-instance plugin example:
7975 Multi-instance plugin example:
7977 <Plugin "write_graphite">
7987 Plugin "write_graphite/foo"
7992 Starts processing the rules of another chain, see L<"Flow control"> above. If
7993 the end of that chain is reached, or a stop condition is encountered,
7994 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7995 next target or the next rule. This is similar to the B<-j> command line option
7996 of iptables, see L<iptables(8)>.
8002 =item B<Chain> I<Name>
8004 Jumps to the chain I<Name>. This argument is required and may appear only once.
8016 =head2 Available matches
8022 Matches a value using regular expressions.
8028 =item B<Host> I<Regex>
8030 =item B<Plugin> I<Regex>
8032 =item B<PluginInstance> I<Regex>
8034 =item B<Type> I<Regex>
8036 =item B<TypeInstance> I<Regex>
8038 Match values where the given regular expressions match the various fields of
8039 the identifier of a value. If multiple regular expressions are given, B<all>
8040 regexen must match for a value to match.
8042 =item B<Invert> B<false>|B<true>
8044 When set to B<true>, the result of the match is inverted, i.e. all value lists
8045 where all regular expressions apply are not matched, all other value lists are
8046 matched. Defaults to B<false>.
8053 Host "customer[0-9]+"
8059 Matches values that have a time which differs from the time on the server.
8061 This match is mainly intended for servers that receive values over the
8062 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8063 is very sensitive to the timestamp used when updating the RRD files. In
8064 particular, the time must be ever increasing. If a misbehaving client sends one
8065 packet with a timestamp far in the future, all further packets with a correct
8066 time will be ignored because of that one packet. What's worse, such corrupted
8067 RRD files are hard to fix.
8069 This match lets one match all values B<outside> a specified time range
8070 (relative to the server's time), so you can use the B<stop> target (see below)
8071 to ignore the value, for example.
8077 =item B<Future> I<Seconds>
8079 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8080 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8083 =item B<Past> I<Seconds>
8085 Matches all values that are I<behind> of the server's time by I<Seconds> or
8086 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8098 This example matches all values that are five minutes or more ahead of the
8099 server or one hour (or more) lagging behind.
8103 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8104 values. If a data-set consists of more than one data-source, all data-sources
8105 must match the specified ranges for a positive match.
8111 =item B<Min> I<Value>
8113 Sets the smallest value which still results in a match. If unset, behaves like
8116 =item B<Max> I<Value>
8118 Sets the largest value which still results in a match. If unset, behaves like
8121 =item B<Invert> B<true>|B<false>
8123 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8124 no-match is returned and vice versa. Please note that the B<Invert> setting
8125 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8126 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8128 =item B<DataSource> I<DSName> [I<DSName> ...]
8130 Select one or more of the data sources. If no data source is configured, all
8131 data sources will be checked. If the type handled by the match does not have a
8132 data source of the specified name(s), this will always result in no match
8133 (independent of the B<Invert> setting).
8135 =item B<Satisfy> B<Any>|B<All>
8137 Specifies how checking with several data sources is performed. If set to
8138 B<Any>, the match succeeds if one of the data sources is in the configured
8139 range. If set to B<All> the match only succeeds if all data sources are within
8140 the configured range. Default is B<All>.
8142 Usually B<All> is used for positive matches, B<Any> is used for negative
8143 matches. This means that with B<All> you usually check that all values are in a
8144 "good" range, while with B<Any> you check if any value is within a "bad" range
8145 (or outside the "good" range).
8149 Either B<Min> or B<Max>, but not both, may be unset.
8153 # Match all values smaller than or equal to 100. Matches only if all data
8154 # sources are below 100.
8160 # Match if the value of any data source is outside the range of 0 - 100.
8168 =item B<empty_counter>
8170 Matches all values with one or more data sources of type B<COUNTER> and where
8171 all counter values are zero. These counters usually I<never> increased since
8172 they started existing (and are therefore uninteresting), or got reset recently
8173 or overflowed and you had really, I<really> bad luck.
8175 Please keep in mind that ignoring such counters can result in confusing
8176 behavior: Counters which hardly ever increase will be zero for long periods of
8177 time. If the counter is reset for some reason (machine or service restarted,
8178 usually), the graph will be empty (NAN) for a long time. People may not
8183 Calculates a hash value of the host name and matches values according to that
8184 hash value. This makes it possible to divide all hosts into groups and match
8185 only values that are in a specific group. The intended use is in load
8186 balancing, where you want to handle only part of all data and leave the rest
8189 The hashing function used tries to distribute the hosts evenly. First, it
8190 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8193 for (i = 0; host[i] != 0; i++)
8194 hash_value = (hash_value * 251) + host[i];
8196 The constant 251 is a prime number which is supposed to make this hash value
8197 more random. The code then checks the group for this host according to the
8198 I<Total> and I<Match> arguments:
8200 if ((hash_value % Total) == Match)
8205 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8206 groups), then the least significant bit of the hash value will be the XOR of
8207 all least significant bits in the host name. One consequence is that when you
8208 have two hosts, "server0.example.com" and "server1.example.com", where the host
8209 name differs in one digit only and the digits differ by one, those hosts will
8210 never end up in the same group.
8216 =item B<Match> I<Match> I<Total>
8218 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8219 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8220 be smaller than I<Total>. I<Total> must be at least one, although only values
8221 greater than one really do make any sense.
8223 You can repeat this option to match multiple groups, for example:
8228 The above config will divide the data into seven groups and match groups three
8229 and five. One use would be to keep every value on two hosts so that if one
8230 fails the missing data can later be reconstructed from the second host.
8236 # Operate on the pre-cache chain, so that ignored values are not even in the
8241 # Divide all received hosts in seven groups and accept all hosts in
8245 # If matched: Return and continue.
8248 # If not matched: Return and stop.
8254 =head2 Available targets
8258 =item B<notification>
8260 Creates and dispatches a notification.
8266 =item B<Message> I<String>
8268 This required option sets the message of the notification. The following
8269 placeholders will be replaced by an appropriate value:
8277 =item B<%{plugin_instance}>
8281 =item B<%{type_instance}>
8283 These placeholders are replaced by the identifier field of the same name.
8285 =item B<%{ds:>I<name>B<}>
8287 These placeholders are replaced by a (hopefully) human readable representation
8288 of the current rate of this data source. If you changed the instance name
8289 (using the B<set> or B<replace> targets, see below), it may not be possible to
8290 convert counter values to rates.
8294 Please note that these placeholders are B<case sensitive>!
8296 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8298 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8305 <Target "notification">
8306 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8312 Replaces parts of the identifier using regular expressions.
8318 =item B<Host> I<Regex> I<Replacement>
8320 =item B<Plugin> I<Regex> I<Replacement>
8322 =item B<PluginInstance> I<Regex> I<Replacement>
8324 =item B<TypeInstance> I<Regex> I<Replacement>
8326 Match the appropriate field with the given regular expression I<Regex>. If the
8327 regular expression matches, that part that matches is replaced with
8328 I<Replacement>. If multiple places of the input buffer match a given regular
8329 expression, only the first occurrence will be replaced.
8331 You can specify each option multiple times to use multiple regular expressions
8339 # Replace "example.net" with "example.com"
8340 Host "\\<example.net\\>" "example.com"
8342 # Strip "www." from hostnames
8348 Sets part of the identifier of a value to a given string.
8354 =item B<Host> I<String>
8356 =item B<Plugin> I<String>
8358 =item B<PluginInstance> I<String>
8360 =item B<TypeInstance> I<String>
8362 Set the appropriate field to the given string. The strings for plugin instance
8363 and type instance may be empty, the strings for host and plugin may not be
8364 empty. It's currently not possible to set the type of a value this way.
8371 PluginInstance "coretemp"
8372 TypeInstance "core3"
8377 =head2 Backwards compatibility
8379 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8380 B<Chain> block, it will behave as it used to. This is equivalent to the
8381 following configuration:
8387 If you specify a B<PostCacheChain>, the B<write> target will not be added
8388 anywhere and you will have to make sure that it is called where appropriate. We
8389 suggest to add the above snippet as default target to your "PostCache" chain.
8393 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8409 L<collectd-exec(5)>,
8410 L<collectd-perl(5)>,
8411 L<collectd-unixsock(5)>,
8424 Florian Forster E<lt>octo@collectd.orgE<gt>