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.
780 =head2 Plugin C<apcups>
784 =item B<Host> I<Hostname>
786 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
787 that IPv6 support has been disabled unless someone can confirm or decline that
788 B<apcupsd> can handle it.
790 =item B<Port> I<Port>
792 TCP-Port to connect to. Defaults to B<3551>.
794 =item B<ReportSeconds> B<true|false>
796 If set to B<true>, the time reported in the C<timeleft> metric will be
797 converted to seconds. This is the recommended setting. If set to B<false>, the
798 default for backwards compatibility, the time will be reported in minutes.
802 =head2 Plugin C<aquaero>
804 This plugin collects the value of the available sensors in an
805 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
806 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
807 connection for monitoring and configuration. The board can handle multiple
808 temperature sensors, fans, water pumps and water level sensors and adjust the
809 output settings such as fan voltage or power used by the water pump based on
810 the available inputs using a configurable controller included in the board.
811 This plugin collects all the available inputs as well as some of the output
812 values chosen by this controller. The plugin is based on the I<libaquaero5>
813 library provided by I<aquatools-ng>.
817 =item B<Device> I<DevicePath>
819 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
820 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
821 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
825 =head2 Plugin C<ascent>
827 This plugin collects information about an Ascent server, a free server for the
828 "World of Warcraft" game. This plugin gathers the information by fetching the
829 XML status page using C<libcurl> and parses it using C<libxml2>.
831 The configuration options are the same as for the C<apache> plugin above:
835 =item B<URL> I<http://localhost/ascent/status/>
837 Sets the URL of the XML status output.
839 =item B<User> I<Username>
841 Optional user name needed for authentication.
843 =item B<Password> I<Password>
845 Optional password needed for authentication.
847 =item B<VerifyPeer> B<true|false>
849 Enable or disable peer SSL certificate verification. See
850 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
852 =item B<VerifyHost> B<true|false>
854 Enable or disable peer host name verification. If enabled, the plugin checks
855 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
856 certificate matches the host name provided by the B<URL> option. If this
857 identity check fails, the connection is aborted. Obviously, only works when
858 connecting to a SSL enabled server. Enabled by default.
860 =item B<CACert> I<File>
862 File that holds one or more SSL certificates. If you want to use HTTPS you will
863 possibly need this option. What CA certificates come bundled with C<libcurl>
864 and are checked by default depends on the distribution you use.
868 =head2 Plugin C<barometer>
870 This plugin reads absolute air pressure using digital barometer sensor MPL115A2
871 or MPL3115 from Freescale (sensor attached to any I2C bus available in
872 the computer, for HW details see
873 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A> or
874 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>).
875 The sensor type - one fo these two - is detected automatically by the plugin
876 and indicated in the plugin_instance (typically you will see subdirectory
877 "barometer-mpl115" or "barometer-mpl3115").
879 The plugin provides absolute barometric pressure, air pressure reduced to sea
880 level (several possible approximations) and as an auxiliary value also internal
881 sensor temperature. It uses (expects/provides) typical metric units - pressure
882 in [hPa], temperature in [C], altitude in [m].
884 It was developed and tested under Linux only. The only platform dependency is
885 the standard Linux i2c-dev interface (the particular bus driver has to
886 support the SM Bus command subset).
888 The reduction or normalization to mean sea level pressure requires (depedning on
889 selected method/approximation) also altitude and reference to temperature sensor(s).
890 When multiple temperature sensors are configured the minumum of their values is
891 always used (expecting that the warmer ones are affected by e.g. direct sun light
900 TemperatureOffset 0.0
903 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
908 =item B<Device> I<device>
910 Device name of the I2C bus to which the sensor is connected. Note that typically
911 you need to have loaded the i2c-dev module.
912 Using i2c-tools you can check/list i2c buses available on your system by:
916 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
920 This way you should be able to verify that the pressure sensor (either type) is
921 connected and detected on address 0x60.
923 =item B<Oversampling> I<value>
925 For MPL115 this is the size of the averaging window. To filter out sensor noise
926 a simple averaging using floating window of configurable size is used. The plugin
927 will use average of the last C<value> measurements (value of 1 means no averaging).
928 Minimal size is 1, maximal 1024.
930 For MPL3115 this is the oversampling value. The actual oversampling is performed
931 by the sensor and the higher value the higher accuracy and longer conversion time
932 (although nothing to worry about in the collectd context). Supported values are:
933 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
934 the closest supported one. Default is 128.
936 =item B<PressureOffset> I<offset>
938 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
939 This is added to the measured/caclulated value (i.e. if the measured value is too high
940 then use negative offset).
941 In hPa, default is 0.0.
943 =item B<TemperatureOffset> I<offset>
945 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
946 This is added to the measured/caclulated value (i.e. if the measured value is too high
947 then use negative offset).
948 In C, default is 0.0.
950 =item B<Normalization> I<method>
952 Normalization method - what approximation/model is used to compute mean sea
953 level pressure from the air absolute pressure.
955 Supported values of the C<method> (integer between from 0 to 2) are:
959 =item B<0> - no conversion, absolute pressrure is simply copied over. For this method you
960 do not need to configure C<Altitude> or C<TemperatureSensor>.
962 =item B<1> - international formula for conversion ,
963 See I<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
964 For this method you have to configure C<Altitude> but do not need C<TemperatureSensor>
965 (uses fixed global temperature average instead).
967 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
968 Meteorological Service).
969 See I<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
970 For this method you have to configure both C<Altitude> and C<TemperatureSensor>.
975 =item B<Altitude> I<altitude>
977 The altitude (in meters) of the location where you meassure the pressure.
979 =item B<TemperatureSensor> I<reference>
981 Temperature sensor which should be used as a reference when normalizing the pressure.
982 When specified more sensors a minumum is found and uses each time.
983 The temperature reading directly from this pressure sensor/plugin
984 is typically not suitable as the pressure sensor
985 will be probably inside while we want outside temperature.
986 The collectd reference name is something like
987 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
988 (<type_instance> is usually omitted when there is just single value type).
989 Or you can figure it out from the path of the output data files.
993 =head2 Plugin C<battery>
995 The I<battery plugin> reports the remaining capacity, power and voltage of
1000 =item B<ValuesPercentage> B<false>|B<true>
1002 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1003 capacity remaining". Otherwise the capacity is stored as reported by the
1004 battery, most likely in "Wh". This option does not work with all input methods,
1005 in particular when only C</proc/pmu> is available on an old Linux system.
1006 Defaults to B<false>.
1008 =item B<ReportDegraded> B<false>|B<true>
1010 Typical laptop batteries degrade over time, meaning the capacity decreases with
1011 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1012 "last full capacity" and used to determine that a battery is "fully charged".
1014 When this option is set to B<false>, the default, the I<battery plugin> will
1015 only report the remaining capacity. If the B<ValuesPercentage> option is
1016 enabled, the relative remaining capacity is calculated as the ratio of the
1017 "remaining capacity" and the "last full capacity". This is what most tools,
1018 such as the status bar of desktop environments, also do.
1020 When set to B<true>, the battery plugin will report three values: B<charged>
1021 (remaining capacity), B<discharged> (difference between "last full capacity"
1022 and "remaining capacity") and B<degraded> (difference between "design capacity"
1023 and "last full capacity").
1027 =head2 Plugin C<bind>
1029 Starting with BIND 9.5.0, the most widely used DNS server software provides
1030 extensive statistics about queries, responses and lots of other information.
1031 The bind plugin retrieves this information that's encoded in XML and provided
1032 via HTTP and submits the values to collectd.
1034 To use this plugin, you first need to tell BIND to make this information
1035 available. This is done with the C<statistics-channels> configuration option:
1037 statistics-channels {
1038 inet localhost port 8053;
1041 The configuration follows the grouping that can be seen when looking at the
1042 data with an XSLT compatible viewer, such as a modern web browser. It's
1043 probably a good idea to make yourself familiar with the provided values, so you
1044 can understand what the collected statistics actually mean.
1049 URL "http://localhost:8053/"
1064 Zone "127.in-addr.arpa/IN"
1068 The bind plugin accepts the following configuration options:
1074 URL from which to retrieve the XML data. If not specified,
1075 C<http://localhost:8053/> will be used.
1077 =item B<ParseTime> B<true>|B<false>
1079 When set to B<true>, the time provided by BIND will be parsed and used to
1080 dispatch the values. When set to B<false>, the local time source is queried.
1082 This setting is set to B<true> by default for backwards compatibility; setting
1083 this to B<false> is I<recommended> to avoid problems with timezones and
1086 =item B<OpCodes> B<true>|B<false>
1088 When enabled, statistics about the I<"OpCodes">, for example the number of
1089 C<QUERY> packets, are collected.
1093 =item B<QTypes> B<true>|B<false>
1095 When enabled, the number of I<incoming> queries by query types (for example
1096 C<A>, C<MX>, C<AAAA>) is collected.
1100 =item B<ServerStats> B<true>|B<false>
1102 Collect global server statistics, such as requests received over IPv4 and IPv6,
1103 successful queries, and failed updates.
1107 =item B<ZoneMaintStats> B<true>|B<false>
1109 Collect zone maintenance statistics, mostly information about notifications
1110 (zone updates) and zone transfers.
1114 =item B<ResolverStats> B<true>|B<false>
1116 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1117 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1118 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1119 default. Use the B<ResolverStats> option within a B<View "_default"> block
1120 instead for the same functionality.
1124 =item B<MemoryStats>
1126 Collect global memory statistics.
1130 =item B<View> I<Name>
1132 Collect statistics about a specific I<"view">. BIND can behave different,
1133 mostly depending on the source IP-address of the request. These different
1134 configurations are called "views". If you don't use this feature, you most
1135 likely are only interested in the C<_default> view.
1137 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1138 information you want to collect about a view. If no B<View> block is
1139 configured, no detailed view statistics will be collected.
1143 =item B<QTypes> B<true>|B<false>
1145 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1146 C<MX>) is collected.
1150 =item B<ResolverStats> B<true>|B<false>
1152 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1153 (e.E<nbsp>g. queries over IPv4, lame servers).
1157 =item B<CacheRRSets> B<true>|B<false>
1159 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1160 type is collected. Negative entries (queries which resulted in an error, for
1161 example names that do not exist) are reported with a leading exclamation mark,
1166 =item B<Zone> I<Name>
1168 When given, collect detailed information about the given zone in the view. The
1169 information collected if very similar to the global B<ServerStats> information
1172 You can repeat this option to collect detailed information about multiple
1175 By default no detailed zone information is collected.
1181 =head2 Plugin C<ceph>
1183 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1184 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1186 A separate B<Daemon> block must be configured for each ceph daemon to be
1187 monitored. The following example will read daemon statistics from four
1188 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1191 LongRunAvgLatency false
1192 ConvertSpecialMetricTypes true
1194 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1197 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1200 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1203 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1207 The ceph plugin accepts the following configuration options:
1211 =item B<LongRunAvgLatency> B<true>|B<false>
1213 If enabled, latency values(sum,count pairs) are calculated as the long run
1214 average - average since the ceph daemon was started = (sum / count).
1215 When disabled, latency values are calculated as the average since the last
1216 collection = (sum_now - sum_last) / (count_now - count_last).
1220 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1222 If enabled, special metrics (metrics that differ in type from similar counters)
1223 are converted to the type of those similar counters. This currently only
1224 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1225 ceph schema reports this metric type as a sum,count pair while similar counters
1226 are treated as derive types. When converted, the sum is used as the counter
1227 value and is treated as a derive type.
1228 When disabled, all metrics are treated as the types received from the ceph schema.
1234 Each B<Daemon> block must have a string argument for the plugin instance name.
1235 A B<SocketPath> is also required for each B<Daemon> block:
1239 =item B<Daemon> I<DaemonName>
1241 Name to be used as the instance name for this daemon.
1243 =item B<SocketPath> I<SocketPath>
1245 Specifies the path to the UNIX admin socket of the ceph daemon.
1249 =head2 Plugin C<cgroups>
1251 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1252 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1253 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1257 =item B<CGroup> I<Directory>
1259 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1260 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1263 =item B<IgnoreSelected> B<true>|B<false>
1265 Invert the selection: If set to true, all cgroups I<except> the ones that
1266 match any one of the criteria are collected. By default only selected
1267 cgroups are collected if a selection is made. If no selection is configured
1268 at all, B<all> cgroups are selected.
1272 =head2 Plugin C<conntrack>
1274 This plugin collects IP conntrack statistics.
1280 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1281 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1285 =head2 Plugin C<cpu>
1287 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1288 as Jiffies, using the C<cpu> type. Two aggregations are available:
1294 Sum, per-state, over all CPUs installed in the system; and
1298 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1302 The two aggregations can be combined, leading to I<collectd> only emitting a
1303 single "active" metric for the entire system. As soon as one of these
1304 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1305 rather than Jiffies. In addition, you can request individual, per-state,
1306 per-CPU metrics to be reported as percentage.
1308 The following configuration options are available:
1312 =item B<ReportByState> B<true>|B<false>
1314 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1316 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1319 =item B<ReportByCpu> B<true>|B<false>
1321 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1322 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1323 global sum of CPU states is emitted.
1325 =item B<ValuesPercentage> B<false>|B<true>
1327 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1328 are set to B<true>. In this case, by default, metrics will be reported as
1329 Jiffies. By setting this option to B<true>, you can request percentage values
1330 in the un-aggregated (per-CPU, per-state) mode as well.
1334 =head2 Plugin C<cpufreq>
1336 This plugin doesn't have any options. It reads
1337 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1338 installed) to get the current CPU frequency. If this file does not exist make
1339 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1340 installed and an "cpu governor" (that's a kernel module) is loaded.
1342 =head2 Plugin C<csv>
1346 =item B<DataDir> I<Directory>
1348 Set the directory to store CSV-files under. Per default CSV-files are generated
1349 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1350 The special strings B<stdout> and B<stderr> can be used to write to the standard
1351 output and standard error channels, respectively. This, of course, only makes
1352 much sense when collectd is running in foreground- or non-daemon-mode.
1354 =item B<StoreRates> B<true|false>
1356 If set to B<true>, convert counter values to rates. If set to B<false> (the
1357 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1362 =head2 Plugin C<curl>
1364 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1365 and the match infrastructure (the same code used by the tail plugin) to use
1366 regular expressions with the received data.
1368 The following example will read the current value of AMD stock from Google's
1369 finance page and dispatch the value to collectd.
1372 <Page "stock_quotes">
1373 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1379 CACert "/path/to/ca.crt"
1380 Header "X-Custom-Header: foobar"
1383 MeasureResponseTime false
1384 MeasureResponseCode false
1387 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1388 DSType "GaugeAverage"
1389 # Note: `stock_value' is not a standard type.
1396 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1397 a web page and one or more "matches" to be performed on the returned data. The
1398 string argument to the B<Page> block is used as plugin instance.
1400 The following options are valid within B<Page> blocks:
1406 URL of the web site to retrieve. Since a regular expression will be used to
1407 extract information from this data, non-binary data is a big plus here ;)
1409 =item B<User> I<Name>
1411 Username to use if authorization is required to read the page.
1413 =item B<Password> I<Password>
1415 Password to use if authorization is required to read the page.
1417 =item B<Digest> B<true>|B<false>
1419 Enable HTTP digest authentication.
1421 =item B<VerifyPeer> B<true>|B<false>
1423 Enable or disable peer SSL certificate verification. See
1424 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1426 =item B<VerifyHost> B<true>|B<false>
1428 Enable or disable peer host name verification. If enabled, the plugin checks if
1429 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1430 matches the host name provided by the B<URL> option. If this identity check
1431 fails, the connection is aborted. Obviously, only works when connecting to a
1432 SSL enabled server. Enabled by default.
1434 =item B<CACert> I<file>
1436 File that holds one or more SSL certificates. If you want to use HTTPS you will
1437 possibly need this option. What CA certificates come bundled with C<libcurl>
1438 and are checked by default depends on the distribution you use.
1440 =item B<Header> I<Header>
1442 A HTTP header to add to the request. Multiple headers are added if this option
1443 is specified more than once.
1445 =item B<Post> I<Body>
1447 Specifies that the HTTP operation should be a POST instead of a GET. The
1448 complete data to be posted is given as the argument. This option will usually
1449 need to be accompanied by a B<Header> option to set an appropriate
1450 C<Content-Type> for the post body (e.g. to
1451 C<application/x-www-form-urlencoded>).
1453 =item B<MeasureResponseTime> B<true>|B<false>
1455 Measure response time for the request. If this setting is enabled, B<Match>
1456 blocks (see below) are optional. Disabled by default.
1458 Beware that requests will get aborted if they take too long to complete. Adjust
1459 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1462 =item B<MeasureResponseCode> B<true>|B<false>
1464 Measure response code for the request. If this setting is enabled, B<Match>
1465 blocks (see below) are optional. Disabled by default.
1467 =item B<E<lt>MatchE<gt>>
1469 One or more B<Match> blocks that define how to match information in the data
1470 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1471 used by the C<tail> plugin, so please see the documentation of the C<tail>
1472 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1473 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1476 =item B<Timeout> I<Milliseconds>
1478 The B<Timeout> option sets the overall timeout for HTTP requests, in
1479 milliseconds. By default, the configured B<Interval> is used to set the
1480 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1481 indefinitely. This legacy behaviour can be achieved by setting the value of
1484 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1485 network connection will stall one read thread. Adjust the B<ReadThreads> global
1486 setting accordingly to prevent this from blocking other plugins.
1490 =head2 Plugin C<curl_json>
1492 The B<curl_json plugin> collects values from JSON data to be parsed by
1493 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1494 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1495 unix socket. The former can be used, for example, to collect values
1496 from CouchDB documents (which are stored JSON notation), and the
1497 latter to collect values from a uWSGI stats socket.
1499 The following example will collect several values from the built-in
1500 C<_stats> runtime statistics module of I<CouchDB>
1501 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1504 <URL "http://localhost:5984/_stats">
1506 <Key "httpd/requests/count">
1507 Type "http_requests"
1510 <Key "httpd_request_methods/*/count">
1511 Type "http_request_methods"
1514 <Key "httpd_status_codes/*/count">
1515 Type "http_response_codes"
1520 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1523 <Sock "/var/run/uwsgi.stats.sock">
1525 <Key "workers/*/requests">
1526 Type "http_requests"
1529 <Key "workers/*/apps/*/requests">
1530 Type "http_requests"
1535 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1536 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1537 blocks defining a unix socket to read JSON from directly. Each of
1538 these blocks may have one or more B<Key> blocks.
1540 The B<Key> string argument must be in a path format. Each component is
1541 used to match the key from a JSON map or the index of an JSON
1542 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1543 values for all map keys or array indices will be collectd.
1545 The following options are valid within B<URL> blocks:
1549 =item B<Instance> I<Instance>
1551 Sets the plugin instance to I<Instance>.
1553 =item B<Interval> I<Interval>
1555 Sets the interval (in seconds) in which the values will be collected from this
1556 URL. By default the global B<Interval> setting will be used.
1558 =item B<User> I<Name>
1560 =item B<Password> I<Password>
1562 =item B<Digest> B<true>|B<false>
1564 =item B<VerifyPeer> B<true>|B<false>
1566 =item B<VerifyHost> B<true>|B<false>
1568 =item B<CACert> I<file>
1570 =item B<Header> I<Header>
1572 =item B<Post> I<Body>
1574 =item B<Timeout> I<Milliseconds>
1576 These options behave exactly equivalent to the appropriate options of the
1577 I<cURL> plugin. Please see there for a detailed description.
1581 The following options are valid within B<Key> blocks:
1585 =item B<Type> I<Type>
1587 Sets the type used to dispatch the values to the daemon. Detailed information
1588 about types and their configuration can be found in L<types.db(5)>. This
1589 option is mandatory.
1591 =item B<Instance> I<Instance>
1593 Type-instance to use. Defaults to the current map key or current string array element value.
1597 =head2 Plugin C<curl_xml>
1599 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1600 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1603 <URL "http://localhost/stats.xml">
1605 Instance "some_instance"
1610 CACert "/path/to/ca.crt"
1611 Header "X-Custom-Header: foobar"
1614 <XPath "table[@id=\"magic_level\"]/tr">
1616 #InstancePrefix "prefix-"
1617 InstanceFrom "td[1]"
1618 ValuesFrom "td[2]/span[@class=\"level\"]"
1623 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1624 URL to be fetched using libcurl. Within each B<URL> block there are
1625 options which specify the connection parameters, for example authentication
1626 information, and one or more B<XPath> blocks.
1628 Each B<XPath> block specifies how to get one type of information. The
1629 string argument must be a valid XPath expression which returns a list
1630 of "base elements". One value is dispatched for each "base element". The
1631 I<type instance> and values are looked up using further I<XPath> expressions
1632 that should be relative to the base element.
1634 Within the B<URL> block the following options are accepted:
1638 =item B<Host> I<Name>
1640 Use I<Name> as the host name when submitting values. Defaults to the global
1643 =item B<Instance> I<Instance>
1645 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1646 empty string (no plugin instance).
1648 =item B<Namespace> I<Prefix> I<URL>
1650 If an XPath expression references namespaces, they must be specified
1651 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1652 I<URL> is the "namespace name", an URI reference uniquely identifying the
1653 namespace. The option can be repeated to register multiple namespaces.
1657 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1658 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1660 =item B<User> I<User>
1662 =item B<Password> I<Password>
1664 =item B<Digest> B<true>|B<false>
1666 =item B<VerifyPeer> B<true>|B<false>
1668 =item B<VerifyHost> B<true>|B<false>
1670 =item B<CACert> I<CA Cert File>
1672 =item B<Header> I<Header>
1674 =item B<Post> I<Body>
1676 These options behave exactly equivalent to the appropriate options of the
1677 I<cURL plugin>. Please see there for a detailed description.
1679 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1681 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1682 B<XPath> block specifies how to get one type of information. The string
1683 argument must be a valid XPath expression which returns a list of "base
1684 elements". One value is dispatched for each "base element".
1686 Within the B<XPath> block the following options are accepted:
1690 =item B<Type> I<Type>
1692 Specifies the I<Type> used for submitting patches. This determines the number
1693 of values that are required / expected and whether the strings are parsed as
1694 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1695 This option is required.
1697 =item B<InstancePrefix> I<InstancePrefix>
1699 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1700 concatenated together without any separator.
1701 This option is optional.
1703 =item B<InstanceFrom> I<InstanceFrom>
1705 Specifies a XPath expression to use for determining the I<type instance>. The
1706 XPath expression must return exactly one element. The element's value is then
1707 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1709 This value is required. As a special exception, if the "base XPath expression"
1710 (the argument to the B<XPath> block) returns exactly one argument, then this
1711 option may be omitted.
1713 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1715 Specifies one or more XPath expression to use for reading the values. The
1716 number of XPath expressions must match the number of data sources in the
1717 I<type> specified with B<Type> (see above). Each XPath expression must return
1718 exactly one element. The element's value is then parsed as a number and used as
1719 value for the appropriate value in the value list dispatched to the daemon.
1725 =head2 Plugin C<dbi>
1727 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1728 connect to various databases, execute I<SQL> statements and read back the
1729 results. I<dbi> is an acronym for "database interface" in case you were
1730 wondering about the name. You can configure how each column is to be
1731 interpreted and the plugin will generate one or more data sets from each row
1732 returned according to these rules.
1734 Because the plugin is very generic, the configuration is a little more complex
1735 than those of other plugins. It usually looks something like this:
1738 <Query "out_of_stock">
1739 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1740 # Use with MySQL 5.0.0 or later
1744 InstancePrefix "out_of_stock"
1745 InstancesFrom "category"
1749 <Database "product_information">
1751 DriverOption "host" "localhost"
1752 DriverOption "username" "collectd"
1753 DriverOption "password" "aZo6daiw"
1754 DriverOption "dbname" "prod_info"
1755 SelectDB "prod_info"
1756 Query "out_of_stock"
1760 The configuration above defines one query with one result and one database. The
1761 query is then linked to the database with the B<Query> option I<within> the
1762 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1763 and you can also use the B<Include> statement to split up the configuration
1764 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1765 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1768 The following is a complete list of options:
1770 =head3 B<Query> blocks
1772 Query blocks define I<SQL> statements and how the returned data should be
1773 interpreted. They are identified by the name that is given in the opening line
1774 of the block. Thus the name needs to be unique. Other than that, the name is
1775 not used in collectd.
1777 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1778 define which column holds which value or instance information. You can use
1779 multiple B<Result> blocks to create multiple values from one returned row. This
1780 is especially useful, when queries take a long time and sending almost the same
1781 query again and again is not desirable.
1785 <Query "environment">
1786 Statement "select station, temperature, humidity from environment"
1789 # InstancePrefix "foo"
1790 InstancesFrom "station"
1791 ValuesFrom "temperature"
1795 InstancesFrom "station"
1796 ValuesFrom "humidity"
1800 The following options are accepted:
1804 =item B<Statement> I<SQL>
1806 Sets the statement that should be executed on the server. This is B<not>
1807 interpreted by collectd, but simply passed to the database server. Therefore,
1808 the SQL dialect that's used depends on the server collectd is connected to.
1810 The query has to return at least two columns, one for the instance and one
1811 value. You cannot omit the instance, even if the statement is guaranteed to
1812 always return exactly one line. In that case, you can usually specify something
1815 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1817 (That works with MySQL but may not be valid SQL according to the spec. If you
1818 use a more strict database server, you may have to select from a dummy table or
1821 Please note that some databases, for example B<Oracle>, will fail if you
1822 include a semicolon at the end of the statement.
1824 =item B<MinVersion> I<Version>
1826 =item B<MaxVersion> I<Value>
1828 Only use this query for the specified database version. You can use these
1829 options to provide multiple queries with the same name but with a slightly
1830 different syntax. The plugin will use only those queries, where the specified
1831 minimum and maximum versions fit the version of the database in use.
1833 The database version is determined by C<dbi_conn_get_engine_version>, see the
1834 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1835 for details. Basically, each part of the version is assumed to be in the range
1836 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1837 "40102", version "5.0.42" becomes "50042".
1839 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1840 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1841 happen. Don't to it! A valid example would be something along these lines:
1852 In the above example, there are three ranges that don't overlap. The last one
1853 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1854 before "4.0.0" are not specified.
1856 =item B<Type> I<Type>
1858 The B<type> that's used for each line returned. See L<types.db(5)> for more
1859 details on how types are defined. In short: A type is a predefined layout of
1860 data and the number of values and type of values has to match the type
1863 If you specify "temperature" here, you need exactly one gauge column. If you
1864 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1867 There must be exactly one B<Type> option inside each B<Result> block.
1869 =item B<InstancePrefix> I<prefix>
1871 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1872 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1873 all strings returned in the appropriate columns are concatenated together,
1874 separated by dashes I<("-")>.
1876 =item B<InstancesFrom> I<column0> [I<column1> ...]
1878 Specifies the columns whose values will be used to create the "type-instance"
1879 for each row. If you specify more than one column, the value of all columns
1880 will be joined together with dashes I<("-")> as separation characters.
1882 The plugin itself does not check whether or not all built instances are
1883 different. It's your responsibility to assure that each is unique. This is
1884 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1885 sure that only one row is returned in this case.
1887 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1890 =item B<ValuesFrom> I<column0> [I<column1> ...]
1892 Names the columns whose content is used as the actual data for the data sets
1893 that are dispatched to the daemon. How many such columns you need is determined
1894 by the B<Type> setting above. If you specify too many or not enough columns,
1895 the plugin will complain about that and no data will be submitted to the
1898 The actual data type in the columns is not that important. The plugin will
1899 automatically cast the values to the right type if it know how to do that. So
1900 it should be able to handle integer an floating point types, as well as strings
1901 (if they include a number at the beginning).
1903 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1905 =item B<MetadataFrom> [I<column0> I<column1> ...]
1907 Names the columns whose content is used as metadata for the data sets
1908 that are dispatched to the daemon.
1910 The actual data type in the columns is not that important. The plugin will
1911 automatically cast the values to the right type if it know how to do that. So
1912 it should be able to handle integer an floating point types, as well as strings
1913 (if they include a number at the beginning).
1917 =head3 B<Database> blocks
1919 Database blocks define a connection to a database and which queries should be
1920 sent to that database. Since the used "dbi" library can handle a wide variety
1921 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1922 documentationE<nbsp>- we stick as close to the terminology used there.
1924 Each database needs a "name" as string argument in the starting tag of the
1925 block. This name will be used as "PluginInstance" in the values submitted to
1926 the daemon. Other than that, that name is not used.
1930 =item B<Driver> I<Driver>
1932 Specifies the driver to use to connect to the database. In many cases those
1933 drivers are named after the database they can connect to, but this is not a
1934 technical necessity. These drivers are sometimes referred to as "DBD",
1935 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1936 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1937 project at L<http://libdbi-drivers.sourceforge.net/>.
1939 You need to give the driver name as expected by the "dbi" library here. You
1940 should be able to find that in the documentation for each driver. If you
1941 mistype the driver name, the plugin will dump a list of all known driver names
1944 =item B<DriverOption> I<Key> I<Value>
1946 Sets driver-specific options. What option a driver supports can be found in the
1947 documentation for each driver, somewhere at
1948 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1949 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1951 DBDs can register two types of options: String options and numeric options. The
1952 plugin will use the C<dbi_conn_set_option> function when the configuration
1953 provides a string and the C<dbi_conn_require_option_numeric> function when the
1954 configuration provides a number. So these two lines will actually result in
1955 different calls being used:
1957 DriverOption "Port" 1234 # numeric
1958 DriverOption "Port" "1234" # string
1960 Unfortunately, drivers are not too keen to report errors when an unknown option
1961 is passed to them, so invalid settings here may go unnoticed. This is not the
1962 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1963 the driver. If a driver complains about an option, the plugin will dump a
1964 complete list of all options understood by that driver to the log. There is no
1965 way to programatically find out if an option expects a string or a numeric
1966 argument, so you will have to refer to the appropriate DBD's documentation to
1967 find this out. Sorry.
1969 =item B<SelectDB> I<Database>
1971 In some cases, the database name you connect with is not the database name you
1972 want to use for querying data. If this option is set, the plugin will "select"
1973 (switch to) that database after the connection is established.
1975 =item B<Query> I<QueryName>
1977 Associates the query named I<QueryName> with this database connection. The
1978 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1979 blocks you want to refer to must be placed above the database block you want to
1982 =item B<Host> I<Hostname>
1984 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1985 values. Defaults to the global hostname setting.
1993 =item B<Device> I<Device>
1995 Select partitions based on the devicename.
1997 =item B<MountPoint> I<Directory>
1999 Select partitions based on the mountpoint.
2001 =item B<FSType> I<FSType>
2003 Select partitions based on the filesystem type.
2005 =item B<IgnoreSelected> B<true>|B<false>
2007 Invert the selection: If set to true, all partitions B<except> the ones that
2008 match any one of the criteria are collected. By default only selected
2009 partitions are collected if a selection is made. If no selection is configured
2010 at all, B<all> partitions are selected.
2012 =item B<ReportByDevice> B<true>|B<false>
2014 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2015 (the default), it will report a disk as "root", but with it I<true>, it will be
2016 "sda1" (or whichever).
2018 =item B<ReportInodes> B<true>|B<false>
2020 Enables or disables reporting of free, reserved and used inodes. Defaults to
2021 inode collection being disabled.
2023 Enable this option if inodes are a scarce resource for you, usually because
2024 many small files are stored on the disk. This is a usual scenario for mail
2025 transfer agents and web caches.
2027 =item B<ValuesAbsolute> B<true>|B<false>
2029 Enables or disables reporting of free and used disk space in 1K-blocks.
2030 Defaults to B<true>.
2032 =item B<ValuesPercentage> B<false>|B<true>
2034 Enables or disables reporting of free and used disk space in percentage.
2035 Defaults to B<false>.
2037 This is useful for deploying I<collectd> on the cloud, where machines with
2038 different disk size may exist. Then it is more practical to configure
2039 thresholds based on relative disk size.
2043 =head2 Plugin C<disk>
2045 The C<disk> plugin collects information about the usage of physical disks and
2046 logical disks (partitions). Values collected are the number of octets written
2047 to and read from a disk or partition, the number of read/write operations
2048 issued to the disk and a rather complex "time" it took for these commands to be
2051 Using the following two options you can ignore some disks or configure the
2052 collection only of specific disks.
2056 =item B<Disk> I<Name>
2058 Select the disk I<Name>. Whether it is collected or ignored depends on the
2059 B<IgnoreSelected> setting, see below. As with other plugins that use the
2060 daemon's ignorelist functionality, a string that starts and ends with a slash
2061 is interpreted as a regular expression. Examples:
2066 =item B<IgnoreSelected> B<true>|B<false>
2068 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2069 statements, are ignored or if all other disks are ignored. The behavior
2070 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2071 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2072 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2073 is set to B<true>, all disks are collected B<except> the ones matched.
2075 =item B<UseBSDName> B<true>|B<false>
2077 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2078 default major/minor numbers. Requires collectd to be built with Apple's
2081 =item B<UdevNameAttr> I<Attribute>
2083 Attempt to override disk instance name with the value of a specified udev
2084 attribute when built with B<libudev>. If the attribute is not defined for the
2085 given device, the default name is used. Example:
2087 UdevNameAttr "DM_NAME"
2091 =head2 Plugin C<dns>
2095 =item B<Interface> I<Interface>
2097 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2098 option sets the interface that should be used. If this option is not set, or
2099 set to "any", the plugin will try to get packets from B<all> interfaces. This
2100 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2102 =item B<IgnoreSource> I<IP-address>
2104 Ignore packets that originate from this address.
2106 =item B<SelectNumericQueryTypes> B<true>|B<false>
2108 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2112 =head2 Plugin C<email>
2116 =item B<SocketFile> I<Path>
2118 Sets the socket-file which is to be created.
2120 =item B<SocketGroup> I<Group>
2122 If running as root change the group of the UNIX-socket after it has been
2123 created. Defaults to B<collectd>.
2125 =item B<SocketPerms> I<Permissions>
2127 Change the file permissions of the UNIX-socket after it has been created. The
2128 permissions must be given as a numeric, octal value as you would pass to
2129 L<chmod(1)>. Defaults to B<0770>.
2131 =item B<MaxConns> I<Number>
2133 Sets the maximum number of connections that can be handled in parallel. Since
2134 this many threads will be started immediately setting this to a very high
2135 value will waste valuable resources. Defaults to B<5> and will be forced to be
2136 at most B<16384> to prevent typos and dumb mistakes.
2140 =head2 Plugin C<ethstat>
2142 The I<ethstat plugin> collects information about network interface cards (NICs)
2143 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2149 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2150 Map "multicast" "if_multicast"
2157 =item B<Interface> I<Name>
2159 Collect statistical information about interface I<Name>.
2161 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2163 By default, the plugin will submit values as type C<derive> and I<type
2164 instance> set to I<Name>, the name of the metric as reported by the driver. If
2165 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2166 I<TypeInstance> will be used.
2168 =item B<MappedOnly> B<true>|B<false>
2170 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2171 collected, all other metrics will be ignored. Defaults to B<false>.
2175 =head2 Plugin C<exec>
2177 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2178 contains valuable information on when the executable is executed and the
2179 output that is expected from it.
2183 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2185 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2187 Execute the executable I<Executable> as user I<User>. If the user name is
2188 followed by a colon and a group name, the effective group is set to that group.
2189 The real group and saved-set group will be set to the default group of that
2190 user. If no group is given the effective group ID will be the same as the real
2193 Please note that in order to change the user and/or group the daemon needs
2194 superuser privileges. If the daemon is run as an unprivileged user you must
2195 specify the same user/group here. If the daemon is run with superuser
2196 privileges, you must supply a non-root user here.
2198 The executable may be followed by optional arguments that are passed to the
2199 program. Please note that due to the configuration parsing numbers and boolean
2200 values may be changed. If you want to be absolutely sure that something is
2201 passed as-is please enclose it in quotes.
2203 The B<Exec> and B<NotificationExec> statements change the semantics of the
2204 programs executed, i.E<nbsp>e. the data passed to them and the response
2205 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2209 =head2 Plugin C<filecount>
2211 The C<filecount> plugin counts the number of files in a certain directory (and
2212 its subdirectories) and their combined size. The configuration is very straight
2215 <Plugin "filecount">
2216 <Directory "/var/qmail/queue/mess">
2217 Instance "qmail-message"
2219 <Directory "/var/qmail/queue/todo">
2220 Instance "qmail-todo"
2222 <Directory "/var/lib/php5">
2223 Instance "php5-sessions"
2228 The example above counts the number of files in QMail's queue directories and
2229 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2230 QMail has not yet looked at, the "message" queue holds the messages that were
2231 classified into "local" and "remote".
2233 As you can see, the configuration consists of one or more C<Directory> blocks,
2234 each of which specifies a directory in which to count the files. Within those
2235 blocks, the following options are recognized:
2239 =item B<Instance> I<Instance>
2241 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2242 it's your responsibility, the plugin doesn't check for that. If not given, the
2243 instance is set to the directory name with all slashes replaced by underscores
2244 and all leading underscores removed.
2246 =item B<Name> I<Pattern>
2248 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2249 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2250 against the pattern, not the entire path. In case this makes it easier for you:
2251 This option has been named after the B<-name> parameter to L<find(1)>.
2253 =item B<MTime> I<Age>
2255 Count only files of a specific age: If I<Age> is greater than zero, only files
2256 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2257 a negative number, this is inversed. For example, if B<-60> is specified, only
2258 files that have been modified in the last minute will be counted.
2260 The number can also be followed by a "multiplier" to easily specify a larger
2261 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2262 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2263 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2264 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2265 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2268 =item B<Size> I<Size>
2270 Count only files of a specific size. When I<Size> is a positive number, only
2271 files that are at least this big are counted. If I<Size> is a negative number,
2272 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2273 I<Size> are counted.
2275 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2276 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2277 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2278 note that there are 1000 bytes in a kilobyte, not 1024.
2280 =item B<Recursive> I<true>|I<false>
2282 Controls whether or not to recurse into subdirectories. Enabled by default.
2284 =item B<IncludeHidden> I<true>|I<false>
2286 Controls whether or not to include "hidden" files and directories in the count.
2287 "Hidden" files and directories are those, whose name begins with a dot.
2288 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2292 =head2 Plugin C<GenericJMX>
2294 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2295 L<collectd-java(5)>.
2297 =head2 Plugin C<gmond>
2299 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2300 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2301 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2306 MCReceiveFrom "239.2.11.71" "8649"
2307 <Metric "swap_total">
2309 TypeInstance "total"
2312 <Metric "swap_free">
2319 The following metrics are built-in:
2325 load_one, load_five, load_fifteen
2329 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2333 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2345 Available configuration options:
2349 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2351 Sets sets the multicast group and UDP port to which to subscribe.
2353 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2355 =item E<lt>B<Metric> I<Name>E<gt>
2357 These blocks add a new metric conversion to the internal table. I<Name>, the
2358 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2362 =item B<Type> I<Type>
2364 Type to map this metric to. Required.
2366 =item B<TypeInstance> I<Instance>
2368 Type-instance to use. Optional.
2370 =item B<DataSource> I<Name>
2372 Data source to map this metric to. If the configured type has exactly one data
2373 source, this is optional. Otherwise the option is required.
2379 =head2 Plugin C<hddtemp>
2381 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2382 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2383 default values, see below. C<hddtemp> has to be running to work correctly. If
2384 C<hddtemp> is not running timeouts may appear which may interfere with other
2387 The B<hddtemp> homepage can be found at
2388 L<http://www.guzu.net/linux/hddtemp.php>.
2392 =item B<Host> I<Hostname>
2394 Hostname to connect to. Defaults to B<127.0.0.1>.
2396 =item B<Port> I<Port>
2398 TCP-Port to connect to. Defaults to B<7634>.
2402 =head2 Plugin C<interface>
2406 =item B<Interface> I<Interface>
2408 Select this interface. By default these interfaces will then be collected. For
2409 a more detailed description see B<IgnoreSelected> below.
2411 =item B<IgnoreSelected> I<true>|I<false>
2413 If no configuration if given, the B<traffic>-plugin will collect data from
2414 all interfaces. This may not be practical, especially for loopback- and
2415 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2416 interfaces you're interested in. Sometimes, however, it's easier/preferred
2417 to collect all interfaces I<except> a few ones. This option enables you to
2418 do that: By setting B<IgnoreSelected> to I<true> the effect of
2419 B<Interface> is inverted: All selected interfaces are ignored and all
2420 other interfaces are collected.
2424 =head2 Plugin C<ipmi>
2428 =item B<Sensor> I<Sensor>
2430 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2432 =item B<IgnoreSelected> I<true>|I<false>
2434 If no configuration if given, the B<ipmi> plugin will collect data from all
2435 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2436 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2437 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2438 all other sensors are collected.
2440 =item B<NotifySensorAdd> I<true>|I<false>
2442 If a sensor appears after initialization time of a minute a notification
2445 =item B<NotifySensorRemove> I<true>|I<false>
2447 If a sensor disappears a notification is sent.
2449 =item B<NotifySensorNotPresent> I<true>|I<false>
2451 If you have for example dual power supply and one of them is (un)plugged then
2452 a notification is sent.
2456 =head2 Plugin C<iptables>
2460 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2462 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2463 will collect the counters of all rules which have a comment-match. The comment
2464 is then used as type-instance.
2466 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2467 the I<n>th rule will be collected. Again, the comment (or the number) will be
2468 used as the type-instance.
2470 If I<Name> is supplied, it will be used as the type-instance instead of the
2471 comment or the number.
2475 =head2 Plugin C<irq>
2481 Select this irq. By default these irqs will then be collected. For a more
2482 detailed description see B<IgnoreSelected> below.
2484 =item B<IgnoreSelected> I<true>|I<false>
2486 If no configuration if given, the B<irq>-plugin will collect data from all
2487 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2488 can use the B<Irq>-option to pick the interrupt you're interested in.
2489 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2490 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2491 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2492 and all other interrupts are collected.
2496 =head2 Plugin C<java>
2498 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2499 This section only discusses the syntax and semantic of the configuration
2500 options. For more in-depth information on the I<Java> plugin, please read
2501 L<collectd-java(5)>.
2506 JVMArg "-verbose:jni"
2507 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2508 LoadPlugin "org.collectd.java.Foobar"
2509 <Plugin "org.collectd.java.Foobar">
2510 # To be parsed by the plugin
2514 Available configuration options:
2518 =item B<JVMArg> I<Argument>
2520 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2521 exactly the way the arguments to the I<java> binary on the command line work.
2522 Execute C<javaE<nbsp>--help> for details.
2524 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2525 any other options! When another option is found, the JVM will be started and
2526 later options will have to be ignored!
2528 =item B<LoadPlugin> I<JavaClass>
2530 Instantiates a new I<JavaClass> object. The constructor of this object very
2531 likely then registers one or more callback methods with the server.
2533 See L<collectd-java(5)> for details.
2535 When the first such option is found, the virtual machine (JVM) is created. This
2536 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2537 B<LoadPlugin> options!
2539 =item B<Plugin> I<Name>
2541 The entire block is passed to the Java plugin as an
2542 I<org.collectd.api.OConfigItem> object.
2544 For this to work, the plugin has to register a configuration callback first,
2545 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2546 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2547 depends on the (Java) plugin registering the callback and is completely
2548 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2552 =head2 Plugin C<load>
2554 The I<Load plugin> collects the system load. These numbers give a rough overview
2555 over the utilization of a machine. The system load is defined as the number of
2556 runnable tasks in the run-queue and is provided by many operating systems as a
2557 one, five or fifteen minute average.
2559 The following configuration options are available:
2563 =item B<ReportRelative> B<false>|B<true>
2565 When enabled, system load divided by number of available CPU cores is reported
2566 for intervals 1 min, 5 min and 15 min. Defaults to false.
2571 =head2 Plugin C<logfile>
2575 =item B<LogLevel> B<debug|info|notice|warning|err>
2577 Sets the log-level. If, for example, set to B<notice>, then all events with
2578 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2580 Please note that B<debug> is only available if collectd has been compiled with
2583 =item B<File> I<File>
2585 Sets the file to write log messages to. The special strings B<stdout> and
2586 B<stderr> can be used to write to the standard output and standard error
2587 channels, respectively. This, of course, only makes much sense when I<collectd>
2588 is running in foreground- or non-daemon-mode.
2590 =item B<Timestamp> B<true>|B<false>
2592 Prefix all lines printed by the current time. Defaults to B<true>.
2594 =item B<PrintSeverity> B<true>|B<false>
2596 When enabled, all lines are prefixed by the severity of the log message, for
2597 example "warning". Defaults to B<false>.
2601 B<Note>: There is no need to notify the daemon after moving or removing the
2602 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2603 for each line it writes.
2605 =head2 Plugin C<log_logstash>
2607 The I<log logstash plugin> behaves like the logfile plugin but formats
2608 messages as JSON events for logstash to parse and input.
2612 =item B<LogLevel> B<debug|info|notice|warning|err>
2614 Sets the log-level. If, for example, set to B<notice>, then all events with
2615 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2617 Please note that B<debug> is only available if collectd has been compiled with
2620 =item B<File> I<File>
2622 Sets the file to write log messages to. The special strings B<stdout> and
2623 B<stderr> can be used to write to the standard output and standard error
2624 channels, respectively. This, of course, only makes much sense when I<collectd>
2625 is running in foreground- or non-daemon-mode.
2629 B<Note>: There is no need to notify the daemon after moving or removing the
2630 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2631 for each line it writes.
2633 =head2 Plugin C<lpar>
2635 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2636 virtualization technique for IBM POWER processors. It takes into account CPU
2637 time stolen from or donated to a partition, in addition to the usual user,
2638 system, I/O statistics.
2640 The following configuration options are available:
2644 =item B<CpuPoolStats> B<false>|B<true>
2646 When enabled, statistics about the processor pool are read, too. The partition
2647 needs to have pool authority in order to be able to acquire this information.
2650 =item B<ReportBySerial> B<false>|B<true>
2652 If enabled, the serial of the physical machine the partition is currently
2653 running on is reported as I<hostname> and the logical hostname of the machine
2654 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2655 used (just like other plugins) and the I<plugin instance> will be empty.
2660 =head2 Plugin C<mbmon>
2662 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2664 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2665 B<Host> and B<Port> options can be used to change these values, see below.
2666 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2667 timeouts may appear which may interfere with other statistics..
2669 C<mbmon> must be run with the -r option ("print TAG and Value format");
2670 Debian's F</etc/init.d/mbmon> script already does this, other people
2671 will need to ensure that this is the case.
2675 =item B<Host> I<Hostname>
2677 Hostname to connect to. Defaults to B<127.0.0.1>.
2679 =item B<Port> I<Port>
2681 TCP-Port to connect to. Defaults to B<411>.
2687 The C<md plugin> collects information from Linux Software-RAID devices (md).
2689 All reported values are of the type C<md_disks>. Reported type instances are
2690 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2691 I<missing> (physically absent) disks.
2695 =item B<Device> I<Device>
2697 Select md devices based on device name. The I<device name> is the basename of
2698 the device, i.e. the name of the block device without the leading C</dev/>.
2699 See B<IgnoreSelected> for more details.
2701 =item B<IgnoreSelected> B<true>|B<false>
2703 Invert device selection: If set to B<true>, all md devices B<except> those
2704 listed using B<Device> are collected. If B<false> (the default), only those
2705 listed are collected. If no configuration is given, the B<md> plugin will
2706 collect data from all md devices.
2710 =head2 Plugin C<memcachec>
2712 The C<memcachec plugin> connects to a memcached server, queries one or more
2713 given I<pages> and parses the returned data according to user specification.
2714 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2717 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2718 library. Please note that there is another library with a very similar name,
2719 libmemcache (notice the missing `d'), which is not applicable.
2721 Synopsis of the configuration:
2723 <Plugin "memcachec">
2724 <Page "plugin_instance">
2728 Regex "(\\d+) bytes sent"
2731 Instance "type_instance"
2736 The configuration options are:
2740 =item E<lt>B<Page> I<Name>E<gt>
2742 Each B<Page> block defines one I<page> to be queried from the memcached server.
2743 The block requires one string argument which is used as I<plugin instance>.
2745 =item B<Server> I<Address>
2747 Sets the server address to connect to when querying the page. Must be inside a
2752 When connected to the memcached server, asks for the page I<Key>.
2754 =item E<lt>B<Match>E<gt>
2756 Match blocks define which strings to look for and how matches substrings are
2757 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2761 =head2 Plugin C<memcached>
2763 The B<memcached plugin> connects to a memcached server and queries statistics
2764 about cache utilization, memory and bandwidth used.
2765 L<http://www.danga.com/memcached/>
2767 <Plugin "memcached">
2769 Host "memcache.example.com"
2774 The plugin configuration consists of one or more B<Instance> blocks which
2775 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2776 following options are allowed:
2780 =item B<Host> I<Hostname>
2782 Hostname to connect to. Defaults to B<127.0.0.1>.
2784 =item B<Port> I<Port>
2786 TCP-Port to connect to. Defaults to B<11211>.
2788 =item B<Socket> I<Path>
2790 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2791 setting is given, the B<Host> and B<Port> settings are ignored.
2795 =head2 Plugin C<mic>
2797 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2798 Intel's Many Integrated Core (MIC) systems.
2807 ShowTemperatures true
2810 IgnoreSelectedTemperature true
2815 IgnoreSelectedPower true
2818 The following options are valid inside the B<PluginE<nbsp>mic> block:
2822 =item B<ShowCPU> B<true>|B<false>
2824 If enabled (the default) a sum of the CPU usage across all cores is reported.
2826 =item B<ShowCPUCores> B<true>|B<false>
2828 If enabled (the default) per-core CPU usage is reported.
2830 =item B<ShowMemory> B<true>|B<false>
2832 If enabled (the default) the physical memory usage of the MIC system is
2835 =item B<ShowTemperatures> B<true>|B<false>
2837 If enabled (the default) various temperatures of the MIC system are reported.
2839 =item B<Temperature> I<Name>
2841 This option controls which temperatures are being reported. Whether matching
2842 temperatures are being ignored or I<only> matching temperatures are reported
2843 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2844 temperatures are reported.
2846 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2848 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2849 (the default) only temperatures matching a B<Temperature> option are reported
2850 or, if no B<Temperature> option is specified, all temperatures are reported. If
2851 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2854 Known temperature names are:
2888 =item B<ShowPower> B<true>|B<false>
2890 If enabled (the default) various temperatures of the MIC system are reported.
2892 =item B<Power> I<Name>
2894 This option controls which power readings are being reported. Whether matching
2895 power readings are being ignored or I<only> matching power readings are reported
2896 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2897 power readings are reported.
2899 =item B<IgnoreSelectedPower> B<false>|B<true>
2901 Controls the behavior of the B<Power> setting above. If set to B<false>
2902 (the default) only power readings matching a B<Power> option are reported
2903 or, if no B<Power> option is specified, all power readings are reported. If
2904 set to B<true>, matching power readings are I<ignored> and all other power readings
2907 Known power names are:
2913 Total power utilization averaged over Time Window 0 (uWatts).
2917 Total power utilization averaged over Time Window 0 (uWatts).
2921 Instantaneous power (uWatts).
2925 Max instantaneous power (uWatts).
2929 PCI-E connector power (uWatts).
2933 2x3 connector power (uWatts).
2937 2x4 connector power (uWatts).
2945 Uncore rail (uVolts).
2949 Memory subsystem rail (uVolts).
2955 =head2 Plugin C<memory>
2957 The I<memory plugin> provides the following configuration options:
2961 =item B<ValuesAbsolute> B<true>|B<false>
2963 Enables or disables reporting of physical memory usage in absolute numbers,
2964 i.e. bytes. Defaults to B<true>.
2966 =item B<ValuesPercentage> B<false>|B<true>
2968 Enables or disables reporting of physical memory usage in percentages, e.g.
2969 percent of physical memory used. Defaults to B<false>.
2971 This is useful for deploying I<collectd> in a heterogeneous environment in
2972 which the sizes of physical memory vary.
2976 =head2 Plugin C<modbus>
2978 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
2979 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
2980 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2981 values (two registers interpreted as IEEE floats in big endian notation).
2985 <Data "voltage-input-1">
2988 RegisterCmd ReadHolding
2993 <Data "voltage-input-2">
2996 RegisterCmd ReadHolding
3001 <Data "supply-temperature-1">
3004 RegisterCmd ReadHolding
3009 <Host "modbus.example.com">
3010 Address "192.168.0.42"
3015 Instance "power-supply"
3016 Collect "voltage-input-1"
3017 Collect "voltage-input-2"
3022 Device "/dev/ttyUSB0"
3027 Instance "temperature"
3028 Collect "supply-temperature-1"
3034 =item E<lt>B<Data> I<Name>E<gt> blocks
3036 Data blocks define a mapping between register numbers and the "types" used by
3039 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3043 =item B<RegisterBase> I<Number>
3045 Configures the base register to read from the device. If the option
3046 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3047 register will be read (the register number is increased by one).
3049 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3051 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3052 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3053 combined into one value. Defaults to B<Uint16>.
3055 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3057 Specifies register type to be collected from device. Works only with libmodbus
3058 2.9.2 or higher. Defaults to B<ReadHolding>.
3060 =item B<Type> I<Type>
3062 Specifies the "type" (data set) to use when dispatching the value to
3063 I<collectd>. Currently, only data sets with exactly one data source are
3066 =item B<Instance> I<Instance>
3068 Sets the type instance to use when dispatching the value to I<collectd>. If
3069 unset, an empty string (no type instance) is used.
3073 =item E<lt>B<Host> I<Name>E<gt> blocks
3075 Host blocks are used to specify to which hosts to connect and what data to read
3076 from their "slaves". The string argument I<Name> is used as hostname when
3077 dispatching the values to I<collectd>.
3079 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3083 =item B<Address> I<Hostname>
3085 For Modbus/TCP, specifies the node name (the actual network address) used to
3086 connect to the host. This may be an IP address or a hostname. Please note that
3087 the used I<libmodbus> library only supports IPv4 at the moment.
3089 =item B<Port> I<Service>
3091 for Modbus/TCP, specifies the port used to connect to the host. The port can
3092 either be given as a number or as a service name. Please note that the
3093 I<Service> argument must be a string, even if ports are given in their numerical
3094 form. Defaults to "502".
3096 =item B<Device> I<Devicenode>
3098 For Modbus/RTU, specifies the path to the serial device being used.
3100 =item B<Baudrate> I<Baudrate>
3102 For Modbus/RTU, specifies the baud rate of the serial device.
3103 Note, connections currently support only 8/N/1.
3105 =item B<Interval> I<Interval>
3107 Sets the interval (in seconds) in which the values will be collected from this
3108 host. By default the global B<Interval> setting will be used.
3110 =item E<lt>B<Slave> I<ID>E<gt>
3112 Over each connection, multiple Modbus devices may be reached. The slave ID
3113 is used to specify which device should be addressed. For each device you want
3114 to query, one B<Slave> block must be given.
3116 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3120 =item B<Instance> I<Instance>
3122 Specify the plugin instance to use when dispatching the values to I<collectd>.
3123 By default "slave_I<ID>" is used.
3125 =item B<Collect> I<DataName>
3127 Specifies which data to retrieve from the device. I<DataName> must be the same
3128 string as the I<Name> argument passed to a B<Data> block. You can specify this
3129 option multiple times to collect more than one value from a slave. At least one
3130 B<Collect> option is mandatory.
3138 =head2 Plugin C<mysql>
3140 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3141 one or more databases when started and keeps the connection up as long as
3142 possible. When the connection is interrupted for whatever reason it will try
3143 to re-connect. The plugin will complain loudly in case anything goes wrong.
3145 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3146 and collects information about MySQL network traffic, executed statements,
3147 requests, the query cache and threads by evaluating the
3148 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3149 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3150 Status Variables> for an explanation of these values.
3152 Optionally, master and slave statistics may be collected in a MySQL
3153 replication setup. In that case, information about the synchronization state
3154 of the nodes are collected by evaluating the C<Position> return value of the
3155 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3156 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3157 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3158 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3159 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3176 Socket "/var/run/mysql/mysqld.sock"
3178 SlaveNotifications true
3182 A B<Database> block defines one connection to a MySQL database. It accepts a
3183 single argument which specifies the name of the database. None of the other
3184 options are required. MySQL will use default values as documented in the
3185 section "mysql_real_connect()" in the B<MySQL reference manual>.
3189 =item B<Alias> I<Alias>
3191 Alias to use as sender instead of hostname when reporting. This may be useful
3192 when having cryptic hostnames.
3194 =item B<Host> I<Hostname>
3196 Hostname of the database server. Defaults to B<localhost>.
3198 =item B<User> I<Username>
3200 Username to use when connecting to the database. The user does not have to be
3201 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3202 unless you want to collectd replication statistics (see B<MasterStats> and
3203 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3204 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3206 =item B<Password> I<Password>
3208 Password needed to log into the database.
3210 =item B<Database> I<Database>
3212 Select this database. Defaults to I<no database> which is a perfectly reasonable
3213 option for what this plugin does.
3215 =item B<Port> I<Port>
3217 TCP-port to connect to. The port must be specified in its numeric form, but it
3218 must be passed as a string nonetheless. For example:
3222 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3223 See the documentation for the C<mysql_real_connect> function for details.
3225 =item B<Socket> I<Socket>
3227 Specifies the path to the UNIX domain socket of the MySQL server. This option
3228 only has any effect, if B<Host> is set to B<localhost> (the default).
3229 Otherwise, use the B<Port> option above. See the documentation for the
3230 C<mysql_real_connect> function for details.
3232 =item B<InnodbStats> I<true|false>
3234 If enabled, metrics about the InnoDB storage engine are collected.
3235 Disabled by default.
3237 =item B<MasterStats> I<true|false>
3239 =item B<SlaveStats> I<true|false>
3241 Enable the collection of master / slave statistics in a replication setup. In
3242 order to be able to get access to these statistics, the user needs special
3243 privileges. See the B<User> documentation above. Defaults to B<false>.
3245 =item B<SlaveNotifications> I<true|false>
3247 If enabled, the plugin sends a notification if the replication slave I/O and /
3248 or SQL threads are not running. Defaults to B<false>.
3250 =item B<ConnectTimeout> I<Seconds>
3252 Sets the connect timeout for the MySQL client.
3256 =head2 Plugin C<netapp>
3258 The netapp plugin can collect various performance and capacity information
3259 from a NetApp filer using the NetApp API.
3261 Please note that NetApp has a wide line of products and a lot of different
3262 software versions for each of these products. This plugin was developed for a
3263 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3264 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3265 model and software version but it is very hard to test this.
3266 If you have used this plugin with other models and/or software version, feel
3267 free to send us a mail to tell us about the results, even if it's just a short
3270 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3271 basic authentication.
3273 B<Do not use a regular user for this!> Create a special collectd user with just
3274 the minimum of capabilities needed. The user only needs the "login-http-admin"
3275 capability as well as a few more depending on which data will be collected.
3276 Required capabilities are documented below.
3281 <Host "netapp1.example.com">
3305 IgnoreSelectedIO false
3307 IgnoreSelectedOps false
3308 GetLatency "volume0"
3309 IgnoreSelectedLatency false
3316 IgnoreSelectedCapacity false
3319 IgnoreSelectedSnapshot false
3347 The netapp plugin accepts the following configuration options:
3351 =item B<Host> I<Name>
3353 A host block defines one NetApp filer. It will appear in collectd with the name
3354 you specify here which does not have to be its real name nor its hostname (see
3355 the B<Address> option below).
3357 =item B<VFiler> I<Name>
3359 A B<VFiler> block may only be used inside a host block. It accepts all the
3360 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3361 will execute all NetApp API commands in the context of the specified
3362 VFiler(R). It will appear in collectd with the name you specify here which
3363 does not have to be its real name. The VFiler name may be specified using the
3364 B<VFilerName> option. If this is not specified, it will default to the name
3367 The VFiler block inherits all connection related settings from the surrounding
3368 B<Host> block (which appear before the B<VFiler> block) but they may be
3369 overwritten inside the B<VFiler> block.
3371 This feature is useful, for example, when using a VFiler as SnapVault target
3372 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3373 available in the host filer (vfiler0) but only in the respective VFiler
3376 =item B<Protocol> B<httpd>|B<http>
3378 The protocol collectd will use to query this host.
3386 Valid options: http, https
3388 =item B<Address> I<Address>
3390 The hostname or IP address of the host.
3396 Default: The "host" block's name.
3398 =item B<Port> I<Port>
3400 The TCP port to connect to on the host.
3406 Default: 80 for protocol "http", 443 for protocol "https"
3408 =item B<User> I<User>
3410 =item B<Password> I<Password>
3412 The username and password to use to login to the NetApp.
3418 =item B<VFilerName> I<Name>
3420 The name of the VFiler in which context to execute API commands. If not
3421 specified, the name provided to the B<VFiler> block will be used instead.
3427 Default: name of the B<VFiler> block
3429 B<Note:> This option may only be used inside B<VFiler> blocks.
3431 =item B<Interval> I<Interval>
3437 The following options decide what kind of data will be collected. You can
3438 either use them as a block and fine tune various parameters inside this block,
3439 use them as a single statement to just accept all default values, or omit it to
3440 not collect any data.
3442 The following options are valid inside all blocks:
3446 =item B<Interval> I<Seconds>
3448 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3449 host specific setting.
3453 =head3 The System block
3455 This will collect various performance data about the whole system.
3457 B<Note:> To get this data the collectd user needs the
3458 "api-perf-object-get-instances" capability.
3462 =item B<Interval> I<Seconds>
3464 Collect disk statistics every I<Seconds> seconds.
3466 =item B<GetCPULoad> B<true>|B<false>
3468 If you set this option to true the current CPU usage will be read. This will be
3469 the average usage between all CPUs in your NetApp without any information about
3472 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3473 returns in the "CPU" field.
3481 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3483 =item B<GetInterfaces> B<true>|B<false>
3485 If you set this option to true the current traffic of the network interfaces
3486 will be read. This will be the total traffic over all interfaces of your NetApp
3487 without any information about individual interfaces.
3489 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3490 in the "Net kB/s" field.
3500 Result: One value list of type "if_octects".
3502 =item B<GetDiskIO> B<true>|B<false>
3504 If you set this option to true the current IO throughput will be read. This
3505 will be the total IO of your NetApp without any information about individual
3506 disks, volumes or aggregates.
3508 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3509 in the "DiskE<nbsp>kB/s" field.
3517 Result: One value list of type "disk_octets".
3519 =item B<GetDiskOps> B<true>|B<false>
3521 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3522 iSCSI, etc. operations will be read. This will be the total number of
3523 operations on your NetApp without any information about individual volumes or
3526 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3527 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3535 Result: A variable number of value lists of type "disk_ops_complex". Each type
3536 of operation will result in one value list with the name of the operation as
3541 =head3 The WAFL block
3543 This will collect various performance data about the WAFL file system. At the
3544 moment this just means cache performance.
3546 B<Note:> To get this data the collectd user needs the
3547 "api-perf-object-get-instances" capability.
3549 B<Note:> The interface to get these values is classified as "Diagnostics" by
3550 NetApp. This means that it is not guaranteed to be stable even between minor
3555 =item B<Interval> I<Seconds>
3557 Collect disk statistics every I<Seconds> seconds.
3559 =item B<GetNameCache> B<true>|B<false>
3567 Result: One value list of type "cache_ratio" and type instance
3570 =item B<GetDirCache> B<true>|B<false>
3578 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3580 =item B<GetInodeCache> B<true>|B<false>
3588 Result: One value list of type "cache_ratio" and type instance
3591 =item B<GetBufferCache> B<true>|B<false>
3593 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3594 in the "Cache hit" field.
3602 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3606 =head3 The Disks block
3608 This will collect performance data about the individual disks in the NetApp.
3610 B<Note:> To get this data the collectd user needs the
3611 "api-perf-object-get-instances" capability.
3615 =item B<Interval> I<Seconds>
3617 Collect disk statistics every I<Seconds> seconds.
3619 =item B<GetBusy> B<true>|B<false>
3621 If you set this option to true the busy time of all disks will be calculated
3622 and the value of the busiest disk in the system will be written.
3624 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3625 in the "Disk util" field. Probably.
3633 Result: One value list of type "percent" and type instance "disk_busy".
3637 =head3 The VolumePerf block
3639 This will collect various performance data about the individual volumes.
3641 You can select which data to collect about which volume using the following
3642 options. They follow the standard ignorelist semantic.
3644 B<Note:> To get this data the collectd user needs the
3645 I<api-perf-object-get-instances> capability.
3649 =item B<Interval> I<Seconds>
3651 Collect volume performance data every I<Seconds> seconds.
3653 =item B<GetIO> I<Volume>
3655 =item B<GetOps> I<Volume>
3657 =item B<GetLatency> I<Volume>
3659 Select the given volume for IO, operations or latency statistics collection.
3660 The argument is the name of the volume without the C</vol/> prefix.
3662 Since the standard ignorelist functionality is used here, you can use a string
3663 starting and ending with a slash to specify regular expression matching: To
3664 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3667 GetIO "/^vol[027]$/"
3669 If no regular expression is specified, an exact match is required. Both,
3670 regular and exact matching are case sensitive.
3672 If no volume was specified at all for either of the three options, that data
3673 will be collected for all available volumes.
3675 =item B<IgnoreSelectedIO> B<true>|B<false>
3677 =item B<IgnoreSelectedOps> B<true>|B<false>
3679 =item B<IgnoreSelectedLatency> B<true>|B<false>
3681 When set to B<true>, the volumes selected for IO, operations or latency
3682 statistics collection will be ignored and the data will be collected for all
3685 When set to B<false>, data will only be collected for the specified volumes and
3686 all other volumes will be ignored.
3688 If no volumes have been specified with the above B<Get*> options, all volumes
3689 will be collected regardless of the B<IgnoreSelected*> option.
3691 Defaults to B<false>
3695 =head3 The VolumeUsage block
3697 This will collect capacity data about the individual volumes.
3699 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3704 =item B<Interval> I<Seconds>
3706 Collect volume usage statistics every I<Seconds> seconds.
3708 =item B<GetCapacity> I<VolumeName>
3710 The current capacity of the volume will be collected. This will result in two
3711 to four value lists, depending on the configuration of the volume. All data
3712 sources are of type "df_complex" with the name of the volume as
3715 There will be type_instances "used" and "free" for the number of used and
3716 available bytes on the volume. If the volume has some space reserved for
3717 snapshots, a type_instance "snap_reserved" will be available. If the volume
3718 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3719 number of bytes saved by the SIS feature.
3721 B<Note:> The current NetApp API has a bug that results in this value being
3722 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3723 number which works most of the time. If you see strange values here, bug
3724 NetApp support to fix this.
3726 Repeat this option to specify multiple volumes.
3728 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3730 Specify whether to collect only the volumes selected by the B<GetCapacity>
3731 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3732 B<false>. However, if no B<GetCapacity> option is specified at all, all
3733 capacities will be selected anyway.
3735 =item B<GetSnapshot> I<VolumeName>
3737 Select volumes from which to collect snapshot information.
3739 Usually, the space used for snapshots is included in the space reported as
3740 "used". If snapshot information is collected as well, the space used for
3741 snapshots is subtracted from the used space.
3743 To make things even more interesting, it is possible to reserve space to be
3744 used for snapshots. If the space required for snapshots is less than that
3745 reserved space, there is "reserved free" and "reserved used" space in addition
3746 to "free" and "used". If the space required for snapshots exceeds the reserved
3747 space, that part allocated in the normal space is subtracted from the "used"
3750 Repeat this option to specify multiple volumes.
3752 =item B<IgnoreSelectedSnapshot>
3754 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3755 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3756 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3757 capacities will be selected anyway.
3761 =head3 The Quota block
3763 This will collect (tree) quota statistics (used disk space and number of used
3764 files). This mechanism is useful to get usage information for single qtrees.
3765 In case the quotas are not used for any other purpose, an entry similar to the
3766 following in C</etc/quotas> would be sufficient:
3768 /vol/volA/some_qtree tree - - - - -
3770 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3774 =item B<Interval> I<Seconds>
3776 Collect SnapVault(R) statistics every I<Seconds> seconds.
3780 =head3 The SnapVault block
3782 This will collect statistics about the time and traffic of SnapVault(R)
3787 =item B<Interval> I<Seconds>
3789 Collect SnapVault(R) statistics every I<Seconds> seconds.
3793 =head2 Plugin C<netlink>
3795 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3796 statistics of various interface and routing aspects.
3800 =item B<Interface> I<Interface>
3802 =item B<VerboseInterface> I<Interface>
3804 Instruct the plugin to collect interface statistics. This is basically the same
3805 as the statistics provided by the C<interface> plugin (see above) but
3806 potentially much more detailed.
3808 When configuring with B<Interface> only the basic statistics will be collected,
3809 namely octets, packets, and errors. These statistics are collected by
3810 the C<interface> plugin, too, so using both at the same time is no benefit.
3812 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3813 so that no data needs to be collected twice if you use the C<interface> plugin.
3814 This includes dropped packets, received multicast packets, collisions and a
3815 whole zoo of differentiated RX and TX errors. You can try the following command
3816 to get an idea of what awaits you:
3820 If I<Interface> is B<All>, all interfaces will be selected.
3822 =item B<QDisc> I<Interface> [I<QDisc>]
3824 =item B<Class> I<Interface> [I<Class>]
3826 =item B<Filter> I<Interface> [I<Filter>]
3828 Collect the octets and packets that pass a certain qdisc, class or filter.
3830 QDiscs and classes are identified by their type and handle (or classid).
3831 Filters don't necessarily have a handle, therefore the parent's handle is used.
3832 The notation used in collectd differs from that used in tc(1) in that it
3833 doesn't skip the major or minor number if it's zero and doesn't print special
3834 ids by their name. So, for example, a qdisc may be identified by
3835 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3836 thus not displayed by tc(1).
3838 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3839 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3840 associated with that interface will be collected.
3842 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3843 used. This may lead to problems when more than one filter is attached to a
3844 qdisc or class. This isn't nice, but we don't know how this could be done any
3845 better. If you have a idea, please don't hesitate to tell us.
3847 As with the B<Interface> option you can specify B<All> as the interface,
3848 meaning all interfaces.
3850 Here are some examples to help you understand the above text more easily:
3853 VerboseInterface "All"
3854 QDisc "eth0" "pfifo_fast-1:0"
3856 Class "ppp0" "htb-1:10"
3857 Filter "ppp0" "u32-1:0"
3860 =item B<IgnoreSelected>
3862 The behavior is the same as with all other similar plugins: If nothing is
3863 selected at all, everything is collected. If some things are selected using the
3864 options described above, only these statistics are collected. If you set
3865 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3866 specified statistics will not be collected.
3870 =head2 Plugin C<network>
3872 The Network plugin sends data to a remote instance of collectd, receives data
3873 from a remote instance, or both at the same time. Data which has been received
3874 from the network is usually not transmitted again, but this can be activated, see
3875 the B<Forward> option below.
3877 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3878 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3880 Both, B<Server> and B<Listen> can be used as single option or as block. When
3881 used as block, given options are valid for this socket only. The following
3882 example will export the metrics twice: Once to an "internal" server (without
3883 encryption and signing) and one to an external server (with cryptographic
3887 # Export to an internal server
3888 # (demonstrates usage without additional options)
3889 Server "collectd.internal.tld"
3891 # Export to an external server
3892 # (demonstrates usage with signature options)
3893 <Server "collectd.external.tld">
3894 SecurityLevel "sign"
3895 Username "myhostname"
3902 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3904 The B<Server> statement/block sets the server to send datagrams to. The
3905 statement may occur multiple times to send each datagram to multiple
3908 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3909 optional second argument specifies a port number or a service name. If not
3910 given, the default, B<25826>, is used.
3912 The following options are recognized within B<Server> blocks:
3916 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3918 Set the security you require for network communication. When the security level
3919 has been set to B<Encrypt>, data sent over the network will be encrypted using
3920 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3921 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3922 authentication code. When set to B<None>, data is sent without any security.
3924 This feature is only available if the I<network> plugin was linked with
3927 =item B<Username> I<Username>
3929 Sets the username to transmit. This is used by the server to lookup the
3930 password. See B<AuthFile> below. All security levels except B<None> require
3933 This feature is only available if the I<network> plugin was linked with
3936 =item B<Password> I<Password>
3938 Sets a password (shared secret) for this socket. All security levels except
3939 B<None> require this setting.
3941 This feature is only available if the I<network> plugin was linked with
3944 =item B<Interface> I<Interface name>
3946 Set the outgoing interface for IP packets. This applies at least
3947 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3948 undefined or a non-existent interface name is specified, the default
3949 behavior is to let the kernel choose the appropriate interface. Be warned
3950 that the manual selection of an interface for unicast traffic is only
3951 necessary in rare cases.
3953 =item B<ResolveInterval> I<Seconds>
3955 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
3956 useful to force a regular DNS lookup to support a high availability setup. If
3957 not specified, re-resolves are never attempted.
3961 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3963 The B<Listen> statement sets the interfaces to bind to. When multiple
3964 statements are found the daemon will bind to multiple interfaces.
3966 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3967 the argument is a multicast address the daemon will join that multicast group.
3968 The optional second argument specifies a port number or a service name. If not
3969 given, the default, B<25826>, is used.
3971 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3975 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3977 Set the security you require for network communication. When the security level
3978 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3979 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3980 signed and encrypted data is accepted. When set to B<None>, all data will be
3981 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3982 decrypted if possible.
3984 This feature is only available if the I<network> plugin was linked with
3987 =item B<AuthFile> I<Filename>
3989 Sets a file in which usernames are mapped to passwords. These passwords are
3990 used to verify signatures and to decrypt encrypted network packets. If
3991 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3992 verified and encrypted packets are decrypted. Otherwise, signed data is
3993 accepted without checking the signature and encrypted data cannot be decrypted.
3994 For the other security levels this option is mandatory.
3996 The file format is very simple: Each line consists of a username followed by a
3997 colon and any number of spaces followed by the password. To demonstrate, an
3998 example file could look like this:
4003 Each time a packet is received, the modification time of the file is checked
4004 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4005 the file is being read, it is locked using L<fcntl(2)>.
4007 =item B<Interface> I<Interface name>
4009 Set the incoming interface for IP packets explicitly. This applies at least
4010 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4011 undefined or a non-existent interface name is specified, the default
4012 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4013 traffic gets only accepted, if it arrives on the given interface.
4017 =item B<TimeToLive> I<1-255>
4019 Set the time-to-live of sent packets. This applies to all, unicast and
4020 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4021 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4024 =item B<MaxPacketSize> I<1024-65535>
4026 Set the maximum size for datagrams received over the network. Packets larger
4027 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4028 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4031 On the server side, this limit should be set to the largest value used on
4032 I<any> client. Likewise, the value on the client must not be larger than the
4033 value on the server, or data will be lost.
4035 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4036 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4037 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4040 =item B<Forward> I<true|false>
4042 If set to I<true>, write packets that were received via the network plugin to
4043 the sending sockets. This should only be activated when the B<Listen>- and
4044 B<Server>-statements differ. Otherwise packets may be send multiple times to
4045 the same multicast group. While this results in more network traffic than
4046 necessary it's not a huge problem since the plugin has a duplicate detection,
4047 so the values will not loop.
4049 =item B<ReportStats> B<true>|B<false>
4051 The network plugin cannot only receive and send statistics, it can also create
4052 statistics about itself. Collected data included the number of received and
4053 sent octets and packets, the length of the receive queue and the number of
4054 values handled. When set to B<true>, the I<Network plugin> will make these
4055 statistics available. Defaults to B<false>.
4059 =head2 Plugin C<nginx>
4061 This plugin collects the number of connections and requests handled by the
4062 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4063 queries the page provided by the C<ngx_http_stub_status_module> module, which
4064 isn't compiled by default. Please refer to
4065 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4066 how to compile and configure nginx and this module.
4068 The following options are accepted by the C<nginx plugin>:
4072 =item B<URL> I<http://host/nginx_status>
4074 Sets the URL of the C<ngx_http_stub_status_module> output.
4076 =item B<User> I<Username>
4078 Optional user name needed for authentication.
4080 =item B<Password> I<Password>
4082 Optional password needed for authentication.
4084 =item B<VerifyPeer> B<true|false>
4086 Enable or disable peer SSL certificate verification. See
4087 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4089 =item B<VerifyHost> B<true|false>
4091 Enable or disable peer host name verification. If enabled, the plugin checks
4092 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4093 certificate matches the host name provided by the B<URL> option. If this
4094 identity check fails, the connection is aborted. Obviously, only works when
4095 connecting to a SSL enabled server. Enabled by default.
4097 =item B<CACert> I<File>
4099 File that holds one or more SSL certificates. If you want to use HTTPS you will
4100 possibly need this option. What CA certificates come bundled with C<libcurl>
4101 and are checked by default depends on the distribution you use.
4105 =head2 Plugin C<notify_desktop>
4107 This plugin sends a desktop notification to a notification daemon, as defined
4108 in the Desktop Notification Specification. To actually display the
4109 notifications, B<notification-daemon> is required and B<collectd> has to be
4110 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4111 environment variables have to be set correctly) and the D-Bus message bus.
4113 The Desktop Notification Specification can be found at
4114 L<http://www.galago-project.org/specs/notification/>.
4118 =item B<OkayTimeout> I<timeout>
4120 =item B<WarningTimeout> I<timeout>
4122 =item B<FailureTimeout> I<timeout>
4124 Set the I<timeout>, in milliseconds, after which to expire the notification
4125 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4126 been specified, the displayed notification will not be closed at all - the
4127 user has to do so herself. These options default to 5000. If a negative number
4128 has been specified, the default is used as well.
4132 =head2 Plugin C<notify_email>
4134 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4135 configured email address.
4137 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4139 Available configuration options:
4143 =item B<From> I<Address>
4145 Email address from which the emails should appear to come from.
4147 Default: C<root@localhost>
4149 =item B<Recipient> I<Address>
4151 Configures the email address(es) to which the notifications should be mailed.
4152 May be repeated to send notifications to multiple addresses.
4154 At least one B<Recipient> must be present for the plugin to work correctly.
4156 =item B<SMTPServer> I<Hostname>
4158 Hostname of the SMTP server to connect to.
4160 Default: C<localhost>
4162 =item B<SMTPPort> I<Port>
4164 TCP port to connect to.
4168 =item B<SMTPUser> I<Username>
4170 Username for ASMTP authentication. Optional.
4172 =item B<SMTPPassword> I<Password>
4174 Password for ASMTP authentication. Optional.
4176 =item B<Subject> I<Subject>
4178 Subject-template to use when sending emails. There must be exactly two
4179 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4180 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4183 Default: C<Collectd notify: %s@%s>
4187 =head2 Plugin C<ntpd>
4191 =item B<Host> I<Hostname>
4193 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4195 =item B<Port> I<Port>
4197 UDP-Port to connect to. Defaults to B<123>.
4199 =item B<ReverseLookups> B<true>|B<false>
4201 Sets whether or not to perform reverse lookups on peers. Since the name or
4202 IP-address may be used in a filename it is recommended to disable reverse
4203 lookups. The default is to do reverse lookups to preserve backwards
4204 compatibility, though.
4206 =item B<IncludeUnitID> B<true>|B<false>
4208 When a peer is a refclock, include the unit ID in the I<type instance>.
4209 Defaults to B<false> for backward compatibility.
4211 If two refclock peers use the same driver and this is B<false>, the plugin will
4212 try to write simultaneous measurements from both to the same type instance.
4213 This will result in error messages in the log and only one set of measurements
4218 =head2 Plugin C<nut>
4222 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4224 Add a UPS to collect data from. The format is identical to the one accepted by
4229 =head2 Plugin C<olsrd>
4231 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4232 the Optimized Link State Routing daemon and reads information about the current
4233 state of the meshed network.
4235 The following configuration options are understood:
4239 =item B<Host> I<Host>
4241 Connect to I<Host>. Defaults to B<"localhost">.
4243 =item B<Port> I<Port>
4245 Specifies the port to connect to. This must be a string, even if you give the
4246 port as a number rather than a service name. Defaults to B<"2006">.
4248 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4250 Specifies what information to collect about links, i.E<nbsp>e. direct
4251 connections of the daemon queried. If set to B<No>, no information is
4252 collected. If set to B<Summary>, the number of links and the average of all
4253 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4254 If set to B<Detail> LQ and NLQ are collected per link.
4256 Defaults to B<Detail>.
4258 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4260 Specifies what information to collect about routes of the daemon queried. If
4261 set to B<No>, no information is collected. If set to B<Summary>, the number of
4262 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4263 metric and ETX are collected per route.
4265 Defaults to B<Summary>.
4267 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4269 Specifies what information to collect about the global topology. If set to
4270 B<No>, no information is collected. If set to B<Summary>, the number of links
4271 in the entire topology and the average I<link quality> (LQ) is calculated.
4272 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4274 Defaults to B<Summary>.
4278 =head2 Plugin C<onewire>
4280 B<EXPERIMENTAL!> See notes below.
4282 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4283 L<http://owfs.org/> to read sensors connected via the onewire bus.
4285 It can be used in two possible modes - standard or advanced.
4287 In the standard mode only temperature sensors (sensors with the family code
4288 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4289 other sensors you would like to have included, please send a sort request to
4290 the mailing list. You can select sensors to be read or to be ignored depending
4291 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4292 walked and all sensors are read.
4294 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4295 experimental, below.
4297 In the advanced mode you can configure any sensor to be read (only numerical
4298 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4299 In this mode you have to list all the sensors. Neither default bus walk nor
4300 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4301 the path automatically and should produce compatible structure with the "standard"
4302 mode (basically the path is expected as for example
4303 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4304 "F10FCA000800" and the rest after the slash is considered the type - here
4306 There are two advantages to this mode - you can access virtually any sensor
4307 (not just temperature), select whether to use cached or directly read values
4308 and it is slighlty faster. The downside is more complex configuration.
4310 The two modes are distinguished automatically by the format of the address.
4311 It is not possible to mix the two modes. Once a full path is detected in any
4312 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4313 (and as standard addresses will fail parsing they will be ignored).
4317 =item B<Device> I<Device>
4319 Sets the device to read the values from. This can either be a "real" hardware
4320 device, such as a serial port or an USB port, or the address of the
4321 L<owserver(1)> socket, usually B<localhost:4304>.
4323 Though the documentation claims to automatically recognize the given address
4324 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4325 with that version, the following configuration worked for us:
4328 Device "-s localhost:4304"
4331 This directive is B<required> and does not have a default value.
4333 =item B<Sensor> I<Sensor>
4335 In the standard mode selects sensors to collect or to ignore
4336 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4337 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4338 and B<not> include the leading C<10.> family byte and point.
4339 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4340 sensors (see above) are read.
4342 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4343 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4344 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4346 As there can be multiple devices on the bus you can list multiple sensor (use
4347 multiple B<Sensor> elements).
4349 =item B<IgnoreSelected> I<true>|I<false>
4351 If no configuration is given, the B<onewire> plugin will collect data from all
4352 sensors found. This may not be practical, especially if sensors are added and
4353 removed regularly. Sometimes, however, it's easier/preferred to collect only
4354 specific sensors or all sensors I<except> a few specified ones. This option
4355 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4356 B<Sensor> is inverted: All selected interfaces are ignored and all other
4357 interfaces are collected.
4359 Used only in the standard mode - see above.
4361 =item B<Interval> I<Seconds>
4363 Sets the interval in which all sensors should be read. If not specified, the
4364 global B<Interval> setting is used.
4368 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4369 work with big setups. It works with one sensor being attached to one
4370 controller, but as soon as you throw in a couple more senors and maybe a hub
4371 or two, reading all values will take more than ten seconds (the default
4372 interval). We will probably add some separate thread for reading the sensors
4373 and some cache or something like that, but it's not done yet. We will try to
4374 maintain backwards compatibility in the future, but we can't promise. So in
4375 short: If it works for you: Great! But keep in mind that the config I<might>
4376 change, though this is unlikely. Oh, and if you want to help improving this
4377 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4379 =head2 Plugin C<openldap>
4381 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4382 server correctly. The backend database C<monitor> needs to be loaded and
4383 working. See slapd-monitor(5) for the details.
4385 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4386 blocks. Each block requires one string argument as the instance name. For
4391 URL "ldap://localhost/"
4394 URL "ldaps://localhost/"
4398 The instance name will be used as the I<plugin instance>. To emulate the old
4399 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4400 plugin to work correctly, each instance name must be unique. This is not
4401 enforced by the plugin and it is your responsibility to ensure it is.
4403 The following options are accepted within each B<Instance> block:
4407 =item B<URL> I<ldap://host/binddn>
4409 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4412 =item B<StartTLS> B<true|false>
4414 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4415 Disabled by default.
4417 =item B<VerifyHost> B<true|false>
4419 Enables or disables peer host name verification. If enabled, the plugin checks
4420 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4421 certificate matches the host name provided by the B<URL> option. If this
4422 identity check fails, the connection is aborted. Enabled by default.
4424 =item B<CACert> I<File>
4426 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4427 may possibly need this option. What CA certificates are checked by default
4428 depends on the distribution you use and can be changed with the usual ldap
4429 client configuration mechanisms. See ldap.conf(5) for the details.
4431 =item B<Timeout> I<Seconds>
4433 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4434 an infinite timeout.
4436 =item B<Version> I<Version>
4438 An integer which sets the LDAP protocol version number to use when connecting
4439 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4443 =head2 Plugin C<openvpn>
4445 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4446 traffic statistics about connected clients.
4448 To set up OpenVPN to write to the status file periodically, use the
4449 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4450 you need to set the required format, too. This is done by setting
4451 B<--status-version> to B<2>.
4453 So, in a nutshell you need:
4455 openvpn $OTHER_OPTIONS \
4456 --status "/var/run/openvpn-status" 10 \
4463 =item B<StatusFile> I<File>
4465 Specifies the location of the status file.
4467 =item B<ImprovedNamingSchema> B<true>|B<false>
4469 When enabled, the filename of the status file will be used as plugin instance
4470 and the client's "common name" will be used as type instance. This is required
4471 when reading multiple status files. Enabling this option is recommended, but to
4472 maintain backwards compatibility this option is disabled by default.
4474 =item B<CollectCompression> B<true>|B<false>
4476 Sets whether or not statistics about the compression used by OpenVPN should be
4477 collected. This information is only available in I<single> mode. Enabled by
4480 =item B<CollectIndividualUsers> B<true>|B<false>
4482 Sets whether or not traffic information is collected for each connected client
4483 individually. If set to false, currently no traffic data is collected at all
4484 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4486 =item B<CollectUserCount> B<true>|B<false>
4488 When enabled, the number of currently connected clients or users is collected.
4489 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4490 can be configured independently from that option. Defaults to B<false>.
4494 =head2 Plugin C<oracle>
4496 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4497 Oracle® Database and lets you execute SQL statements there. It is very similar
4498 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4499 plugin's documentation above for details.
4502 <Query "out_of_stock">
4503 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4506 # InstancePrefix "foo"
4507 InstancesFrom "category"
4511 <Database "product_information">
4515 Query "out_of_stock"
4519 =head3 B<Query> blocks
4521 The Query blocks are handled identically to the Query blocks of the "dbi"
4522 plugin. Please see its documentation above for details on how to specify
4525 =head3 B<Database> blocks
4527 Database blocks define a connection to a database and which queries should be
4528 sent to that database. Each database needs a "name" as string argument in the
4529 starting tag of the block. This name will be used as "PluginInstance" in the
4530 values submitted to the daemon. Other than that, that name is not used.
4534 =item B<ConnectID> I<ID>
4536 Defines the "database alias" or "service name" to connect to. Usually, these
4537 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4539 =item B<Host> I<Host>
4541 Hostname to use when dispatching values for this database. Defaults to using
4542 the global hostname of the I<collectd> instance.
4544 =item B<Username> I<Username>
4546 Username used for authentication.
4548 =item B<Password> I<Password>
4550 Password used for authentication.
4552 =item B<Query> I<QueryName>
4554 Associates the query named I<QueryName> with this database connection. The
4555 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4556 blocks you want to refer to must be placed above the database block you want to
4561 =head2 Plugin C<perl>
4563 This plugin embeds a Perl-interpreter into collectd and provides an interface
4564 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4566 =head2 Plugin C<pinba>
4568 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4569 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4570 PHP-based webpage has been delivered, the extension will send a UDP packet
4571 containing timing information, peak memory usage and so on. The plugin will
4572 wait for such packets, parse them and account the provided information, which
4573 is then dispatched to the daemon once per interval.
4580 # Overall statistics for the website.
4582 Server "www.example.com"
4584 # Statistics for www-a only
4586 Host "www-a.example.com"
4587 Server "www.example.com"
4589 # Statistics for www-b only
4591 Host "www-b.example.com"
4592 Server "www.example.com"
4596 The plugin provides the following configuration options:
4600 =item B<Address> I<Node>
4602 Configures the address used to open a listening socket. By default, plugin will
4603 bind to the I<any> address C<::0>.
4605 =item B<Port> I<Service>
4607 Configures the port (service) to bind to. By default the default Pinba port
4608 "30002" will be used. The option accepts service names in addition to port
4609 numbers and thus requires a I<string> argument.
4611 =item E<lt>B<View> I<Name>E<gt> block
4613 The packets sent by the Pinba extension include the hostname of the server, the
4614 server name (the name of the virtual host) and the script that was executed.
4615 Using B<View> blocks it is possible to separate the data into multiple groups
4616 to get more meaningful statistics. Each packet is added to all matching groups,
4617 so that a packet may be accounted for more than once.
4621 =item B<Host> I<Host>
4623 Matches the hostname of the system the webserver / script is running on. This
4624 will contain the result of the L<gethostname(2)> system call. If not
4625 configured, all hostnames will be accepted.
4627 =item B<Server> I<Server>
4629 Matches the name of the I<virtual host>, i.e. the contents of the
4630 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4631 server names will be accepted.
4633 =item B<Script> I<Script>
4635 Matches the name of the I<script name>, i.e. the contents of the
4636 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4637 script names will be accepted.
4643 =head2 Plugin C<ping>
4645 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4646 configured hosts periodically and measures the network latency. Whenever the
4647 C<read> function of the plugin is called, it submits the average latency, the
4648 standard deviation and the drop rate for each host.
4650 Available configuration options:
4654 =item B<Host> I<IP-address>
4656 Host to ping periodically. This option may be repeated several times to ping
4659 =item B<Interval> I<Seconds>
4661 Sets the interval in which to send ICMP echo packets to the configured hosts.
4662 This is B<not> the interval in which statistics are queries from the plugin but
4663 the interval in which the hosts are "pinged". Therefore, the setting here
4664 should be smaller than or equal to the global B<Interval> setting. Fractional
4665 times, such as "1.24" are allowed.
4669 =item B<Timeout> I<Seconds>
4671 Time to wait for a response from the host to which an ICMP packet had been
4672 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4673 to be down or the packet to be dropped. This setting must be smaller than the
4674 B<Interval> setting above for the plugin to work correctly. Fractional
4675 arguments are accepted.
4679 =item B<TTL> I<0-255>
4681 Sets the Time-To-Live of generated ICMP packets.
4683 =item B<SourceAddress> I<host>
4685 Sets the source address to use. I<host> may either be a numerical network
4686 address or a network hostname.
4688 =item B<Device> I<name>
4690 Sets the outgoing network device to be used. I<name> has to specify an
4691 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4694 =item B<MaxMissed> I<Packets>
4696 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4697 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4699 Default: B<-1> (disabled)
4703 =head2 Plugin C<postgresql>
4705 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4706 keeps a persistent connection to all configured databases and tries to
4707 reconnect if the connection has been interrupted. A database is configured by
4708 specifying a B<Database> block as described below. The default statistics are
4709 collected from PostgreSQL's B<statistics collector> which thus has to be
4710 enabled for this plugin to work correctly. This should usually be the case by
4711 default. See the section "The Statistics Collector" of the B<PostgreSQL
4712 Documentation> for details.
4714 By specifying custom database queries using a B<Query> block as described
4715 below, you may collect any data that is available from some PostgreSQL
4716 database. This way, you are able to access statistics of external daemons
4717 which are available in a PostgreSQL database or use future or special
4718 statistics provided by PostgreSQL without the need to upgrade your collectd
4721 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4722 PostgreSQL databases as well. This has been implemented in a generic way. You
4723 need to specify an SQL statement which will then be executed by collectd in
4724 order to write the data (see below for details). The benefit of that approach
4725 is that there is no fixed database layout. Rather, the layout may be optimized
4726 for the current setup.
4728 The B<PostgreSQL Documentation> manual can be found at
4729 L<http://www.postgresql.org/docs/manuals/>.
4733 Statement "SELECT magic FROM wizard WHERE host = $1;"
4737 InstancePrefix "magic"
4742 <Query rt36_tickets>
4743 Statement "SELECT COUNT(type) AS count, type \
4745 WHEN resolved = 'epoch' THEN 'open' \
4746 ELSE 'resolved' END AS type \
4747 FROM tickets) type \
4751 InstancePrefix "rt36_tickets"
4752 InstancesFrom "type"
4758 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4768 KRBSrvName "kerberos_service_name"
4774 Service "service_name"
4775 Query backend # predefined
4786 The B<Query> block defines one database query which may later be used by a
4787 database definition. It accepts a single mandatory argument which specifies
4788 the name of the query. The names of all queries have to be unique (see the
4789 B<MinVersion> and B<MaxVersion> options below for an exception to this
4790 rule). The following configuration options are available to define the query:
4792 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4793 blocks define how to handle the values returned from the query. They define
4794 which column holds which value and how to dispatch that value to the daemon.
4795 Multiple B<Result> blocks may be used to extract multiple values from a single
4800 =item B<Statement> I<sql query statement>
4802 Specify the I<sql query statement> which the plugin should execute. The string
4803 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4804 first, second, etc. parameter. The value of the parameters is specified by the
4805 B<Param> configuration option - see below for details. To include a literal
4806 B<$> character followed by a number, surround it with single quotes (B<'>).
4808 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4809 allowed. Note, however, that only a single command may be used. Semicolons are
4810 allowed as long as a single non-empty command has been specified only.
4812 The returned lines will be handled separately one after another.
4814 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4816 Specify the parameters which should be passed to the SQL query. The parameters
4817 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4818 they appear in the configuration file. The value of the parameter is
4819 determined depending on the value of the B<Param> option as follows:
4825 The configured hostname of the database connection. If a UNIX domain socket is
4826 used, the parameter expands to "localhost".
4830 The name of the database of the current connection.
4834 The name of the database plugin instance. See the B<Instance> option of the
4835 database specification below for details.
4839 The username used to connect to the database.
4843 The interval with which this database is queried (as specified by the database
4844 specific or global B<Interval> options).
4848 Please note that parameters are only supported by PostgreSQL's protocol
4849 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4851 =item B<Type> I<type>
4853 The I<type> name to be used when dispatching the values. The type describes
4854 how to handle the data and where to store it. See L<types.db(5)> for more
4855 details on types and their configuration. The number and type of values (as
4856 selected by the B<ValuesFrom> option) has to match the type of the given name.
4858 This option is required inside a B<Result> block.
4860 =item B<InstancePrefix> I<prefix>
4862 =item B<InstancesFrom> I<column0> [I<column1> ...]
4864 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4865 B<InstancePrefix> defines a static prefix that will be prepended to all type
4866 instances. B<InstancesFrom> defines the column names whose values will be used
4867 to create the type instance. Multiple values will be joined together using the
4868 hyphen (C<->) as separation character.
4870 The plugin itself does not check whether or not all built instances are
4871 different. It is your responsibility to assure that each is unique.
4873 Both options are optional. If none is specified, the type instance will be
4876 =item B<ValuesFrom> I<column0> [I<column1> ...]
4878 Names the columns whose content is used as the actual data for the data sets
4879 that are dispatched to the daemon. How many such columns you need is
4880 determined by the B<Type> setting as explained above. If you specify too many
4881 or not enough columns, the plugin will complain about that and no data will be
4882 submitted to the daemon.
4884 The actual data type, as seen by PostgreSQL, is not that important as long as
4885 it represents numbers. The plugin will automatically cast the values to the
4886 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4887 L<strtod(3)> functions, so anything supported by those functions is supported
4888 by the plugin as well.
4890 This option is required inside a B<Result> block and may be specified multiple
4891 times. If multiple B<ValuesFrom> options are specified, the columns are read
4894 =item B<MinVersion> I<version>
4896 =item B<MaxVersion> I<version>
4898 Specify the minimum or maximum version of PostgreSQL that this query should be
4899 used with. Some statistics might only be available with certain versions of
4900 PostgreSQL. This allows you to specify multiple queries with the same name but
4901 which apply to different versions, thus allowing you to use the same
4902 configuration in a heterogeneous environment.
4904 The I<version> has to be specified as the concatenation of the major, minor
4905 and patch-level versions, each represented as two-decimal-digit numbers. For
4906 example, version 8.2.3 will become 80203.
4910 The following predefined queries are available (the definitions can be found
4911 in the F<postgresql_default.conf> file which, by default, is available at
4912 C<I<prefix>/share/collectd/>):
4918 This query collects the number of backends, i.E<nbsp>e. the number of
4921 =item B<transactions>
4923 This query collects the numbers of committed and rolled-back transactions of
4928 This query collects the numbers of various table modifications (i.E<nbsp>e.
4929 insertions, updates, deletions) of the user tables.
4931 =item B<query_plans>
4933 This query collects the numbers of various table scans and returned tuples of
4936 =item B<table_states>
4938 This query collects the numbers of live and dead rows in the user tables.
4942 This query collects disk block access counts for user tables.
4946 This query collects the on-disk size of the database in bytes.
4950 In addition, the following detailed queries are available by default. Please
4951 note that each of those queries collects information B<by table>, thus,
4952 potentially producing B<a lot> of data. For details see the description of the
4953 non-by_table queries above.
4957 =item B<queries_by_table>
4959 =item B<query_plans_by_table>
4961 =item B<table_states_by_table>
4963 =item B<disk_io_by_table>
4967 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4968 mandatory argument specifying the name of the writer. This will then be used
4969 in the B<Database> specification in order to activate the writer instance. The
4970 names of all writers have to be unique. The following options may be
4975 =item B<Statement> I<sql statement>
4977 This mandatory option specifies the SQL statement that will be executed for
4978 each submitted value. A single SQL statement is allowed only. Anything after
4979 the first semicolon will be ignored.
4981 Nine parameters will be passed to the statement and should be specified as
4982 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4983 values are made available through those parameters:
4989 The timestamp of the queried value as a floating point number.
4993 The hostname of the queried value.
4997 The plugin name of the queried value.
5001 The plugin instance of the queried value. This value may be B<NULL> if there
5002 is no plugin instance.
5006 The type of the queried value (cf. L<types.db(5)>).
5010 The type instance of the queried value. This value may be B<NULL> if there is
5015 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5016 sources of the submitted value-list).
5020 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5021 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5022 B<StoreRates> is enabled (which is the default, see below), all types will be
5027 An array of the submitted values. The dimensions of the value name and value
5032 In general, it is advisable to create and call a custom function in the
5033 PostgreSQL database for this purpose. Any procedural language supported by
5034 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5037 =item B<StoreRates> B<false>|B<true>
5039 If set to B<true> (the default), convert counter values to rates. If set to
5040 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5045 The B<Database> block defines one PostgreSQL database for which to collect
5046 statistics. It accepts a single mandatory argument which specifies the
5047 database name. None of the other options are required. PostgreSQL will use
5048 default values as documented in the section "CONNECTING TO A DATABASE" in the
5049 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5050 the user collectd is run as and special environment variables. See the manpage
5055 =item B<Interval> I<seconds>
5057 Specify the interval with which the database should be queried. The default is
5058 to use the global B<Interval> setting.
5060 =item B<CommitInterval> I<seconds>
5062 This option may be used for database connections which have "writers" assigned
5063 (see above). If specified, it causes a writer to put several updates into a
5064 single transaction. This transaction will last for the specified amount of
5065 time. By default, each update will be executed in a separate transaction. Each
5066 transaction generates a fair amount of overhead which can, thus, be reduced by
5067 activating this option. The draw-back is, that data covering the specified
5068 amount of time will be lost, for example, if a single statement within the
5069 transaction fails or if the database server crashes.
5071 =item B<Host> I<hostname>
5073 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5074 value begins with a slash, it is interpreted as the directory name in which to
5075 look for the UNIX domain socket.
5077 This option is also used to determine the hostname that is associated with a
5078 collected data set. If it has been omitted or either begins with with a slash
5079 or equals B<localhost> it will be replaced with the global hostname definition
5080 of collectd. Any other value will be passed literally to collectd when
5081 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5083 =item B<Port> I<port>
5085 Specify the TCP port or the local UNIX domain socket file extension of the
5088 =item B<User> I<username>
5090 Specify the username to be used when connecting to the server.
5092 =item B<Password> I<password>
5094 Specify the password to be used when connecting to the server.
5096 =item B<ExpireDelay> I<delay>
5098 Skip expired values in query output.
5100 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5102 Specify whether to use an SSL connection when contacting the server. The
5103 following modes are supported:
5109 Do not use SSL at all.
5113 First, try to connect without using SSL. If that fails, try using SSL.
5115 =item I<prefer> (default)
5117 First, try to connect using SSL. If that fails, try without using SSL.
5125 =item B<Instance> I<name>
5127 Specify the plugin instance name that should be used instead of the database
5128 name (which is the default, if this option has not been specified). This
5129 allows to query multiple databases of the same name on the same host (e.g.
5130 when running multiple database server versions in parallel).
5132 =item B<KRBSrvName> I<kerberos_service_name>
5134 Specify the Kerberos service name to use when authenticating with Kerberos 5
5135 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5136 B<PostgreSQL Documentation> for details.
5138 =item B<Service> I<service_name>
5140 Specify the PostgreSQL service name to use for additional parameters. That
5141 service has to be defined in F<pg_service.conf> and holds additional
5142 connection parameters. See the section "The Connection Service File" in the
5143 B<PostgreSQL Documentation> for details.
5145 =item B<Query> I<query>
5147 Specifies a I<query> which should be executed in the context of the database
5148 connection. This may be any of the predefined or user-defined queries. If no
5149 such option is given, it defaults to "backends", "transactions", "queries",
5150 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5151 has been specified). Else, the specified queries are used only.
5153 =item B<Writer> I<writer>
5155 Assigns the specified I<writer> backend to the database connection. This
5156 causes all collected data to be send to the database using the settings
5157 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5158 below for details on how to selectively send data to certain plugins).
5160 Each writer will register a flush callback which may be used when having long
5161 transactions enabled (see the B<CommitInterval> option above). When issuing
5162 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5163 transaction will be committed right away. Two different kinds of flush
5164 callbacks are available with the C<postgresql> plugin:
5170 Flush all writer backends.
5172 =item B<postgresql->I<database>
5174 Flush all writers of the specified I<database> only.
5180 =head2 Plugin C<powerdns>
5182 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5183 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5184 values, many of which are probably meaningless to most users, but may be useful
5185 for some. So you may chose which values to collect, but if you don't, some
5186 reasonable defaults will be collected.
5189 <Server "server_name">
5191 Collect "udp-answers" "udp-queries"
5192 Socket "/var/run/pdns.controlsocket"
5194 <Recursor "recursor_name">
5196 Collect "cache-hits" "cache-misses"
5197 Socket "/var/run/pdns_recursor.controlsocket"
5199 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5204 =item B<Server> and B<Recursor> block
5206 The B<Server> block defines one authoritative server to query, the B<Recursor>
5207 does the same for an recursing server. The possible options in both blocks are
5208 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5213 =item B<Collect> I<Field>
5215 Using the B<Collect> statement you can select which values to collect. Here,
5216 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5217 C<dlg-only-drops>, C<answers10-100>.
5219 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5220 When querying the server a C<SHOW *> command is issued in any case, because
5221 that's the only way of getting multiple values out of the server at once.
5222 collectd then picks out the values you have selected. When querying the
5223 recursor, a command is generated to query exactly these values. So if you
5224 specify invalid fields when querying the recursor, a syntax error may be
5225 returned by the daemon and collectd may not collect any values at all.
5227 If no B<Collect> statement is given, the following B<Server> values will be
5234 =item packetcache-hit
5236 =item packetcache-miss
5238 =item packetcache-size
5240 =item query-cache-hit
5242 =item query-cache-miss
5244 =item recursing-answers
5246 =item recursing-questions
5258 The following B<Recursor> values will be collected by default:
5262 =item noerror-answers
5264 =item nxdomain-answers
5266 =item servfail-answers
5284 Please note that up to that point collectd doesn't know what values are
5285 available on the server and values that are added do not need a change of the
5286 mechanism so far. However, the values must be mapped to collectd's naming
5287 scheme, which is done using a lookup table that lists all known values. If
5288 values are added in the future and collectd does not know about them, you will
5289 get an error much like this:
5291 powerdns plugin: submit: Not found in lookup table: foobar = 42
5293 In this case please file a bug report with the collectd team.
5295 =item B<Socket> I<Path>
5297 Configures the path to the UNIX domain socket to be used when connecting to the
5298 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5299 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5300 will be used for the recursor.
5304 =item B<LocalSocket> I<Path>
5306 Querying the recursor is done using UDP. When using UDP over UNIX domain
5307 sockets, the client socket needs a name in the file system, too. You can set
5308 this local name to I<Path> using the B<LocalSocket> option. The default is
5309 C<I<prefix>/var/run/collectd-powerdns>.
5313 =head2 Plugin C<processes>
5317 =item B<Process> I<Name>
5319 Select more detailed statistics of processes matching this name. The statistics
5320 collected for these selected processes are size of the resident segment size
5321 (RSS), user- and system-time used, number of processes and number of threads,
5322 io data (where available) and minor and major pagefaults.
5324 =item B<ProcessMatch> I<name> I<regex>
5326 Similar to the B<Process> option this allows to select more detailed
5327 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5328 details). The statistics of all matching processes are summed up and
5329 dispatched to the daemon using the specified I<name> as an identifier. This
5330 allows to "group" several processes together. I<name> must not contain
5335 =head2 Plugin C<protocols>
5337 Collects a lot of information about various network protocols, such as I<IP>,
5338 I<TCP>, I<UDP>, etc.
5340 Available configuration options:
5344 =item B<Value> I<Selector>
5346 Selects whether or not to select a specific value. The string being matched is
5347 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5348 plugin instance and I<ValueName> will be used as type instance. An example of
5349 the string being used would be C<Tcp:RetransSegs>.
5351 You can use regular expressions to match a large number of values with just one
5352 configuration option. To select all "extended" I<TCP> values, you could use the
5353 following statement:
5357 Whether only matched values are selected or all matched values are ignored
5358 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5359 If no value is configured at all, all values will be selected.
5361 =item B<IgnoreSelected> B<true>|B<false>
5363 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5364 matching values will be ignored.
5368 =head2 Plugin C<python>
5370 This plugin embeds a Python-interpreter into collectd and provides an interface
5371 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5373 =head2 Plugin C<routeros>
5375 The C<routeros> plugin connects to a device running I<RouterOS>, the
5376 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5377 I<librouteros> to connect and reads information about the interfaces and
5378 wireless connections of the device. The configuration supports querying
5383 Host "router0.example.com"
5386 CollectInterface true
5391 Host "router1.example.com"
5394 CollectInterface true
5395 CollectRegistrationTable true
5401 As you can see above, the configuration of the I<routeros> plugin consists of
5402 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5403 options are understood:
5407 =item B<Host> I<Host>
5409 Hostname or IP-address of the router to connect to.
5411 =item B<Port> I<Port>
5413 Port name or port number used when connecting. If left unspecified, the default
5414 will be chosen by I<librouteros>, currently "8728". This option expects a
5415 string argument, even when a numeric port number is given.
5417 =item B<User> I<User>
5419 Use the user name I<User> to authenticate. Defaults to "admin".
5421 =item B<Password> I<Password>
5423 Set the password used to authenticate.
5425 =item B<CollectInterface> B<true>|B<false>
5427 When set to B<true>, interface statistics will be collected for all interfaces
5428 present on the device. Defaults to B<false>.
5430 =item B<CollectRegistrationTable> B<true>|B<false>
5432 When set to B<true>, information about wireless LAN connections will be
5433 collected. Defaults to B<false>.
5435 =item B<CollectCPULoad> B<true>|B<false>
5437 When set to B<true>, information about the CPU usage will be collected. The
5438 number is a dimensionless value where zero indicates no CPU usage at all.
5439 Defaults to B<false>.
5441 =item B<CollectMemory> B<true>|B<false>
5443 When enabled, the amount of used and free memory will be collected. How used
5444 memory is calculated is unknown, for example whether or not caches are counted
5446 Defaults to B<false>.
5448 =item B<CollectDF> B<true>|B<false>
5450 When enabled, the amount of used and free disk space will be collected.
5451 Defaults to B<false>.
5453 =item B<CollectDisk> B<true>|B<false>
5455 When enabled, the number of sectors written and bad blocks will be collected.
5456 Defaults to B<false>.
5460 =head2 Plugin C<redis>
5462 The I<Redis plugin> connects to one or more Redis servers and gathers
5463 information about each server's state. For each server there is a I<Node> block
5464 which configures the connection parameters for this node.
5471 <Query "LLEN myqueue">
5478 The information shown in the synopsis above is the I<default configuration>
5479 which is used by the plugin if no configuration is present.
5483 =item B<Node> I<Nodename>
5485 The B<Node> block identifies a new Redis node, that is a new Redis instance
5486 running in an specified host and port. The name for node is a canonical
5487 identifier which is used as I<plugin instance>. It is limited to
5488 64E<nbsp>characters in length.
5490 =item B<Host> I<Hostname>
5492 The B<Host> option is the hostname or IP-address where the Redis instance is
5495 =item B<Port> I<Port>
5497 The B<Port> option is the TCP port on which the Redis instance accepts
5498 connections. Either a service name of a port number may be given. Please note
5499 that numerical port numbers must be given as a string, too.
5501 =item B<Password> I<Password>
5503 Use I<Password> to authenticate when connecting to I<Redis>.
5505 =item B<Timeout> I<Timeout in miliseconds>
5507 The B<Timeout> option set the socket timeout for node response. Since the Redis
5508 read function is blocking, you should keep this value as low as possible. Keep
5509 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5510 than B<Interval> defined globally.
5512 =item B<Query> I<Querystring>
5514 The B<Query> block identifies a query to execute against the redis server.
5515 There may be an arbitrary number of queries to execute.
5517 =item B<Type> I<Collectd type>
5519 Within a query definition, a valid collectd type to use as when submitting
5520 the result of the query. When not supplied, will default to B<gauge>.
5522 =item B<Instance> I<Type instance>
5524 Within a query definition, an optional type instance to use when submitting
5525 the result of the query. When not supplied will default to the escaped
5526 command, up to 64 chars.
5530 =head2 Plugin C<rrdcached>
5532 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5533 to store values to RRD files in an efficient manner. The combination of the
5534 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5535 way the C<rrdtool> plugin works (see below). The added abstraction layer
5536 provides a number of benefits, though: Because the cache is not within
5537 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5538 restarted. This results in much shorter (if any) gaps in graphs, especially
5539 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5540 daemon so that it can flush values to disk automatically when needed. This
5541 allows to integrate automated flushing of values into graphing solutions much
5544 There are disadvantages, though: The daemon may reside on a different host, so
5545 it may not be possible for C<collectd> to create the appropriate RRD files
5546 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5547 different base directory, so relative paths may do weird stuff if you're not
5550 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5551 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5552 setting should be set to an absolute path, so that a changed base directory
5553 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5557 =item B<DaemonAddress> I<Address>
5559 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5560 library. See L<rrdcached(1)> for details. Example:
5562 <Plugin "rrdcached">
5563 DaemonAddress "unix:/var/run/rrdcached.sock"
5566 =item B<DataDir> I<Directory>
5568 Set the base directory in which the RRD files reside. If this is a relative
5569 path, it is relative to the working base directory of the C<rrdcached> daemon!
5570 Use of an absolute path is recommended.
5572 =item B<CreateFiles> B<true>|B<false>
5574 Enables or disables the creation of RRD files. If the daemon is not running
5575 locally, or B<DataDir> is set to a relative path, this will not work as
5576 expected. Default is B<true>.
5578 =item B<CreateFilesAsync> B<false>|B<true>
5580 When enabled, new RRD files are enabled asynchronously, using a separate thread
5581 that runs in the background. This prevents writes to block, which is a problem
5582 especially when many hundreds of files need to be created at once. However,
5583 since the purpose of creating the files asynchronously is I<not> to block until
5584 the file is available, values before the file is available will be discarded.
5585 When disabled (the default) files are created synchronously, blocking for a
5586 short while, while the file is being written.
5588 =item B<StepSize> I<Seconds>
5590 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5591 this setting is unset and the stepsize is set to the interval in which the data
5592 is collected. Do not use this option unless you absolutely have to for some
5593 reason. Setting this option may cause problems with the C<snmp plugin>, the
5594 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5596 =item B<HeartBeat> I<Seconds>
5598 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5599 in which case the heartbeat is set to twice the B<StepSize> which should equal
5600 the interval in which data is collected. Do not set this option unless you have
5601 a very good reason to do so.
5603 =item B<RRARows> I<NumRows>
5605 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5606 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5607 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5608 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5609 week, one month, and one year.
5611 So for each timespan, it calculates how many PDPs need to be consolidated into
5612 one CDP by calculating:
5613 number of PDPs = timespan / (stepsize * rrarows)
5615 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5618 =item B<RRATimespan> I<Seconds>
5620 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5621 more then one RRA. If this option is never used, the built-in default of (3600,
5622 86400, 604800, 2678400, 31622400) is used.
5624 For more information on how RRA-sizes are calculated see B<RRARows> above.
5626 =item B<XFF> I<Factor>
5628 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5629 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5632 =item B<CollectStatistics> B<false>|B<true>
5634 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5635 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5637 Statistics are read via I<rrdcached>s socket using the STATS command.
5638 See L<rrdcached(1)> for details.
5642 =head2 Plugin C<rrdtool>
5644 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5645 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5646 using these settings. If you don't want to dive into the depths of RRDtool, you
5647 can safely ignore these settings.
5651 =item B<DataDir> I<Directory>
5653 Set the directory to store RRD files under. By default RRD files are generated
5654 beneath the daemon's working directory, i.e. the B<BaseDir>.
5656 =item B<CreateFilesAsync> B<false>|B<true>
5658 When enabled, new RRD files are enabled asynchronously, using a separate thread
5659 that runs in the background. This prevents writes to block, which is a problem
5660 especially when many hundreds of files need to be created at once. However,
5661 since the purpose of creating the files asynchronously is I<not> to block until
5662 the file is available, values before the file is available will be discarded.
5663 When disabled (the default) files are created synchronously, blocking for a
5664 short while, while the file is being written.
5666 =item B<StepSize> I<Seconds>
5668 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5669 this setting is unset and the stepsize is set to the interval in which the data
5670 is collected. Do not use this option unless you absolutely have to for some
5671 reason. Setting this option may cause problems with the C<snmp plugin>, the
5672 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5674 =item B<HeartBeat> I<Seconds>
5676 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5677 in which case the heartbeat is set to twice the B<StepSize> which should equal
5678 the interval in which data is collected. Do not set this option unless you have
5679 a very good reason to do so.
5681 =item B<RRARows> I<NumRows>
5683 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5684 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5685 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5686 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5687 week, one month, and one year.
5689 So for each timespan, it calculates how many PDPs need to be consolidated into
5690 one CDP by calculating:
5691 number of PDPs = timespan / (stepsize * rrarows)
5693 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5696 =item B<RRATimespan> I<Seconds>
5698 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5699 more then one RRA. If this option is never used, the built-in default of (3600,
5700 86400, 604800, 2678400, 31622400) is used.
5702 For more information on how RRA-sizes are calculated see B<RRARows> above.
5704 =item B<XFF> I<Factor>
5706 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5707 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5710 =item B<CacheFlush> I<Seconds>
5712 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5713 it writes all values for a certain RRD-file if the oldest value is older than
5714 (or equal to) the number of seconds specified. If some RRD-file is not updated
5715 anymore for some reason (the computer was shut down, the network is broken,
5716 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5717 entire cache is searched for entries older than B<CacheTimeout> seconds and
5718 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5719 does nothing under normal circumstances, this value should not be too small.
5720 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5721 normally do much harm either.
5723 =item B<CacheTimeout> I<Seconds>
5725 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5726 save values in a cache, as described above. Writing multiple values at once
5727 reduces IO-operations and thus lessens the load produced by updating the files.
5728 The trade off is that the graphs kind of "drag behind" and that more memory is
5731 =item B<WritesPerSecond> I<Updates>
5733 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5734 will run serious performance problems. The B<CacheFlush> setting and the
5735 internal update queue assert that collectd continues to work just fine even
5736 under heavy load, but the system may become very unresponsive and slow. This is
5737 a problem especially if you create graphs from the RRD files on the same
5738 machine, for example using the C<graph.cgi> script included in the
5739 C<contrib/collection3/> directory.
5741 This setting is designed for very large setups. Setting this option to a value
5742 between 25 and 80 updates per second, depending on your hardware, will leave
5743 the server responsive enough to draw graphs even while all the cached values
5744 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5745 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5746 written as fast as possible, so that web frontends have up to date data when
5749 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5750 updates per second, writing all values to disk will take approximately
5751 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5752 "collection3" you'll end up with a responsive and fast system, up to date
5753 graphs and basically a "backup" of your values every hour.
5755 =item B<RandomTimeout> I<Seconds>
5757 When set, the actual timeout for each value is chosen randomly between
5758 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5759 intention is to avoid high load situations that appear when many values timeout
5760 at the same time. This is especially a problem shortly after the daemon starts,
5761 because all values were added to the internal cache at roughly the same time.
5765 =head2 Plugin C<sensors>
5767 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5768 that all the needed modules have to be loaded and lm_sensors has to be
5769 configured (most likely by editing F</etc/sensors.conf>. Read
5770 L<sensors.conf(5)> for details.
5772 The B<lm_sensors> homepage can be found at
5773 L<http://secure.netroedge.com/~lm78/>.
5777 =item B<SensorConfigFile> I<File>
5779 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5780 the library's default will be used.
5782 =item B<Sensor> I<chip-bus-address/type-feature>
5784 Selects the name of the sensor which you want to collect or ignore, depending
5785 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5786 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5787 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5789 =item B<IgnoreSelected> I<true>|I<false>
5791 If no configuration if given, the B<sensors>-plugin will collect data from all
5792 sensors. This may not be practical, especially for uninteresting sensors.
5793 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5794 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5795 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5796 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5797 and all other sensors are collected.
5801 =head2 Plugin C<sigrok>
5803 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5804 supported by the L<sigrok|http://sigrok.org/> project.
5810 <Device "AC Voltage">
5815 <Device "Sound Level">
5816 Driver "cem-dt-885x"
5823 =item B<LogLevel> B<0-5>
5825 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5826 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5827 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5828 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5829 their level, are always submitted to I<collectd> at its INFO log level.
5831 =item E<lt>B<Device> I<Name>E<gt>
5833 A sigrok-supported device, uniquely identified by this section's options. The
5834 I<Name> is passed to I<collectd> as the I<plugin instance>.
5836 =item B<Driver> I<DriverName>
5838 The sigrok driver to use for this device.
5840 =item B<Conn> I<ConnectionSpec>
5842 If the device cannot be auto-discovered, or more than one might be discovered
5843 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5844 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5845 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5846 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5847 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5849 =item B<SerialComm> I<SerialSpec>
5851 For serial devices with non-standard port settings, this option can be used
5852 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5853 This should not be necessary; drivers know how to communicate with devices they
5856 =item B<MinimumInterval> I<Seconds>
5858 Specifies the minimum time between measurement dispatches to I<collectd>, in
5859 seconds. Since some I<sigrok> supported devices can acquire measurements many
5860 times per second, it may be necessary to throttle these. For example, the
5861 I<RRD plugin> cannot process writes more than once per second.
5863 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5864 device are always dispatched to I<collectd>. When throttled, unused
5865 measurements are discarded.
5869 =head2 Plugin C<smart>
5871 The C<smart> plugin collects SMART information from physical
5872 disks. Values collectd include temperature, power cycle count, poweron
5873 time and bad sectors. Also, all SMART attributes are collected along
5874 with the normalized current value, the worst value, the threshold and
5875 a human readable value.
5877 Using the following two options you can ignore some disks or configure the
5878 collection only of specific disks.
5882 =item B<Disk> I<Name>
5884 Select the disk I<Name>. Whether it is collected or ignored depends on the
5885 B<IgnoreSelected> setting, see below. As with other plugins that use the
5886 daemon's ignorelist functionality, a string that starts and ends with a slash
5887 is interpreted as a regular expression. Examples:
5892 =item B<IgnoreSelected> B<true>|B<false>
5894 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
5895 statements, are ignored or if all other disks are ignored. The behavior
5896 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
5897 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
5898 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
5899 is set to B<true>, all disks are collected B<except> the ones matched.
5903 =head2 Plugin C<snmp>
5905 Since the configuration of the C<snmp plugin> is a little more complicated than
5906 other plugins, its documentation has been moved to an own manpage,
5907 L<collectd-snmp(5)>. Please see there for details.
5909 =head2 Plugin C<statsd>
5911 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5912 protocol and dispatches rates or other aggregates of these numbers
5915 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5916 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5917 C<objects> respectively.
5919 The following configuration options are valid:
5923 =item B<Host> I<Host>
5925 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5926 "any" address, i.e. accept packets sent to any of the hosts addresses.
5928 =item B<Port> I<Port>
5930 UDP port to listen to. This can be either a service name or a port number.
5931 Defaults to C<8125>.
5933 =item B<DeleteCounters> B<false>|B<true>
5935 =item B<DeleteTimers> B<false>|B<true>
5937 =item B<DeleteGauges> B<false>|B<true>
5939 =item B<DeleteSets> B<false>|B<true>
5941 These options control what happens if metrics are not updated in an interval.
5942 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5943 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5944 are unchanged. If set to B<True>, the such metrics are not dispatched and
5945 removed from the internal cache.
5947 =item B<TimerPercentile> I<Percent>
5949 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5950 that I<Percent> of all reported timers are smaller than or equal to the
5951 computed latency. This is useful for cutting off the long tail latency, as it's
5952 often done in I<Service Level Agreements> (SLAs).
5954 Different percentiles can be calculated by setting this option several times.
5955 If none are specified, no percentiles are calculated / dispatched.
5957 =item B<TimerLower> B<false>|B<true>
5959 =item B<TimerUpper> B<false>|B<true>
5961 =item B<TimerSum> B<false>|B<true>
5963 =item B<TimerCount> B<false>|B<true>
5965 Calculate and dispatch various values out of I<Timer> metrics received during
5966 an interval. If set to B<False>, the default, these values aren't calculated /
5971 =head2 Plugin C<swap>
5973 The I<Swap plugin> collects information about used and available swap space. On
5974 I<Linux> and I<Solaris>, the following options are available:
5978 =item B<ReportByDevice> B<false>|B<true>
5980 Configures how to report physical swap devices. If set to B<false> (the
5981 default), the summary over all swap devices is reported only, i.e. the globally
5982 used and available space over all devices. If B<true> is configured, the used
5983 and available space of each device will be reported separately.
5985 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5986 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5988 =item B<ReportBytes> B<false>|B<true>
5990 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5991 I<swap I/O> is reported in pages. This option is available under Linux only.
5993 =item B<ValuesAbsolute> B<true>|B<false>
5995 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5996 available and used. Defaults to B<true>.
5998 =item B<ValuesPercentage> B<false>|B<true>
6000 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6001 available and free. Defaults to B<false>.
6003 This is useful for deploying I<collectd> in a heterogeneous environment, where
6004 swap sizes differ and you want to specify generic thresholds or similar.
6008 =head2 Plugin C<syslog>
6012 =item B<LogLevel> B<debug|info|notice|warning|err>
6014 Sets the log-level. If, for example, set to B<notice>, then all events with
6015 severity B<notice>, B<warning>, or B<err> will be submitted to the
6018 Please note that B<debug> is only available if collectd has been compiled with
6021 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6023 Controls which notifications should be sent to syslog. The default behaviour is
6024 not to send any. Less severe notifications always imply logging more severe
6025 notifications: Setting this to B<OKAY> means all notifications will be sent to
6026 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6027 notifications but will dismiss B<OKAY> notifications. Setting this option to
6028 B<FAILURE> will only send failures to syslog.
6032 =head2 Plugin C<table>
6034 The C<table plugin> provides generic means to parse tabular data and dispatch
6035 user specified values. Values are selected based on column numbers. For
6036 example, this plugin may be used to get values from the Linux L<proc(5)>
6037 filesystem or CSV (comma separated values) files.
6040 <Table "/proc/slabinfo">
6045 InstancePrefix "active_objs"
6051 InstancePrefix "objperslab"
6058 The configuration consists of one or more B<Table> blocks, each of which
6059 configures one file to parse. Within each B<Table> block, there are one or
6060 more B<Result> blocks, which configure which data to select and how to
6063 The following options are available inside a B<Table> block:
6067 =item B<Instance> I<instance>
6069 If specified, I<instance> is used as the plugin instance. So, in the above
6070 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6071 filename of the table is used instead, with all special characters replaced
6072 with an underscore (C<_>).
6074 =item B<Separator> I<string>
6076 Any character of I<string> is interpreted as a delimiter between the different
6077 columns of the table. A sequence of two or more contiguous delimiters in the
6078 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6079 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6080 of a table - see its documentation for more details. This option is mandatory.
6082 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6083 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6084 required because of collectd's config parsing.
6088 The following options are available inside a B<Result> block:
6092 =item B<Type> I<type>
6094 Sets the type used to dispatch the values to the daemon. Detailed information
6095 about types and their configuration can be found in L<types.db(5)>. This
6096 option is mandatory.
6098 =item B<InstancePrefix> I<prefix>
6100 If specified, prepend I<prefix> to the type instance. If omitted, only the
6101 B<InstancesFrom> option is considered for the type instance.
6103 =item B<InstancesFrom> I<column0> [I<column1> ...]
6105 If specified, the content of the given columns (identified by the column
6106 number starting at zero) will be used to create the type instance for each
6107 row. Multiple values (and the instance prefix) will be joined together with
6108 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6109 option is considered for the type instance.
6111 The plugin itself does not check whether or not all built instances are
6112 different. It’s your responsibility to assure that each is unique. This is
6113 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6114 sure that the table only contains one row.
6116 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6119 =item B<ValuesFrom> I<column0> [I<column1> ...]
6121 Specifies the columns (identified by the column numbers starting at zero)
6122 whose content is used as the actual data for the data sets that are dispatched
6123 to the daemon. How many such columns you need is determined by the B<Type>
6124 setting above. If you specify too many or not enough columns, the plugin will
6125 complain about that and no data will be submitted to the daemon. The plugin
6126 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6127 respectively, so anything supported by those functions is supported by the
6128 plugin as well. This option is mandatory.
6132 =head2 Plugin C<tail>
6134 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6135 each line and dispatches found values. What is matched can be configured by the
6136 user using (extended) regular expressions, as described in L<regex(7)>.
6139 <File "/var/log/exim4/mainlog">
6143 Regex "S=([1-9][0-9]*)"
6149 Regex "\\<R=local_user\\>"
6150 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6153 Instance "local_user"
6158 The config consists of one or more B<File> blocks, each of which configures one
6159 logfile to parse. Within each B<File> block, there are one or more B<Match>
6160 blocks, which configure a regular expression to search for.
6162 The B<Instance> option in the B<File> block may be used to set the plugin
6163 instance. So in the above example the plugin name C<tail-foo> would be used.
6164 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6165 next B<Instance> option. This way you can extract several plugin instances from
6166 one logfile, handy when parsing syslog and the like.
6168 The B<Interval> option allows you to define the length of time between reads. If
6169 this is not set, the default Interval will be used.
6171 Each B<Match> block has the following options to describe how the match should
6176 =item B<Regex> I<regex>
6178 Sets the regular expression to use for matching against a line. The first
6179 subexpression has to match something that can be turned into a number by
6180 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6181 below. Because B<extended> regular expressions are used, you do not need to use
6182 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6183 collectd's config parsing you need to escape backslashes, though. So if you
6184 want to match literal parentheses you need to do the following:
6186 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6188 =item B<ExcludeRegex> I<regex>
6190 Sets an optional regular expression to use for excluding lines from the match.
6191 An example which excludes all connections from localhost from the match:
6193 ExcludeRegex "127\\.0\\.0\\.1"
6195 =item B<DSType> I<Type>
6197 Sets how the values are cumulated. I<Type> is one of:
6201 =item B<GaugeAverage>
6203 Calculate the average.
6207 Use the smallest number only.
6211 Use the greatest number only.
6215 Use the last number found.
6221 =item B<AbsoluteSet>
6223 The matched number is a counter. Simply I<sets> the internal counter to this
6224 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6232 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6233 matched number may be negative, which will effectively subtract from the
6242 Increase the internal counter by one. These B<DSType> are the only ones that do
6243 not use the matched subexpression, but simply count the number of matched
6244 lines. Thus, you may use a regular expression without submatch in this case.
6248 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6249 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6250 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6251 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6252 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6255 =item B<Type> I<Type>
6257 Sets the type used to dispatch this value. Detailed information about types and
6258 their configuration can be found in L<types.db(5)>.
6260 =item B<Instance> I<TypeInstance>
6262 This optional setting sets the type instance to use.
6266 =head2 Plugin C<tail_csv>
6268 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6269 written by I<Snort>.
6274 <Metric "snort-dropped">
6279 <File "/var/log/snort/snort.stats">
6280 Instance "snort-eth0"
6282 Collect "snort-dropped"
6286 The configuration consists of one or more B<Metric> blocks that define an index
6287 into the line of the CSV file and how this value is mapped to I<collectd's>
6288 internal representation. These are followed by one or more B<Instance> blocks
6289 which configure which file to read, in which interval and which metrics to
6294 =item E<lt>B<Metric> I<Name>E<gt>
6296 The B<Metric> block configures a new metric to be extracted from the statistics
6297 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6298 only used inside the B<Instance> blocks to refer to this block, so you can use
6299 one B<Metric> block for multiple CSV files.
6303 =item B<Type> I<Type>
6305 Configures which I<Type> to use when dispatching this metric. Types are defined
6306 in the L<types.db(5)> file, see the appropriate manual page for more
6307 information on specifying types. Only types with a single I<data source> are
6308 supported by the I<tail_csv plugin>. The information whether the value is an
6309 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6310 I<Type's> definition.
6312 =item B<Instance> I<TypeInstance>
6314 If set, I<TypeInstance> is used to populate the type instance field of the
6315 created value lists. Otherwise, no type instance is used.
6317 =item B<ValueFrom> I<Index>
6319 Configure to read the value from the field with the zero-based index I<Index>.
6320 If the value is parsed as signed integer, unsigned integer or double depends on
6321 the B<Type> setting, see above.
6325 =item E<lt>B<File> I<Path>E<gt>
6327 Each B<File> block represents one CSV file to read. There must be at least one
6328 I<File> block but there can be multiple if you have multiple CSV files.
6332 =item B<Instance> I<PluginInstance>
6334 Sets the I<plugin instance> used when dispatching the values.
6336 =item B<Collect> I<Metric>
6338 Specifies which I<Metric> to collect. This option must be specified at least
6339 once, and you can use this option multiple times to specify more than one
6340 metric to be extracted from this statistic file.
6342 =item B<Interval> I<Seconds>
6344 Configures the interval in which to read values from this instance / file.
6345 Defaults to the plugin's default interval.
6347 =item B<TimeFrom> I<Index>
6349 Rather than using the local time when dispatching a value, read the timestamp
6350 from the field with the zero-based index I<Index>. The value is interpreted as
6351 seconds since epoch. The value is parsed as a double and may be factional.
6357 =head2 Plugin C<teamspeak2>
6359 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6360 polls interesting global and virtual server data. The plugin can query only one
6361 physical server but unlimited virtual servers. You can use the following
6362 options to configure it:
6366 =item B<Host> I<hostname/ip>
6368 The hostname or ip which identifies the physical server.
6371 =item B<Port> I<port>
6373 The query port of the physical server. This needs to be a string.
6376 =item B<Server> I<port>
6378 This option has to be added once for every virtual server the plugin should
6379 query. If you want to query the virtual server on port 8767 this is what the
6380 option would look like:
6384 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6385 use quotes around it! If no such statement is given only global information
6390 =head2 Plugin C<ted>
6392 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6393 measure power consumption. These devices are usually connected to a serial
6394 (RS232) or USB port. The plugin opens a configured device and tries to read the
6395 current energy readings. For more information on TED, visit
6396 L<http://www.theenergydetective.com/>.
6398 Available configuration options:
6402 =item B<Device> I<Path>
6404 Path to the device on which TED is connected. collectd will need read and write
6405 permissions on that file.
6407 Default: B</dev/ttyUSB0>
6409 =item B<Retries> I<Num>
6411 Apparently reading from TED is not that reliable. You can therefore configure a
6412 number of retries here. You only configure the I<retries> here, to if you
6413 specify zero, one reading will be performed (but no retries if that fails); if
6414 you specify three, a maximum of four readings are performed. Negative values
6421 =head2 Plugin C<tcpconns>
6423 The C<tcpconns plugin> counts the number of currently established TCP
6424 connections based on the local port and/or the remote port. Since there may be
6425 a lot of connections the default if to count all connections with a local port,
6426 for which a listening socket is opened. You can use the following options to
6427 fine-tune the ports you are interested in:
6431 =item B<ListeningPorts> I<true>|I<false>
6433 If this option is set to I<true>, statistics for all local ports for which a
6434 listening socket exists are collected. The default depends on B<LocalPort> and
6435 B<RemotePort> (see below): If no port at all is specifically selected, the
6436 default is to collect listening ports. If specific ports (no matter if local or
6437 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6438 the selected ports will be collected unless this option is set to I<true>
6441 =item B<LocalPort> I<Port>
6443 Count the connections to a specific local port. This can be used to see how
6444 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6445 You have to specify the port in numeric form, so for the mailserver example
6446 you'd need to set B<25>.
6448 =item B<RemotePort> I<Port>
6450 Count the connections to a specific remote port. This is useful to see how
6451 much a remote service is used. This is most useful if you want to know how many
6452 connections a local service has opened to remote services, e.E<nbsp>g. how many
6453 connections a mail server or news server has to other mail or news servers, or
6454 how many connections a web proxy holds to web servers. You have to give the
6455 port in numeric form.
6457 =item B<AllPortsSummary> I<true>|I<false>
6459 If this option is set to I<true> a summary of statistics from all connections
6460 are collectd. This option defaults to I<false>.
6464 =head2 Plugin C<thermal>
6468 =item B<ForceUseProcfs> I<true>|I<false>
6470 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6471 C<sysfs> interface. If that is not available, the plugin falls back to the
6472 C<procfs> interface. By setting this option to I<true>, you can force the
6473 plugin to use the latter. This option defaults to I<false>.
6475 =item B<Device> I<Device>
6477 Selects the name of the thermal device that you want to collect or ignore,
6478 depending on the value of the B<IgnoreSelected> option. This option may be
6479 used multiple times to specify a list of devices.
6481 =item B<IgnoreSelected> I<true>|I<false>
6483 Invert the selection: If set to true, all devices B<except> the ones that
6484 match the device names specified by the B<Device> option are collected. By
6485 default only selected devices are collected if a selection is made. If no
6486 selection is configured at all, B<all> devices are selected.
6490 =head2 Plugin C<threshold>
6492 The I<Threshold plugin> checks values collected or received by I<collectd>
6493 against a configurable I<threshold> and issues I<notifications> if values are
6496 Documentation for this plugin is available in the L<collectd-threshold(5)>
6499 =head2 Plugin C<tokyotyrant>
6501 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6502 couple metrics: number of records, and database size on disk.
6506 =item B<Host> I<Hostname/IP>
6508 The hostname or ip which identifies the server.
6509 Default: B<127.0.0.1>
6511 =item B<Port> I<Service/Port>
6513 The query port of the server. This needs to be a string, even if the port is
6514 given in its numeric form.
6519 =head2 Plugin C<unixsock>
6523 =item B<SocketFile> I<Path>
6525 Sets the socket-file which is to be created.
6527 =item B<SocketGroup> I<Group>
6529 If running as root change the group of the UNIX-socket after it has been
6530 created. Defaults to B<collectd>.
6532 =item B<SocketPerms> I<Permissions>
6534 Change the file permissions of the UNIX-socket after it has been created. The
6535 permissions must be given as a numeric, octal value as you would pass to
6536 L<chmod(1)>. Defaults to B<0770>.
6538 =item B<DeleteSocket> B<false>|B<true>
6540 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6541 with the given name already exists. If I<collectd> crashes a socket file may be
6542 left over, preventing the daemon from opening a new socket when restarted.
6543 Since this is potentially dangerous, this defaults to B<false>.
6547 =head2 Plugin C<uuid>
6549 This plugin, if loaded, causes the Hostname to be taken from the machine's
6550 UUID. The UUID is a universally unique designation for the machine, usually
6551 taken from the machine's BIOS. This is most useful if the machine is running in
6552 a virtual environment such as Xen, in which case the UUID is preserved across
6553 shutdowns and migration.
6555 The following methods are used to find the machine's UUID, in order:
6561 Check I</etc/uuid> (or I<UUIDFile>).
6565 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6570 Check for UUID from C<dmidecode> / SMBIOS.
6574 Check for UUID from Xen hypervisor.
6578 If no UUID can be found then the hostname is not modified.
6582 =item B<UUIDFile> I<Path>
6584 Take the UUID from the given file (default I</etc/uuid>).
6588 =head2 Plugin C<varnish>
6590 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6591 It collects a subset of the values displayed by L<varnishstat(1)>, and
6592 organizes them in categories which can be enabled or disabled. Currently only
6593 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6594 meaning of each metric can be found in L<varnish-counters(7)>.
6599 <Instance "example">
6603 CollectConnections true
6604 CollectDirectorDNS false
6608 CollectObjects false
6610 CollectSession false
6620 CollectWorkers false
6624 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6625 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6626 will collectd statistics from the default "varnishd" instance (this should work
6627 fine in most cases).
6629 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6633 =item B<CollectBackend> B<true>|B<false>
6635 Back-end connection statistics, such as successful, reused,
6636 and closed connections. True by default.
6638 =item B<CollectBan> B<true>|B<false>
6640 Statistics about ban operations, such as number of bans added, retired, and
6641 number of objects tested against ban operations. Only available with Varnish
6642 3.x and above. False by default.
6644 =item B<CollectCache> B<true>|B<false>
6646 Cache hits and misses. True by default.
6648 =item B<CollectConnections> B<true>|B<false>
6650 Number of client connections received, accepted and dropped. True by default.
6652 =item B<CollectDirectorDNS> B<true>|B<false>
6654 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6657 =item B<CollectESI> B<true>|B<false>
6659 Edge Side Includes (ESI) parse statistics. False by default.
6661 =item B<CollectFetch> B<true>|B<false>
6663 Statistics about fetches (HTTP requests sent to the backend). False by default.
6665 =item B<CollectHCB> B<true>|B<false>
6667 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6668 divided into locked and unlocked look-ups. False by default.
6670 =item B<CollectObjects> B<true>|B<false>
6672 Statistics on cached objects: number of objects expired, nuked (prematurely
6673 expired), saved, moved, etc. False by default.
6675 =item B<CollectPurge> B<true>|B<false>
6677 Statistics about purge operations, such as number of purges added, retired, and
6678 number of objects tested against purge operations. Only available with Varnish
6679 2.x. False by default.
6681 =item B<CollectSession> B<true>|B<false>
6683 Client session statistics. Number of past and current sessions, session herd and
6684 linger counters, etc. False by default. Note that if using Varnish 4.x, some
6685 metrics found in the Connections and Threads sections with previous versions of
6686 Varnish have been moved here.
6688 =item B<CollectSHM> B<true>|B<false>
6690 Statistics about the shared memory log, a memory region to store
6691 log messages which is flushed to disk when full. True by default.
6693 =item B<CollectSMA> B<true>|B<false>
6695 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6696 component is Solaris specific. Only available with Varnish 2.x. False by
6699 =item B<CollectSMS> B<true>|B<false>
6701 synth (synthetic content) storage statistics. This storage
6702 component is used internally only. False by default.
6704 =item B<CollectSM> B<true>|B<false>
6706 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6709 =item B<CollectStruct> B<true>|B<false>
6711 Current varnish internal state statistics. Number of current sessions, objects
6712 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6715 =item B<CollectTotals> B<true>|B<false>
6717 Collects overview counters, such as the number of sessions created,
6718 the number of requests and bytes transferred. False by default.
6720 =item B<CollectUptime> B<true>|B<false>
6722 Varnish uptime. Only available with Varnish 3.x and above. False by default.
6724 =item B<CollectVCL> B<true>|B<false>
6726 Number of total (available + discarded) VCL (config files). False by default.
6728 =item B<CollectVSM> B<true>|B<false>
6730 Collect statistics about Varnish's shared memory usage (used by the logging and
6731 statistics subsystems). Only available with Varnish 4.x. False by default.
6733 =item B<CollectWorkers> B<true>|B<false>
6735 Collect statistics about worker threads. False by default.
6739 =head2 Plugin C<virt>
6741 This plugin allows CPU, disk and network load to be collected for virtualized
6742 guests on the machine. This means that these metrics can be collected for guest
6743 systems without installing any software on them - I<collectd> only runs on the
6744 host system. The statistics are collected through libvirt
6745 (L<http://libvirt.org/>).
6747 Only I<Connection> is required.
6751 =item B<Connection> I<uri>
6753 Connect to the hypervisor given by I<uri>. For example if using Xen use:
6755 Connection "xen:///"
6757 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
6759 =item B<RefreshInterval> I<seconds>
6761 Refresh the list of domains and devices every I<seconds>. The default is 60
6762 seconds. Setting this to be the same or smaller than the I<Interval> will cause
6763 the list of domains and devices to be refreshed on every iteration.
6765 Refreshing the devices in particular is quite a costly operation, so if your
6766 virtualization setup is static you might consider increasing this. If this
6767 option is set to 0, refreshing is disabled completely.
6769 =item B<Domain> I<name>
6771 =item B<BlockDevice> I<name:dev>
6773 =item B<InterfaceDevice> I<name:dev>
6775 =item B<IgnoreSelected> B<true>|B<false>
6777 Select which domains and devices are collected.
6779 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
6780 disk/network devices are collected.
6782 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
6783 domains and disk/network devices are ignored, while the rest are collected.
6785 The domain name and device names may use a regular expression, if the name is
6786 surrounded by I</.../> and collectd was compiled with support for regexps.
6788 The default is to collect statistics for all domains and all their devices.
6792 BlockDevice "/:hdb/"
6793 IgnoreSelected "true"
6795 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
6798 =item B<HostnameFormat> B<name|uuid|hostname|...>
6800 When the virt plugin logs data, it sets the hostname of the collected data
6801 according to this setting. The default is to use the guest name as provided by
6802 the hypervisor, which is equal to setting B<name>.
6804 B<uuid> means use the guest's UUID. This is useful if you want to track the
6805 same guest across migrations.
6807 B<hostname> means to use the global B<Hostname> setting, which is probably not
6808 useful on its own because all guests will appear to have the same name.
6810 You can also specify combinations of these fields. For example B<name uuid>
6811 means to concatenate the guest name and UUID (with a literal colon character
6812 between, thus I<"foo:1234-1234-1234-1234">).
6814 =item B<InterfaceFormat> B<name>|B<address>
6816 When the virt plugin logs interface data, it sets the name of the collected
6817 data according to this setting. The default is to use the path as provided by
6818 the hypervisor (the "dev" property of the target node), which is equal to
6821 B<address> means use the interface's mac address. This is useful since the
6822 interface path might change between reboots of a guest or across migrations.
6824 =item B<PluginInstanceFormat> B<name|uuid>
6826 When the virt plugin logs data, it sets the plugin_instance of the collected
6827 data according to this setting. The default is to use the guest name as provided
6828 by the hypervisor, which is equal to setting B<name>.
6830 B<uuid> means use the guest's UUID.
6834 =head2 Plugin C<vmem>
6836 The C<vmem> plugin collects information about the usage of virtual memory.
6837 Since the statistics provided by the Linux kernel are very detailed, they are
6838 collected very detailed. However, to get all the details, you have to switch
6839 them on manually. Most people just want an overview over, such as the number of
6840 pages read from swap space.
6844 =item B<Verbose> B<true>|B<false>
6846 Enables verbose collection of information. This will start collecting page
6847 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6848 Part of these statistics are collected on a "per zone" basis.
6852 =head2 Plugin C<vserver>
6854 This plugin doesn't have any options. B<VServer> support is only available for
6855 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6856 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6857 need to apply the patches and compile your own kernel, which will then provide
6858 the F</proc/virtual> filesystem that is required by this plugin.
6860 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6862 B<Note>: The traffic collected by this plugin accounts for the amount of
6863 traffic passing a socket which might be a lot less than the actual on-wire
6864 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6865 collect on-wire traffic you could, for example, use the logging facilities of
6866 iptables to feed data for the guest IPs into the iptables plugin.
6868 =head2 Plugin C<write_graphite>
6870 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6871 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6872 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6873 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6874 of at most 1428 bytes to minimize the number of network packets.
6878 <Plugin write_graphite>
6888 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6889 blocks. Inside the B<Node> blocks, the following options are recognized:
6893 =item B<Host> I<Address>
6895 Hostname or address to connect to. Defaults to C<localhost>.
6897 =item B<Port> I<Service>
6899 Service name or port number to connect to. Defaults to C<2003>.
6901 =item B<Protocol> I<String>
6903 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6905 =item B<LogSendErrors> B<false>|B<true>
6907 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6908 If set to B<false>, it will not log the errors. This is especially useful when
6909 using Protocol UDP since many times we want to use the "fire-and-forget"
6910 approach and logging errors fills syslog with unneeded messages.
6912 =item B<Prefix> I<String>
6914 When set, I<String> is added in front of the host name. Dots and whitespace are
6915 I<not> escaped in this string (see B<EscapeCharacter> below).
6917 =item B<Postfix> I<String>
6919 When set, I<String> is appended to the host name. Dots and whitespace are
6920 I<not> escaped in this string (see B<EscapeCharacter> below).
6922 =item B<EscapeCharacter> I<Char>
6924 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6925 in the identifier. The B<EscapeCharacter> option determines which character
6926 dots, whitespace and control characters are replaced with. Defaults to
6929 =item B<StoreRates> B<false>|B<true>
6931 If set to B<true> (the default), convert counter values to rates. If set to
6932 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6935 =item B<SeparateInstances> B<false>|B<true>
6937 If set to B<true>, the plugin instance and type instance will be in their own
6938 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6939 default), the plugin and plugin instance (and likewise the type and type
6940 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6942 =item B<AlwaysAppendDS> B<false>|B<true>
6944 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6945 identifier. If set to B<false> (the default), this is only done when there is
6950 =head2 Plugin C<write_tsdb>
6952 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6953 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6954 state daemon that ingests metrics and stores them in HBase. The plugin uses
6955 I<TCP> over the "line based" protocol with a default port 4242. The data will
6956 be sent in blocks of at most 1428 bytes to minimize the number of network
6963 Host "tsd-1.my.domain"
6965 HostTags "status=production"
6969 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6970 blocks. Inside the B<Node> blocks, the following options are recognized:
6974 =item B<Host> I<Address>
6976 Hostname or address to connect to. Defaults to C<localhost>.
6978 =item B<Port> I<Service>
6980 Service name or port number to connect to. Defaults to C<4242>.
6983 =item B<HostTags> I<String>
6985 When set, I<HostTags> is added to the end of the metric. It is intended to be
6986 used for name=value pairs that the TSD will tag the metric with. Dots and
6987 whitespace are I<not> escaped in this string.
6989 =item B<StoreRates> B<false>|B<true>
6991 If set to B<true>, convert counter values to rates. If set to B<false>
6992 (the default) counter values are stored as is, as an increasing
6995 =item B<AlwaysAppendDS> B<false>|B<true>
6997 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6998 identifier. If set to B<false> (the default), this is only done when there is
7003 =head2 Plugin C<write_mongodb>
7005 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7010 <Plugin "write_mongodb">
7019 The plugin can send values to multiple instances of I<MongoDB> by specifying
7020 one B<Node> block for each instance. Within the B<Node> blocks, the following
7021 options are available:
7025 =item B<Host> I<Address>
7027 Hostname or address to connect to. Defaults to C<localhost>.
7029 =item B<Port> I<Service>
7031 Service name or port number to connect to. Defaults to C<27017>.
7033 =item B<Timeout> I<Timeout>
7035 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7036 Setting this option to zero means no timeout, which is the default.
7038 =item B<StoreRates> B<false>|B<true>
7040 If set to B<true> (the default), convert counter values to rates. If set to
7041 B<false> counter values are stored as is, i.e. as an increasing integer
7044 =item B<Database> I<Database>
7046 =item B<User> I<User>
7048 =item B<Password> I<Password>
7050 Sets the information used when authenticating to a I<MongoDB> database. The
7051 fields are optional (in which case no authentication is attempted), but if you
7052 want to use authentication all three fields must be set.
7056 =head2 Plugin C<write_http>
7058 This output plugin submits values to an HTTP server using POST requests and
7059 encoding metrics with JSON or using the C<PUTVAL> command described in
7060 L<collectd-unixsock(5)>.
7064 <Plugin "write_http">
7066 URL "http://example.com/post-collectd"
7073 The plugin can send values to multiple HTTP servers by specifying one
7074 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7075 block, the following options are available:
7081 URL to which the values are submitted to. Mandatory.
7083 =item B<User> I<Username>
7085 Optional user name needed for authentication.
7087 =item B<Password> I<Password>
7089 Optional password needed for authentication.
7091 =item B<VerifyPeer> B<true>|B<false>
7093 Enable or disable peer SSL certificate verification. See
7094 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7096 =item B<VerifyHost> B<true|false>
7098 Enable or disable peer host name verification. If enabled, the plugin checks if
7099 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7100 matches the host name provided by the B<URL> option. If this identity check
7101 fails, the connection is aborted. Obviously, only works when connecting to a
7102 SSL enabled server. Enabled by default.
7104 =item B<CACert> I<File>
7106 File that holds one or more SSL certificates. If you want to use HTTPS you will
7107 possibly need this option. What CA certificates come bundled with C<libcurl>
7108 and are checked by default depends on the distribution you use.
7110 =item B<CAPath> I<Directory>
7112 Directory holding one or more CA certificate files. You can use this if for
7113 some reason all the needed CA certificates aren't in the same file and can't be
7114 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7117 =item B<ClientKey> I<File>
7119 File that holds the private key in PEM format to be used for certificate-based
7122 =item B<ClientCert> I<File>
7124 File that holds the SSL certificate to be used for certificate-based
7127 =item B<ClientKeyPass> I<Password>
7129 Password required to load the private key in B<ClientKey>.
7131 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7133 Define which SSL protocol version must be used. By default C<libcurl> will
7134 attempt to figure out the remote SSL protocol version. See
7135 L<curl_easy_setopt(3)> for more details.
7137 =item B<Format> B<Command>|B<JSON>
7139 Format of the output to generate. If set to B<Command>, will create output that
7140 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7141 create output in the I<JavaScript Object Notation> (JSON).
7143 Defaults to B<Command>.
7145 =item B<StoreRates> B<true|false>
7147 If set to B<true>, convert counter values to rates. If set to B<false> (the
7148 default) counter values are stored as is, i.e. as an increasing integer number.
7150 =item B<BufferSize> I<Bytes>
7152 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7153 requests will be generated, but more metrics will be batched / metrics are
7154 cached for longer before being sent, introducing additional delay until they
7155 are available on the server side. I<Bytes> must be at least 1024 and cannot
7156 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7157 Defaults to C<4096>.
7161 =head2 Plugin C<write_kafka>
7163 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7167 <Plugin "write_kafka">
7168 Property "metadata.broker.list" "broker1:9092,broker2:9092"
7174 The following options are understood by the I<write_kafka plugin>:
7178 =item E<lt>B<Topic> I<Name>E<gt>
7180 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7181 is given a unique I<Name> and specifies one kafka producer.
7182 Inside the B<Topic> block, the following per-topic options are
7187 =item B<Property> I<String> I<String>
7189 Configure the named property for the current topic. Properties are
7190 forwarded to the kafka producer library B<librdkafka>.
7192 =item B<Key> I<String>
7194 Use the specified string as a partioning key for the topic. Kafka breaks
7195 topic into partitions and guarantees that for a given topology, the same
7196 consumer will be used for a specific key. The special (case insensitive)
7197 string B<Random> can be used to specify that an arbitrary partition should
7200 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7202 Selects the format in which messages are sent to the broker. If set to
7203 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7204 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7206 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7207 an easy and straight forward exchange format.
7209 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7210 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7212 =item B<StoreRates> B<true>|B<false>
7214 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7215 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7216 default), no conversion is performed. Otherwise the conversion is performed
7217 using the internal value cache.
7219 Please note that currently this option is only used if the B<Format> option has
7220 been set to B<JSON>.
7222 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7224 A prefix can be added in the metric name when outputting in the I<Graphite>
7225 format. It's added before the I<Host> name.
7227 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>>
7229 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7231 A postfix can be added in the metric name when outputting in the I<Graphite>
7232 format. It's added after the I<Host> name.
7234 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>>
7236 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7238 Specify a character to replace dots (.) in the host part of the metric name.
7239 In I<Graphite> metric name, dots are used as separators between different
7240 metric parts (host, plugin, type).
7241 Default is C<_> (I<Underscore>).
7243 =item B<GraphiteSeparateInstances> B<false>|B<true>
7245 If set to B<true>, the plugin instance and type instance will be in their own
7246 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7247 default), the plugin and plugin instance (and likewise the type and type
7248 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7250 =item B<StoreRates> B<true>|B<false>
7252 If set to B<true> (the default), convert counter values to rates. If set to
7253 B<false> counter values are stored as is, i.e. as an increasing integer number.
7255 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7256 converted values will have "rate" appended to the data source type, e.g.
7257 C<ds_type:derive:rate>.
7261 =item B<Property> I<String> I<String>
7263 Configure the kafka producer through properties, you almost always will
7264 want to set B<metadata.broker.list> to your Kafka broker list.
7268 =head2 Plugin C<write_redis>
7270 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7274 <Plugin "write_redis">
7282 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7283 the timestamp as the score. Retrieving a date range can then be done using the
7284 C<ZRANGEBYSCORE> I<Redis> command. Additionnally, all the identifiers of these
7285 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
7286 retrieved using the C<SMEMBERS> I<Redis> command. See
7287 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7290 The information shown in the synopsis above is the I<default configuration>
7291 which is used by the plugin if no configuration is present.
7293 The plugin can send values to multiple instances of I<Redis> by specifying
7294 one B<Node> block for each instance. Within the B<Node> blocks, the following
7295 options are available:
7299 =item B<Node> I<Nodename>
7301 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7302 instance running in an specified host and port. The name for node is a
7303 canonical identifier which is used as I<plugin instance>. It is limited to
7304 64E<nbsp>characters in length.
7306 =item B<Host> I<Hostname>
7308 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7311 =item B<Port> I<Port>
7313 The B<Port> option is the TCP port on which the Redis instance accepts
7314 connections. Either a service name of a port number may be given. Please note
7315 that numerical port numbers must be given as a string, too.
7317 =item B<Timeout> I<Timeout in miliseconds>
7319 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7323 =head2 Plugin C<write_riemann>
7325 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7326 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7327 I<Riemann> using UDP packets.
7331 <Plugin "write_riemann">
7337 AlwaysAppendDS false
7341 Attribute "foo" "bar"
7344 The following options are understood by the I<write_riemann plugin>:
7348 =item E<lt>B<Node> I<Name>E<gt>
7350 The plugin's configuration consists of one or more B<Node> blocks. Each block
7351 is given a unique I<Name> and specifies one connection to an instance of
7352 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7357 =item B<Host> I<Address>
7359 Hostname or address to connect to. Defaults to C<localhost>.
7361 =item B<Port> I<Service>
7363 Service name or port number to connect to. Defaults to C<5555>.
7365 =item B<Protocol> B<UDP>|B<TCP>
7367 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7370 =item B<Batch> B<true>|B<false>
7372 If set to B<true> and B<Protocol> is set to B<TCP>,
7373 events will be batched in memory and flushed at
7374 regular intervals or when B<BatchMaxSize> is exceeded.
7376 Notifications are not batched and sent as soon as possible.
7378 When enabled, it can occur that events get processed by the Riemann server
7379 close to or after their expiration time. Tune the B<TTLFactor> and
7380 B<BatchMaxSize> settings according to the amount of values collected, if this
7385 =item B<BatchMaxSize> I<size>
7387 Maximum payload size for a riemann packet. Defaults to 8192
7389 =item B<StoreRates> B<true>|B<false>
7391 If set to B<true> (the default), convert counter values to rates. If set to
7392 B<false> counter values are stored as is, i.e. as an increasing integer number.
7394 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7395 converted values will have "rate" appended to the data source type, e.g.
7396 C<ds_type:derive:rate>.
7398 =item B<AlwaysAppendDS> B<false>|B<true>
7400 If set the B<true>, append the name of the I<Data Source> (DS) to the
7401 "service", i.e. the field that, together with the "host" field, uniquely
7402 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7403 only done when there is more than one DS.
7405 =item B<TTLFactor> I<Factor>
7407 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7408 event is considered active. I<collectd> populates this field based on the
7409 metrics interval setting. This setting controls the factor with which the
7410 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7411 know exactly what you're doing, you should only increase this setting from its
7414 =item B<Notifications> B<false>|B<true>
7416 If set to B<true>, create riemann events for notifications. This is B<true>
7417 by default. When processing thresholds from write_riemann, it might prove
7418 useful to avoid getting notification events.
7420 =item B<CheckThresholds> B<false>|B<true>
7422 If set to B<true>, attach state to events based on thresholds defined
7423 in the B<Threshold> plugin. Defaults to B<false>.
7425 =item B<EventServicePrefix> I<String>
7427 Add the given string as a prefix to the event service name.
7428 If B<EventServicePrefix> not set or set to an empty string (""),
7429 no prefix will be used.
7433 =item B<Tag> I<String>
7435 Add the given string as an additional tag to the metric being sent to
7438 =item B<Attribute> I<String> I<String>
7440 Consider the two given strings to be the key and value of an additional
7441 attribute for each metric being sent out to I<Riemann>.
7445 =head2 Plugin C<zookeeper>
7447 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
7448 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
7453 <Plugin "zookeeper">
7460 =item B<Host> I<Address>
7462 Hostname or address to connect to. Defaults to C<localhost>.
7464 =item B<Port> I<Service>
7466 Service name or port number to connect to. Defaults to C<2181>.
7470 =head1 THRESHOLD CONFIGURATION
7472 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7473 we mean that the values are not only stored or sent somewhere, but that they
7474 are judged and, if a problem is recognized, acted upon. The only action
7475 collectd takes itself is to generate and dispatch a "notification". Plugins can
7476 register to receive notifications and perform appropriate further actions.
7478 Since systems and what you expect them to do differ a lot, you can configure
7479 B<thresholds> for your values freely. This gives you a lot of flexibility but
7480 also a lot of responsibility.
7482 Every time a value is out of range a notification is dispatched. This means
7483 that the idle percentage of your CPU needs to be less then the configured
7484 threshold only once for a notification to be generated. There's no such thing
7485 as a moving average or similar - at least not now.
7487 Also, all values that match a threshold are considered to be relevant or
7488 "interesting". As a consequence collectd will issue a notification if they are
7489 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7490 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7491 "2" (the default) and some hosts sends it's CPU statistics to the server every
7492 60 seconds, a notification will be dispatched after about 120 seconds. It may
7493 take a little longer because the timeout is checked only once each B<Interval>
7496 When a value comes within range again or is received after it was missing, an
7497 "OKAY-notification" is dispatched.
7499 Here is a configuration example to get you started. Read below for more
7512 <Plugin "interface">
7529 WarningMin 100000000
7535 There are basically two types of configuration statements: The C<Host>,
7536 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7537 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7538 C<Instance> option. You can combine the block by nesting the blocks, though
7539 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7540 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7541 C<Type> may not contain other blocks. If multiple blocks apply to the same
7542 value the most specific block is used.
7544 The other statements specify the threshold to configure. They B<must> be
7545 included in a C<Type> block. Currently the following statements are recognized:
7549 =item B<FailureMax> I<Value>
7551 =item B<WarningMax> I<Value>
7553 Sets the upper bound of acceptable values. If unset defaults to positive
7554 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7555 will be created. If the value is greater than B<WarningMax> but less than (or
7556 equal to) B<FailureMax> a B<WARNING> notification will be created.
7558 =item B<FailureMin> I<Value>
7560 =item B<WarningMin> I<Value>
7562 Sets the lower bound of acceptable values. If unset defaults to negative
7563 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7564 be created. If the value is less than B<WarningMin> but greater than (or equal
7565 to) B<FailureMin> a B<WARNING> notification will be created.
7567 =item B<DataSource> I<DSName>
7569 Some data sets have more than one "data source". Interesting examples are the
7570 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7571 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7572 system load data set, C<load>, even has three data sources: C<shortterm>,
7573 C<midterm>, and C<longterm>.
7575 Normally, all data sources are checked against a configured threshold. If this
7576 is undesirable, or if you want to specify different limits for each data
7577 source, you can use the B<DataSource> option to have a threshold apply only to
7580 =item B<Invert> B<true>|B<false>
7582 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7583 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7584 B<WarningMax>) are not okay. Defaults to B<false>.
7586 =item B<Persist> B<true>|B<false>
7588 Sets how often notifications are generated. If set to B<true> one notification
7589 will be generated for each value that is out of the acceptable range. If set to
7590 B<false> (the default) then a notification is only generated if a value is out
7591 of range but the previous value was okay.
7593 This applies to missing values, too: If set to B<true> a notification about a
7594 missing value is generated once every B<Interval> seconds. If set to B<false>
7595 only one such notification is generated until the value appears again.
7597 =item B<Percentage> B<true>|B<false>
7599 If set to B<true>, the minimum and maximum values given are interpreted as
7600 percentage value, relative to the other data sources. This is helpful for
7601 example for the "df" type, where you may want to issue a warning when less than
7602 5E<nbsp>% of the total space is available. Defaults to B<false>.
7604 =item B<Hits> I<Number>
7606 Delay creating the notification until the threshold has been passed I<Number>
7607 times. When a notification has been generated, or when a subsequent value is
7608 inside the threshold, the counter is reset. If, for example, a value is
7609 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7610 will be dispatched at most once every 30E<nbsp>seconds.
7612 This is useful when short bursts are not a problem. If, for example, 100% CPU
7613 usage for up to a minute is normal (and data is collected every
7614 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7616 =item B<Hysteresis> I<Number>
7618 When set to non-zero, a hysteresis value is applied when checking minimum and
7619 maximum bounds. This is useful for values that increase slowly and fluctuate a
7620 bit while doing so. When these values come close to the threshold, they may
7621 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7623 If, for example, the threshold is configures as
7628 then a I<Warning> notification is created when the value exceeds I<101> and the
7629 corresponding I<Okay> notification is only created once the value falls below
7630 I<99>, thus avoiding the "flapping".
7634 =head1 FILTER CONFIGURATION
7636 Starting with collectd 4.6 there is a powerful filtering infrastructure
7637 implemented in the daemon. The concept has mostly been copied from
7638 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7639 terminology, so that users that are familiar with iptables feel right at home.
7643 The following are the terms used in the remainder of the filter configuration
7644 documentation. For an ASCII-art schema of the mechanism, see
7645 L<"General structure"> below.
7651 A I<match> is a criteria to select specific values. Examples are, of course, the
7652 name of the value or it's current value.
7654 Matches are implemented in plugins which you have to load prior to using the
7655 match. The name of such plugins starts with the "match_" prefix.
7659 A I<target> is some action that is to be performed with data. Such actions
7660 could, for example, be to change part of the value's identifier or to ignore
7661 the value completely.
7663 Some of these targets are built into the daemon, see L<"Built-in targets">
7664 below. Other targets are implemented in plugins which you have to load prior to
7665 using the target. The name of such plugins starts with the "target_" prefix.
7669 The combination of any number of matches and at least one target is called a
7670 I<rule>. The target actions will be performed for all values for which B<all>
7671 matches apply. If the rule does not have any matches associated with it, the
7672 target action will be performed for all values.
7676 A I<chain> is a list of rules and possibly default targets. The rules are tried
7677 in order and if one matches, the associated target will be called. If a value
7678 is handled by a rule, it depends on the target whether or not any subsequent
7679 rules are considered or if traversal of the chain is aborted, see
7680 L<"Flow control"> below. After all rules have been checked, the default targets
7685 =head2 General structure
7687 The following shows the resulting structure:
7694 +---------+ +---------+ +---------+ +---------+
7695 ! Rule !->! Match !->! Match !->! Target !
7696 +---------+ +---------+ +---------+ +---------+
7699 +---------+ +---------+ +---------+
7700 ! Rule !->! Target !->! Target !
7701 +---------+ +---------+ +---------+
7708 +---------+ +---------+ +---------+
7709 ! Rule !->! Match !->! Target !
7710 +---------+ +---------+ +---------+
7720 There are four ways to control which way a value takes through the filter
7727 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7728 process the value with another chain. When the called chain finishes, usually
7729 the next target or rule after the jump is executed.
7733 The stop condition, signaled for example by the built-in target B<stop>, causes
7734 all processing of the value to be stopped immediately.
7738 Causes processing in the current chain to be aborted, but processing of the
7739 value generally will continue. This means that if the chain was called via
7740 B<Jump>, the next target or rule after the jump will be executed. If the chain
7741 was not called by another chain, control will be returned to the daemon and it
7742 may pass the value to another chain.
7746 Most targets will signal the B<continue> condition, meaning that processing
7747 should continue normally. There is no special built-in target for this
7754 The configuration reflects this structure directly:
7756 PostCacheChain "PostCache"
7758 <Rule "ignore_mysql_show">
7761 Type "^mysql_command$"
7762 TypeInstance "^show_"
7772 The above configuration example will ignore all values where the plugin field
7773 is "mysql", the type is "mysql_command" and the type instance begins with
7774 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7775 default target of the chain. Since this chain is run after the value has been
7776 added to the cache, the MySQL C<show_*> command statistics will be available
7777 via the C<unixsock> plugin.
7779 =head2 List of configuration options
7783 =item B<PreCacheChain> I<ChainName>
7785 =item B<PostCacheChain> I<ChainName>
7787 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7788 argument is the name of a I<chain> that should be executed before and/or after
7789 the values have been added to the cache.
7791 To understand the implications, it's important you know what is going on inside
7792 I<collectd>. The following diagram shows how values are passed from the
7793 read-plugins to the write-plugins:
7799 + - - - - V - - - - +
7800 : +---------------+ :
7803 : +-------+-------+ :
7806 : +-------+-------+ : +---------------+
7807 : ! Cache !--->! Value Cache !
7808 : ! insert ! : +---+---+-------+
7809 : +-------+-------+ : ! !
7810 : ! ,------------' !
7812 : +-------+---+---+ : +-------+-------+
7813 : ! Post-Cache +--->! Write-Plugins !
7814 : ! Chain ! : +---------------+
7815 : +---------------+ :
7818 + - - - - - - - - - +
7820 After the values are passed from the "read" plugins to the dispatch functions,
7821 the pre-cache chain is run first. The values are added to the internal cache
7822 afterwards. The post-cache chain is run after the values have been added to the
7823 cache. So why is it such a huge deal if chains are run before or after the
7824 values have been added to this cache?
7826 Targets that change the identifier of a value list should be executed before
7827 the values are added to the cache, so that the name in the cache matches the
7828 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7829 this cache to receive a list of all available values. If you change the
7830 identifier after the value list has been added to the cache, this may easily
7831 lead to confusion, but it's not forbidden of course.
7833 The cache is also used to convert counter values to rates. These rates are, for
7834 example, used by the C<value> match (see below). If you use the rate stored in
7835 the cache B<before> the new value is added, you will use the old, B<previous>
7836 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7837 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7840 Last but not last, the B<stop> target makes a difference: If the pre-cache
7841 chain returns the stop condition, the value will not be added to the cache and
7842 the post-cache chain will not be run.
7844 =item B<Chain> I<Name>
7846 Adds a new chain with a certain name. This name can be used to refer to a
7847 specific chain, for example to jump to it.
7849 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7851 =item B<Rule> [I<Name>]
7853 Adds a new rule to the current chain. The name of the rule is optional and
7854 currently has no meaning for the daemon.
7856 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7857 must be at least one B<Target> block.
7859 =item B<Match> I<Name>
7861 Adds a match to a B<Rule> block. The name specifies what kind of match should
7862 be performed. Available matches depend on the plugins that have been loaded.
7864 The arguments inside the B<Match> block are passed to the plugin implementing
7865 the match, so which arguments are valid here depends on the plugin being used.
7866 If you do not need any to pass any arguments to a match, you can use the
7871 Which is equivalent to:
7876 =item B<Target> I<Name>
7878 Add a target to a rule or a default target to a chain. The name specifies what
7879 kind of target is to be added. Which targets are available depends on the
7880 plugins being loaded.
7882 The arguments inside the B<Target> block are passed to the plugin implementing
7883 the target, so which arguments are valid here depends on the plugin being used.
7884 If you do not need any to pass any arguments to a target, you can use the
7889 This is the same as writing:
7896 =head2 Built-in targets
7898 The following targets are built into the core daemon and therefore need no
7899 plugins to be loaded:
7905 Signals the "return" condition, see the L<"Flow control"> section above. This
7906 causes the current chain to stop processing the value and returns control to
7907 the calling chain. The calling chain will continue processing targets and rules
7908 just after the B<jump> target (see below). This is very similar to the
7909 B<RETURN> target of iptables, see L<iptables(8)>.
7911 This target does not have any options.
7919 Signals the "stop" condition, see the L<"Flow control"> section above. This
7920 causes processing of the value to be aborted immediately. This is similar to
7921 the B<DROP> target of iptables, see L<iptables(8)>.
7923 This target does not have any options.
7931 Sends the value to "write" plugins.
7937 =item B<Plugin> I<Name>
7939 Name of the write plugin to which the data should be sent. This option may be
7940 given multiple times to send the data to more than one write plugin. If the
7941 plugin supports multiple instances, the plugin's instance(s) must also be
7946 If no plugin is explicitly specified, the values will be sent to all available
7949 Single-instance plugin example:
7955 Multi-instance plugin example:
7957 <Plugin "write_graphite">
7967 Plugin "write_graphite/foo"
7972 Starts processing the rules of another chain, see L<"Flow control"> above. If
7973 the end of that chain is reached, or a stop condition is encountered,
7974 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7975 next target or the next rule. This is similar to the B<-j> command line option
7976 of iptables, see L<iptables(8)>.
7982 =item B<Chain> I<Name>
7984 Jumps to the chain I<Name>. This argument is required and may appear only once.
7996 =head2 Available matches
8002 Matches a value using regular expressions.
8008 =item B<Host> I<Regex>
8010 =item B<Plugin> I<Regex>
8012 =item B<PluginInstance> I<Regex>
8014 =item B<Type> I<Regex>
8016 =item B<TypeInstance> I<Regex>
8018 Match values where the given regular expressions match the various fields of
8019 the identifier of a value. If multiple regular expressions are given, B<all>
8020 regexen must match for a value to match.
8022 =item B<Invert> B<false>|B<true>
8024 When set to B<true>, the result of the match is inverted, i.e. all value lists
8025 where all regular expressions apply are not matched, all other value lists are
8026 matched. Defaults to B<false>.
8033 Host "customer[0-9]+"
8039 Matches values that have a time which differs from the time on the server.
8041 This match is mainly intended for servers that receive values over the
8042 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8043 is very sensitive to the timestamp used when updating the RRD files. In
8044 particular, the time must be ever increasing. If a misbehaving client sends one
8045 packet with a timestamp far in the future, all further packets with a correct
8046 time will be ignored because of that one packet. What's worse, such corrupted
8047 RRD files are hard to fix.
8049 This match lets one match all values B<outside> a specified time range
8050 (relative to the server's time), so you can use the B<stop> target (see below)
8051 to ignore the value, for example.
8057 =item B<Future> I<Seconds>
8059 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8060 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8063 =item B<Past> I<Seconds>
8065 Matches all values that are I<behind> of the server's time by I<Seconds> or
8066 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8078 This example matches all values that are five minutes or more ahead of the
8079 server or one hour (or more) lagging behind.
8083 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8084 values. If a data-set consists of more than one data-source, all data-sources
8085 must match the specified ranges for a positive match.
8091 =item B<Min> I<Value>
8093 Sets the smallest value which still results in a match. If unset, behaves like
8096 =item B<Max> I<Value>
8098 Sets the largest value which still results in a match. If unset, behaves like
8101 =item B<Invert> B<true>|B<false>
8103 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8104 no-match is returned and vice versa. Please note that the B<Invert> setting
8105 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8106 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8108 =item B<DataSource> I<DSName> [I<DSName> ...]
8110 Select one or more of the data sources. If no data source is configured, all
8111 data sources will be checked. If the type handled by the match does not have a
8112 data source of the specified name(s), this will always result in no match
8113 (independent of the B<Invert> setting).
8115 =item B<Satisfy> B<Any>|B<All>
8117 Specifies how checking with several data sources is performed. If set to
8118 B<Any>, the match succeeds if one of the data sources is in the configured
8119 range. If set to B<All> the match only succeeds if all data sources are within
8120 the configured range. Default is B<All>.
8122 Usually B<All> is used for positive matches, B<Any> is used for negative
8123 matches. This means that with B<All> you usually check that all values are in a
8124 "good" range, while with B<Any> you check if any value is within a "bad" range
8125 (or outside the "good" range).
8129 Either B<Min> or B<Max>, but not both, may be unset.
8133 # Match all values smaller than or equal to 100. Matches only if all data
8134 # sources are below 100.
8140 # Match if the value of any data source is outside the range of 0 - 100.
8148 =item B<empty_counter>
8150 Matches all values with one or more data sources of type B<COUNTER> and where
8151 all counter values are zero. These counters usually I<never> increased since
8152 they started existing (and are therefore uninteresting), or got reset recently
8153 or overflowed and you had really, I<really> bad luck.
8155 Please keep in mind that ignoring such counters can result in confusing
8156 behavior: Counters which hardly ever increase will be zero for long periods of
8157 time. If the counter is reset for some reason (machine or service restarted,
8158 usually), the graph will be empty (NAN) for a long time. People may not
8163 Calculates a hash value of the host name and matches values according to that
8164 hash value. This makes it possible to divide all hosts into groups and match
8165 only values that are in a specific group. The intended use is in load
8166 balancing, where you want to handle only part of all data and leave the rest
8169 The hashing function used tries to distribute the hosts evenly. First, it
8170 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8173 for (i = 0; host[i] != 0; i++)
8174 hash_value = (hash_value * 251) + host[i];
8176 The constant 251 is a prime number which is supposed to make this hash value
8177 more random. The code then checks the group for this host according to the
8178 I<Total> and I<Match> arguments:
8180 if ((hash_value % Total) == Match)
8185 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8186 groups), then the least significant bit of the hash value will be the XOR of
8187 all least significant bits in the host name. One consequence is that when you
8188 have two hosts, "server0.example.com" and "server1.example.com", where the host
8189 name differs in one digit only and the digits differ by one, those hosts will
8190 never end up in the same group.
8196 =item B<Match> I<Match> I<Total>
8198 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8199 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8200 be smaller than I<Total>. I<Total> must be at least one, although only values
8201 greater than one really do make any sense.
8203 You can repeat this option to match multiple groups, for example:
8208 The above config will divide the data into seven groups and match groups three
8209 and five. One use would be to keep every value on two hosts so that if one
8210 fails the missing data can later be reconstructed from the second host.
8216 # Operate on the pre-cache chain, so that ignored values are not even in the
8221 # Divide all received hosts in seven groups and accept all hosts in
8225 # If matched: Return and continue.
8228 # If not matched: Return and stop.
8234 =head2 Available targets
8238 =item B<notification>
8240 Creates and dispatches a notification.
8246 =item B<Message> I<String>
8248 This required option sets the message of the notification. The following
8249 placeholders will be replaced by an appropriate value:
8257 =item B<%{plugin_instance}>
8261 =item B<%{type_instance}>
8263 These placeholders are replaced by the identifier field of the same name.
8265 =item B<%{ds:>I<name>B<}>
8267 These placeholders are replaced by a (hopefully) human readable representation
8268 of the current rate of this data source. If you changed the instance name
8269 (using the B<set> or B<replace> targets, see below), it may not be possible to
8270 convert counter values to rates.
8274 Please note that these placeholders are B<case sensitive>!
8276 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8278 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8285 <Target "notification">
8286 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8292 Replaces parts of the identifier using regular expressions.
8298 =item B<Host> I<Regex> I<Replacement>
8300 =item B<Plugin> I<Regex> I<Replacement>
8302 =item B<PluginInstance> I<Regex> I<Replacement>
8304 =item B<TypeInstance> I<Regex> I<Replacement>
8306 Match the appropriate field with the given regular expression I<Regex>. If the
8307 regular expression matches, that part that matches is replaced with
8308 I<Replacement>. If multiple places of the input buffer match a given regular
8309 expression, only the first occurrence will be replaced.
8311 You can specify each option multiple times to use multiple regular expressions
8319 # Replace "example.net" with "example.com"
8320 Host "\\<example.net\\>" "example.com"
8322 # Strip "www." from hostnames
8328 Sets part of the identifier of a value to a given string.
8334 =item B<Host> I<String>
8336 =item B<Plugin> I<String>
8338 =item B<PluginInstance> I<String>
8340 =item B<TypeInstance> I<String>
8342 Set the appropriate field to the given string. The strings for plugin instance
8343 and type instance may be empty, the strings for host and plugin may not be
8344 empty. It's currently not possible to set the type of a value this way.
8351 PluginInstance "coretemp"
8352 TypeInstance "core3"
8357 =head2 Backwards compatibility
8359 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8360 B<Chain> block, it will behave as it used to. This is equivalent to the
8361 following configuration:
8367 If you specify a B<PostCacheChain>, the B<write> target will not be added
8368 anywhere and you will have to make sure that it is called where appropriate. We
8369 suggest to add the above snippet as default target to your "PostCache" chain.
8373 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8389 L<collectd-exec(5)>,
8390 L<collectd-perl(5)>,
8391 L<collectd-unixsock(5)>,
8404 Florian Forster E<lt>octo@collectd.orgE<gt>