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 =item B<MeasureResponseCode> B<true>|B<false>
1460 Measure response code for the request. If this setting is enabled, B<Match>
1461 blocks (see below) are optional. Disabled by default.
1463 =item B<E<lt>MatchE<gt>>
1465 One or more B<Match> blocks that define how to match information in the data
1466 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1467 used by the C<tail> plugin, so please see the documentation of the C<tail>
1468 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1469 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1472 =item B<Timeout> I<Timeout in miliseconds>
1474 The B<Timeout> option sets the overall timeout for each request. Make sure that
1475 collectd is configured with enough C<ReadThreads>, otherwise an overly long
1476 timeout could block other plugins. By default or when set to B<0>, a timeout
1477 equal to the B<Interval> is used. Prior to version 5.5.0, there was no timeout
1478 and requests might hang indefinitely.
1482 =head2 Plugin C<curl_json>
1484 The B<curl_json plugin> collects values from JSON data to be parsed by
1485 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1486 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1487 unix socket. The former can be used, for example, to collect values
1488 from CouchDB documents (which are stored JSON notation), and the
1489 latter to collect values from a uWSGI stats socket.
1491 The following example will collect several values from the built-in
1492 C<_stats> runtime statistics module of I<CouchDB>
1493 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1496 <URL "http://localhost:5984/_stats">
1498 <Key "httpd/requests/count">
1499 Type "http_requests"
1502 <Key "httpd_request_methods/*/count">
1503 Type "http_request_methods"
1506 <Key "httpd_status_codes/*/count">
1507 Type "http_response_codes"
1512 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1515 <Sock "/var/run/uwsgi.stats.sock">
1517 <Key "workers/*/requests">
1518 Type "http_requests"
1521 <Key "workers/*/apps/*/requests">
1522 Type "http_requests"
1527 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1528 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1529 blocks defining a unix socket to read JSON from directly. Each of
1530 these blocks may have one or more B<Key> blocks.
1532 The B<Key> string argument must be in a path format. Each component is
1533 used to match the key from a JSON map or the index of an JSON
1534 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1535 values for all map keys or array indices will be collectd.
1537 The following options are valid within B<URL> blocks:
1541 =item B<Instance> I<Instance>
1543 Sets the plugin instance to I<Instance>.
1545 =item B<Interval> I<Interval>
1547 Sets the interval (in seconds) in which the values will be collected from this
1548 URL. By default the global B<Interval> setting will be used.
1550 =item B<User> I<Name>
1552 =item B<Password> I<Password>
1554 =item B<Digest> B<true>|B<false>
1556 =item B<VerifyPeer> B<true>|B<false>
1558 =item B<VerifyHost> B<true>|B<false>
1560 =item B<CACert> I<file>
1562 =item B<Header> I<Header>
1564 =item B<Post> I<Body>
1565 =item B<Timeout> I<Timeout in miliseconds>
1567 These options behave exactly equivalent to the appropriate options of the
1568 I<cURL> plugin. Please see there for a detailed description.
1572 The following options are valid within B<Key> blocks:
1576 =item B<Type> I<Type>
1578 Sets the type used to dispatch the values to the daemon. Detailed information
1579 about types and their configuration can be found in L<types.db(5)>. This
1580 option is mandatory.
1582 =item B<Instance> I<Instance>
1584 Type-instance to use. Defaults to the current map key or current string array element value.
1588 =head2 Plugin C<curl_xml>
1590 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1591 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1594 <URL "http://localhost/stats.xml">
1596 Instance "some_instance"
1601 CACert "/path/to/ca.crt"
1602 Header "X-Custom-Header: foobar"
1605 <XPath "table[@id=\"magic_level\"]/tr">
1607 #InstancePrefix "prefix-"
1608 InstanceFrom "td[1]"
1609 ValuesFrom "td[2]/span[@class=\"level\"]"
1614 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1615 URL to be fetched using libcurl. Within each B<URL> block there are
1616 options which specify the connection parameters, for example authentication
1617 information, and one or more B<XPath> blocks.
1619 Each B<XPath> block specifies how to get one type of information. The
1620 string argument must be a valid XPath expression which returns a list
1621 of "base elements". One value is dispatched for each "base element". The
1622 I<type instance> and values are looked up using further I<XPath> expressions
1623 that should be relative to the base element.
1625 Within the B<URL> block the following options are accepted:
1629 =item B<Host> I<Name>
1631 Use I<Name> as the host name when submitting values. Defaults to the global
1634 =item B<Instance> I<Instance>
1636 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1637 empty string (no plugin instance).
1639 =item B<Namespace> I<Prefix> I<URL>
1641 If an XPath expression references namespaces, they must be specified
1642 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1643 I<URL> is the "namespace name", an URI reference uniquely identifying the
1644 namespace. The option can be repeated to register multiple namespaces.
1648 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1649 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1651 =item B<User> I<User>
1653 =item B<Password> I<Password>
1655 =item B<Digest> B<true>|B<false>
1657 =item B<VerifyPeer> B<true>|B<false>
1659 =item B<VerifyHost> B<true>|B<false>
1661 =item B<CACert> I<CA Cert File>
1663 =item B<Header> I<Header>
1665 =item B<Post> I<Body>
1667 These options behave exactly equivalent to the appropriate options of the
1668 I<cURL plugin>. Please see there for a detailed description.
1670 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1672 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1673 B<XPath> block specifies how to get one type of information. The string
1674 argument must be a valid XPath expression which returns a list of "base
1675 elements". One value is dispatched for each "base element".
1677 Within the B<XPath> block the following options are accepted:
1681 =item B<Type> I<Type>
1683 Specifies the I<Type> used for submitting patches. This determines the number
1684 of values that are required / expected and whether the strings are parsed as
1685 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1686 This option is required.
1688 =item B<InstancePrefix> I<InstancePrefix>
1690 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1691 concatenated together without any separator.
1692 This option is optional.
1694 =item B<InstanceFrom> I<InstanceFrom>
1696 Specifies a XPath expression to use for determining the I<type instance>. The
1697 XPath expression must return exactly one element. The element's value is then
1698 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1700 This value is required. As a special exception, if the "base XPath expression"
1701 (the argument to the B<XPath> block) returns exactly one argument, then this
1702 option may be omitted.
1704 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1706 Specifies one or more XPath expression to use for reading the values. The
1707 number of XPath expressions must match the number of data sources in the
1708 I<type> specified with B<Type> (see above). Each XPath expression must return
1709 exactly one element. The element's value is then parsed as a number and used as
1710 value for the appropriate value in the value list dispatched to the daemon.
1716 =head2 Plugin C<dbi>
1718 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1719 connect to various databases, execute I<SQL> statements and read back the
1720 results. I<dbi> is an acronym for "database interface" in case you were
1721 wondering about the name. You can configure how each column is to be
1722 interpreted and the plugin will generate one or more data sets from each row
1723 returned according to these rules.
1725 Because the plugin is very generic, the configuration is a little more complex
1726 than those of other plugins. It usually looks something like this:
1729 <Query "out_of_stock">
1730 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1731 # Use with MySQL 5.0.0 or later
1735 InstancePrefix "out_of_stock"
1736 InstancesFrom "category"
1740 <Database "product_information">
1742 DriverOption "host" "localhost"
1743 DriverOption "username" "collectd"
1744 DriverOption "password" "aZo6daiw"
1745 DriverOption "dbname" "prod_info"
1746 SelectDB "prod_info"
1747 Query "out_of_stock"
1751 The configuration above defines one query with one result and one database. The
1752 query is then linked to the database with the B<Query> option I<within> the
1753 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1754 and you can also use the B<Include> statement to split up the configuration
1755 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1756 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1759 The following is a complete list of options:
1761 =head3 B<Query> blocks
1763 Query blocks define I<SQL> statements and how the returned data should be
1764 interpreted. They are identified by the name that is given in the opening line
1765 of the block. Thus the name needs to be unique. Other than that, the name is
1766 not used in collectd.
1768 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1769 define which column holds which value or instance information. You can use
1770 multiple B<Result> blocks to create multiple values from one returned row. This
1771 is especially useful, when queries take a long time and sending almost the same
1772 query again and again is not desirable.
1776 <Query "environment">
1777 Statement "select station, temperature, humidity from environment"
1780 # InstancePrefix "foo"
1781 InstancesFrom "station"
1782 ValuesFrom "temperature"
1786 InstancesFrom "station"
1787 ValuesFrom "humidity"
1791 The following options are accepted:
1795 =item B<Statement> I<SQL>
1797 Sets the statement that should be executed on the server. This is B<not>
1798 interpreted by collectd, but simply passed to the database server. Therefore,
1799 the SQL dialect that's used depends on the server collectd is connected to.
1801 The query has to return at least two columns, one for the instance and one
1802 value. You cannot omit the instance, even if the statement is guaranteed to
1803 always return exactly one line. In that case, you can usually specify something
1806 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1808 (That works with MySQL but may not be valid SQL according to the spec. If you
1809 use a more strict database server, you may have to select from a dummy table or
1812 Please note that some databases, for example B<Oracle>, will fail if you
1813 include a semicolon at the end of the statement.
1815 =item B<MinVersion> I<Version>
1817 =item B<MaxVersion> I<Value>
1819 Only use this query for the specified database version. You can use these
1820 options to provide multiple queries with the same name but with a slightly
1821 different syntax. The plugin will use only those queries, where the specified
1822 minimum and maximum versions fit the version of the database in use.
1824 The database version is determined by C<dbi_conn_get_engine_version>, see the
1825 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1826 for details. Basically, each part of the version is assumed to be in the range
1827 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1828 "40102", version "5.0.42" becomes "50042".
1830 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1831 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1832 happen. Don't to it! A valid example would be something along these lines:
1843 In the above example, there are three ranges that don't overlap. The last one
1844 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1845 before "4.0.0" are not specified.
1847 =item B<Type> I<Type>
1849 The B<type> that's used for each line returned. See L<types.db(5)> for more
1850 details on how types are defined. In short: A type is a predefined layout of
1851 data and the number of values and type of values has to match the type
1854 If you specify "temperature" here, you need exactly one gauge column. If you
1855 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1858 There must be exactly one B<Type> option inside each B<Result> block.
1860 =item B<InstancePrefix> I<prefix>
1862 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1863 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1864 all strings returned in the appropriate columns are concatenated together,
1865 separated by dashes I<("-")>.
1867 =item B<InstancesFrom> I<column0> [I<column1> ...]
1869 Specifies the columns whose values will be used to create the "type-instance"
1870 for each row. If you specify more than one column, the value of all columns
1871 will be joined together with dashes I<("-")> as separation characters.
1873 The plugin itself does not check whether or not all built instances are
1874 different. It's your responsibility to assure that each is unique. This is
1875 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1876 sure that only one row is returned in this case.
1878 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1881 =item B<ValuesFrom> I<column0> [I<column1> ...]
1883 Names the columns whose content is used as the actual data for the data sets
1884 that are dispatched to the daemon. How many such columns you need is determined
1885 by the B<Type> setting above. If you specify too many or not enough columns,
1886 the plugin will complain about that and no data will be submitted to the
1889 The actual data type in the columns is not that important. The plugin will
1890 automatically cast the values to the right type if it know how to do that. So
1891 it should be able to handle integer an floating point types, as well as strings
1892 (if they include a number at the beginning).
1894 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1896 =item B<MetadataFrom> [I<column0> I<column1> ...]
1898 Names the columns whose content is used as metadata for the data sets
1899 that are dispatched to the daemon.
1901 The actual data type in the columns is not that important. The plugin will
1902 automatically cast the values to the right type if it know how to do that. So
1903 it should be able to handle integer an floating point types, as well as strings
1904 (if they include a number at the beginning).
1908 =head3 B<Database> blocks
1910 Database blocks define a connection to a database and which queries should be
1911 sent to that database. Since the used "dbi" library can handle a wide variety
1912 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1913 documentationE<nbsp>- we stick as close to the terminology used there.
1915 Each database needs a "name" as string argument in the starting tag of the
1916 block. This name will be used as "PluginInstance" in the values submitted to
1917 the daemon. Other than that, that name is not used.
1921 =item B<Driver> I<Driver>
1923 Specifies the driver to use to connect to the database. In many cases those
1924 drivers are named after the database they can connect to, but this is not a
1925 technical necessity. These drivers are sometimes referred to as "DBD",
1926 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1927 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1928 project at L<http://libdbi-drivers.sourceforge.net/>.
1930 You need to give the driver name as expected by the "dbi" library here. You
1931 should be able to find that in the documentation for each driver. If you
1932 mistype the driver name, the plugin will dump a list of all known driver names
1935 =item B<DriverOption> I<Key> I<Value>
1937 Sets driver-specific options. What option a driver supports can be found in the
1938 documentation for each driver, somewhere at
1939 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1940 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1942 DBDs can register two types of options: String options and numeric options. The
1943 plugin will use the C<dbi_conn_set_option> function when the configuration
1944 provides a string and the C<dbi_conn_require_option_numeric> function when the
1945 configuration provides a number. So these two lines will actually result in
1946 different calls being used:
1948 DriverOption "Port" 1234 # numeric
1949 DriverOption "Port" "1234" # string
1951 Unfortunately, drivers are not too keen to report errors when an unknown option
1952 is passed to them, so invalid settings here may go unnoticed. This is not the
1953 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1954 the driver. If a driver complains about an option, the plugin will dump a
1955 complete list of all options understood by that driver to the log. There is no
1956 way to programatically find out if an option expects a string or a numeric
1957 argument, so you will have to refer to the appropriate DBD's documentation to
1958 find this out. Sorry.
1960 =item B<SelectDB> I<Database>
1962 In some cases, the database name you connect with is not the database name you
1963 want to use for querying data. If this option is set, the plugin will "select"
1964 (switch to) that database after the connection is established.
1966 =item B<Query> I<QueryName>
1968 Associates the query named I<QueryName> with this database connection. The
1969 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1970 blocks you want to refer to must be placed above the database block you want to
1973 =item B<Host> I<Hostname>
1975 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1976 values. Defaults to the global hostname setting.
1984 =item B<Device> I<Device>
1986 Select partitions based on the devicename.
1988 =item B<MountPoint> I<Directory>
1990 Select partitions based on the mountpoint.
1992 =item B<FSType> I<FSType>
1994 Select partitions based on the filesystem type.
1996 =item B<IgnoreSelected> B<true>|B<false>
1998 Invert the selection: If set to true, all partitions B<except> the ones that
1999 match any one of the criteria are collected. By default only selected
2000 partitions are collected if a selection is made. If no selection is configured
2001 at all, B<all> partitions are selected.
2003 =item B<ReportByDevice> B<true>|B<false>
2005 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2006 (the default), it will report a disk as "root", but with it I<true>, it will be
2007 "sda1" (or whichever).
2009 =item B<ReportInodes> B<true>|B<false>
2011 Enables or disables reporting of free, reserved and used inodes. Defaults to
2012 inode collection being disabled.
2014 Enable this option if inodes are a scarce resource for you, usually because
2015 many small files are stored on the disk. This is a usual scenario for mail
2016 transfer agents and web caches.
2018 =item B<ValuesAbsolute> B<true>|B<false>
2020 Enables or disables reporting of free and used disk space in 1K-blocks.
2021 Defaults to B<true>.
2023 =item B<ValuesPercentage> B<false>|B<true>
2025 Enables or disables reporting of free and used disk space in percentage.
2026 Defaults to B<false>.
2028 This is useful for deploying I<collectd> on the cloud, where machines with
2029 different disk size may exist. Then it is more practical to configure
2030 thresholds based on relative disk size.
2034 =head2 Plugin C<disk>
2036 The C<disk> plugin collects information about the usage of physical disks and
2037 logical disks (partitions). Values collected are the number of octets written
2038 to and read from a disk or partition, the number of read/write operations
2039 issued to the disk and a rather complex "time" it took for these commands to be
2042 Using the following two options you can ignore some disks or configure the
2043 collection only of specific disks.
2047 =item B<Disk> I<Name>
2049 Select the disk I<Name>. Whether it is collected or ignored depends on the
2050 B<IgnoreSelected> setting, see below. As with other plugins that use the
2051 daemon's ignorelist functionality, a string that starts and ends with a slash
2052 is interpreted as a regular expression. Examples:
2057 =item B<IgnoreSelected> B<true>|B<false>
2059 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2060 statements, are ignored or if all other disks are ignored. The behavior
2061 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2062 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2063 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2064 is set to B<true>, all disks are collected B<except> the ones matched.
2066 =item B<UseBSDName> B<true>|B<false>
2068 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2069 default major/minor numbers. Requires collectd to be built with Apple's
2072 =item B<UdevNameAttr> I<Attribute>
2074 Attempt to override disk instance name with the value of a specified udev
2075 attribute when built with B<libudev>. If the attribute is not defined for the
2076 given device, the default name is used. Example:
2078 UdevNameAttr "DM_NAME"
2082 =head2 Plugin C<dns>
2086 =item B<Interface> I<Interface>
2088 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2089 option sets the interface that should be used. If this option is not set, or
2090 set to "any", the plugin will try to get packets from B<all> interfaces. This
2091 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2093 =item B<IgnoreSource> I<IP-address>
2095 Ignore packets that originate from this address.
2097 =item B<SelectNumericQueryTypes> B<true>|B<false>
2099 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2103 =head2 Plugin C<email>
2107 =item B<SocketFile> I<Path>
2109 Sets the socket-file which is to be created.
2111 =item B<SocketGroup> I<Group>
2113 If running as root change the group of the UNIX-socket after it has been
2114 created. Defaults to B<collectd>.
2116 =item B<SocketPerms> I<Permissions>
2118 Change the file permissions of the UNIX-socket after it has been created. The
2119 permissions must be given as a numeric, octal value as you would pass to
2120 L<chmod(1)>. Defaults to B<0770>.
2122 =item B<MaxConns> I<Number>
2124 Sets the maximum number of connections that can be handled in parallel. Since
2125 this many threads will be started immediately setting this to a very high
2126 value will waste valuable resources. Defaults to B<5> and will be forced to be
2127 at most B<16384> to prevent typos and dumb mistakes.
2131 =head2 Plugin C<ethstat>
2133 The I<ethstat plugin> collects information about network interface cards (NICs)
2134 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2140 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2141 Map "multicast" "if_multicast"
2148 =item B<Interface> I<Name>
2150 Collect statistical information about interface I<Name>.
2152 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2154 By default, the plugin will submit values as type C<derive> and I<type
2155 instance> set to I<Name>, the name of the metric as reported by the driver. If
2156 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2157 I<TypeInstance> will be used.
2159 =item B<MappedOnly> B<true>|B<false>
2161 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2162 collected, all other metrics will be ignored. Defaults to B<false>.
2166 =head2 Plugin C<exec>
2168 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2169 contains valuable information on when the executable is executed and the
2170 output that is expected from it.
2174 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2176 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2178 Execute the executable I<Executable> as user I<User>. If the user name is
2179 followed by a colon and a group name, the effective group is set to that group.
2180 The real group and saved-set group will be set to the default group of that
2181 user. If no group is given the effective group ID will be the same as the real
2184 Please note that in order to change the user and/or group the daemon needs
2185 superuser privileges. If the daemon is run as an unprivileged user you must
2186 specify the same user/group here. If the daemon is run with superuser
2187 privileges, you must supply a non-root user here.
2189 The executable may be followed by optional arguments that are passed to the
2190 program. Please note that due to the configuration parsing numbers and boolean
2191 values may be changed. If you want to be absolutely sure that something is
2192 passed as-is please enclose it in quotes.
2194 The B<Exec> and B<NotificationExec> statements change the semantics of the
2195 programs executed, i.E<nbsp>e. the data passed to them and the response
2196 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2200 =head2 Plugin C<filecount>
2202 The C<filecount> plugin counts the number of files in a certain directory (and
2203 its subdirectories) and their combined size. The configuration is very straight
2206 <Plugin "filecount">
2207 <Directory "/var/qmail/queue/mess">
2208 Instance "qmail-message"
2210 <Directory "/var/qmail/queue/todo">
2211 Instance "qmail-todo"
2213 <Directory "/var/lib/php5">
2214 Instance "php5-sessions"
2219 The example above counts the number of files in QMail's queue directories and
2220 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2221 QMail has not yet looked at, the "message" queue holds the messages that were
2222 classified into "local" and "remote".
2224 As you can see, the configuration consists of one or more C<Directory> blocks,
2225 each of which specifies a directory in which to count the files. Within those
2226 blocks, the following options are recognized:
2230 =item B<Instance> I<Instance>
2232 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2233 it's your responsibility, the plugin doesn't check for that. If not given, the
2234 instance is set to the directory name with all slashes replaced by underscores
2235 and all leading underscores removed.
2237 =item B<Name> I<Pattern>
2239 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2240 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2241 against the pattern, not the entire path. In case this makes it easier for you:
2242 This option has been named after the B<-name> parameter to L<find(1)>.
2244 =item B<MTime> I<Age>
2246 Count only files of a specific age: If I<Age> is greater than zero, only files
2247 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2248 a negative number, this is inversed. For example, if B<-60> is specified, only
2249 files that have been modified in the last minute will be counted.
2251 The number can also be followed by a "multiplier" to easily specify a larger
2252 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2253 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2254 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2255 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2256 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2259 =item B<Size> I<Size>
2261 Count only files of a specific size. When I<Size> is a positive number, only
2262 files that are at least this big are counted. If I<Size> is a negative number,
2263 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2264 I<Size> are counted.
2266 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2267 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2268 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2269 note that there are 1000 bytes in a kilobyte, not 1024.
2271 =item B<Recursive> I<true>|I<false>
2273 Controls whether or not to recurse into subdirectories. Enabled by default.
2275 =item B<IncludeHidden> I<true>|I<false>
2277 Controls whether or not to include "hidden" files and directories in the count.
2278 "Hidden" files and directories are those, whose name begins with a dot.
2279 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2283 =head2 Plugin C<GenericJMX>
2285 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2286 L<collectd-java(5)>.
2288 =head2 Plugin C<gmond>
2290 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2291 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2292 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2297 MCReceiveFrom "239.2.11.71" "8649"
2298 <Metric "swap_total">
2300 TypeInstance "total"
2303 <Metric "swap_free">
2310 The following metrics are built-in:
2316 load_one, load_five, load_fifteen
2320 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2324 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2336 Available configuration options:
2340 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2342 Sets sets the multicast group and UDP port to which to subscribe.
2344 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2346 =item E<lt>B<Metric> I<Name>E<gt>
2348 These blocks add a new metric conversion to the internal table. I<Name>, the
2349 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2353 =item B<Type> I<Type>
2355 Type to map this metric to. Required.
2357 =item B<TypeInstance> I<Instance>
2359 Type-instance to use. Optional.
2361 =item B<DataSource> I<Name>
2363 Data source to map this metric to. If the configured type has exactly one data
2364 source, this is optional. Otherwise the option is required.
2370 =head2 Plugin C<hddtemp>
2372 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2373 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2374 default values, see below. C<hddtemp> has to be running to work correctly. If
2375 C<hddtemp> is not running timeouts may appear which may interfere with other
2378 The B<hddtemp> homepage can be found at
2379 L<http://www.guzu.net/linux/hddtemp.php>.
2383 =item B<Host> I<Hostname>
2385 Hostname to connect to. Defaults to B<127.0.0.1>.
2387 =item B<Port> I<Port>
2389 TCP-Port to connect to. Defaults to B<7634>.
2393 =head2 Plugin C<interface>
2397 =item B<Interface> I<Interface>
2399 Select this interface. By default these interfaces will then be collected. For
2400 a more detailed description see B<IgnoreSelected> below.
2402 =item B<IgnoreSelected> I<true>|I<false>
2404 If no configuration if given, the B<traffic>-plugin will collect data from
2405 all interfaces. This may not be practical, especially for loopback- and
2406 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2407 interfaces you're interested in. Sometimes, however, it's easier/preferred
2408 to collect all interfaces I<except> a few ones. This option enables you to
2409 do that: By setting B<IgnoreSelected> to I<true> the effect of
2410 B<Interface> is inverted: All selected interfaces are ignored and all
2411 other interfaces are collected.
2415 =head2 Plugin C<ipmi>
2419 =item B<Sensor> I<Sensor>
2421 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2423 =item B<IgnoreSelected> I<true>|I<false>
2425 If no configuration if given, the B<ipmi> plugin will collect data from all
2426 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2427 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2428 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2429 all other sensors are collected.
2431 =item B<NotifySensorAdd> I<true>|I<false>
2433 If a sensor appears after initialization time of a minute a notification
2436 =item B<NotifySensorRemove> I<true>|I<false>
2438 If a sensor disappears a notification is sent.
2440 =item B<NotifySensorNotPresent> I<true>|I<false>
2442 If you have for example dual power supply and one of them is (un)plugged then
2443 a notification is sent.
2447 =head2 Plugin C<iptables>
2451 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2453 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2454 will collect the counters of all rules which have a comment-match. The comment
2455 is then used as type-instance.
2457 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2458 the I<n>th rule will be collected. Again, the comment (or the number) will be
2459 used as the type-instance.
2461 If I<Name> is supplied, it will be used as the type-instance instead of the
2462 comment or the number.
2466 =head2 Plugin C<irq>
2472 Select this irq. By default these irqs will then be collected. For a more
2473 detailed description see B<IgnoreSelected> below.
2475 =item B<IgnoreSelected> I<true>|I<false>
2477 If no configuration if given, the B<irq>-plugin will collect data from all
2478 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2479 can use the B<Irq>-option to pick the interrupt you're interested in.
2480 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2481 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2482 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2483 and all other interrupts are collected.
2487 =head2 Plugin C<java>
2489 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2490 This section only discusses the syntax and semantic of the configuration
2491 options. For more in-depth information on the I<Java> plugin, please read
2492 L<collectd-java(5)>.
2497 JVMArg "-verbose:jni"
2498 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2499 LoadPlugin "org.collectd.java.Foobar"
2500 <Plugin "org.collectd.java.Foobar">
2501 # To be parsed by the plugin
2505 Available configuration options:
2509 =item B<JVMArg> I<Argument>
2511 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2512 exactly the way the arguments to the I<java> binary on the command line work.
2513 Execute C<javaE<nbsp>--help> for details.
2515 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2516 any other options! When another option is found, the JVM will be started and
2517 later options will have to be ignored!
2519 =item B<LoadPlugin> I<JavaClass>
2521 Instantiates a new I<JavaClass> object. The constructor of this object very
2522 likely then registers one or more callback methods with the server.
2524 See L<collectd-java(5)> for details.
2526 When the first such option is found, the virtual machine (JVM) is created. This
2527 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2528 B<LoadPlugin> options!
2530 =item B<Plugin> I<Name>
2532 The entire block is passed to the Java plugin as an
2533 I<org.collectd.api.OConfigItem> object.
2535 For this to work, the plugin has to register a configuration callback first,
2536 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2537 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2538 depends on the (Java) plugin registering the callback and is completely
2539 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2543 =head2 Plugin C<load>
2545 The I<Load plugin> collects the system load. These numbers give a rough overview
2546 over the utilization of a machine. The system load is defined as the number of
2547 runnable tasks in the run-queue and is provided by many operating systems as a
2548 one, five or fifteen minute average.
2550 The following configuration options are available:
2554 =item B<ReportRelative> B<false>|B<true>
2556 When enabled, system load divided by number of available CPU cores is reported
2557 for intervals 1 min, 5 min and 15 min. Defaults to false.
2562 =head2 Plugin C<logfile>
2566 =item B<LogLevel> B<debug|info|notice|warning|err>
2568 Sets the log-level. If, for example, set to B<notice>, then all events with
2569 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2571 Please note that B<debug> is only available if collectd has been compiled with
2574 =item B<File> I<File>
2576 Sets the file to write log messages to. The special strings B<stdout> and
2577 B<stderr> can be used to write to the standard output and standard error
2578 channels, respectively. This, of course, only makes much sense when I<collectd>
2579 is running in foreground- or non-daemon-mode.
2581 =item B<Timestamp> B<true>|B<false>
2583 Prefix all lines printed by the current time. Defaults to B<true>.
2585 =item B<PrintSeverity> B<true>|B<false>
2587 When enabled, all lines are prefixed by the severity of the log message, for
2588 example "warning". Defaults to B<false>.
2592 B<Note>: There is no need to notify the daemon after moving or removing the
2593 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2594 for each line it writes.
2596 =head2 Plugin C<log_logstash>
2598 The I<log logstash plugin> behaves like the logfile plugin but formats
2599 messages as JSON events for logstash to parse and input.
2603 =item B<LogLevel> B<debug|info|notice|warning|err>
2605 Sets the log-level. If, for example, set to B<notice>, then all events with
2606 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2608 Please note that B<debug> is only available if collectd has been compiled with
2611 =item B<File> I<File>
2613 Sets the file to write log messages to. The special strings B<stdout> and
2614 B<stderr> can be used to write to the standard output and standard error
2615 channels, respectively. This, of course, only makes much sense when I<collectd>
2616 is running in foreground- or non-daemon-mode.
2620 B<Note>: There is no need to notify the daemon after moving or removing the
2621 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2622 for each line it writes.
2624 =head2 Plugin C<lpar>
2626 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2627 virtualization technique for IBM POWER processors. It takes into account CPU
2628 time stolen from or donated to a partition, in addition to the usual user,
2629 system, I/O statistics.
2631 The following configuration options are available:
2635 =item B<CpuPoolStats> B<false>|B<true>
2637 When enabled, statistics about the processor pool are read, too. The partition
2638 needs to have pool authority in order to be able to acquire this information.
2641 =item B<ReportBySerial> B<false>|B<true>
2643 If enabled, the serial of the physical machine the partition is currently
2644 running on is reported as I<hostname> and the logical hostname of the machine
2645 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2646 used (just like other plugins) and the I<plugin instance> will be empty.
2651 =head2 Plugin C<mbmon>
2653 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2655 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2656 B<Host> and B<Port> options can be used to change these values, see below.
2657 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2658 timeouts may appear which may interfere with other statistics..
2660 C<mbmon> must be run with the -r option ("print TAG and Value format");
2661 Debian's F</etc/init.d/mbmon> script already does this, other people
2662 will need to ensure that this is the case.
2666 =item B<Host> I<Hostname>
2668 Hostname to connect to. Defaults to B<127.0.0.1>.
2670 =item B<Port> I<Port>
2672 TCP-Port to connect to. Defaults to B<411>.
2678 The C<md plugin> collects information from Linux Software-RAID devices (md).
2680 All reported values are of the type C<md_disks>. Reported type instances are
2681 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2682 I<missing> (physically absent) disks.
2686 =item B<Device> I<Device>
2688 Select md devices based on device name. The I<device name> is the basename of
2689 the device, i.e. the name of the block device without the leading C</dev/>.
2690 See B<IgnoreSelected> for more details.
2692 =item B<IgnoreSelected> B<true>|B<false>
2694 Invert device selection: If set to B<true>, all md devices B<except> those
2695 listed using B<Device> are collected. If B<false> (the default), only those
2696 listed are collected. If no configuration is given, the B<md> plugin will
2697 collect data from all md devices.
2701 =head2 Plugin C<memcachec>
2703 The C<memcachec plugin> connects to a memcached server, queries one or more
2704 given I<pages> and parses the returned data according to user specification.
2705 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2708 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2709 library. Please note that there is another library with a very similar name,
2710 libmemcache (notice the missing `d'), which is not applicable.
2712 Synopsis of the configuration:
2714 <Plugin "memcachec">
2715 <Page "plugin_instance">
2719 Regex "(\\d+) bytes sent"
2722 Instance "type_instance"
2727 The configuration options are:
2731 =item E<lt>B<Page> I<Name>E<gt>
2733 Each B<Page> block defines one I<page> to be queried from the memcached server.
2734 The block requires one string argument which is used as I<plugin instance>.
2736 =item B<Server> I<Address>
2738 Sets the server address to connect to when querying the page. Must be inside a
2743 When connected to the memcached server, asks for the page I<Key>.
2745 =item E<lt>B<Match>E<gt>
2747 Match blocks define which strings to look for and how matches substrings are
2748 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2752 =head2 Plugin C<memcached>
2754 The B<memcached plugin> connects to a memcached server and queries statistics
2755 about cache utilization, memory and bandwidth used.
2756 L<http://www.danga.com/memcached/>
2758 <Plugin "memcached">
2760 Host "memcache.example.com"
2765 The plugin configuration consists of one or more B<Instance> blocks which
2766 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2767 following options are allowed:
2771 =item B<Host> I<Hostname>
2773 Hostname to connect to. Defaults to B<127.0.0.1>.
2775 =item B<Port> I<Port>
2777 TCP-Port to connect to. Defaults to B<11211>.
2779 =item B<Socket> I<Path>
2781 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2782 setting is given, the B<Host> and B<Port> settings are ignored.
2786 =head2 Plugin C<mic>
2788 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2789 Intel's Many Integrated Core (MIC) systems.
2798 ShowTemperatures true
2801 IgnoreSelectedTemperature true
2806 IgnoreSelectedPower true
2809 The following options are valid inside the B<PluginE<nbsp>mic> block:
2813 =item B<ShowCPU> B<true>|B<false>
2815 If enabled (the default) a sum of the CPU usage across all cores is reported.
2817 =item B<ShowCPUCores> B<true>|B<false>
2819 If enabled (the default) per-core CPU usage is reported.
2821 =item B<ShowMemory> B<true>|B<false>
2823 If enabled (the default) the physical memory usage of the MIC system is
2826 =item B<ShowTemperatures> B<true>|B<false>
2828 If enabled (the default) various temperatures of the MIC system are reported.
2830 =item B<Temperature> I<Name>
2832 This option controls which temperatures are being reported. Whether matching
2833 temperatures are being ignored or I<only> matching temperatures are reported
2834 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2835 temperatures are reported.
2837 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2839 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2840 (the default) only temperatures matching a B<Temperature> option are reported
2841 or, if no B<Temperature> option is specified, all temperatures are reported. If
2842 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2845 Known temperature names are:
2879 =item B<ShowPower> B<true>|B<false>
2881 If enabled (the default) various temperatures of the MIC system are reported.
2883 =item B<Power> I<Name>
2885 This option controls which power readings are being reported. Whether matching
2886 power readings are being ignored or I<only> matching power readings are reported
2887 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2888 power readings are reported.
2890 =item B<IgnoreSelectedPower> B<false>|B<true>
2892 Controls the behavior of the B<Power> setting above. If set to B<false>
2893 (the default) only power readings matching a B<Power> option are reported
2894 or, if no B<Power> option is specified, all power readings are reported. If
2895 set to B<true>, matching power readings are I<ignored> and all other power readings
2898 Known power names are:
2904 Total power utilization averaged over Time Window 0 (uWatts).
2908 Total power utilization averaged over Time Window 0 (uWatts).
2912 Instantaneous power (uWatts).
2916 Max instantaneous power (uWatts).
2920 PCI-E connector power (uWatts).
2924 2x3 connector power (uWatts).
2928 2x4 connector power (uWatts).
2936 Uncore rail (uVolts).
2940 Memory subsystem rail (uVolts).
2946 =head2 Plugin C<memory>
2948 The I<memory plugin> provides the following configuration options:
2952 =item B<ValuesAbsolute> B<true>|B<false>
2954 Enables or disables reporting of physical memory usage in absolute numbers,
2955 i.e. bytes. Defaults to B<true>.
2957 =item B<ValuesPercentage> B<false>|B<true>
2959 Enables or disables reporting of physical memory usage in percentages, e.g.
2960 percent of physical memory used. Defaults to B<false>.
2962 This is useful for deploying I<collectd> in a heterogeneous environment in
2963 which the sizes of physical memory vary.
2967 =head2 Plugin C<modbus>
2969 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
2970 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
2971 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2972 values (two registers interpreted as IEEE floats in big endian notation).
2976 <Data "voltage-input-1">
2979 RegisterCmd ReadHolding
2984 <Data "voltage-input-2">
2987 RegisterCmd ReadHolding
2992 <Data "supply-temperature-1">
2995 RegisterCmd ReadHolding
3000 <Host "modbus.example.com">
3001 Address "192.168.0.42"
3006 Instance "power-supply"
3007 Collect "voltage-input-1"
3008 Collect "voltage-input-2"
3013 Device "/dev/ttyUSB0"
3018 Instance "temperature"
3019 Collect "supply-temperature-1"
3025 =item E<lt>B<Data> I<Name>E<gt> blocks
3027 Data blocks define a mapping between register numbers and the "types" used by
3030 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3034 =item B<RegisterBase> I<Number>
3036 Configures the base register to read from the device. If the option
3037 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3038 register will be read (the register number is increased by one).
3040 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3042 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3043 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3044 combined into one value. Defaults to B<Uint16>.
3046 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3048 Specifies register type to be collected from device. Works only with libmodbus
3049 2.9.2 or higher. Defaults to B<ReadHolding>.
3051 =item B<Type> I<Type>
3053 Specifies the "type" (data set) to use when dispatching the value to
3054 I<collectd>. Currently, only data sets with exactly one data source are
3057 =item B<Instance> I<Instance>
3059 Sets the type instance to use when dispatching the value to I<collectd>. If
3060 unset, an empty string (no type instance) is used.
3064 =item E<lt>B<Host> I<Name>E<gt> blocks
3066 Host blocks are used to specify to which hosts to connect and what data to read
3067 from their "slaves". The string argument I<Name> is used as hostname when
3068 dispatching the values to I<collectd>.
3070 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3074 =item B<Address> I<Hostname>
3076 For Modbus/TCP, specifies the node name (the actual network address) used to
3077 connect to the host. This may be an IP address or a hostname. Please note that
3078 the used I<libmodbus> library only supports IPv4 at the moment.
3080 =item B<Port> I<Service>
3082 for Modbus/TCP, specifies the port used to connect to the host. The port can
3083 either be given as a number or as a service name. Please note that the
3084 I<Service> argument must be a string, even if ports are given in their numerical
3085 form. Defaults to "502".
3087 =item B<Device> I<Devicenode>
3089 For Modbus/RTU, specifies the path to the serial device being used.
3091 =item B<Baudrate> I<Baudrate>
3093 For Modbus/RTU, specifies the baud rate of the serial device.
3094 Note, connections currently support only 8/N/1.
3096 =item B<Interval> I<Interval>
3098 Sets the interval (in seconds) in which the values will be collected from this
3099 host. By default the global B<Interval> setting will be used.
3101 =item E<lt>B<Slave> I<ID>E<gt>
3103 Over each connection, multiple Modbus devices may be reached. The slave ID
3104 is used to specify which device should be addressed. For each device you want
3105 to query, one B<Slave> block must be given.
3107 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3111 =item B<Instance> I<Instance>
3113 Specify the plugin instance to use when dispatching the values to I<collectd>.
3114 By default "slave_I<ID>" is used.
3116 =item B<Collect> I<DataName>
3118 Specifies which data to retrieve from the device. I<DataName> must be the same
3119 string as the I<Name> argument passed to a B<Data> block. You can specify this
3120 option multiple times to collect more than one value from a slave. At least one
3121 B<Collect> option is mandatory.
3129 =head2 Plugin C<mysql>
3131 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3132 one or more databases when started and keeps the connection up as long as
3133 possible. When the connection is interrupted for whatever reason it will try
3134 to re-connect. The plugin will complain loudly in case anything goes wrong.
3136 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3137 and collects information about MySQL network traffic, executed statements,
3138 requests, the query cache and threads by evaluating the
3139 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3140 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3141 Status Variables> for an explanation of these values.
3143 Optionally, master and slave statistics may be collected in a MySQL
3144 replication setup. In that case, information about the synchronization state
3145 of the nodes are collected by evaluating the C<Position> return value of the
3146 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3147 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3148 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3149 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3150 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3167 Socket "/var/run/mysql/mysqld.sock"
3169 SlaveNotifications true
3173 A B<Database> block defines one connection to a MySQL database. It accepts a
3174 single argument which specifies the name of the database. None of the other
3175 options are required. MySQL will use default values as documented in the
3176 section "mysql_real_connect()" in the B<MySQL reference manual>.
3180 =item B<Alias> I<Alias>
3182 Alias to use as sender instead of hostname when reporting. This may be useful
3183 when having cryptic hostnames.
3185 =item B<Host> I<Hostname>
3187 Hostname of the database server. Defaults to B<localhost>.
3189 =item B<User> I<Username>
3191 Username to use when connecting to the database. The user does not have to be
3192 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3193 unless you want to collectd replication statistics (see B<MasterStats> and
3194 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3195 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3197 =item B<Password> I<Password>
3199 Password needed to log into the database.
3201 =item B<Database> I<Database>
3203 Select this database. Defaults to I<no database> which is a perfectly reasonable
3204 option for what this plugin does.
3206 =item B<Port> I<Port>
3208 TCP-port to connect to. The port must be specified in its numeric form, but it
3209 must be passed as a string nonetheless. For example:
3213 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3214 See the documentation for the C<mysql_real_connect> function for details.
3216 =item B<Socket> I<Socket>
3218 Specifies the path to the UNIX domain socket of the MySQL server. This option
3219 only has any effect, if B<Host> is set to B<localhost> (the default).
3220 Otherwise, use the B<Port> option above. See the documentation for the
3221 C<mysql_real_connect> function for details.
3223 =item B<InnodbStats> I<true|false>
3225 If enabled, metrics about the InnoDB storage engine are collected.
3226 Disabled by default.
3228 =item B<MasterStats> I<true|false>
3230 =item B<SlaveStats> I<true|false>
3232 Enable the collection of master / slave statistics in a replication setup. In
3233 order to be able to get access to these statistics, the user needs special
3234 privileges. See the B<User> documentation above. Defaults to B<false>.
3236 =item B<SlaveNotifications> I<true|false>
3238 If enabled, the plugin sends a notification if the replication slave I/O and /
3239 or SQL threads are not running. Defaults to B<false>.
3241 =item B<ConnectTimeout> I<Seconds>
3243 Sets the connect timeout for the MySQL client.
3247 =head2 Plugin C<netapp>
3249 The netapp plugin can collect various performance and capacity information
3250 from a NetApp filer using the NetApp API.
3252 Please note that NetApp has a wide line of products and a lot of different
3253 software versions for each of these products. This plugin was developed for a
3254 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3255 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3256 model and software version but it is very hard to test this.
3257 If you have used this plugin with other models and/or software version, feel
3258 free to send us a mail to tell us about the results, even if it's just a short
3261 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3262 basic authentication.
3264 B<Do not use a regular user for this!> Create a special collectd user with just
3265 the minimum of capabilities needed. The user only needs the "login-http-admin"
3266 capability as well as a few more depending on which data will be collected.
3267 Required capabilities are documented below.
3272 <Host "netapp1.example.com">
3296 IgnoreSelectedIO false
3298 IgnoreSelectedOps false
3299 GetLatency "volume0"
3300 IgnoreSelectedLatency false
3307 IgnoreSelectedCapacity false
3310 IgnoreSelectedSnapshot false
3338 The netapp plugin accepts the following configuration options:
3342 =item B<Host> I<Name>
3344 A host block defines one NetApp filer. It will appear in collectd with the name
3345 you specify here which does not have to be its real name nor its hostname (see
3346 the B<Address> option below).
3348 =item B<VFiler> I<Name>
3350 A B<VFiler> block may only be used inside a host block. It accepts all the
3351 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3352 will execute all NetApp API commands in the context of the specified
3353 VFiler(R). It will appear in collectd with the name you specify here which
3354 does not have to be its real name. The VFiler name may be specified using the
3355 B<VFilerName> option. If this is not specified, it will default to the name
3358 The VFiler block inherits all connection related settings from the surrounding
3359 B<Host> block (which appear before the B<VFiler> block) but they may be
3360 overwritten inside the B<VFiler> block.
3362 This feature is useful, for example, when using a VFiler as SnapVault target
3363 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3364 available in the host filer (vfiler0) but only in the respective VFiler
3367 =item B<Protocol> B<httpd>|B<http>
3369 The protocol collectd will use to query this host.
3377 Valid options: http, https
3379 =item B<Address> I<Address>
3381 The hostname or IP address of the host.
3387 Default: The "host" block's name.
3389 =item B<Port> I<Port>
3391 The TCP port to connect to on the host.
3397 Default: 80 for protocol "http", 443 for protocol "https"
3399 =item B<User> I<User>
3401 =item B<Password> I<Password>
3403 The username and password to use to login to the NetApp.
3409 =item B<VFilerName> I<Name>
3411 The name of the VFiler in which context to execute API commands. If not
3412 specified, the name provided to the B<VFiler> block will be used instead.
3418 Default: name of the B<VFiler> block
3420 B<Note:> This option may only be used inside B<VFiler> blocks.
3422 =item B<Interval> I<Interval>
3428 The following options decide what kind of data will be collected. You can
3429 either use them as a block and fine tune various parameters inside this block,
3430 use them as a single statement to just accept all default values, or omit it to
3431 not collect any data.
3433 The following options are valid inside all blocks:
3437 =item B<Interval> I<Seconds>
3439 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3440 host specific setting.
3444 =head3 The System block
3446 This will collect various performance data about the whole system.
3448 B<Note:> To get this data the collectd user needs the
3449 "api-perf-object-get-instances" capability.
3453 =item B<Interval> I<Seconds>
3455 Collect disk statistics every I<Seconds> seconds.
3457 =item B<GetCPULoad> B<true>|B<false>
3459 If you set this option to true the current CPU usage will be read. This will be
3460 the average usage between all CPUs in your NetApp without any information about
3463 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3464 returns in the "CPU" field.
3472 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3474 =item B<GetInterfaces> B<true>|B<false>
3476 If you set this option to true the current traffic of the network interfaces
3477 will be read. This will be the total traffic over all interfaces of your NetApp
3478 without any information about individual interfaces.
3480 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3481 in the "Net kB/s" field.
3491 Result: One value list of type "if_octects".
3493 =item B<GetDiskIO> B<true>|B<false>
3495 If you set this option to true the current IO throughput will be read. This
3496 will be the total IO of your NetApp without any information about individual
3497 disks, volumes or aggregates.
3499 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3500 in the "DiskE<nbsp>kB/s" field.
3508 Result: One value list of type "disk_octets".
3510 =item B<GetDiskOps> B<true>|B<false>
3512 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3513 iSCSI, etc. operations will be read. This will be the total number of
3514 operations on your NetApp without any information about individual volumes or
3517 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3518 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3526 Result: A variable number of value lists of type "disk_ops_complex". Each type
3527 of operation will result in one value list with the name of the operation as
3532 =head3 The WAFL block
3534 This will collect various performance data about the WAFL file system. At the
3535 moment this just means cache performance.
3537 B<Note:> To get this data the collectd user needs the
3538 "api-perf-object-get-instances" capability.
3540 B<Note:> The interface to get these values is classified as "Diagnostics" by
3541 NetApp. This means that it is not guaranteed to be stable even between minor
3546 =item B<Interval> I<Seconds>
3548 Collect disk statistics every I<Seconds> seconds.
3550 =item B<GetNameCache> B<true>|B<false>
3558 Result: One value list of type "cache_ratio" and type instance
3561 =item B<GetDirCache> B<true>|B<false>
3569 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3571 =item B<GetInodeCache> B<true>|B<false>
3579 Result: One value list of type "cache_ratio" and type instance
3582 =item B<GetBufferCache> B<true>|B<false>
3584 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3585 in the "Cache hit" field.
3593 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3597 =head3 The Disks block
3599 This will collect performance data about the individual disks in the NetApp.
3601 B<Note:> To get this data the collectd user needs the
3602 "api-perf-object-get-instances" capability.
3606 =item B<Interval> I<Seconds>
3608 Collect disk statistics every I<Seconds> seconds.
3610 =item B<GetBusy> B<true>|B<false>
3612 If you set this option to true the busy time of all disks will be calculated
3613 and the value of the busiest disk in the system will be written.
3615 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3616 in the "Disk util" field. Probably.
3624 Result: One value list of type "percent" and type instance "disk_busy".
3628 =head3 The VolumePerf block
3630 This will collect various performance data about the individual volumes.
3632 You can select which data to collect about which volume using the following
3633 options. They follow the standard ignorelist semantic.
3635 B<Note:> To get this data the collectd user needs the
3636 I<api-perf-object-get-instances> capability.
3640 =item B<Interval> I<Seconds>
3642 Collect volume performance data every I<Seconds> seconds.
3644 =item B<GetIO> I<Volume>
3646 =item B<GetOps> I<Volume>
3648 =item B<GetLatency> I<Volume>
3650 Select the given volume for IO, operations or latency statistics collection.
3651 The argument is the name of the volume without the C</vol/> prefix.
3653 Since the standard ignorelist functionality is used here, you can use a string
3654 starting and ending with a slash to specify regular expression matching: To
3655 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3658 GetIO "/^vol[027]$/"
3660 If no regular expression is specified, an exact match is required. Both,
3661 regular and exact matching are case sensitive.
3663 If no volume was specified at all for either of the three options, that data
3664 will be collected for all available volumes.
3666 =item B<IgnoreSelectedIO> B<true>|B<false>
3668 =item B<IgnoreSelectedOps> B<true>|B<false>
3670 =item B<IgnoreSelectedLatency> B<true>|B<false>
3672 When set to B<true>, the volumes selected for IO, operations or latency
3673 statistics collection will be ignored and the data will be collected for all
3676 When set to B<false>, data will only be collected for the specified volumes and
3677 all other volumes will be ignored.
3679 If no volumes have been specified with the above B<Get*> options, all volumes
3680 will be collected regardless of the B<IgnoreSelected*> option.
3682 Defaults to B<false>
3686 =head3 The VolumeUsage block
3688 This will collect capacity data about the individual volumes.
3690 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3695 =item B<Interval> I<Seconds>
3697 Collect volume usage statistics every I<Seconds> seconds.
3699 =item B<GetCapacity> I<VolumeName>
3701 The current capacity of the volume will be collected. This will result in two
3702 to four value lists, depending on the configuration of the volume. All data
3703 sources are of type "df_complex" with the name of the volume as
3706 There will be type_instances "used" and "free" for the number of used and
3707 available bytes on the volume. If the volume has some space reserved for
3708 snapshots, a type_instance "snap_reserved" will be available. If the volume
3709 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3710 number of bytes saved by the SIS feature.
3712 B<Note:> The current NetApp API has a bug that results in this value being
3713 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3714 number which works most of the time. If you see strange values here, bug
3715 NetApp support to fix this.
3717 Repeat this option to specify multiple volumes.
3719 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3721 Specify whether to collect only the volumes selected by the B<GetCapacity>
3722 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3723 B<false>. However, if no B<GetCapacity> option is specified at all, all
3724 capacities will be selected anyway.
3726 =item B<GetSnapshot> I<VolumeName>
3728 Select volumes from which to collect snapshot information.
3730 Usually, the space used for snapshots is included in the space reported as
3731 "used". If snapshot information is collected as well, the space used for
3732 snapshots is subtracted from the used space.
3734 To make things even more interesting, it is possible to reserve space to be
3735 used for snapshots. If the space required for snapshots is less than that
3736 reserved space, there is "reserved free" and "reserved used" space in addition
3737 to "free" and "used". If the space required for snapshots exceeds the reserved
3738 space, that part allocated in the normal space is subtracted from the "used"
3741 Repeat this option to specify multiple volumes.
3743 =item B<IgnoreSelectedSnapshot>
3745 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3746 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3747 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3748 capacities will be selected anyway.
3752 =head3 The Quota block
3754 This will collect (tree) quota statistics (used disk space and number of used
3755 files). This mechanism is useful to get usage information for single qtrees.
3756 In case the quotas are not used for any other purpose, an entry similar to the
3757 following in C</etc/quotas> would be sufficient:
3759 /vol/volA/some_qtree tree - - - - -
3761 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3765 =item B<Interval> I<Seconds>
3767 Collect SnapVault(R) statistics every I<Seconds> seconds.
3771 =head3 The SnapVault block
3773 This will collect statistics about the time and traffic of SnapVault(R)
3778 =item B<Interval> I<Seconds>
3780 Collect SnapVault(R) statistics every I<Seconds> seconds.
3784 =head2 Plugin C<netlink>
3786 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3787 statistics of various interface and routing aspects.
3791 =item B<Interface> I<Interface>
3793 =item B<VerboseInterface> I<Interface>
3795 Instruct the plugin to collect interface statistics. This is basically the same
3796 as the statistics provided by the C<interface> plugin (see above) but
3797 potentially much more detailed.
3799 When configuring with B<Interface> only the basic statistics will be collected,
3800 namely octets, packets, and errors. These statistics are collected by
3801 the C<interface> plugin, too, so using both at the same time is no benefit.
3803 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3804 so that no data needs to be collected twice if you use the C<interface> plugin.
3805 This includes dropped packets, received multicast packets, collisions and a
3806 whole zoo of differentiated RX and TX errors. You can try the following command
3807 to get an idea of what awaits you:
3811 If I<Interface> is B<All>, all interfaces will be selected.
3813 =item B<QDisc> I<Interface> [I<QDisc>]
3815 =item B<Class> I<Interface> [I<Class>]
3817 =item B<Filter> I<Interface> [I<Filter>]
3819 Collect the octets and packets that pass a certain qdisc, class or filter.
3821 QDiscs and classes are identified by their type and handle (or classid).
3822 Filters don't necessarily have a handle, therefore the parent's handle is used.
3823 The notation used in collectd differs from that used in tc(1) in that it
3824 doesn't skip the major or minor number if it's zero and doesn't print special
3825 ids by their name. So, for example, a qdisc may be identified by
3826 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3827 thus not displayed by tc(1).
3829 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3830 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3831 associated with that interface will be collected.
3833 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3834 used. This may lead to problems when more than one filter is attached to a
3835 qdisc or class. This isn't nice, but we don't know how this could be done any
3836 better. If you have a idea, please don't hesitate to tell us.
3838 As with the B<Interface> option you can specify B<All> as the interface,
3839 meaning all interfaces.
3841 Here are some examples to help you understand the above text more easily:
3844 VerboseInterface "All"
3845 QDisc "eth0" "pfifo_fast-1:0"
3847 Class "ppp0" "htb-1:10"
3848 Filter "ppp0" "u32-1:0"
3851 =item B<IgnoreSelected>
3853 The behavior is the same as with all other similar plugins: If nothing is
3854 selected at all, everything is collected. If some things are selected using the
3855 options described above, only these statistics are collected. If you set
3856 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3857 specified statistics will not be collected.
3861 =head2 Plugin C<network>
3863 The Network plugin sends data to a remote instance of collectd, receives data
3864 from a remote instance, or both at the same time. Data which has been received
3865 from the network is usually not transmitted again, but this can be activated, see
3866 the B<Forward> option below.
3868 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3869 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3871 Both, B<Server> and B<Listen> can be used as single option or as block. When
3872 used as block, given options are valid for this socket only. The following
3873 example will export the metrics twice: Once to an "internal" server (without
3874 encryption and signing) and one to an external server (with cryptographic
3878 # Export to an internal server
3879 # (demonstrates usage without additional options)
3880 Server "collectd.internal.tld"
3882 # Export to an external server
3883 # (demonstrates usage with signature options)
3884 <Server "collectd.external.tld">
3885 SecurityLevel "sign"
3886 Username "myhostname"
3893 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3895 The B<Server> statement/block sets the server to send datagrams to. The
3896 statement may occur multiple times to send each datagram to multiple
3899 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3900 optional second argument specifies a port number or a service name. If not
3901 given, the default, B<25826>, is used.
3903 The following options are recognized within B<Server> blocks:
3907 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3909 Set the security you require for network communication. When the security level
3910 has been set to B<Encrypt>, data sent over the network will be encrypted using
3911 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3912 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3913 authentication code. When set to B<None>, data is sent without any security.
3915 This feature is only available if the I<network> plugin was linked with
3918 =item B<Username> I<Username>
3920 Sets the username to transmit. This is used by the server to lookup the
3921 password. See B<AuthFile> below. All security levels except B<None> require
3924 This feature is only available if the I<network> plugin was linked with
3927 =item B<Password> I<Password>
3929 Sets a password (shared secret) for this socket. All security levels except
3930 B<None> require this setting.
3932 This feature is only available if the I<network> plugin was linked with
3935 =item B<Interface> I<Interface name>
3937 Set the outgoing interface for IP packets. This applies at least
3938 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3939 undefined or a non-existent interface name is specified, the default
3940 behavior is to let the kernel choose the appropriate interface. Be warned
3941 that the manual selection of an interface for unicast traffic is only
3942 necessary in rare cases.
3944 =item B<ResolveInterval> I<Seconds>
3946 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
3947 useful to force a regular DNS lookup to support a high availability setup. If
3948 not specified, re-resolves are never attempted.
3952 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3954 The B<Listen> statement sets the interfaces to bind to. When multiple
3955 statements are found the daemon will bind to multiple interfaces.
3957 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3958 the argument is a multicast address the daemon will join that multicast group.
3959 The optional second argument specifies a port number or a service name. If not
3960 given, the default, B<25826>, is used.
3962 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3966 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3968 Set the security you require for network communication. When the security level
3969 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3970 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3971 signed and encrypted data is accepted. When set to B<None>, all data will be
3972 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3973 decrypted if possible.
3975 This feature is only available if the I<network> plugin was linked with
3978 =item B<AuthFile> I<Filename>
3980 Sets a file in which usernames are mapped to passwords. These passwords are
3981 used to verify signatures and to decrypt encrypted network packets. If
3982 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3983 verified and encrypted packets are decrypted. Otherwise, signed data is
3984 accepted without checking the signature and encrypted data cannot be decrypted.
3985 For the other security levels this option is mandatory.
3987 The file format is very simple: Each line consists of a username followed by a
3988 colon and any number of spaces followed by the password. To demonstrate, an
3989 example file could look like this:
3994 Each time a packet is received, the modification time of the file is checked
3995 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3996 the file is being read, it is locked using L<fcntl(2)>.
3998 =item B<Interface> I<Interface name>
4000 Set the incoming interface for IP packets explicitly. This applies at least
4001 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4002 undefined or a non-existent interface name is specified, the default
4003 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4004 traffic gets only accepted, if it arrives on the given interface.
4008 =item B<TimeToLive> I<1-255>
4010 Set the time-to-live of sent packets. This applies to all, unicast and
4011 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4012 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4015 =item B<MaxPacketSize> I<1024-65535>
4017 Set the maximum size for datagrams received over the network. Packets larger
4018 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4019 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4022 On the server side, this limit should be set to the largest value used on
4023 I<any> client. Likewise, the value on the client must not be larger than the
4024 value on the server, or data will be lost.
4026 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4027 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4028 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4031 =item B<Forward> I<true|false>
4033 If set to I<true>, write packets that were received via the network plugin to
4034 the sending sockets. This should only be activated when the B<Listen>- and
4035 B<Server>-statements differ. Otherwise packets may be send multiple times to
4036 the same multicast group. While this results in more network traffic than
4037 necessary it's not a huge problem since the plugin has a duplicate detection,
4038 so the values will not loop.
4040 =item B<ReportStats> B<true>|B<false>
4042 The network plugin cannot only receive and send statistics, it can also create
4043 statistics about itself. Collected data included the number of received and
4044 sent octets and packets, the length of the receive queue and the number of
4045 values handled. When set to B<true>, the I<Network plugin> will make these
4046 statistics available. Defaults to B<false>.
4050 =head2 Plugin C<nginx>
4052 This plugin collects the number of connections and requests handled by the
4053 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4054 queries the page provided by the C<ngx_http_stub_status_module> module, which
4055 isn't compiled by default. Please refer to
4056 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4057 how to compile and configure nginx and this module.
4059 The following options are accepted by the C<nginx plugin>:
4063 =item B<URL> I<http://host/nginx_status>
4065 Sets the URL of the C<ngx_http_stub_status_module> output.
4067 =item B<User> I<Username>
4069 Optional user name needed for authentication.
4071 =item B<Password> I<Password>
4073 Optional password needed for authentication.
4075 =item B<VerifyPeer> B<true|false>
4077 Enable or disable peer SSL certificate verification. See
4078 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4080 =item B<VerifyHost> B<true|false>
4082 Enable or disable peer host name verification. If enabled, the plugin checks
4083 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4084 certificate matches the host name provided by the B<URL> option. If this
4085 identity check fails, the connection is aborted. Obviously, only works when
4086 connecting to a SSL enabled server. Enabled by default.
4088 =item B<CACert> I<File>
4090 File that holds one or more SSL certificates. If you want to use HTTPS you will
4091 possibly need this option. What CA certificates come bundled with C<libcurl>
4092 and are checked by default depends on the distribution you use.
4096 =head2 Plugin C<notify_desktop>
4098 This plugin sends a desktop notification to a notification daemon, as defined
4099 in the Desktop Notification Specification. To actually display the
4100 notifications, B<notification-daemon> is required and B<collectd> has to be
4101 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4102 environment variables have to be set correctly) and the D-Bus message bus.
4104 The Desktop Notification Specification can be found at
4105 L<http://www.galago-project.org/specs/notification/>.
4109 =item B<OkayTimeout> I<timeout>
4111 =item B<WarningTimeout> I<timeout>
4113 =item B<FailureTimeout> I<timeout>
4115 Set the I<timeout>, in milliseconds, after which to expire the notification
4116 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4117 been specified, the displayed notification will not be closed at all - the
4118 user has to do so herself. These options default to 5000. If a negative number
4119 has been specified, the default is used as well.
4123 =head2 Plugin C<notify_email>
4125 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4126 configured email address.
4128 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4130 Available configuration options:
4134 =item B<From> I<Address>
4136 Email address from which the emails should appear to come from.
4138 Default: C<root@localhost>
4140 =item B<Recipient> I<Address>
4142 Configures the email address(es) to which the notifications should be mailed.
4143 May be repeated to send notifications to multiple addresses.
4145 At least one B<Recipient> must be present for the plugin to work correctly.
4147 =item B<SMTPServer> I<Hostname>
4149 Hostname of the SMTP server to connect to.
4151 Default: C<localhost>
4153 =item B<SMTPPort> I<Port>
4155 TCP port to connect to.
4159 =item B<SMTPUser> I<Username>
4161 Username for ASMTP authentication. Optional.
4163 =item B<SMTPPassword> I<Password>
4165 Password for ASMTP authentication. Optional.
4167 =item B<Subject> I<Subject>
4169 Subject-template to use when sending emails. There must be exactly two
4170 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4171 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4174 Default: C<Collectd notify: %s@%s>
4178 =head2 Plugin C<ntpd>
4182 =item B<Host> I<Hostname>
4184 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4186 =item B<Port> I<Port>
4188 UDP-Port to connect to. Defaults to B<123>.
4190 =item B<ReverseLookups> B<true>|B<false>
4192 Sets whether or not to perform reverse lookups on peers. Since the name or
4193 IP-address may be used in a filename it is recommended to disable reverse
4194 lookups. The default is to do reverse lookups to preserve backwards
4195 compatibility, though.
4197 =item B<IncludeUnitID> B<true>|B<false>
4199 When a peer is a refclock, include the unit ID in the I<type instance>.
4200 Defaults to B<false> for backward compatibility.
4202 If two refclock peers use the same driver and this is B<false>, the plugin will
4203 try to write simultaneous measurements from both to the same type instance.
4204 This will result in error messages in the log and only one set of measurements
4209 =head2 Plugin C<nut>
4213 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4215 Add a UPS to collect data from. The format is identical to the one accepted by
4220 =head2 Plugin C<olsrd>
4222 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4223 the Optimized Link State Routing daemon and reads information about the current
4224 state of the meshed network.
4226 The following configuration options are understood:
4230 =item B<Host> I<Host>
4232 Connect to I<Host>. Defaults to B<"localhost">.
4234 =item B<Port> I<Port>
4236 Specifies the port to connect to. This must be a string, even if you give the
4237 port as a number rather than a service name. Defaults to B<"2006">.
4239 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4241 Specifies what information to collect about links, i.E<nbsp>e. direct
4242 connections of the daemon queried. If set to B<No>, no information is
4243 collected. If set to B<Summary>, the number of links and the average of all
4244 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4245 If set to B<Detail> LQ and NLQ are collected per link.
4247 Defaults to B<Detail>.
4249 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4251 Specifies what information to collect about routes of the daemon queried. If
4252 set to B<No>, no information is collected. If set to B<Summary>, the number of
4253 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4254 metric and ETX are collected per route.
4256 Defaults to B<Summary>.
4258 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4260 Specifies what information to collect about the global topology. If set to
4261 B<No>, no information is collected. If set to B<Summary>, the number of links
4262 in the entire topology and the average I<link quality> (LQ) is calculated.
4263 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4265 Defaults to B<Summary>.
4269 =head2 Plugin C<onewire>
4271 B<EXPERIMENTAL!> See notes below.
4273 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4274 L<http://owfs.org/> to read sensors connected via the onewire bus.
4276 It can be used in two possible modes - standard or advanced.
4278 In the standard mode only temperature sensors (sensors with the family code
4279 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4280 other sensors you would like to have included, please send a sort request to
4281 the mailing list. You can select sensors to be read or to be ignored depending
4282 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4283 walked and all sensors are read.
4285 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4286 experimental, below.
4288 In the advanced mode you can configure any sensor to be read (only numerical
4289 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4290 In this mode you have to list all the sensors. Neither default bus walk nor
4291 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4292 the path automatically and should produce compatible structure with the "standard"
4293 mode (basically the path is expected as for example
4294 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4295 "F10FCA000800" and the rest after the slash is considered the type - here
4297 There are two advantages to this mode - you can access virtually any sensor
4298 (not just temperature), select whether to use cached or directly read values
4299 and it is slighlty faster. The downside is more complex configuration.
4301 The two modes are distinguished automatically by the format of the address.
4302 It is not possible to mix the two modes. Once a full path is detected in any
4303 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4304 (and as standard addresses will fail parsing they will be ignored).
4308 =item B<Device> I<Device>
4310 Sets the device to read the values from. This can either be a "real" hardware
4311 device, such as a serial port or an USB port, or the address of the
4312 L<owserver(1)> socket, usually B<localhost:4304>.
4314 Though the documentation claims to automatically recognize the given address
4315 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4316 with that version, the following configuration worked for us:
4319 Device "-s localhost:4304"
4322 This directive is B<required> and does not have a default value.
4324 =item B<Sensor> I<Sensor>
4326 In the standard mode selects sensors to collect or to ignore
4327 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4328 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4329 and B<not> include the leading C<10.> family byte and point.
4330 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4331 sensors (see above) are read.
4333 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4334 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4335 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4337 As there can be multiple devices on the bus you can list multiple sensor (use
4338 multiple B<Sensor> elements).
4340 =item B<IgnoreSelected> I<true>|I<false>
4342 If no configuration is given, the B<onewire> plugin will collect data from all
4343 sensors found. This may not be practical, especially if sensors are added and
4344 removed regularly. Sometimes, however, it's easier/preferred to collect only
4345 specific sensors or all sensors I<except> a few specified ones. This option
4346 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4347 B<Sensor> is inverted: All selected interfaces are ignored and all other
4348 interfaces are collected.
4350 Used only in the standard mode - see above.
4352 =item B<Interval> I<Seconds>
4354 Sets the interval in which all sensors should be read. If not specified, the
4355 global B<Interval> setting is used.
4359 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4360 work with big setups. It works with one sensor being attached to one
4361 controller, but as soon as you throw in a couple more senors and maybe a hub
4362 or two, reading all values will take more than ten seconds (the default
4363 interval). We will probably add some separate thread for reading the sensors
4364 and some cache or something like that, but it's not done yet. We will try to
4365 maintain backwards compatibility in the future, but we can't promise. So in
4366 short: If it works for you: Great! But keep in mind that the config I<might>
4367 change, though this is unlikely. Oh, and if you want to help improving this
4368 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4370 =head2 Plugin C<openldap>
4372 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4373 server correctly. The backend database C<monitor> needs to be loaded and
4374 working. See slapd-monitor(5) for the details.
4376 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4377 blocks. Each block requires one string argument as the instance name. For
4382 URL "ldap://localhost/"
4385 URL "ldaps://localhost/"
4389 The instance name will be used as the I<plugin instance>. To emulate the old
4390 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4391 plugin to work correctly, each instance name must be unique. This is not
4392 enforced by the plugin and it is your responsibility to ensure it is.
4394 The following options are accepted within each B<Instance> block:
4398 =item B<URL> I<ldap://host/binddn>
4400 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4403 =item B<StartTLS> B<true|false>
4405 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4406 Disabled by default.
4408 =item B<VerifyHost> B<true|false>
4410 Enables or disables peer host name verification. If enabled, the plugin checks
4411 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4412 certificate matches the host name provided by the B<URL> option. If this
4413 identity check fails, the connection is aborted. Enabled by default.
4415 =item B<CACert> I<File>
4417 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4418 may possibly need this option. What CA certificates are checked by default
4419 depends on the distribution you use and can be changed with the usual ldap
4420 client configuration mechanisms. See ldap.conf(5) for the details.
4422 =item B<Timeout> I<Seconds>
4424 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4425 an infinite timeout.
4427 =item B<Version> I<Version>
4429 An integer which sets the LDAP protocol version number to use when connecting
4430 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4434 =head2 Plugin C<openvpn>
4436 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4437 traffic statistics about connected clients.
4439 To set up OpenVPN to write to the status file periodically, use the
4440 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4441 you need to set the required format, too. This is done by setting
4442 B<--status-version> to B<2>.
4444 So, in a nutshell you need:
4446 openvpn $OTHER_OPTIONS \
4447 --status "/var/run/openvpn-status" 10 \
4454 =item B<StatusFile> I<File>
4456 Specifies the location of the status file.
4458 =item B<ImprovedNamingSchema> B<true>|B<false>
4460 When enabled, the filename of the status file will be used as plugin instance
4461 and the client's "common name" will be used as type instance. This is required
4462 when reading multiple status files. Enabling this option is recommended, but to
4463 maintain backwards compatibility this option is disabled by default.
4465 =item B<CollectCompression> B<true>|B<false>
4467 Sets whether or not statistics about the compression used by OpenVPN should be
4468 collected. This information is only available in I<single> mode. Enabled by
4471 =item B<CollectIndividualUsers> B<true>|B<false>
4473 Sets whether or not traffic information is collected for each connected client
4474 individually. If set to false, currently no traffic data is collected at all
4475 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4477 =item B<CollectUserCount> B<true>|B<false>
4479 When enabled, the number of currently connected clients or users is collected.
4480 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4481 can be configured independently from that option. Defaults to B<false>.
4485 =head2 Plugin C<oracle>
4487 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4488 Oracle® Database and lets you execute SQL statements there. It is very similar
4489 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4490 plugin's documentation above for details.
4493 <Query "out_of_stock">
4494 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4497 # InstancePrefix "foo"
4498 InstancesFrom "category"
4502 <Database "product_information">
4506 Query "out_of_stock"
4510 =head3 B<Query> blocks
4512 The Query blocks are handled identically to the Query blocks of the "dbi"
4513 plugin. Please see its documentation above for details on how to specify
4516 =head3 B<Database> blocks
4518 Database blocks define a connection to a database and which queries should be
4519 sent to that database. Each database needs a "name" as string argument in the
4520 starting tag of the block. This name will be used as "PluginInstance" in the
4521 values submitted to the daemon. Other than that, that name is not used.
4525 =item B<ConnectID> I<ID>
4527 Defines the "database alias" or "service name" to connect to. Usually, these
4528 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4530 =item B<Host> I<Host>
4532 Hostname to use when dispatching values for this database. Defaults to using
4533 the global hostname of the I<collectd> instance.
4535 =item B<Username> I<Username>
4537 Username used for authentication.
4539 =item B<Password> I<Password>
4541 Password used for authentication.
4543 =item B<Query> I<QueryName>
4545 Associates the query named I<QueryName> with this database connection. The
4546 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4547 blocks you want to refer to must be placed above the database block you want to
4552 =head2 Plugin C<perl>
4554 This plugin embeds a Perl-interpreter into collectd and provides an interface
4555 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4557 =head2 Plugin C<pinba>
4559 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4560 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4561 PHP-based webpage has been delivered, the extension will send a UDP packet
4562 containing timing information, peak memory usage and so on. The plugin will
4563 wait for such packets, parse them and account the provided information, which
4564 is then dispatched to the daemon once per interval.
4571 # Overall statistics for the website.
4573 Server "www.example.com"
4575 # Statistics for www-a only
4577 Host "www-a.example.com"
4578 Server "www.example.com"
4580 # Statistics for www-b only
4582 Host "www-b.example.com"
4583 Server "www.example.com"
4587 The plugin provides the following configuration options:
4591 =item B<Address> I<Node>
4593 Configures the address used to open a listening socket. By default, plugin will
4594 bind to the I<any> address C<::0>.
4596 =item B<Port> I<Service>
4598 Configures the port (service) to bind to. By default the default Pinba port
4599 "30002" will be used. The option accepts service names in addition to port
4600 numbers and thus requires a I<string> argument.
4602 =item E<lt>B<View> I<Name>E<gt> block
4604 The packets sent by the Pinba extension include the hostname of the server, the
4605 server name (the name of the virtual host) and the script that was executed.
4606 Using B<View> blocks it is possible to separate the data into multiple groups
4607 to get more meaningful statistics. Each packet is added to all matching groups,
4608 so that a packet may be accounted for more than once.
4612 =item B<Host> I<Host>
4614 Matches the hostname of the system the webserver / script is running on. This
4615 will contain the result of the L<gethostname(2)> system call. If not
4616 configured, all hostnames will be accepted.
4618 =item B<Server> I<Server>
4620 Matches the name of the I<virtual host>, i.e. the contents of the
4621 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4622 server names will be accepted.
4624 =item B<Script> I<Script>
4626 Matches the name of the I<script name>, i.e. the contents of the
4627 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4628 script names will be accepted.
4634 =head2 Plugin C<ping>
4636 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4637 configured hosts periodically and measures the network latency. Whenever the
4638 C<read> function of the plugin is called, it submits the average latency, the
4639 standard deviation and the drop rate for each host.
4641 Available configuration options:
4645 =item B<Host> I<IP-address>
4647 Host to ping periodically. This option may be repeated several times to ping
4650 =item B<Interval> I<Seconds>
4652 Sets the interval in which to send ICMP echo packets to the configured hosts.
4653 This is B<not> the interval in which statistics are queries from the plugin but
4654 the interval in which the hosts are "pinged". Therefore, the setting here
4655 should be smaller than or equal to the global B<Interval> setting. Fractional
4656 times, such as "1.24" are allowed.
4660 =item B<Timeout> I<Seconds>
4662 Time to wait for a response from the host to which an ICMP packet had been
4663 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4664 to be down or the packet to be dropped. This setting must be smaller than the
4665 B<Interval> setting above for the plugin to work correctly. Fractional
4666 arguments are accepted.
4670 =item B<TTL> I<0-255>
4672 Sets the Time-To-Live of generated ICMP packets.
4674 =item B<SourceAddress> I<host>
4676 Sets the source address to use. I<host> may either be a numerical network
4677 address or a network hostname.
4679 =item B<Device> I<name>
4681 Sets the outgoing network device to be used. I<name> has to specify an
4682 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4685 =item B<MaxMissed> I<Packets>
4687 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4688 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4690 Default: B<-1> (disabled)
4694 =head2 Plugin C<postgresql>
4696 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4697 keeps a persistent connection to all configured databases and tries to
4698 reconnect if the connection has been interrupted. A database is configured by
4699 specifying a B<Database> block as described below. The default statistics are
4700 collected from PostgreSQL's B<statistics collector> which thus has to be
4701 enabled for this plugin to work correctly. This should usually be the case by
4702 default. See the section "The Statistics Collector" of the B<PostgreSQL
4703 Documentation> for details.
4705 By specifying custom database queries using a B<Query> block as described
4706 below, you may collect any data that is available from some PostgreSQL
4707 database. This way, you are able to access statistics of external daemons
4708 which are available in a PostgreSQL database or use future or special
4709 statistics provided by PostgreSQL without the need to upgrade your collectd
4712 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4713 PostgreSQL databases as well. This has been implemented in a generic way. You
4714 need to specify an SQL statement which will then be executed by collectd in
4715 order to write the data (see below for details). The benefit of that approach
4716 is that there is no fixed database layout. Rather, the layout may be optimized
4717 for the current setup.
4719 The B<PostgreSQL Documentation> manual can be found at
4720 L<http://www.postgresql.org/docs/manuals/>.
4724 Statement "SELECT magic FROM wizard WHERE host = $1;"
4728 InstancePrefix "magic"
4733 <Query rt36_tickets>
4734 Statement "SELECT COUNT(type) AS count, type \
4736 WHEN resolved = 'epoch' THEN 'open' \
4737 ELSE 'resolved' END AS type \
4738 FROM tickets) type \
4742 InstancePrefix "rt36_tickets"
4743 InstancesFrom "type"
4749 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4759 KRBSrvName "kerberos_service_name"
4765 Service "service_name"
4766 Query backend # predefined
4777 The B<Query> block defines one database query which may later be used by a
4778 database definition. It accepts a single mandatory argument which specifies
4779 the name of the query. The names of all queries have to be unique (see the
4780 B<MinVersion> and B<MaxVersion> options below for an exception to this
4781 rule). The following configuration options are available to define the query:
4783 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4784 blocks define how to handle the values returned from the query. They define
4785 which column holds which value and how to dispatch that value to the daemon.
4786 Multiple B<Result> blocks may be used to extract multiple values from a single
4791 =item B<Statement> I<sql query statement>
4793 Specify the I<sql query statement> which the plugin should execute. The string
4794 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4795 first, second, etc. parameter. The value of the parameters is specified by the
4796 B<Param> configuration option - see below for details. To include a literal
4797 B<$> character followed by a number, surround it with single quotes (B<'>).
4799 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4800 allowed. Note, however, that only a single command may be used. Semicolons are
4801 allowed as long as a single non-empty command has been specified only.
4803 The returned lines will be handled separately one after another.
4805 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4807 Specify the parameters which should be passed to the SQL query. The parameters
4808 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4809 they appear in the configuration file. The value of the parameter is
4810 determined depending on the value of the B<Param> option as follows:
4816 The configured hostname of the database connection. If a UNIX domain socket is
4817 used, the parameter expands to "localhost".
4821 The name of the database of the current connection.
4825 The name of the database plugin instance. See the B<Instance> option of the
4826 database specification below for details.
4830 The username used to connect to the database.
4834 The interval with which this database is queried (as specified by the database
4835 specific or global B<Interval> options).
4839 Please note that parameters are only supported by PostgreSQL's protocol
4840 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4842 =item B<Type> I<type>
4844 The I<type> name to be used when dispatching the values. The type describes
4845 how to handle the data and where to store it. See L<types.db(5)> for more
4846 details on types and their configuration. The number and type of values (as
4847 selected by the B<ValuesFrom> option) has to match the type of the given name.
4849 This option is required inside a B<Result> block.
4851 =item B<InstancePrefix> I<prefix>
4853 =item B<InstancesFrom> I<column0> [I<column1> ...]
4855 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4856 B<InstancePrefix> defines a static prefix that will be prepended to all type
4857 instances. B<InstancesFrom> defines the column names whose values will be used
4858 to create the type instance. Multiple values will be joined together using the
4859 hyphen (C<->) as separation character.
4861 The plugin itself does not check whether or not all built instances are
4862 different. It is your responsibility to assure that each is unique.
4864 Both options are optional. If none is specified, the type instance will be
4867 =item B<ValuesFrom> I<column0> [I<column1> ...]
4869 Names the columns whose content is used as the actual data for the data sets
4870 that are dispatched to the daemon. How many such columns you need is
4871 determined by the B<Type> setting as explained above. If you specify too many
4872 or not enough columns, the plugin will complain about that and no data will be
4873 submitted to the daemon.
4875 The actual data type, as seen by PostgreSQL, is not that important as long as
4876 it represents numbers. The plugin will automatically cast the values to the
4877 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4878 L<strtod(3)> functions, so anything supported by those functions is supported
4879 by the plugin as well.
4881 This option is required inside a B<Result> block and may be specified multiple
4882 times. If multiple B<ValuesFrom> options are specified, the columns are read
4885 =item B<MinVersion> I<version>
4887 =item B<MaxVersion> I<version>
4889 Specify the minimum or maximum version of PostgreSQL that this query should be
4890 used with. Some statistics might only be available with certain versions of
4891 PostgreSQL. This allows you to specify multiple queries with the same name but
4892 which apply to different versions, thus allowing you to use the same
4893 configuration in a heterogeneous environment.
4895 The I<version> has to be specified as the concatenation of the major, minor
4896 and patch-level versions, each represented as two-decimal-digit numbers. For
4897 example, version 8.2.3 will become 80203.
4901 The following predefined queries are available (the definitions can be found
4902 in the F<postgresql_default.conf> file which, by default, is available at
4903 C<I<prefix>/share/collectd/>):
4909 This query collects the number of backends, i.E<nbsp>e. the number of
4912 =item B<transactions>
4914 This query collects the numbers of committed and rolled-back transactions of
4919 This query collects the numbers of various table modifications (i.E<nbsp>e.
4920 insertions, updates, deletions) of the user tables.
4922 =item B<query_plans>
4924 This query collects the numbers of various table scans and returned tuples of
4927 =item B<table_states>
4929 This query collects the numbers of live and dead rows in the user tables.
4933 This query collects disk block access counts for user tables.
4937 This query collects the on-disk size of the database in bytes.
4941 In addition, the following detailed queries are available by default. Please
4942 note that each of those queries collects information B<by table>, thus,
4943 potentially producing B<a lot> of data. For details see the description of the
4944 non-by_table queries above.
4948 =item B<queries_by_table>
4950 =item B<query_plans_by_table>
4952 =item B<table_states_by_table>
4954 =item B<disk_io_by_table>
4958 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4959 mandatory argument specifying the name of the writer. This will then be used
4960 in the B<Database> specification in order to activate the writer instance. The
4961 names of all writers have to be unique. The following options may be
4966 =item B<Statement> I<sql statement>
4968 This mandatory option specifies the SQL statement that will be executed for
4969 each submitted value. A single SQL statement is allowed only. Anything after
4970 the first semicolon will be ignored.
4972 Nine parameters will be passed to the statement and should be specified as
4973 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4974 values are made available through those parameters:
4980 The timestamp of the queried value as a floating point number.
4984 The hostname of the queried value.
4988 The plugin name of the queried value.
4992 The plugin instance of the queried value. This value may be B<NULL> if there
4993 is no plugin instance.
4997 The type of the queried value (cf. L<types.db(5)>).
5001 The type instance of the queried value. This value may be B<NULL> if there is
5006 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5007 sources of the submitted value-list).
5011 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5012 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5013 B<StoreRates> is enabled (which is the default, see below), all types will be
5018 An array of the submitted values. The dimensions of the value name and value
5023 In general, it is advisable to create and call a custom function in the
5024 PostgreSQL database for this purpose. Any procedural language supported by
5025 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5028 =item B<StoreRates> B<false>|B<true>
5030 If set to B<true> (the default), convert counter values to rates. If set to
5031 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5036 The B<Database> block defines one PostgreSQL database for which to collect
5037 statistics. It accepts a single mandatory argument which specifies the
5038 database name. None of the other options are required. PostgreSQL will use
5039 default values as documented in the section "CONNECTING TO A DATABASE" in the
5040 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5041 the user collectd is run as and special environment variables. See the manpage
5046 =item B<Interval> I<seconds>
5048 Specify the interval with which the database should be queried. The default is
5049 to use the global B<Interval> setting.
5051 =item B<CommitInterval> I<seconds>
5053 This option may be used for database connections which have "writers" assigned
5054 (see above). If specified, it causes a writer to put several updates into a
5055 single transaction. This transaction will last for the specified amount of
5056 time. By default, each update will be executed in a separate transaction. Each
5057 transaction generates a fair amount of overhead which can, thus, be reduced by
5058 activating this option. The draw-back is, that data covering the specified
5059 amount of time will be lost, for example, if a single statement within the
5060 transaction fails or if the database server crashes.
5062 =item B<Host> I<hostname>
5064 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5065 value begins with a slash, it is interpreted as the directory name in which to
5066 look for the UNIX domain socket.
5068 This option is also used to determine the hostname that is associated with a
5069 collected data set. If it has been omitted or either begins with with a slash
5070 or equals B<localhost> it will be replaced with the global hostname definition
5071 of collectd. Any other value will be passed literally to collectd when
5072 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5074 =item B<Port> I<port>
5076 Specify the TCP port or the local UNIX domain socket file extension of the
5079 =item B<User> I<username>
5081 Specify the username to be used when connecting to the server.
5083 =item B<Password> I<password>
5085 Specify the password to be used when connecting to the server.
5087 =item B<ExpireDelay> I<delay>
5089 Skip expired values in query output.
5091 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5093 Specify whether to use an SSL connection when contacting the server. The
5094 following modes are supported:
5100 Do not use SSL at all.
5104 First, try to connect without using SSL. If that fails, try using SSL.
5106 =item I<prefer> (default)
5108 First, try to connect using SSL. If that fails, try without using SSL.
5116 =item B<Instance> I<name>
5118 Specify the plugin instance name that should be used instead of the database
5119 name (which is the default, if this option has not been specified). This
5120 allows to query multiple databases of the same name on the same host (e.g.
5121 when running multiple database server versions in parallel).
5123 =item B<KRBSrvName> I<kerberos_service_name>
5125 Specify the Kerberos service name to use when authenticating with Kerberos 5
5126 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5127 B<PostgreSQL Documentation> for details.
5129 =item B<Service> I<service_name>
5131 Specify the PostgreSQL service name to use for additional parameters. That
5132 service has to be defined in F<pg_service.conf> and holds additional
5133 connection parameters. See the section "The Connection Service File" in the
5134 B<PostgreSQL Documentation> for details.
5136 =item B<Query> I<query>
5138 Specifies a I<query> which should be executed in the context of the database
5139 connection. This may be any of the predefined or user-defined queries. If no
5140 such option is given, it defaults to "backends", "transactions", "queries",
5141 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5142 has been specified). Else, the specified queries are used only.
5144 =item B<Writer> I<writer>
5146 Assigns the specified I<writer> backend to the database connection. This
5147 causes all collected data to be send to the database using the settings
5148 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5149 below for details on how to selectively send data to certain plugins).
5151 Each writer will register a flush callback which may be used when having long
5152 transactions enabled (see the B<CommitInterval> option above). When issuing
5153 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5154 transaction will be committed right away. Two different kinds of flush
5155 callbacks are available with the C<postgresql> plugin:
5161 Flush all writer backends.
5163 =item B<postgresql->I<database>
5165 Flush all writers of the specified I<database> only.
5171 =head2 Plugin C<powerdns>
5173 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5174 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5175 values, many of which are probably meaningless to most users, but may be useful
5176 for some. So you may chose which values to collect, but if you don't, some
5177 reasonable defaults will be collected.
5180 <Server "server_name">
5182 Collect "udp-answers" "udp-queries"
5183 Socket "/var/run/pdns.controlsocket"
5185 <Recursor "recursor_name">
5187 Collect "cache-hits" "cache-misses"
5188 Socket "/var/run/pdns_recursor.controlsocket"
5190 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5195 =item B<Server> and B<Recursor> block
5197 The B<Server> block defines one authoritative server to query, the B<Recursor>
5198 does the same for an recursing server. The possible options in both blocks are
5199 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5204 =item B<Collect> I<Field>
5206 Using the B<Collect> statement you can select which values to collect. Here,
5207 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5208 C<dlg-only-drops>, C<answers10-100>.
5210 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5211 When querying the server a C<SHOW *> command is issued in any case, because
5212 that's the only way of getting multiple values out of the server at once.
5213 collectd then picks out the values you have selected. When querying the
5214 recursor, a command is generated to query exactly these values. So if you
5215 specify invalid fields when querying the recursor, a syntax error may be
5216 returned by the daemon and collectd may not collect any values at all.
5218 If no B<Collect> statement is given, the following B<Server> values will be
5225 =item packetcache-hit
5227 =item packetcache-miss
5229 =item packetcache-size
5231 =item query-cache-hit
5233 =item query-cache-miss
5235 =item recursing-answers
5237 =item recursing-questions
5249 The following B<Recursor> values will be collected by default:
5253 =item noerror-answers
5255 =item nxdomain-answers
5257 =item servfail-answers
5275 Please note that up to that point collectd doesn't know what values are
5276 available on the server and values that are added do not need a change of the
5277 mechanism so far. However, the values must be mapped to collectd's naming
5278 scheme, which is done using a lookup table that lists all known values. If
5279 values are added in the future and collectd does not know about them, you will
5280 get an error much like this:
5282 powerdns plugin: submit: Not found in lookup table: foobar = 42
5284 In this case please file a bug report with the collectd team.
5286 =item B<Socket> I<Path>
5288 Configures the path to the UNIX domain socket to be used when connecting to the
5289 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5290 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5291 will be used for the recursor.
5295 =item B<LocalSocket> I<Path>
5297 Querying the recursor is done using UDP. When using UDP over UNIX domain
5298 sockets, the client socket needs a name in the file system, too. You can set
5299 this local name to I<Path> using the B<LocalSocket> option. The default is
5300 C<I<prefix>/var/run/collectd-powerdns>.
5304 =head2 Plugin C<processes>
5308 =item B<Process> I<Name>
5310 Select more detailed statistics of processes matching this name. The statistics
5311 collected for these selected processes are size of the resident segment size
5312 (RSS), user- and system-time used, number of processes and number of threads,
5313 io data (where available) and minor and major pagefaults.
5315 =item B<ProcessMatch> I<name> I<regex>
5317 Similar to the B<Process> option this allows to select more detailed
5318 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5319 details). The statistics of all matching processes are summed up and
5320 dispatched to the daemon using the specified I<name> as an identifier. This
5321 allows to "group" several processes together. I<name> must not contain
5326 =head2 Plugin C<protocols>
5328 Collects a lot of information about various network protocols, such as I<IP>,
5329 I<TCP>, I<UDP>, etc.
5331 Available configuration options:
5335 =item B<Value> I<Selector>
5337 Selects whether or not to select a specific value. The string being matched is
5338 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5339 plugin instance and I<ValueName> will be used as type instance. An example of
5340 the string being used would be C<Tcp:RetransSegs>.
5342 You can use regular expressions to match a large number of values with just one
5343 configuration option. To select all "extended" I<TCP> values, you could use the
5344 following statement:
5348 Whether only matched values are selected or all matched values are ignored
5349 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5350 If no value is configured at all, all values will be selected.
5352 =item B<IgnoreSelected> B<true>|B<false>
5354 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5355 matching values will be ignored.
5359 =head2 Plugin C<python>
5361 This plugin embeds a Python-interpreter into collectd and provides an interface
5362 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5364 =head2 Plugin C<routeros>
5366 The C<routeros> plugin connects to a device running I<RouterOS>, the
5367 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5368 I<librouteros> to connect and reads information about the interfaces and
5369 wireless connections of the device. The configuration supports querying
5374 Host "router0.example.com"
5377 CollectInterface true
5382 Host "router1.example.com"
5385 CollectInterface true
5386 CollectRegistrationTable true
5392 As you can see above, the configuration of the I<routeros> plugin consists of
5393 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5394 options are understood:
5398 =item B<Host> I<Host>
5400 Hostname or IP-address of the router to connect to.
5402 =item B<Port> I<Port>
5404 Port name or port number used when connecting. If left unspecified, the default
5405 will be chosen by I<librouteros>, currently "8728". This option expects a
5406 string argument, even when a numeric port number is given.
5408 =item B<User> I<User>
5410 Use the user name I<User> to authenticate. Defaults to "admin".
5412 =item B<Password> I<Password>
5414 Set the password used to authenticate.
5416 =item B<CollectInterface> B<true>|B<false>
5418 When set to B<true>, interface statistics will be collected for all interfaces
5419 present on the device. Defaults to B<false>.
5421 =item B<CollectRegistrationTable> B<true>|B<false>
5423 When set to B<true>, information about wireless LAN connections will be
5424 collected. Defaults to B<false>.
5426 =item B<CollectCPULoad> B<true>|B<false>
5428 When set to B<true>, information about the CPU usage will be collected. The
5429 number is a dimensionless value where zero indicates no CPU usage at all.
5430 Defaults to B<false>.
5432 =item B<CollectMemory> B<true>|B<false>
5434 When enabled, the amount of used and free memory will be collected. How used
5435 memory is calculated is unknown, for example whether or not caches are counted
5437 Defaults to B<false>.
5439 =item B<CollectDF> B<true>|B<false>
5441 When enabled, the amount of used and free disk space will be collected.
5442 Defaults to B<false>.
5444 =item B<CollectDisk> B<true>|B<false>
5446 When enabled, the number of sectors written and bad blocks will be collected.
5447 Defaults to B<false>.
5451 =head2 Plugin C<redis>
5453 The I<Redis plugin> connects to one or more Redis servers and gathers
5454 information about each server's state. For each server there is a I<Node> block
5455 which configures the connection parameters for this node.
5462 <Query "LLEN myqueue">
5469 The information shown in the synopsis above is the I<default configuration>
5470 which is used by the plugin if no configuration is present.
5474 =item B<Node> I<Nodename>
5476 The B<Node> block identifies a new Redis node, that is a new Redis instance
5477 running in an specified host and port. The name for node is a canonical
5478 identifier which is used as I<plugin instance>. It is limited to
5479 64E<nbsp>characters in length.
5481 =item B<Host> I<Hostname>
5483 The B<Host> option is the hostname or IP-address where the Redis instance is
5486 =item B<Port> I<Port>
5488 The B<Port> option is the TCP port on which the Redis instance accepts
5489 connections. Either a service name of a port number may be given. Please note
5490 that numerical port numbers must be given as a string, too.
5492 =item B<Password> I<Password>
5494 Use I<Password> to authenticate when connecting to I<Redis>.
5496 =item B<Timeout> I<Timeout in miliseconds>
5498 The B<Timeout> option set the socket timeout for node response. Since the Redis
5499 read function is blocking, you should keep this value as low as possible. Keep
5500 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5501 than B<Interval> defined globally.
5503 =item B<Query> I<Querystring>
5505 The B<Query> block identifies a query to execute against the redis server.
5506 There may be an arbitrary number of queries to execute.
5508 =item B<Type> I<Collectd type>
5510 Within a query definition, a valid collectd type to use as when submitting
5511 the result of the query. When not supplied, will default to B<gauge>.
5513 =item B<Instance> I<Type instance>
5515 Within a query definition, an optional type instance to use when submitting
5516 the result of the query. When not supplied will default to the escaped
5517 command, up to 64 chars.
5521 =head2 Plugin C<rrdcached>
5523 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5524 to store values to RRD files in an efficient manner. The combination of the
5525 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5526 way the C<rrdtool> plugin works (see below). The added abstraction layer
5527 provides a number of benefits, though: Because the cache is not within
5528 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5529 restarted. This results in much shorter (if any) gaps in graphs, especially
5530 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5531 daemon so that it can flush values to disk automatically when needed. This
5532 allows to integrate automated flushing of values into graphing solutions much
5535 There are disadvantages, though: The daemon may reside on a different host, so
5536 it may not be possible for C<collectd> to create the appropriate RRD files
5537 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5538 different base directory, so relative paths may do weird stuff if you're not
5541 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5542 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5543 setting should be set to an absolute path, so that a changed base directory
5544 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5548 =item B<DaemonAddress> I<Address>
5550 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5551 library. See L<rrdcached(1)> for details. Example:
5553 <Plugin "rrdcached">
5554 DaemonAddress "unix:/var/run/rrdcached.sock"
5557 =item B<DataDir> I<Directory>
5559 Set the base directory in which the RRD files reside. If this is a relative
5560 path, it is relative to the working base directory of the C<rrdcached> daemon!
5561 Use of an absolute path is recommended.
5563 =item B<CreateFiles> B<true>|B<false>
5565 Enables or disables the creation of RRD files. If the daemon is not running
5566 locally, or B<DataDir> is set to a relative path, this will not work as
5567 expected. Default is B<true>.
5569 =item B<CreateFilesAsync> B<false>|B<true>
5571 When enabled, new RRD files are enabled asynchronously, using a separate thread
5572 that runs in the background. This prevents writes to block, which is a problem
5573 especially when many hundreds of files need to be created at once. However,
5574 since the purpose of creating the files asynchronously is I<not> to block until
5575 the file is available, values before the file is available will be discarded.
5576 When disabled (the default) files are created synchronously, blocking for a
5577 short while, while the file is being written.
5579 =item B<StepSize> I<Seconds>
5581 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5582 this setting is unset and the stepsize is set to the interval in which the data
5583 is collected. Do not use this option unless you absolutely have to for some
5584 reason. Setting this option may cause problems with the C<snmp plugin>, the
5585 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5587 =item B<HeartBeat> I<Seconds>
5589 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5590 in which case the heartbeat is set to twice the B<StepSize> which should equal
5591 the interval in which data is collected. Do not set this option unless you have
5592 a very good reason to do so.
5594 =item B<RRARows> I<NumRows>
5596 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5597 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5598 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5599 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5600 week, one month, and one year.
5602 So for each timespan, it calculates how many PDPs need to be consolidated into
5603 one CDP by calculating:
5604 number of PDPs = timespan / (stepsize * rrarows)
5606 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5609 =item B<RRATimespan> I<Seconds>
5611 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5612 more then one RRA. If this option is never used, the built-in default of (3600,
5613 86400, 604800, 2678400, 31622400) is used.
5615 For more information on how RRA-sizes are calculated see B<RRARows> above.
5617 =item B<XFF> I<Factor>
5619 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5620 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5623 =item B<CollectStatistics> B<false>|B<true>
5625 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5626 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5628 Statistics are read via I<rrdcached>s socket using the STATS command.
5629 See L<rrdcached(1)> for details.
5633 =head2 Plugin C<rrdtool>
5635 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5636 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5637 using these settings. If you don't want to dive into the depths of RRDtool, you
5638 can safely ignore these settings.
5642 =item B<DataDir> I<Directory>
5644 Set the directory to store RRD files under. By default RRD files are generated
5645 beneath the daemon's working directory, i.e. the B<BaseDir>.
5647 =item B<CreateFilesAsync> B<false>|B<true>
5649 When enabled, new RRD files are enabled asynchronously, using a separate thread
5650 that runs in the background. This prevents writes to block, which is a problem
5651 especially when many hundreds of files need to be created at once. However,
5652 since the purpose of creating the files asynchronously is I<not> to block until
5653 the file is available, values before the file is available will be discarded.
5654 When disabled (the default) files are created synchronously, blocking for a
5655 short while, while the file is being written.
5657 =item B<StepSize> I<Seconds>
5659 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5660 this setting is unset and the stepsize is set to the interval in which the data
5661 is collected. Do not use this option unless you absolutely have to for some
5662 reason. Setting this option may cause problems with the C<snmp plugin>, the
5663 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5665 =item B<HeartBeat> I<Seconds>
5667 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5668 in which case the heartbeat is set to twice the B<StepSize> which should equal
5669 the interval in which data is collected. Do not set this option unless you have
5670 a very good reason to do so.
5672 =item B<RRARows> I<NumRows>
5674 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5675 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5676 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5677 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5678 week, one month, and one year.
5680 So for each timespan, it calculates how many PDPs need to be consolidated into
5681 one CDP by calculating:
5682 number of PDPs = timespan / (stepsize * rrarows)
5684 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5687 =item B<RRATimespan> I<Seconds>
5689 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5690 more then one RRA. If this option is never used, the built-in default of (3600,
5691 86400, 604800, 2678400, 31622400) is used.
5693 For more information on how RRA-sizes are calculated see B<RRARows> above.
5695 =item B<XFF> I<Factor>
5697 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5698 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5701 =item B<CacheFlush> I<Seconds>
5703 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5704 it writes all values for a certain RRD-file if the oldest value is older than
5705 (or equal to) the number of seconds specified. If some RRD-file is not updated
5706 anymore for some reason (the computer was shut down, the network is broken,
5707 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5708 entire cache is searched for entries older than B<CacheTimeout> seconds and
5709 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5710 does nothing under normal circumstances, this value should not be too small.
5711 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5712 normally do much harm either.
5714 =item B<CacheTimeout> I<Seconds>
5716 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5717 save values in a cache, as described above. Writing multiple values at once
5718 reduces IO-operations and thus lessens the load produced by updating the files.
5719 The trade off is that the graphs kind of "drag behind" and that more memory is
5722 =item B<WritesPerSecond> I<Updates>
5724 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5725 will run serious performance problems. The B<CacheFlush> setting and the
5726 internal update queue assert that collectd continues to work just fine even
5727 under heavy load, but the system may become very unresponsive and slow. This is
5728 a problem especially if you create graphs from the RRD files on the same
5729 machine, for example using the C<graph.cgi> script included in the
5730 C<contrib/collection3/> directory.
5732 This setting is designed for very large setups. Setting this option to a value
5733 between 25 and 80 updates per second, depending on your hardware, will leave
5734 the server responsive enough to draw graphs even while all the cached values
5735 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5736 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5737 written as fast as possible, so that web frontends have up to date data when
5740 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5741 updates per second, writing all values to disk will take approximately
5742 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5743 "collection3" you'll end up with a responsive and fast system, up to date
5744 graphs and basically a "backup" of your values every hour.
5746 =item B<RandomTimeout> I<Seconds>
5748 When set, the actual timeout for each value is chosen randomly between
5749 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5750 intention is to avoid high load situations that appear when many values timeout
5751 at the same time. This is especially a problem shortly after the daemon starts,
5752 because all values were added to the internal cache at roughly the same time.
5756 =head2 Plugin C<sensors>
5758 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5759 that all the needed modules have to be loaded and lm_sensors has to be
5760 configured (most likely by editing F</etc/sensors.conf>. Read
5761 L<sensors.conf(5)> for details.
5763 The B<lm_sensors> homepage can be found at
5764 L<http://secure.netroedge.com/~lm78/>.
5768 =item B<SensorConfigFile> I<File>
5770 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5771 the library's default will be used.
5773 =item B<Sensor> I<chip-bus-address/type-feature>
5775 Selects the name of the sensor which you want to collect or ignore, depending
5776 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5777 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5778 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5780 =item B<IgnoreSelected> I<true>|I<false>
5782 If no configuration if given, the B<sensors>-plugin will collect data from all
5783 sensors. This may not be practical, especially for uninteresting sensors.
5784 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5785 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5786 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5787 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5788 and all other sensors are collected.
5792 =head2 Plugin C<sigrok>
5794 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5795 supported by the L<sigrok|http://sigrok.org/> project.
5801 <Device "AC Voltage">
5806 <Device "Sound Level">
5807 Driver "cem-dt-885x"
5814 =item B<LogLevel> B<0-5>
5816 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5817 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5818 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5819 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5820 their level, are always submitted to I<collectd> at its INFO log level.
5822 =item E<lt>B<Device> I<Name>E<gt>
5824 A sigrok-supported device, uniquely identified by this section's options. The
5825 I<Name> is passed to I<collectd> as the I<plugin instance>.
5827 =item B<Driver> I<DriverName>
5829 The sigrok driver to use for this device.
5831 =item B<Conn> I<ConnectionSpec>
5833 If the device cannot be auto-discovered, or more than one might be discovered
5834 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5835 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5836 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5837 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5838 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5840 =item B<SerialComm> I<SerialSpec>
5842 For serial devices with non-standard port settings, this option can be used
5843 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5844 This should not be necessary; drivers know how to communicate with devices they
5847 =item B<MinimumInterval> I<Seconds>
5849 Specifies the minimum time between measurement dispatches to I<collectd>, in
5850 seconds. Since some I<sigrok> supported devices can acquire measurements many
5851 times per second, it may be necessary to throttle these. For example, the
5852 I<RRD plugin> cannot process writes more than once per second.
5854 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5855 device are always dispatched to I<collectd>. When throttled, unused
5856 measurements are discarded.
5860 =head2 Plugin C<smart>
5862 The C<smart> plugin collects SMART information from physical
5863 disks. Values collectd include temperature, power cycle count, poweron
5864 time and bad sectors. Also, all SMART attributes are collected along
5865 with the normalized current value, the worst value, the threshold and
5866 a human readable value.
5868 Using the following two options you can ignore some disks or configure the
5869 collection only of specific disks.
5873 =item B<Disk> I<Name>
5875 Select the disk I<Name>. Whether it is collected or ignored depends on the
5876 B<IgnoreSelected> setting, see below. As with other plugins that use the
5877 daemon's ignorelist functionality, a string that starts and ends with a slash
5878 is interpreted as a regular expression. Examples:
5883 =item B<IgnoreSelected> B<true>|B<false>
5885 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
5886 statements, are ignored or if all other disks are ignored. The behavior
5887 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
5888 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
5889 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
5890 is set to B<true>, all disks are collected B<except> the ones matched.
5894 =head2 Plugin C<snmp>
5896 Since the configuration of the C<snmp plugin> is a little more complicated than
5897 other plugins, its documentation has been moved to an own manpage,
5898 L<collectd-snmp(5)>. Please see there for details.
5900 =head2 Plugin C<statsd>
5902 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5903 protocol and dispatches rates or other aggregates of these numbers
5906 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5907 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5908 C<objects> respectively.
5910 The following configuration options are valid:
5914 =item B<Host> I<Host>
5916 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5917 "any" address, i.e. accept packets sent to any of the hosts addresses.
5919 =item B<Port> I<Port>
5921 UDP port to listen to. This can be either a service name or a port number.
5922 Defaults to C<8125>.
5924 =item B<DeleteCounters> B<false>|B<true>
5926 =item B<DeleteTimers> B<false>|B<true>
5928 =item B<DeleteGauges> B<false>|B<true>
5930 =item B<DeleteSets> B<false>|B<true>
5932 These options control what happens if metrics are not updated in an interval.
5933 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5934 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5935 are unchanged. If set to B<True>, the such metrics are not dispatched and
5936 removed from the internal cache.
5938 =item B<TimerPercentile> I<Percent>
5940 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5941 that I<Percent> of all reported timers are smaller than or equal to the
5942 computed latency. This is useful for cutting off the long tail latency, as it's
5943 often done in I<Service Level Agreements> (SLAs).
5945 Different percentiles can be calculated by setting this option several times.
5946 If none are specified, no percentiles are calculated / dispatched.
5948 =item B<TimerLower> B<false>|B<true>
5950 =item B<TimerUpper> B<false>|B<true>
5952 =item B<TimerSum> B<false>|B<true>
5954 =item B<TimerCount> B<false>|B<true>
5956 Calculate and dispatch various values out of I<Timer> metrics received during
5957 an interval. If set to B<False>, the default, these values aren't calculated /
5962 =head2 Plugin C<swap>
5964 The I<Swap plugin> collects information about used and available swap space. On
5965 I<Linux> and I<Solaris>, the following options are available:
5969 =item B<ReportByDevice> B<false>|B<true>
5971 Configures how to report physical swap devices. If set to B<false> (the
5972 default), the summary over all swap devices is reported only, i.e. the globally
5973 used and available space over all devices. If B<true> is configured, the used
5974 and available space of each device will be reported separately.
5976 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5977 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5979 =item B<ReportBytes> B<false>|B<true>
5981 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5982 I<swap I/O> is reported in pages. This option is available under Linux only.
5984 =item B<ValuesAbsolute> B<true>|B<false>
5986 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5987 available and used. Defaults to B<true>.
5989 =item B<ValuesPercentage> B<false>|B<true>
5991 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5992 available and free. Defaults to B<false>.
5994 This is useful for deploying I<collectd> in a heterogeneous environment, where
5995 swap sizes differ and you want to specify generic thresholds or similar.
5999 =head2 Plugin C<syslog>
6003 =item B<LogLevel> B<debug|info|notice|warning|err>
6005 Sets the log-level. If, for example, set to B<notice>, then all events with
6006 severity B<notice>, B<warning>, or B<err> will be submitted to the
6009 Please note that B<debug> is only available if collectd has been compiled with
6012 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6014 Controls which notifications should be sent to syslog. The default behaviour is
6015 not to send any. Less severe notifications always imply logging more severe
6016 notifications: Setting this to B<OKAY> means all notifications will be sent to
6017 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6018 notifications but will dismiss B<OKAY> notifications. Setting this option to
6019 B<FAILURE> will only send failures to syslog.
6023 =head2 Plugin C<table>
6025 The C<table plugin> provides generic means to parse tabular data and dispatch
6026 user specified values. Values are selected based on column numbers. For
6027 example, this plugin may be used to get values from the Linux L<proc(5)>
6028 filesystem or CSV (comma separated values) files.
6031 <Table "/proc/slabinfo">
6036 InstancePrefix "active_objs"
6042 InstancePrefix "objperslab"
6049 The configuration consists of one or more B<Table> blocks, each of which
6050 configures one file to parse. Within each B<Table> block, there are one or
6051 more B<Result> blocks, which configure which data to select and how to
6054 The following options are available inside a B<Table> block:
6058 =item B<Instance> I<instance>
6060 If specified, I<instance> is used as the plugin instance. So, in the above
6061 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6062 filename of the table is used instead, with all special characters replaced
6063 with an underscore (C<_>).
6065 =item B<Separator> I<string>
6067 Any character of I<string> is interpreted as a delimiter between the different
6068 columns of the table. A sequence of two or more contiguous delimiters in the
6069 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6070 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6071 of a table - see its documentation for more details. This option is mandatory.
6073 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6074 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6075 required because of collectd's config parsing.
6079 The following options are available inside a B<Result> block:
6083 =item B<Type> I<type>
6085 Sets the type used to dispatch the values to the daemon. Detailed information
6086 about types and their configuration can be found in L<types.db(5)>. This
6087 option is mandatory.
6089 =item B<InstancePrefix> I<prefix>
6091 If specified, prepend I<prefix> to the type instance. If omitted, only the
6092 B<InstancesFrom> option is considered for the type instance.
6094 =item B<InstancesFrom> I<column0> [I<column1> ...]
6096 If specified, the content of the given columns (identified by the column
6097 number starting at zero) will be used to create the type instance for each
6098 row. Multiple values (and the instance prefix) will be joined together with
6099 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6100 option is considered for the type instance.
6102 The plugin itself does not check whether or not all built instances are
6103 different. It’s your responsibility to assure that each is unique. This is
6104 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6105 sure that the table only contains one row.
6107 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6110 =item B<ValuesFrom> I<column0> [I<column1> ...]
6112 Specifies the columns (identified by the column numbers starting at zero)
6113 whose content is used as the actual data for the data sets that are dispatched
6114 to the daemon. How many such columns you need is determined by the B<Type>
6115 setting above. If you specify too many or not enough columns, the plugin will
6116 complain about that and no data will be submitted to the daemon. The plugin
6117 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6118 respectively, so anything supported by those functions is supported by the
6119 plugin as well. This option is mandatory.
6123 =head2 Plugin C<tail>
6125 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6126 each line and dispatches found values. What is matched can be configured by the
6127 user using (extended) regular expressions, as described in L<regex(7)>.
6130 <File "/var/log/exim4/mainlog">
6134 Regex "S=([1-9][0-9]*)"
6140 Regex "\\<R=local_user\\>"
6141 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6144 Instance "local_user"
6149 The config consists of one or more B<File> blocks, each of which configures one
6150 logfile to parse. Within each B<File> block, there are one or more B<Match>
6151 blocks, which configure a regular expression to search for.
6153 The B<Instance> option in the B<File> block may be used to set the plugin
6154 instance. So in the above example the plugin name C<tail-foo> would be used.
6155 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6156 next B<Instance> option. This way you can extract several plugin instances from
6157 one logfile, handy when parsing syslog and the like.
6159 The B<Interval> option allows you to define the length of time between reads. If
6160 this is not set, the default Interval will be used.
6162 Each B<Match> block has the following options to describe how the match should
6167 =item B<Regex> I<regex>
6169 Sets the regular expression to use for matching against a line. The first
6170 subexpression has to match something that can be turned into a number by
6171 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6172 below. Because B<extended> regular expressions are used, you do not need to use
6173 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6174 collectd's config parsing you need to escape backslashes, though. So if you
6175 want to match literal parentheses you need to do the following:
6177 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6179 =item B<ExcludeRegex> I<regex>
6181 Sets an optional regular expression to use for excluding lines from the match.
6182 An example which excludes all connections from localhost from the match:
6184 ExcludeRegex "127\\.0\\.0\\.1"
6186 =item B<DSType> I<Type>
6188 Sets how the values are cumulated. I<Type> is one of:
6192 =item B<GaugeAverage>
6194 Calculate the average.
6198 Use the smallest number only.
6202 Use the greatest number only.
6206 Use the last number found.
6212 =item B<AbsoluteSet>
6214 The matched number is a counter. Simply I<sets> the internal counter to this
6215 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6223 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6224 matched number may be negative, which will effectively subtract from the
6233 Increase the internal counter by one. These B<DSType> are the only ones that do
6234 not use the matched subexpression, but simply count the number of matched
6235 lines. Thus, you may use a regular expression without submatch in this case.
6239 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6240 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6241 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6242 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6243 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6246 =item B<Type> I<Type>
6248 Sets the type used to dispatch this value. Detailed information about types and
6249 their configuration can be found in L<types.db(5)>.
6251 =item B<Instance> I<TypeInstance>
6253 This optional setting sets the type instance to use.
6257 =head2 Plugin C<tail_csv>
6259 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6260 written by I<Snort>.
6265 <Metric "snort-dropped">
6270 <File "/var/log/snort/snort.stats">
6271 Instance "snort-eth0"
6273 Collect "snort-dropped"
6277 The configuration consists of one or more B<Metric> blocks that define an index
6278 into the line of the CSV file and how this value is mapped to I<collectd's>
6279 internal representation. These are followed by one or more B<Instance> blocks
6280 which configure which file to read, in which interval and which metrics to
6285 =item E<lt>B<Metric> I<Name>E<gt>
6287 The B<Metric> block configures a new metric to be extracted from the statistics
6288 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6289 only used inside the B<Instance> blocks to refer to this block, so you can use
6290 one B<Metric> block for multiple CSV files.
6294 =item B<Type> I<Type>
6296 Configures which I<Type> to use when dispatching this metric. Types are defined
6297 in the L<types.db(5)> file, see the appropriate manual page for more
6298 information on specifying types. Only types with a single I<data source> are
6299 supported by the I<tail_csv plugin>. The information whether the value is an
6300 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6301 I<Type's> definition.
6303 =item B<Instance> I<TypeInstance>
6305 If set, I<TypeInstance> is used to populate the type instance field of the
6306 created value lists. Otherwise, no type instance is used.
6308 =item B<ValueFrom> I<Index>
6310 Configure to read the value from the field with the zero-based index I<Index>.
6311 If the value is parsed as signed integer, unsigned integer or double depends on
6312 the B<Type> setting, see above.
6316 =item E<lt>B<File> I<Path>E<gt>
6318 Each B<File> block represents one CSV file to read. There must be at least one
6319 I<File> block but there can be multiple if you have multiple CSV files.
6323 =item B<Instance> I<PluginInstance>
6325 Sets the I<plugin instance> used when dispatching the values.
6327 =item B<Collect> I<Metric>
6329 Specifies which I<Metric> to collect. This option must be specified at least
6330 once, and you can use this option multiple times to specify more than one
6331 metric to be extracted from this statistic file.
6333 =item B<Interval> I<Seconds>
6335 Configures the interval in which to read values from this instance / file.
6336 Defaults to the plugin's default interval.
6338 =item B<TimeFrom> I<Index>
6340 Rather than using the local time when dispatching a value, read the timestamp
6341 from the field with the zero-based index I<Index>. The value is interpreted as
6342 seconds since epoch. The value is parsed as a double and may be factional.
6348 =head2 Plugin C<teamspeak2>
6350 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6351 polls interesting global and virtual server data. The plugin can query only one
6352 physical server but unlimited virtual servers. You can use the following
6353 options to configure it:
6357 =item B<Host> I<hostname/ip>
6359 The hostname or ip which identifies the physical server.
6362 =item B<Port> I<port>
6364 The query port of the physical server. This needs to be a string.
6367 =item B<Server> I<port>
6369 This option has to be added once for every virtual server the plugin should
6370 query. If you want to query the virtual server on port 8767 this is what the
6371 option would look like:
6375 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6376 use quotes around it! If no such statement is given only global information
6381 =head2 Plugin C<ted>
6383 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6384 measure power consumption. These devices are usually connected to a serial
6385 (RS232) or USB port. The plugin opens a configured device and tries to read the
6386 current energy readings. For more information on TED, visit
6387 L<http://www.theenergydetective.com/>.
6389 Available configuration options:
6393 =item B<Device> I<Path>
6395 Path to the device on which TED is connected. collectd will need read and write
6396 permissions on that file.
6398 Default: B</dev/ttyUSB0>
6400 =item B<Retries> I<Num>
6402 Apparently reading from TED is not that reliable. You can therefore configure a
6403 number of retries here. You only configure the I<retries> here, to if you
6404 specify zero, one reading will be performed (but no retries if that fails); if
6405 you specify three, a maximum of four readings are performed. Negative values
6412 =head2 Plugin C<tcpconns>
6414 The C<tcpconns plugin> counts the number of currently established TCP
6415 connections based on the local port and/or the remote port. Since there may be
6416 a lot of connections the default if to count all connections with a local port,
6417 for which a listening socket is opened. You can use the following options to
6418 fine-tune the ports you are interested in:
6422 =item B<ListeningPorts> I<true>|I<false>
6424 If this option is set to I<true>, statistics for all local ports for which a
6425 listening socket exists are collected. The default depends on B<LocalPort> and
6426 B<RemotePort> (see below): If no port at all is specifically selected, the
6427 default is to collect listening ports. If specific ports (no matter if local or
6428 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6429 the selected ports will be collected unless this option is set to I<true>
6432 =item B<LocalPort> I<Port>
6434 Count the connections to a specific local port. This can be used to see how
6435 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6436 You have to specify the port in numeric form, so for the mailserver example
6437 you'd need to set B<25>.
6439 =item B<RemotePort> I<Port>
6441 Count the connections to a specific remote port. This is useful to see how
6442 much a remote service is used. This is most useful if you want to know how many
6443 connections a local service has opened to remote services, e.E<nbsp>g. how many
6444 connections a mail server or news server has to other mail or news servers, or
6445 how many connections a web proxy holds to web servers. You have to give the
6446 port in numeric form.
6448 =item B<AllPortsSummary> I<true>|I<false>
6450 If this option is set to I<true> a summary of statistics from all connections
6451 are collectd. This option defaults to I<false>.
6455 =head2 Plugin C<thermal>
6459 =item B<ForceUseProcfs> I<true>|I<false>
6461 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6462 C<sysfs> interface. If that is not available, the plugin falls back to the
6463 C<procfs> interface. By setting this option to I<true>, you can force the
6464 plugin to use the latter. This option defaults to I<false>.
6466 =item B<Device> I<Device>
6468 Selects the name of the thermal device that you want to collect or ignore,
6469 depending on the value of the B<IgnoreSelected> option. This option may be
6470 used multiple times to specify a list of devices.
6472 =item B<IgnoreSelected> I<true>|I<false>
6474 Invert the selection: If set to true, all devices B<except> the ones that
6475 match the device names specified by the B<Device> option are collected. By
6476 default only selected devices are collected if a selection is made. If no
6477 selection is configured at all, B<all> devices are selected.
6481 =head2 Plugin C<threshold>
6483 The I<Threshold plugin> checks values collected or received by I<collectd>
6484 against a configurable I<threshold> and issues I<notifications> if values are
6487 Documentation for this plugin is available in the L<collectd-threshold(5)>
6490 =head2 Plugin C<tokyotyrant>
6492 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6493 couple metrics: number of records, and database size on disk.
6497 =item B<Host> I<Hostname/IP>
6499 The hostname or ip which identifies the server.
6500 Default: B<127.0.0.1>
6502 =item B<Port> I<Service/Port>
6504 The query port of the server. This needs to be a string, even if the port is
6505 given in its numeric form.
6510 =head2 Plugin C<unixsock>
6514 =item B<SocketFile> I<Path>
6516 Sets the socket-file which is to be created.
6518 =item B<SocketGroup> I<Group>
6520 If running as root change the group of the UNIX-socket after it has been
6521 created. Defaults to B<collectd>.
6523 =item B<SocketPerms> I<Permissions>
6525 Change the file permissions of the UNIX-socket after it has been created. The
6526 permissions must be given as a numeric, octal value as you would pass to
6527 L<chmod(1)>. Defaults to B<0770>.
6529 =item B<DeleteSocket> B<false>|B<true>
6531 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6532 with the given name already exists. If I<collectd> crashes a socket file may be
6533 left over, preventing the daemon from opening a new socket when restarted.
6534 Since this is potentially dangerous, this defaults to B<false>.
6538 =head2 Plugin C<uuid>
6540 This plugin, if loaded, causes the Hostname to be taken from the machine's
6541 UUID. The UUID is a universally unique designation for the machine, usually
6542 taken from the machine's BIOS. This is most useful if the machine is running in
6543 a virtual environment such as Xen, in which case the UUID is preserved across
6544 shutdowns and migration.
6546 The following methods are used to find the machine's UUID, in order:
6552 Check I</etc/uuid> (or I<UUIDFile>).
6556 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6561 Check for UUID from C<dmidecode> / SMBIOS.
6565 Check for UUID from Xen hypervisor.
6569 If no UUID can be found then the hostname is not modified.
6573 =item B<UUIDFile> I<Path>
6575 Take the UUID from the given file (default I</etc/uuid>).
6579 =head2 Plugin C<varnish>
6581 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6582 It collects a subset of the values displayed by L<varnishstat(1)>, and
6583 organizes them in categories which can be enabled or disabled. Currently only
6584 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6585 meaning of each metric can be found in L<varnish-counters(7)>.
6590 <Instance "example">
6594 CollectConnections true
6595 CollectDirectorDNS false
6599 CollectObjects false
6601 CollectSession false
6611 CollectWorkers false
6615 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6616 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6617 will collectd statistics from the default "varnishd" instance (this should work
6618 fine in most cases).
6620 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6624 =item B<CollectBackend> B<true>|B<false>
6626 Back-end connection statistics, such as successful, reused,
6627 and closed connections. True by default.
6629 =item B<CollectBan> B<true>|B<false>
6631 Statistics about ban operations, such as number of bans added, retired, and
6632 number of objects tested against ban operations. Only available with Varnish
6633 3.x and above. False by default.
6635 =item B<CollectCache> B<true>|B<false>
6637 Cache hits and misses. True by default.
6639 =item B<CollectConnections> B<true>|B<false>
6641 Number of client connections received, accepted and dropped. True by default.
6643 =item B<CollectDirectorDNS> B<true>|B<false>
6645 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6648 =item B<CollectESI> B<true>|B<false>
6650 Edge Side Includes (ESI) parse statistics. False by default.
6652 =item B<CollectFetch> B<true>|B<false>
6654 Statistics about fetches (HTTP requests sent to the backend). False by default.
6656 =item B<CollectHCB> B<true>|B<false>
6658 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6659 divided into locked and unlocked look-ups. False by default.
6661 =item B<CollectObjects> B<true>|B<false>
6663 Statistics on cached objects: number of objects expired, nuked (prematurely
6664 expired), saved, moved, etc. False by default.
6666 =item B<CollectPurge> B<true>|B<false>
6668 Statistics about purge operations, such as number of purges added, retired, and
6669 number of objects tested against purge operations. Only available with Varnish
6670 2.x. False by default.
6672 =item B<CollectSession> B<true>|B<false>
6674 Client session statistics. Number of past and current sessions, session herd and
6675 linger counters, etc. False by default. Note that if using Varnish 4.x, some
6676 metrics found in the Connections and Threads sections with previous versions of
6677 Varnish have been moved here.
6679 =item B<CollectSHM> B<true>|B<false>
6681 Statistics about the shared memory log, a memory region to store
6682 log messages which is flushed to disk when full. True by default.
6684 =item B<CollectSMA> B<true>|B<false>
6686 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6687 component is Solaris specific. Only available with Varnish 2.x. False by
6690 =item B<CollectSMS> B<true>|B<false>
6692 synth (synthetic content) storage statistics. This storage
6693 component is used internally only. False by default.
6695 =item B<CollectSM> B<true>|B<false>
6697 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6700 =item B<CollectStruct> B<true>|B<false>
6702 Current varnish internal state statistics. Number of current sessions, objects
6703 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6706 =item B<CollectTotals> B<true>|B<false>
6708 Collects overview counters, such as the number of sessions created,
6709 the number of requests and bytes transferred. False by default.
6711 =item B<CollectUptime> B<true>|B<false>
6713 Varnish uptime. Only available with Varnish 3.x and above. False by default.
6715 =item B<CollectVCL> B<true>|B<false>
6717 Number of total (available + discarded) VCL (config files). False by default.
6719 =item B<CollectVSM> B<true>|B<false>
6721 Collect statistics about Varnish's shared memory usage (used by the logging and
6722 statistics subsystems). Only available with Varnish 4.x. False by default.
6724 =item B<CollectWorkers> B<true>|B<false>
6726 Collect statistics about worker threads. False by default.
6730 =head2 Plugin C<virt>
6732 This plugin allows CPU, disk and network load to be collected for virtualized
6733 guests on the machine. This means that these metrics can be collected for guest
6734 systems without installing any software on them - I<collectd> only runs on the
6735 host system. The statistics are collected through libvirt
6736 (L<http://libvirt.org/>).
6738 Only I<Connection> is required.
6742 =item B<Connection> I<uri>
6744 Connect to the hypervisor given by I<uri>. For example if using Xen use:
6746 Connection "xen:///"
6748 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
6750 =item B<RefreshInterval> I<seconds>
6752 Refresh the list of domains and devices every I<seconds>. The default is 60
6753 seconds. Setting this to be the same or smaller than the I<Interval> will cause
6754 the list of domains and devices to be refreshed on every iteration.
6756 Refreshing the devices in particular is quite a costly operation, so if your
6757 virtualization setup is static you might consider increasing this. If this
6758 option is set to 0, refreshing is disabled completely.
6760 =item B<Domain> I<name>
6762 =item B<BlockDevice> I<name:dev>
6764 =item B<InterfaceDevice> I<name:dev>
6766 =item B<IgnoreSelected> B<true>|B<false>
6768 Select which domains and devices are collected.
6770 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
6771 disk/network devices are collected.
6773 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
6774 domains and disk/network devices are ignored, while the rest are collected.
6776 The domain name and device names may use a regular expression, if the name is
6777 surrounded by I</.../> and collectd was compiled with support for regexps.
6779 The default is to collect statistics for all domains and all their devices.
6783 BlockDevice "/:hdb/"
6784 IgnoreSelected "true"
6786 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
6789 =item B<HostnameFormat> B<name|uuid|hostname|...>
6791 When the virt plugin logs data, it sets the hostname of the collected data
6792 according to this setting. The default is to use the guest name as provided by
6793 the hypervisor, which is equal to setting B<name>.
6795 B<uuid> means use the guest's UUID. This is useful if you want to track the
6796 same guest across migrations.
6798 B<hostname> means to use the global B<Hostname> setting, which is probably not
6799 useful on its own because all guests will appear to have the same name.
6801 You can also specify combinations of these fields. For example B<name uuid>
6802 means to concatenate the guest name and UUID (with a literal colon character
6803 between, thus I<"foo:1234-1234-1234-1234">).
6805 =item B<InterfaceFormat> B<name>|B<address>
6807 When the virt plugin logs interface data, it sets the name of the collected
6808 data according to this setting. The default is to use the path as provided by
6809 the hypervisor (the "dev" property of the target node), which is equal to
6812 B<address> means use the interface's mac address. This is useful since the
6813 interface path might change between reboots of a guest or across migrations.
6815 =item B<PluginInstanceFormat> B<name|uuid>
6817 When the virt plugin logs data, it sets the plugin_instance of the collected
6818 data according to this setting. The default is to use the guest name as provided
6819 by the hypervisor, which is equal to setting B<name>.
6821 B<uuid> means use the guest's UUID.
6825 =head2 Plugin C<vmem>
6827 The C<vmem> plugin collects information about the usage of virtual memory.
6828 Since the statistics provided by the Linux kernel are very detailed, they are
6829 collected very detailed. However, to get all the details, you have to switch
6830 them on manually. Most people just want an overview over, such as the number of
6831 pages read from swap space.
6835 =item B<Verbose> B<true>|B<false>
6837 Enables verbose collection of information. This will start collecting page
6838 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6839 Part of these statistics are collected on a "per zone" basis.
6843 =head2 Plugin C<vserver>
6845 This plugin doesn't have any options. B<VServer> support is only available for
6846 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6847 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6848 need to apply the patches and compile your own kernel, which will then provide
6849 the F</proc/virtual> filesystem that is required by this plugin.
6851 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6853 B<Note>: The traffic collected by this plugin accounts for the amount of
6854 traffic passing a socket which might be a lot less than the actual on-wire
6855 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6856 collect on-wire traffic you could, for example, use the logging facilities of
6857 iptables to feed data for the guest IPs into the iptables plugin.
6859 =head2 Plugin C<write_graphite>
6861 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6862 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6863 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6864 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6865 of at most 1428 bytes to minimize the number of network packets.
6869 <Plugin write_graphite>
6879 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6880 blocks. Inside the B<Node> blocks, the following options are recognized:
6884 =item B<Host> I<Address>
6886 Hostname or address to connect to. Defaults to C<localhost>.
6888 =item B<Port> I<Service>
6890 Service name or port number to connect to. Defaults to C<2003>.
6892 =item B<Protocol> I<String>
6894 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6896 =item B<LogSendErrors> B<false>|B<true>
6898 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6899 If set to B<false>, it will not log the errors. This is especially useful when
6900 using Protocol UDP since many times we want to use the "fire-and-forget"
6901 approach and logging errors fills syslog with unneeded messages.
6903 =item B<Prefix> I<String>
6905 When set, I<String> is added in front of the host name. Dots and whitespace are
6906 I<not> escaped in this string (see B<EscapeCharacter> below).
6908 =item B<Postfix> I<String>
6910 When set, I<String> is appended to the host name. Dots and whitespace are
6911 I<not> escaped in this string (see B<EscapeCharacter> below).
6913 =item B<EscapeCharacter> I<Char>
6915 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6916 in the identifier. The B<EscapeCharacter> option determines which character
6917 dots, whitespace and control characters are replaced with. Defaults to
6920 =item B<StoreRates> B<false>|B<true>
6922 If set to B<true> (the default), convert counter values to rates. If set to
6923 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6926 =item B<SeparateInstances> B<false>|B<true>
6928 If set to B<true>, the plugin instance and type instance will be in their own
6929 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6930 default), the plugin and plugin instance (and likewise the type and type
6931 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6933 =item B<AlwaysAppendDS> B<false>|B<true>
6935 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6936 identifier. If set to B<false> (the default), this is only done when there is
6941 =head2 Plugin C<write_tsdb>
6943 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6944 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6945 state daemon that ingests metrics and stores them in HBase. The plugin uses
6946 I<TCP> over the "line based" protocol with a default port 4242. The data will
6947 be sent in blocks of at most 1428 bytes to minimize the number of network
6954 Host "tsd-1.my.domain"
6956 HostTags "status=production"
6960 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6961 blocks. Inside the B<Node> blocks, the following options are recognized:
6965 =item B<Host> I<Address>
6967 Hostname or address to connect to. Defaults to C<localhost>.
6969 =item B<Port> I<Service>
6971 Service name or port number to connect to. Defaults to C<4242>.
6974 =item B<HostTags> I<String>
6976 When set, I<HostTags> is added to the end of the metric. It is intended to be
6977 used for name=value pairs that the TSD will tag the metric with. Dots and
6978 whitespace are I<not> escaped in this string.
6980 =item B<StoreRates> B<false>|B<true>
6982 If set to B<true>, convert counter values to rates. If set to B<false>
6983 (the default) counter values are stored as is, as an increasing
6986 =item B<AlwaysAppendDS> B<false>|B<true>
6988 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6989 identifier. If set to B<false> (the default), this is only done when there is
6994 =head2 Plugin C<write_mongodb>
6996 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7001 <Plugin "write_mongodb">
7010 The plugin can send values to multiple instances of I<MongoDB> by specifying
7011 one B<Node> block for each instance. Within the B<Node> blocks, the following
7012 options are available:
7016 =item B<Host> I<Address>
7018 Hostname or address to connect to. Defaults to C<localhost>.
7020 =item B<Port> I<Service>
7022 Service name or port number to connect to. Defaults to C<27017>.
7024 =item B<Timeout> I<Timeout>
7026 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7027 Setting this option to zero means no timeout, which is the default.
7029 =item B<StoreRates> B<false>|B<true>
7031 If set to B<true> (the default), convert counter values to rates. If set to
7032 B<false> counter values are stored as is, i.e. as an increasing integer
7035 =item B<Database> I<Database>
7037 =item B<User> I<User>
7039 =item B<Password> I<Password>
7041 Sets the information used when authenticating to a I<MongoDB> database. The
7042 fields are optional (in which case no authentication is attempted), but if you
7043 want to use authentication all three fields must be set.
7047 =head2 Plugin C<write_http>
7049 This output plugin submits values to an HTTP server using POST requests and
7050 encoding metrics with JSON or using the C<PUTVAL> command described in
7051 L<collectd-unixsock(5)>.
7055 <Plugin "write_http">
7057 URL "http://example.com/post-collectd"
7064 The plugin can send values to multiple HTTP servers by specifying one
7065 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7066 block, the following options are available:
7072 URL to which the values are submitted to. Mandatory.
7074 =item B<User> I<Username>
7076 Optional user name needed for authentication.
7078 =item B<Password> I<Password>
7080 Optional password needed for authentication.
7082 =item B<VerifyPeer> B<true>|B<false>
7084 Enable or disable peer SSL certificate verification. See
7085 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7087 =item B<VerifyHost> B<true|false>
7089 Enable or disable peer host name verification. If enabled, the plugin checks if
7090 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7091 matches the host name provided by the B<URL> option. If this identity check
7092 fails, the connection is aborted. Obviously, only works when connecting to a
7093 SSL enabled server. Enabled by default.
7095 =item B<CACert> I<File>
7097 File that holds one or more SSL certificates. If you want to use HTTPS you will
7098 possibly need this option. What CA certificates come bundled with C<libcurl>
7099 and are checked by default depends on the distribution you use.
7101 =item B<CAPath> I<Directory>
7103 Directory holding one or more CA certificate files. You can use this if for
7104 some reason all the needed CA certificates aren't in the same file and can't be
7105 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7108 =item B<ClientKey> I<File>
7110 File that holds the private key in PEM format to be used for certificate-based
7113 =item B<ClientCert> I<File>
7115 File that holds the SSL certificate to be used for certificate-based
7118 =item B<ClientKeyPass> I<Password>
7120 Password required to load the private key in B<ClientKey>.
7122 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7124 Define which SSL protocol version must be used. By default C<libcurl> will
7125 attempt to figure out the remote SSL protocol version. See
7126 L<curl_easy_setopt(3)> for more details.
7128 =item B<Format> B<Command>|B<JSON>
7130 Format of the output to generate. If set to B<Command>, will create output that
7131 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7132 create output in the I<JavaScript Object Notation> (JSON).
7134 Defaults to B<Command>.
7136 =item B<StoreRates> B<true|false>
7138 If set to B<true>, convert counter values to rates. If set to B<false> (the
7139 default) counter values are stored as is, i.e. as an increasing integer number.
7141 =item B<BufferSize> I<Bytes>
7143 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7144 requests will be generated, but more metrics will be batched / metrics are
7145 cached for longer before being sent, introducing additional delay until they
7146 are available on the server side. I<Bytes> must be at least 1024 and cannot
7147 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7148 Defaults to C<4096>.
7152 =head2 Plugin C<write_kafka>
7154 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7158 <Plugin "write_kafka">
7159 Property "metadata.broker.list" "broker1:9092,broker2:9092"
7165 The following options are understood by the I<write_kafka plugin>:
7169 =item E<lt>B<Topic> I<Name>E<gt>
7171 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7172 is given a unique I<Name> and specifies one kafka producer.
7173 Inside the B<Topic> block, the following per-topic options are
7178 =item B<Property> I<String> I<String>
7180 Configure the named property for the current topic. Properties are
7181 forwarded to the kafka producer library B<librdkafka>.
7183 =item B<Key> I<String>
7185 Use the specified string as a partioning key for the topic. Kafka breaks
7186 topic into partitions and guarantees that for a given topology, the same
7187 consumer will be used for a specific key. The special (case insensitive)
7188 string B<Random> can be used to specify that an arbitrary partition should
7191 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7193 Selects the format in which messages are sent to the broker. If set to
7194 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7195 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7197 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7198 an easy and straight forward exchange format.
7200 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7201 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7203 =item B<StoreRates> B<true>|B<false>
7205 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7206 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7207 default), no conversion is performed. Otherwise the conversion is performed
7208 using the internal value cache.
7210 Please note that currently this option is only used if the B<Format> option has
7211 been set to B<JSON>.
7213 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7215 A prefix can be added in the metric name when outputting in the I<Graphite>
7216 format. It's added before the I<Host> name.
7218 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>>
7220 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7222 A postfix can be added in the metric name when outputting in the I<Graphite>
7223 format. It's added after the I<Host> name.
7225 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>>
7227 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7229 Specify a character to replace dots (.) in the host part of the metric name.
7230 In I<Graphite> metric name, dots are used as separators between different
7231 metric parts (host, plugin, type).
7232 Default is C<_> (I<Underscore>).
7234 =item B<GraphiteSeparateInstances> B<false>|B<true>
7236 If set to B<true>, the plugin instance and type instance will be in their own
7237 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7238 default), the plugin and plugin instance (and likewise the type and type
7239 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7241 =item B<StoreRates> B<true>|B<false>
7243 If set to B<true> (the default), convert counter values to rates. If set to
7244 B<false> counter values are stored as is, i.e. as an increasing integer number.
7246 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7247 converted values will have "rate" appended to the data source type, e.g.
7248 C<ds_type:derive:rate>.
7252 =item B<Property> I<String> I<String>
7254 Configure the kafka producer through properties, you almost always will
7255 want to set B<metadata.broker.list> to your Kafka broker list.
7259 =head2 Plugin C<write_redis>
7261 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7265 <Plugin "write_redis">
7273 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7274 the timestamp as the score. Retrieving a date range can then be done using the
7275 C<ZRANGEBYSCORE> I<Redis> command. Additionnally, all the identifiers of these
7276 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
7277 retrieved using the C<SMEMBERS> I<Redis> command. See
7278 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7281 The information shown in the synopsis above is the I<default configuration>
7282 which is used by the plugin if no configuration is present.
7284 The plugin can send values to multiple instances of I<Redis> by specifying
7285 one B<Node> block for each instance. Within the B<Node> blocks, the following
7286 options are available:
7290 =item B<Node> I<Nodename>
7292 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7293 instance running in an specified host and port. The name for node is a
7294 canonical identifier which is used as I<plugin instance>. It is limited to
7295 64E<nbsp>characters in length.
7297 =item B<Host> I<Hostname>
7299 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7302 =item B<Port> I<Port>
7304 The B<Port> option is the TCP port on which the Redis instance accepts
7305 connections. Either a service name of a port number may be given. Please note
7306 that numerical port numbers must be given as a string, too.
7308 =item B<Timeout> I<Timeout in miliseconds>
7310 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7314 =head2 Plugin C<write_riemann>
7316 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7317 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7318 I<Riemann> using UDP packets.
7322 <Plugin "write_riemann">
7328 AlwaysAppendDS false
7332 Attribute "foo" "bar"
7335 The following options are understood by the I<write_riemann plugin>:
7339 =item E<lt>B<Node> I<Name>E<gt>
7341 The plugin's configuration consists of one or more B<Node> blocks. Each block
7342 is given a unique I<Name> and specifies one connection to an instance of
7343 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7348 =item B<Host> I<Address>
7350 Hostname or address to connect to. Defaults to C<localhost>.
7352 =item B<Port> I<Service>
7354 Service name or port number to connect to. Defaults to C<5555>.
7356 =item B<Protocol> B<UDP>|B<TCP>
7358 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7361 =item B<Batch> B<true>|B<false>
7363 If set to B<true> and B<Protocol> is set to B<TCP>,
7364 events will be batched in memory and flushed at
7365 regular intervals or when B<BatchMaxSize> is exceeded.
7367 Notifications are not batched and sent as soon as possible.
7369 When enabled, it can occur that events get processed by the Riemann server
7370 close to or after their expiration time. Tune the B<TTLFactor> and
7371 B<BatchMaxSize> settings according to the amount of values collected, if this
7376 =item B<BatchMaxSize> I<size>
7378 Maximum payload size for a riemann packet. Defaults to 8192
7380 =item B<StoreRates> B<true>|B<false>
7382 If set to B<true> (the default), convert counter values to rates. If set to
7383 B<false> counter values are stored as is, i.e. as an increasing integer number.
7385 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7386 converted values will have "rate" appended to the data source type, e.g.
7387 C<ds_type:derive:rate>.
7389 =item B<AlwaysAppendDS> B<false>|B<true>
7391 If set the B<true>, append the name of the I<Data Source> (DS) to the
7392 "service", i.e. the field that, together with the "host" field, uniquely
7393 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7394 only done when there is more than one DS.
7396 =item B<TTLFactor> I<Factor>
7398 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7399 event is considered active. I<collectd> populates this field based on the
7400 metrics interval setting. This setting controls the factor with which the
7401 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7402 know exactly what you're doing, you should only increase this setting from its
7405 =item B<Notifications> B<false>|B<true>
7407 If set to B<true>, create riemann events for notifications. This is B<true>
7408 by default. When processing thresholds from write_riemann, it might prove
7409 useful to avoid getting notification events.
7411 =item B<CheckThresholds> B<false>|B<true>
7413 If set to B<true>, attach state to events based on thresholds defined
7414 in the B<Threshold> plugin. Defaults to B<false>.
7416 =item B<EventServicePrefix> I<String>
7418 Add the given string as a prefix to the event service name.
7419 If B<EventServicePrefix> not set or set to an empty string (""),
7420 no prefix will be used.
7424 =item B<Tag> I<String>
7426 Add the given string as an additional tag to the metric being sent to
7429 =item B<Attribute> I<String> I<String>
7431 Consider the two given strings to be the key and value of an additional
7432 attribute for each metric being sent out to I<Riemann>.
7436 =head2 Plugin C<zookeeper>
7438 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
7439 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
7444 <Plugin "zookeeper">
7451 =item B<Host> I<Address>
7453 Hostname or address to connect to. Defaults to C<localhost>.
7455 =item B<Port> I<Service>
7457 Service name or port number to connect to. Defaults to C<2181>.
7461 =head1 THRESHOLD CONFIGURATION
7463 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7464 we mean that the values are not only stored or sent somewhere, but that they
7465 are judged and, if a problem is recognized, acted upon. The only action
7466 collectd takes itself is to generate and dispatch a "notification". Plugins can
7467 register to receive notifications and perform appropriate further actions.
7469 Since systems and what you expect them to do differ a lot, you can configure
7470 B<thresholds> for your values freely. This gives you a lot of flexibility but
7471 also a lot of responsibility.
7473 Every time a value is out of range a notification is dispatched. This means
7474 that the idle percentage of your CPU needs to be less then the configured
7475 threshold only once for a notification to be generated. There's no such thing
7476 as a moving average or similar - at least not now.
7478 Also, all values that match a threshold are considered to be relevant or
7479 "interesting". As a consequence collectd will issue a notification if they are
7480 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7481 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7482 "2" (the default) and some hosts sends it's CPU statistics to the server every
7483 60 seconds, a notification will be dispatched after about 120 seconds. It may
7484 take a little longer because the timeout is checked only once each B<Interval>
7487 When a value comes within range again or is received after it was missing, an
7488 "OKAY-notification" is dispatched.
7490 Here is a configuration example to get you started. Read below for more
7503 <Plugin "interface">
7520 WarningMin 100000000
7526 There are basically two types of configuration statements: The C<Host>,
7527 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7528 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7529 C<Instance> option. You can combine the block by nesting the blocks, though
7530 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7531 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7532 C<Type> may not contain other blocks. If multiple blocks apply to the same
7533 value the most specific block is used.
7535 The other statements specify the threshold to configure. They B<must> be
7536 included in a C<Type> block. Currently the following statements are recognized:
7540 =item B<FailureMax> I<Value>
7542 =item B<WarningMax> I<Value>
7544 Sets the upper bound of acceptable values. If unset defaults to positive
7545 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7546 will be created. If the value is greater than B<WarningMax> but less than (or
7547 equal to) B<FailureMax> a B<WARNING> notification will be created.
7549 =item B<FailureMin> I<Value>
7551 =item B<WarningMin> I<Value>
7553 Sets the lower bound of acceptable values. If unset defaults to negative
7554 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7555 be created. If the value is less than B<WarningMin> but greater than (or equal
7556 to) B<FailureMin> a B<WARNING> notification will be created.
7558 =item B<DataSource> I<DSName>
7560 Some data sets have more than one "data source". Interesting examples are the
7561 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7562 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7563 system load data set, C<load>, even has three data sources: C<shortterm>,
7564 C<midterm>, and C<longterm>.
7566 Normally, all data sources are checked against a configured threshold. If this
7567 is undesirable, or if you want to specify different limits for each data
7568 source, you can use the B<DataSource> option to have a threshold apply only to
7571 =item B<Invert> B<true>|B<false>
7573 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7574 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7575 B<WarningMax>) are not okay. Defaults to B<false>.
7577 =item B<Persist> B<true>|B<false>
7579 Sets how often notifications are generated. If set to B<true> one notification
7580 will be generated for each value that is out of the acceptable range. If set to
7581 B<false> (the default) then a notification is only generated if a value is out
7582 of range but the previous value was okay.
7584 This applies to missing values, too: If set to B<true> a notification about a
7585 missing value is generated once every B<Interval> seconds. If set to B<false>
7586 only one such notification is generated until the value appears again.
7588 =item B<Percentage> B<true>|B<false>
7590 If set to B<true>, the minimum and maximum values given are interpreted as
7591 percentage value, relative to the other data sources. This is helpful for
7592 example for the "df" type, where you may want to issue a warning when less than
7593 5E<nbsp>% of the total space is available. Defaults to B<false>.
7595 =item B<Hits> I<Number>
7597 Delay creating the notification until the threshold has been passed I<Number>
7598 times. When a notification has been generated, or when a subsequent value is
7599 inside the threshold, the counter is reset. If, for example, a value is
7600 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7601 will be dispatched at most once every 30E<nbsp>seconds.
7603 This is useful when short bursts are not a problem. If, for example, 100% CPU
7604 usage for up to a minute is normal (and data is collected every
7605 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7607 =item B<Hysteresis> I<Number>
7609 When set to non-zero, a hysteresis value is applied when checking minimum and
7610 maximum bounds. This is useful for values that increase slowly and fluctuate a
7611 bit while doing so. When these values come close to the threshold, they may
7612 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7614 If, for example, the threshold is configures as
7619 then a I<Warning> notification is created when the value exceeds I<101> and the
7620 corresponding I<Okay> notification is only created once the value falls below
7621 I<99>, thus avoiding the "flapping".
7625 =head1 FILTER CONFIGURATION
7627 Starting with collectd 4.6 there is a powerful filtering infrastructure
7628 implemented in the daemon. The concept has mostly been copied from
7629 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7630 terminology, so that users that are familiar with iptables feel right at home.
7634 The following are the terms used in the remainder of the filter configuration
7635 documentation. For an ASCII-art schema of the mechanism, see
7636 L<"General structure"> below.
7642 A I<match> is a criteria to select specific values. Examples are, of course, the
7643 name of the value or it's current value.
7645 Matches are implemented in plugins which you have to load prior to using the
7646 match. The name of such plugins starts with the "match_" prefix.
7650 A I<target> is some action that is to be performed with data. Such actions
7651 could, for example, be to change part of the value's identifier or to ignore
7652 the value completely.
7654 Some of these targets are built into the daemon, see L<"Built-in targets">
7655 below. Other targets are implemented in plugins which you have to load prior to
7656 using the target. The name of such plugins starts with the "target_" prefix.
7660 The combination of any number of matches and at least one target is called a
7661 I<rule>. The target actions will be performed for all values for which B<all>
7662 matches apply. If the rule does not have any matches associated with it, the
7663 target action will be performed for all values.
7667 A I<chain> is a list of rules and possibly default targets. The rules are tried
7668 in order and if one matches, the associated target will be called. If a value
7669 is handled by a rule, it depends on the target whether or not any subsequent
7670 rules are considered or if traversal of the chain is aborted, see
7671 L<"Flow control"> below. After all rules have been checked, the default targets
7676 =head2 General structure
7678 The following shows the resulting structure:
7685 +---------+ +---------+ +---------+ +---------+
7686 ! Rule !->! Match !->! Match !->! Target !
7687 +---------+ +---------+ +---------+ +---------+
7690 +---------+ +---------+ +---------+
7691 ! Rule !->! Target !->! Target !
7692 +---------+ +---------+ +---------+
7699 +---------+ +---------+ +---------+
7700 ! Rule !->! Match !->! Target !
7701 +---------+ +---------+ +---------+
7711 There are four ways to control which way a value takes through the filter
7718 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7719 process the value with another chain. When the called chain finishes, usually
7720 the next target or rule after the jump is executed.
7724 The stop condition, signaled for example by the built-in target B<stop>, causes
7725 all processing of the value to be stopped immediately.
7729 Causes processing in the current chain to be aborted, but processing of the
7730 value generally will continue. This means that if the chain was called via
7731 B<Jump>, the next target or rule after the jump will be executed. If the chain
7732 was not called by another chain, control will be returned to the daemon and it
7733 may pass the value to another chain.
7737 Most targets will signal the B<continue> condition, meaning that processing
7738 should continue normally. There is no special built-in target for this
7745 The configuration reflects this structure directly:
7747 PostCacheChain "PostCache"
7749 <Rule "ignore_mysql_show">
7752 Type "^mysql_command$"
7753 TypeInstance "^show_"
7763 The above configuration example will ignore all values where the plugin field
7764 is "mysql", the type is "mysql_command" and the type instance begins with
7765 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7766 default target of the chain. Since this chain is run after the value has been
7767 added to the cache, the MySQL C<show_*> command statistics will be available
7768 via the C<unixsock> plugin.
7770 =head2 List of configuration options
7774 =item B<PreCacheChain> I<ChainName>
7776 =item B<PostCacheChain> I<ChainName>
7778 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7779 argument is the name of a I<chain> that should be executed before and/or after
7780 the values have been added to the cache.
7782 To understand the implications, it's important you know what is going on inside
7783 I<collectd>. The following diagram shows how values are passed from the
7784 read-plugins to the write-plugins:
7790 + - - - - V - - - - +
7791 : +---------------+ :
7794 : +-------+-------+ :
7797 : +-------+-------+ : +---------------+
7798 : ! Cache !--->! Value Cache !
7799 : ! insert ! : +---+---+-------+
7800 : +-------+-------+ : ! !
7801 : ! ,------------' !
7803 : +-------+---+---+ : +-------+-------+
7804 : ! Post-Cache +--->! Write-Plugins !
7805 : ! Chain ! : +---------------+
7806 : +---------------+ :
7809 + - - - - - - - - - +
7811 After the values are passed from the "read" plugins to the dispatch functions,
7812 the pre-cache chain is run first. The values are added to the internal cache
7813 afterwards. The post-cache chain is run after the values have been added to the
7814 cache. So why is it such a huge deal if chains are run before or after the
7815 values have been added to this cache?
7817 Targets that change the identifier of a value list should be executed before
7818 the values are added to the cache, so that the name in the cache matches the
7819 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7820 this cache to receive a list of all available values. If you change the
7821 identifier after the value list has been added to the cache, this may easily
7822 lead to confusion, but it's not forbidden of course.
7824 The cache is also used to convert counter values to rates. These rates are, for
7825 example, used by the C<value> match (see below). If you use the rate stored in
7826 the cache B<before> the new value is added, you will use the old, B<previous>
7827 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7828 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7831 Last but not last, the B<stop> target makes a difference: If the pre-cache
7832 chain returns the stop condition, the value will not be added to the cache and
7833 the post-cache chain will not be run.
7835 =item B<Chain> I<Name>
7837 Adds a new chain with a certain name. This name can be used to refer to a
7838 specific chain, for example to jump to it.
7840 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7842 =item B<Rule> [I<Name>]
7844 Adds a new rule to the current chain. The name of the rule is optional and
7845 currently has no meaning for the daemon.
7847 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7848 must be at least one B<Target> block.
7850 =item B<Match> I<Name>
7852 Adds a match to a B<Rule> block. The name specifies what kind of match should
7853 be performed. Available matches depend on the plugins that have been loaded.
7855 The arguments inside the B<Match> block are passed to the plugin implementing
7856 the match, so which arguments are valid here depends on the plugin being used.
7857 If you do not need any to pass any arguments to a match, you can use the
7862 Which is equivalent to:
7867 =item B<Target> I<Name>
7869 Add a target to a rule or a default target to a chain. The name specifies what
7870 kind of target is to be added. Which targets are available depends on the
7871 plugins being loaded.
7873 The arguments inside the B<Target> block are passed to the plugin implementing
7874 the target, so which arguments are valid here depends on the plugin being used.
7875 If you do not need any to pass any arguments to a target, you can use the
7880 This is the same as writing:
7887 =head2 Built-in targets
7889 The following targets are built into the core daemon and therefore need no
7890 plugins to be loaded:
7896 Signals the "return" condition, see the L<"Flow control"> section above. This
7897 causes the current chain to stop processing the value and returns control to
7898 the calling chain. The calling chain will continue processing targets and rules
7899 just after the B<jump> target (see below). This is very similar to the
7900 B<RETURN> target of iptables, see L<iptables(8)>.
7902 This target does not have any options.
7910 Signals the "stop" condition, see the L<"Flow control"> section above. This
7911 causes processing of the value to be aborted immediately. This is similar to
7912 the B<DROP> target of iptables, see L<iptables(8)>.
7914 This target does not have any options.
7922 Sends the value to "write" plugins.
7928 =item B<Plugin> I<Name>
7930 Name of the write plugin to which the data should be sent. This option may be
7931 given multiple times to send the data to more than one write plugin. If the
7932 plugin supports multiple instances, the plugin's instance(s) must also be
7937 If no plugin is explicitly specified, the values will be sent to all available
7940 Single-instance plugin example:
7946 Multi-instance plugin example:
7948 <Plugin "write_graphite">
7958 Plugin "write_graphite/foo"
7963 Starts processing the rules of another chain, see L<"Flow control"> above. If
7964 the end of that chain is reached, or a stop condition is encountered,
7965 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7966 next target or the next rule. This is similar to the B<-j> command line option
7967 of iptables, see L<iptables(8)>.
7973 =item B<Chain> I<Name>
7975 Jumps to the chain I<Name>. This argument is required and may appear only once.
7987 =head2 Available matches
7993 Matches a value using regular expressions.
7999 =item B<Host> I<Regex>
8001 =item B<Plugin> I<Regex>
8003 =item B<PluginInstance> I<Regex>
8005 =item B<Type> I<Regex>
8007 =item B<TypeInstance> I<Regex>
8009 Match values where the given regular expressions match the various fields of
8010 the identifier of a value. If multiple regular expressions are given, B<all>
8011 regexen must match for a value to match.
8013 =item B<Invert> B<false>|B<true>
8015 When set to B<true>, the result of the match is inverted, i.e. all value lists
8016 where all regular expressions apply are not matched, all other value lists are
8017 matched. Defaults to B<false>.
8024 Host "customer[0-9]+"
8030 Matches values that have a time which differs from the time on the server.
8032 This match is mainly intended for servers that receive values over the
8033 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8034 is very sensitive to the timestamp used when updating the RRD files. In
8035 particular, the time must be ever increasing. If a misbehaving client sends one
8036 packet with a timestamp far in the future, all further packets with a correct
8037 time will be ignored because of that one packet. What's worse, such corrupted
8038 RRD files are hard to fix.
8040 This match lets one match all values B<outside> a specified time range
8041 (relative to the server's time), so you can use the B<stop> target (see below)
8042 to ignore the value, for example.
8048 =item B<Future> I<Seconds>
8050 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8051 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8054 =item B<Past> I<Seconds>
8056 Matches all values that are I<behind> of the server's time by I<Seconds> or
8057 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8069 This example matches all values that are five minutes or more ahead of the
8070 server or one hour (or more) lagging behind.
8074 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8075 values. If a data-set consists of more than one data-source, all data-sources
8076 must match the specified ranges for a positive match.
8082 =item B<Min> I<Value>
8084 Sets the smallest value which still results in a match. If unset, behaves like
8087 =item B<Max> I<Value>
8089 Sets the largest value which still results in a match. If unset, behaves like
8092 =item B<Invert> B<true>|B<false>
8094 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8095 no-match is returned and vice versa. Please note that the B<Invert> setting
8096 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8097 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8099 =item B<DataSource> I<DSName> [I<DSName> ...]
8101 Select one or more of the data sources. If no data source is configured, all
8102 data sources will be checked. If the type handled by the match does not have a
8103 data source of the specified name(s), this will always result in no match
8104 (independent of the B<Invert> setting).
8106 =item B<Satisfy> B<Any>|B<All>
8108 Specifies how checking with several data sources is performed. If set to
8109 B<Any>, the match succeeds if one of the data sources is in the configured
8110 range. If set to B<All> the match only succeeds if all data sources are within
8111 the configured range. Default is B<All>.
8113 Usually B<All> is used for positive matches, B<Any> is used for negative
8114 matches. This means that with B<All> you usually check that all values are in a
8115 "good" range, while with B<Any> you check if any value is within a "bad" range
8116 (or outside the "good" range).
8120 Either B<Min> or B<Max>, but not both, may be unset.
8124 # Match all values smaller than or equal to 100. Matches only if all data
8125 # sources are below 100.
8131 # Match if the value of any data source is outside the range of 0 - 100.
8139 =item B<empty_counter>
8141 Matches all values with one or more data sources of type B<COUNTER> and where
8142 all counter values are zero. These counters usually I<never> increased since
8143 they started existing (and are therefore uninteresting), or got reset recently
8144 or overflowed and you had really, I<really> bad luck.
8146 Please keep in mind that ignoring such counters can result in confusing
8147 behavior: Counters which hardly ever increase will be zero for long periods of
8148 time. If the counter is reset for some reason (machine or service restarted,
8149 usually), the graph will be empty (NAN) for a long time. People may not
8154 Calculates a hash value of the host name and matches values according to that
8155 hash value. This makes it possible to divide all hosts into groups and match
8156 only values that are in a specific group. The intended use is in load
8157 balancing, where you want to handle only part of all data and leave the rest
8160 The hashing function used tries to distribute the hosts evenly. First, it
8161 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8164 for (i = 0; host[i] != 0; i++)
8165 hash_value = (hash_value * 251) + host[i];
8167 The constant 251 is a prime number which is supposed to make this hash value
8168 more random. The code then checks the group for this host according to the
8169 I<Total> and I<Match> arguments:
8171 if ((hash_value % Total) == Match)
8176 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8177 groups), then the least significant bit of the hash value will be the XOR of
8178 all least significant bits in the host name. One consequence is that when you
8179 have two hosts, "server0.example.com" and "server1.example.com", where the host
8180 name differs in one digit only and the digits differ by one, those hosts will
8181 never end up in the same group.
8187 =item B<Match> I<Match> I<Total>
8189 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8190 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8191 be smaller than I<Total>. I<Total> must be at least one, although only values
8192 greater than one really do make any sense.
8194 You can repeat this option to match multiple groups, for example:
8199 The above config will divide the data into seven groups and match groups three
8200 and five. One use would be to keep every value on two hosts so that if one
8201 fails the missing data can later be reconstructed from the second host.
8207 # Operate on the pre-cache chain, so that ignored values are not even in the
8212 # Divide all received hosts in seven groups and accept all hosts in
8216 # If matched: Return and continue.
8219 # If not matched: Return and stop.
8225 =head2 Available targets
8229 =item B<notification>
8231 Creates and dispatches a notification.
8237 =item B<Message> I<String>
8239 This required option sets the message of the notification. The following
8240 placeholders will be replaced by an appropriate value:
8248 =item B<%{plugin_instance}>
8252 =item B<%{type_instance}>
8254 These placeholders are replaced by the identifier field of the same name.
8256 =item B<%{ds:>I<name>B<}>
8258 These placeholders are replaced by a (hopefully) human readable representation
8259 of the current rate of this data source. If you changed the instance name
8260 (using the B<set> or B<replace> targets, see below), it may not be possible to
8261 convert counter values to rates.
8265 Please note that these placeholders are B<case sensitive>!
8267 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8269 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8276 <Target "notification">
8277 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8283 Replaces parts of the identifier using regular expressions.
8289 =item B<Host> I<Regex> I<Replacement>
8291 =item B<Plugin> I<Regex> I<Replacement>
8293 =item B<PluginInstance> I<Regex> I<Replacement>
8295 =item B<TypeInstance> I<Regex> I<Replacement>
8297 Match the appropriate field with the given regular expression I<Regex>. If the
8298 regular expression matches, that part that matches is replaced with
8299 I<Replacement>. If multiple places of the input buffer match a given regular
8300 expression, only the first occurrence will be replaced.
8302 You can specify each option multiple times to use multiple regular expressions
8310 # Replace "example.net" with "example.com"
8311 Host "\\<example.net\\>" "example.com"
8313 # Strip "www." from hostnames
8319 Sets part of the identifier of a value to a given string.
8325 =item B<Host> I<String>
8327 =item B<Plugin> I<String>
8329 =item B<PluginInstance> I<String>
8331 =item B<TypeInstance> I<String>
8333 Set the appropriate field to the given string. The strings for plugin instance
8334 and type instance may be empty, the strings for host and plugin may not be
8335 empty. It's currently not possible to set the type of a value this way.
8342 PluginInstance "coretemp"
8343 TypeInstance "core3"
8348 =head2 Backwards compatibility
8350 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8351 B<Chain> block, it will behave as it used to. This is equivalent to the
8352 following configuration:
8358 If you specify a B<PostCacheChain>, the B<write> target will not be added
8359 anywhere and you will have to make sure that it is called where appropriate. We
8360 suggest to add the above snippet as default target to your "PostCache" chain.
8364 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8380 L<collectd-exec(5)>,
8381 L<collectd-perl(5)>,
8382 L<collectd-unixsock(5)>,
8395 Florian Forster E<lt>octo@collectd.orgE<gt>