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<Include> I<Path> [I<pattern>]
151 If I<Path> points to a file, includes that file. If I<Path> points to a
152 directory, recursively includes all files within that directory and its
153 subdirectories. If the C<wordexp> function is available on your system,
154 shell-like wildcards are expanded before files are included. This means you can
155 use statements like the following:
157 Include "/etc/collectd.d/*.conf"
159 Starting with version 5.3, this may also be a block in which further options
160 affecting the behavior of B<Include> may be specified. The following option is
163 <Include "/etc/collectd.d">
169 =item B<Filter> I<pattern>
171 If the C<fnmatch> function is available on your system, a shell-like wildcard
172 I<pattern> may be specified to filter which files to include. This may be used
173 in combination with recursively including a directory to easily be able to
174 arbitrarily mix configuration files and other documents (e.g. README files).
175 The given example is similar to the first example above but includes all files
176 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
178 Include "/etc/collectd.d" "*.conf"
182 If more than one files are included by a single B<Include> option, the files
183 will be included in lexicographical order (as defined by the C<strcmp>
184 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
185 order in which the files are loaded.
187 To prevent loops and shooting yourself in the foot in interesting ways the
188 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
189 most uses. Since symlinks are followed it is still possible to crash the daemon
190 by looping symlinks. In our opinion significant stupidity should result in an
191 appropriate amount of pain.
193 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
194 file, but you cannot include files from within blocks.
196 =item B<PIDFile> I<File>
198 Sets where to write the PID file to. This file is overwritten when it exists
199 and deleted when the program is stopped. Some init-scripts might override this
200 setting using the B<-P> command-line option.
202 =item B<PluginDir> I<Directory>
204 Path to the plugins (shared objects) of collectd.
206 =item B<TypesDB> I<File> [I<File> ...]
208 Set one or more files that contain the data-set descriptions. See
209 L<types.db(5)> for a description of the format of this file.
211 =item B<Interval> I<Seconds>
213 Configures the interval in which to query the read plugins. Obviously smaller
214 values lead to a higher system load produced by collectd, while higher values
215 lead to more coarse statistics.
217 B<Warning:> You should set this once and then never touch it again. If you do,
218 I<you will have to delete all your RRD files> or know some serious RRDtool
219 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
221 =item B<MaxReadInterval> I<Seconds>
223 Read plugin doubles interval between queries after each failed attempt
226 This options limits the maximum value of the interval. The default value is
229 =item B<Timeout> I<Iterations>
231 Consider a value list "missing" when no update has been read or received for
232 I<Iterations> iterations. By default, I<collectd> considers a value list
233 missing when no update has been received for twice the update interval. Since
234 this setting uses iterations, the maximum allowed time without update depends
235 on the I<Interval> information contained in each value list. This is used in
236 the I<Threshold> configuration to dispatch notifications about missing values,
237 see L<collectd-threshold(5)> for details.
239 =item B<ReadThreads> I<Num>
241 Number of threads to start for reading plugins. The default value is B<5>, but
242 you may want to increase this if you have more than five plugins that take a
243 long time to read. Mostly those are plugins that do network-IO. Setting this to
244 a value higher than the number of registered read callbacks is not recommended.
246 =item B<WriteThreads> I<Num>
248 Number of threads to start for dispatching value lists to write plugins. The
249 default value is B<5>, but you may want to increase this if you have more than
250 five plugins that may take relatively long to write to.
252 =item B<WriteQueueLimitHigh> I<HighNum>
254 =item B<WriteQueueLimitLow> I<LowNum>
256 Metrics are read by the I<read threads> and then put into a queue to be handled
257 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
258 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
259 running into memory issues in such a case, you can limit the size of this
262 By default, there is no limit and memory may grow indefinitely. This is most
263 likely not an issue for clients, i.e. instances that only handle the local
264 metrics. For servers it is recommended to set this to a non-zero value, though.
266 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
267 Each of them takes a numerical argument which is the number of metrics in the
268 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
269 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
270 I<will> be enqueued. If the number of metrics currently in the queue is between
271 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
272 proportional to the number of metrics in the queue (i.e. it increases linearly
273 until it reaches 100%.)
275 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
276 unset, the latter will default to half of B<WriteQueueLimitHigh>.
278 If you do not want to randomly drop values when the queue size is between
279 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
280 B<WriteQueueLimitLow> to same value.
282 =item B<Hostname> I<Name>
284 Sets the hostname that identifies a host. If you omit this setting, the
285 hostname will be determined using the L<gethostname(2)> system call.
287 =item B<FQDNLookup> B<true|false>
289 If B<Hostname> is determined automatically this setting controls whether or not
290 the daemon should try to figure out the "fully qualified domain name", FQDN.
291 This is done using a lookup of the name returned by C<gethostname>. This option
292 is enabled by default.
294 =item B<PreCacheChain> I<ChainName>
296 =item B<PostCacheChain> I<ChainName>
298 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
299 see L<FILTER CONFIGURATION> below on information on chains and how these
300 setting change the daemon's behavior.
304 =head1 PLUGIN OPTIONS
306 Some plugins may register own options. These options must be enclosed in a
307 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
308 require external configuration, too. The C<apache plugin>, for example,
309 required C<mod_status> to be configured in the webserver you're going to
310 collect data from. These plugins are listed below as well, even if they don't
311 require any configuration within collectd's configuration file.
313 A list of all plugins and a short summary for each plugin can be found in the
314 F<README> file shipped with the sourcecode and hopefully binary packets as
317 =head2 Plugin C<aggregation>
319 The I<Aggregation plugin> makes it possible to aggregate several values into
320 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
321 This can be put to a wide variety of uses, e.g. average and total CPU
322 statistics for your entire fleet.
324 The grouping is powerful but, as with many powerful tools, may be a bit
325 difficult to wrap your head around. The grouping will therefore be
326 demonstrated using an example: The average and sum of the CPU usage across
327 all CPUs of each host is to be calculated.
329 To select all the affected values for our example, set C<Plugin cpu> and
330 C<Type cpu>. The other values are left unspecified, meaning "all values". The
331 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
332 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
338 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
339 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
340 example, the intention is to have a new value for each host / type instance
341 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
342 It can be specified multiple times to group by more than one field.
345 GroupBy "TypeInstance"
347 We do neither specify nor group by I<plugin instance> (the CPU number), so all
348 metrics that differ in the CPU number only will be aggregated. Each
349 aggregation needs I<at least one> such field, otherwise no aggregation would
352 The full example configuration looks like this:
354 <Plugin "aggregation">
360 GroupBy "TypeInstance"
363 CalculateAverage true
367 There are a couple of limitations you should be aware of:
373 The I<Type> cannot be left unspecified, because it is not reasonable to add
374 apples to oranges. Also, the internal lookup structure won't work if you try
379 There must be at least one unspecified, ungrouped field. Otherwise nothing
384 As you can see in the example above, each aggregation has its own
385 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
386 blocks may match the same values, i.e. one value list can update multiple
387 aggregations. The following options are valid inside B<Aggregation> blocks:
391 =item B<Host> I<Host>
393 =item B<Plugin> I<Plugin>
395 =item B<PluginInstance> I<PluginInstance>
397 =item B<Type> I<Type>
399 =item B<TypeInstance> I<TypeInstance>
401 Selects the value lists to be added to this aggregation. B<Type> must be a
402 valid data set name, see L<types.db(5)> for details.
404 If the string starts with and ends with a slash (C</>), the string is
405 interpreted as a I<regular expression>. The regex flavor used are POSIX
406 extended regular expressions as described in L<regex(7)>. Example usage:
408 Host "/^db[0-9]\\.example\\.com$/"
410 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
412 Group valued by the specified field. The B<GroupBy> option may be repeated to
413 group by multiple fields.
415 =item B<SetHost> I<Host>
417 =item B<SetPlugin> I<Plugin>
419 =item B<SetPluginInstance> I<PluginInstance>
421 =item B<SetTypeInstance> I<TypeInstance>
423 Sets the appropriate part of the identifier to the provided string.
425 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
426 will be replaced with the aggregation function, e.g. "average". Not including
427 the placeholder will result in duplication warnings and/or messed up values if
428 more than one aggregation function are enabled.
430 The following example calculates the average usage of all "even" CPUs:
432 <Plugin "aggregation">
435 PluginInstance "/[0,2,4,6,8]$/"
439 SetPluginInstance "even-%{aggregation}"
442 GroupBy "TypeInstance"
444 CalculateAverage true
448 This will create the files:
454 foo.example.com/cpu-even-average/cpu-idle
458 foo.example.com/cpu-even-average/cpu-system
462 foo.example.com/cpu-even-average/cpu-user
470 =item B<CalculateNum> B<true>|B<false>
472 =item B<CalculateSum> B<true>|B<false>
474 =item B<CalculateAverage> B<true>|B<false>
476 =item B<CalculateMinimum> B<true>|B<false>
478 =item B<CalculateMaximum> B<true>|B<false>
480 =item B<CalculateStddev> B<true>|B<false>
482 Boolean options for enabling calculation of the number of value lists, their
483 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
484 are disabled by default.
488 =head2 Plugin C<amqp>
490 The I<AMQMP plugin> can be used to communicate with other instances of
491 I<collectd> or third party applications using an AMQP message broker. Values
492 are sent to or received from the broker, which handles routing, queueing and
493 possibly filtering or messages.
496 # Send values to an AMQP broker
497 <Publish "some_name">
503 Exchange "amq.fanout"
504 # ExchangeType "fanout"
505 # RoutingKey "collectd"
509 # GraphitePrefix "collectd."
510 # GraphiteEscapeChar "_"
511 # GraphiteSeparateInstances false
512 # GraphiteAlwaysAppendDS false
515 # Receive values from an AMQP broker
516 <Subscribe "some_name">
522 Exchange "amq.fanout"
523 # ExchangeType "fanout"
526 # QueueAutoDelete true
527 # RoutingKey "collectd.#"
531 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
532 blocks, which configure sending and receiving of values respectively. The two
533 blocks are very similar, so unless otherwise noted, an option can be used in
534 either block. The name given in the blocks starting tag is only used for
535 reporting messages, but may be used to support I<flushing> of certain
536 I<Publish> blocks in the future.
540 =item B<Host> I<Host>
542 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
543 the underlying communications library, I<rabbitmq-c>, which is "localhost".
545 =item B<Port> I<Port>
547 Service name or port number on which the AMQP broker accepts connections. This
548 argument must be a string, even if the numeric form is used. Defaults to
551 =item B<VHost> I<VHost>
553 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
555 =item B<User> I<User>
557 =item B<Password> I<Password>
559 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
562 =item B<Exchange> I<Exchange>
564 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
565 By default, "amq.fanout" will be used.
567 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
568 the given exchange and the I<queue> is created, using the I<routing key> if
569 configured. See the B<Queue> and B<RoutingKey> options below.
571 =item B<ExchangeType> I<Type>
573 If given, the plugin will try to create the configured I<exchange> with this
574 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
575 be bound to this exchange.
577 =item B<Queue> I<Queue> (Subscribe only)
579 Configures the I<queue> name to subscribe to. If no queue name was configured
580 explicitly, a unique queue name will be created by the broker.
582 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
584 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
585 or transient (will disappear if the AMQP broker is restarted). Defaults to
588 This option should be used in conjunction with the I<Persistent> option on the
591 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
593 Defines if the I<queue> subscribed to will be deleted once the last consumer
594 unsubscribes. Defaults to "true".
596 =item B<RoutingKey> I<Key>
598 In I<Publish> blocks, this configures the routing key to set on all outgoing
599 messages. If not given, the routing key will be computed from the I<identifier>
600 of the value. The host, plugin, type and the two instances are concatenated
601 together using dots as the separator and all containing dots replaced with
602 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
603 possible to receive only specific values using a "topic" exchange.
605 In I<Subscribe> blocks, configures the I<routing key> used when creating a
606 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
607 used to filter messages when using a "topic" exchange. If you're only
608 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
611 =item B<Persistent> B<true>|B<false> (Publish only)
613 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
614 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
615 default), the I<transient> delivery mode will be used, i.e. messages may be
616 lost due to high load, overflowing queues or similar issues.
618 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
620 Selects the format in which messages are sent to the broker. If set to
621 B<Command> (the default), values are sent as C<PUTVAL> commands which are
622 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
623 case, the C<Content-Type> header field will be set to C<text/collectd>.
625 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
626 an easy and straight forward exchange format. The C<Content-Type> header field
627 will be set to C<application/json>.
629 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
630 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
633 A subscribing client I<should> use the C<Content-Type> header field to
634 determine how to decode the values. Currently, the I<AMQP plugin> itself can
635 only decode the B<Command> format.
637 =item B<StoreRates> B<true>|B<false> (Publish only)
639 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
640 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
641 default), no conversion is performed. Otherwise the conversion is performed
642 using the internal value cache.
644 Please note that currently this option is only used if the B<Format> option has
647 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
649 A prefix can be added in the metric name when outputting in the I<Graphite> format.
650 It's added before the I<Host> name.
651 Metric name will be "<prefix><host><postfix><plugin><type><name>"
653 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
655 A postfix can be added in the metric name when outputting in the I<Graphite> format.
656 It's added after the I<Host> name.
657 Metric name will be "<prefix><host><postfix><plugin><type><name>"
659 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
661 Specify a character to replace dots (.) in the host part of the metric name.
662 In I<Graphite> metric name, dots are used as separators between different
663 metric parts (host, plugin, type).
664 Default is "_" (I<Underscore>).
666 =item B<GraphiteSeparateInstances> B<true>|B<false>
668 If set to B<true>, the plugin instance and type instance will be in their own
669 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
670 default), the plugin and plugin instance (and likewise the type and type
671 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
673 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
675 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
676 identifier. If set to B<false> (the default), this is only done when there is
681 =head2 Plugin C<apache>
683 To configure the C<apache>-plugin you first need to configure the Apache
684 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
685 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
686 the following snipped to base your Apache config upon:
689 <IfModule mod_status.c>
690 <Location /mod_status>
691 SetHandler server-status
695 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
696 also supported. It introduces a new field, called C<BusyServers>, to count the
697 number of currently connected clients. This field is also supported.
699 The configuration of the I<Apache> plugin consists of one or more
700 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
701 as the instance name. For example:
705 URL "http://www1.example.com/mod_status?auto"
708 URL "http://www2.example.com/mod_status?auto"
712 The instance name will be used as the I<plugin instance>. To emulate the old
713 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
714 plugin to work correctly, each instance name must be unique. This is not
715 enforced by the plugin and it is your responsibility to ensure it.
717 The following options are accepted within each I<Instance> block:
721 =item B<URL> I<http://host/mod_status?auto>
723 Sets the URL of the C<mod_status> output. This needs to be the output generated
724 by C<ExtendedStatus on> and it needs to be the machine readable output
725 generated by appending the C<?auto> argument. This option is I<mandatory>.
727 =item B<User> I<Username>
729 Optional user name needed for authentication.
731 =item B<Password> I<Password>
733 Optional password needed for authentication.
735 =item B<VerifyPeer> B<true|false>
737 Enable or disable peer SSL certificate verification. See
738 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
740 =item B<VerifyHost> B<true|false>
742 Enable or disable peer host name verification. If enabled, the plugin checks
743 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
744 certificate matches the host name provided by the B<URL> option. If this
745 identity check fails, the connection is aborted. Obviously, only works when
746 connecting to a SSL enabled server. Enabled by default.
748 =item B<CACert> I<File>
750 File that holds one or more SSL certificates. If you want to use HTTPS you will
751 possibly need this option. What CA certificates come bundled with C<libcurl>
752 and are checked by default depends on the distribution you use.
756 =head2 Plugin C<apcups>
760 =item B<Host> I<Hostname>
762 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
763 that IPv6 support has been disabled unless someone can confirm or decline that
764 B<apcupsd> can handle it.
766 =item B<Port> I<Port>
768 TCP-Port to connect to. Defaults to B<3551>.
770 =item B<ReportSeconds> B<true|false>
772 If set to B<true>, the time reported in the C<timeleft> metric will be
773 converted to seconds. This is the recommended setting. If set to B<false>, the
774 default for backwards compatibility, the time will be reported in minutes.
778 =head2 Plugin C<aquaero>
780 This plugin collects the value of the available sensors in an
781 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
782 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
783 connection for monitoring and configuration. The board can handle multiple
784 temperature sensors, fans, water pumps and water level sensors and adjust the
785 output settings such as fan voltage or power used by the water pump based on
786 the available inputs using a configurable controller included in the board.
787 This plugin collects all the available inputs as well as some of the output
788 values chosen by this controller. The plugin is based on the I<libaquaero5>
789 library provided by I<aquatools-ng>.
793 =item B<Device> I<DevicePath>
795 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
796 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
797 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
801 =head2 Plugin C<ascent>
803 This plugin collects information about an Ascent server, a free server for the
804 "World of Warcraft" game. This plugin gathers the information by fetching the
805 XML status page using C<libcurl> and parses it using C<libxml2>.
807 The configuration options are the same as for the C<apache> plugin above:
811 =item B<URL> I<http://localhost/ascent/status/>
813 Sets the URL of the XML status output.
815 =item B<User> I<Username>
817 Optional user name needed for authentication.
819 =item B<Password> I<Password>
821 Optional password needed for authentication.
823 =item B<VerifyPeer> B<true|false>
825 Enable or disable peer SSL certificate verification. See
826 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
828 =item B<VerifyHost> B<true|false>
830 Enable or disable peer host name verification. If enabled, the plugin checks
831 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
832 certificate matches the host name provided by the B<URL> option. If this
833 identity check fails, the connection is aborted. Obviously, only works when
834 connecting to a SSL enabled server. Enabled by default.
836 =item B<CACert> I<File>
838 File that holds one or more SSL certificates. If you want to use HTTPS you will
839 possibly need this option. What CA certificates come bundled with C<libcurl>
840 and are checked by default depends on the distribution you use.
844 =head2 Plugin C<barometer>
846 This plugin reads absolute air pressure using digital barometer sensor MPL115A2
847 or MPL3115 from Freescale (sensor attached to any I2C bus available in
848 the computer, for HW details see
849 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A> or
850 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>).
851 The sensor type - one fo these two - is detected automatically by the plugin
852 and indicated in the plugin_instance (typically you will see subdirectory
853 "barometer-mpl115" or "barometer-mpl3115").
855 The plugin provides absolute barometric pressure, air pressure reduced to sea
856 level (several possible approximations) and as an auxiliary value also internal
857 sensor temperature. It uses (expects/provides) typical metric units - pressure
858 in [hPa], temperature in [C], altitude in [m].
860 It was developed and tested under Linux only. The only platform dependency is
861 the standard Linux i2c-dev interface (the particular bus driver has to
862 support the SM Bus command subset).
864 The reduction or normalization to mean sea level pressure requires (depedning on
865 selected method/approximation) also altitude and reference to temperature sensor(s).
866 When multiple temperature sensors are configured the minumum of their values is
867 always used (expecting that the warmer ones are affected by e.g. direct sun light
876 TemperatureOffset 0.0
879 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
884 =item B<Device> I<device>
886 Device name of the I2C bus to which the sensor is connected. Note that typically
887 you need to have loaded the i2c-dev module.
888 Using i2c-tools you can check/list i2c buses available on your system by:
892 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
896 This way you should be able to verify that the pressure sensor (either type) is
897 connected and detected on address 0x60.
899 =item B<Oversampling> I<value>
901 For MPL115 this is the size of the averaging window. To filter out sensor noise
902 a simple averaging using floating window of configurable size is used. The plugin
903 will use average of the last C<value> measurements (value of 1 means no averaging).
904 Minimal size is 1, maximal 1024.
906 For MPL3115 this is the oversampling value. The actual oversampling is performed
907 by the sensor and the higher value the higher accuracy and longer conversion time
908 (although nothing to worry about in the collectd context). Supported values are:
909 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
910 the closest supported one. Default is 128.
912 =item B<PressureOffset> I<offset>
914 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
915 This is added to the measured/caclulated value (i.e. if the measured value is too high
916 then use negative offset).
917 In hPa, default is 0.0.
919 =item B<TemperatureOffset> I<offset>
921 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
922 This is added to the measured/caclulated value (i.e. if the measured value is too high
923 then use negative offset).
924 In C, default is 0.0.
926 =item B<Normalization> I<method>
928 Normalization method - what approximation/model is used to compute mean sea
929 level pressure from the air absolute pressure.
931 Supported values of the C<method> (integer between from 0 to 2) are:
935 =item B<0> - no conversion, absolute pressrure is simply copied over. For this method you
936 do not need to configure C<Altitude> or C<TemperatureSensor>.
938 =item B<1> - international formula for conversion ,
939 See I<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
940 For this method you have to configure C<Altitude> but do not need C<TemperatureSensor>
941 (uses fixed global temperature average instead).
943 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
944 Meteorological Service).
945 See I<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
946 For this method you have to configure both C<Altitude> and C<TemperatureSensor>.
951 =item B<Altitude> I<altitude>
953 The altitude (in meters) of the location where you meassure the pressure.
955 =item B<TemperatureSensor> I<reference>
957 Temperature sensor which should be used as a reference when normalizing the pressure.
958 When specified more sensors a minumum is found and uses each time.
959 The temperature reading directly from this pressure sensor/plugin
960 is typically not suitable as the pressure sensor
961 will be probably inside while we want outside temperature.
962 The collectd reference name is something like
963 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
964 (<type_instance> is usually omitted when there is just single value type).
965 Or you can figure it out from the path of the output data files.
969 =head2 Plugin C<bind>
971 Starting with BIND 9.5.0, the most widely used DNS server software provides
972 extensive statistics about queries, responses and lots of other information.
973 The bind plugin retrieves this information that's encoded in XML and provided
974 via HTTP and submits the values to collectd.
976 To use this plugin, you first need to tell BIND to make this information
977 available. This is done with the C<statistics-channels> configuration option:
979 statistics-channels {
980 inet localhost port 8053;
983 The configuration follows the grouping that can be seen when looking at the
984 data with an XSLT compatible viewer, such as a modern web browser. It's
985 probably a good idea to make yourself familiar with the provided values, so you
986 can understand what the collected statistics actually mean.
991 URL "http://localhost:8053/"
1006 Zone "127.in-addr.arpa/IN"
1010 The bind plugin accepts the following configuration options:
1016 URL from which to retrieve the XML data. If not specified,
1017 C<http://localhost:8053/> will be used.
1019 =item B<ParseTime> B<true>|B<false>
1021 When set to B<true>, the time provided by BIND will be parsed and used to
1022 dispatch the values. When set to B<false>, the local time source is queried.
1024 This setting is set to B<true> by default for backwards compatibility; setting
1025 this to B<false> is I<recommended> to avoid problems with timezones and
1028 =item B<OpCodes> B<true>|B<false>
1030 When enabled, statistics about the I<"OpCodes">, for example the number of
1031 C<QUERY> packets, are collected.
1035 =item B<QTypes> B<true>|B<false>
1037 When enabled, the number of I<incoming> queries by query types (for example
1038 C<A>, C<MX>, C<AAAA>) is collected.
1042 =item B<ServerStats> B<true>|B<false>
1044 Collect global server statistics, such as requests received over IPv4 and IPv6,
1045 successful queries, and failed updates.
1049 =item B<ZoneMaintStats> B<true>|B<false>
1051 Collect zone maintenance statistics, mostly information about notifications
1052 (zone updates) and zone transfers.
1056 =item B<ResolverStats> B<true>|B<false>
1058 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1059 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1060 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1061 default. Use the B<ResolverStats> option within a B<View "_default"> block
1062 instead for the same functionality.
1066 =item B<MemoryStats>
1068 Collect global memory statistics.
1072 =item B<View> I<Name>
1074 Collect statistics about a specific I<"view">. BIND can behave different,
1075 mostly depending on the source IP-address of the request. These different
1076 configurations are called "views". If you don't use this feature, you most
1077 likely are only interested in the C<_default> view.
1079 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1080 information you want to collect about a view. If no B<View> block is
1081 configured, no detailed view statistics will be collected.
1085 =item B<QTypes> B<true>|B<false>
1087 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1088 C<MX>) is collected.
1092 =item B<ResolverStats> B<true>|B<false>
1094 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1095 (e.E<nbsp>g. queries over IPv4, lame servers).
1099 =item B<CacheRRSets> B<true>|B<false>
1101 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1102 type is collected. Negative entries (queries which resulted in an error, for
1103 example names that do not exist) are reported with a leading exclamation mark,
1108 =item B<Zone> I<Name>
1110 When given, collect detailed information about the given zone in the view. The
1111 information collected if very similar to the global B<ServerStats> information
1114 You can repeat this option to collect detailed information about multiple
1117 By default no detailed zone information is collected.
1123 =head2 Plugin C<cgroups>
1125 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1126 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1127 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1131 =item B<CGroup> I<Directory>
1133 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1134 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1137 =item B<IgnoreSelected> B<true>|B<false>
1139 Invert the selection: If set to true, all cgroups I<except> the ones that
1140 match any one of the criteria are collected. By default only selected
1141 cgroups are collected if a selection is made. If no selection is configured
1142 at all, B<all> cgroups are selected.
1146 =head2 Plugin C<conntrack>
1148 This plugin collects IP conntrack statistics.
1154 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1155 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1159 =head2 Plugin C<cpu>
1161 The I<CPU plugin> collects CPU usage metrics.
1163 The following configuration options are available:
1167 =item B<ReportActive> B<false>|B<true>
1169 Reports non-idle CPU usage as the "active" value. Defaults to false.
1171 =item B<ReportByCpu> B<false>|B<true>
1173 When true reports usage for all cores. When false, reports cpu usage
1174 aggregated over all cores.
1177 =item B<ValuesPercentage> B<false>|B<true>
1179 When true report percentage usage instead of tick values. Defaults to false.
1184 =head2 Plugin C<cpufreq>
1186 This plugin doesn't have any options. It reads
1187 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1188 installed) to get the current CPU frequency. If this file does not exist make
1189 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1190 installed and an "cpu governor" (that's a kernel module) is loaded.
1192 =head2 Plugin C<csv>
1196 =item B<DataDir> I<Directory>
1198 Set the directory to store CSV-files under. Per default CSV-files are generated
1199 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1200 The special strings B<stdout> and B<stderr> can be used to write to the standard
1201 output and standard error channels, respectively. This, of course, only makes
1202 much sense when collectd is running in foreground- or non-daemon-mode.
1204 =item B<StoreRates> B<true|false>
1206 If set to B<true>, convert counter values to rates. If set to B<false> (the
1207 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1212 =head2 Plugin C<curl>
1214 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1215 and the match infrastructure (the same code used by the tail plugin) to use
1216 regular expressions with the received data.
1218 The following example will read the current value of AMD stock from Google's
1219 finance page and dispatch the value to collectd.
1222 <Page "stock_quotes">
1223 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1229 CACert "/path/to/ca.crt"
1230 Header "X-Custom-Header: foobar"
1233 MeasureResponseTime false
1234 MeasureResponseCode false
1237 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1238 DSType "GaugeAverage"
1239 # Note: `stock_value' is not a standard type.
1246 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1247 a web page and one or more "matches" to be performed on the returned data. The
1248 string argument to the B<Page> block is used as plugin instance.
1250 The following options are valid within B<Page> blocks:
1256 URL of the web site to retrieve. Since a regular expression will be used to
1257 extract information from this data, non-binary data is a big plus here ;)
1259 =item B<User> I<Name>
1261 Username to use if authorization is required to read the page.
1263 =item B<Password> I<Password>
1265 Password to use if authorization is required to read the page.
1267 =item B<Digest> B<true>|B<false>
1269 Enable HTTP digest authentication.
1271 =item B<VerifyPeer> B<true>|B<false>
1273 Enable or disable peer SSL certificate verification. See
1274 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1276 =item B<VerifyHost> B<true>|B<false>
1278 Enable or disable peer host name verification. If enabled, the plugin checks if
1279 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1280 matches the host name provided by the B<URL> option. If this identity check
1281 fails, the connection is aborted. Obviously, only works when connecting to a
1282 SSL enabled server. Enabled by default.
1284 =item B<CACert> I<file>
1286 File that holds one or more SSL certificates. If you want to use HTTPS you will
1287 possibly need this option. What CA certificates come bundled with C<libcurl>
1288 and are checked by default depends on the distribution you use.
1290 =item B<Header> I<Header>
1292 A HTTP header to add to the request. Multiple headers are added if this option
1293 is specified more than once.
1295 =item B<Post> I<Body>
1297 Specifies that the HTTP operation should be a POST instead of a GET. The
1298 complete data to be posted is given as the argument. This option will usually
1299 need to be accompanied by a B<Header> option to set an appropriate
1300 C<Content-Type> for the post body (e.g. to
1301 C<application/x-www-form-urlencoded>).
1303 =item B<MeasureResponseTime> B<true>|B<false>
1305 Measure response time for the request. If this setting is enabled, B<Match>
1306 blocks (see below) are optional. Disabled by default.
1308 =item B<MeasureResponseCode> B<true>|B<false>
1310 Measure response code for the request. If this setting is enabled, B<Match>
1311 blocks (see below) are optional. Disabled by default.
1313 =item B<E<lt>MatchE<gt>>
1315 One or more B<Match> blocks that define how to match information in the data
1316 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1317 used by the C<tail> plugin, so please see the documentation of the C<tail>
1318 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1319 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1324 =head2 Plugin C<curl_json>
1326 The B<curl_json plugin> collects values from JSON data to be parsed by
1327 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1328 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1329 unix socket. The former can be used, for example, to collect values
1330 from CouchDB documents (which are stored JSON notation), and the
1331 latter to collect values from a uWSGI stats socket.
1333 The following example will collect several values from the built-in
1334 C<_stats> runtime statistics module of I<CouchDB>
1335 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1338 <URL "http://localhost:5984/_stats">
1340 <Key "httpd/requests/count">
1341 Type "http_requests"
1344 <Key "httpd_request_methods/*/count">
1345 Type "http_request_methods"
1348 <Key "httpd_status_codes/*/count">
1349 Type "http_response_codes"
1354 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1357 <Sock "/var/run/uwsgi.stats.sock">
1359 <Key "workers/*/requests">
1360 Type "http_requests"
1363 <Key "workers/*/apps/*/requests">
1364 Type "http_requests"
1369 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1370 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1371 blocks defining a unix socket to read JSON from directly. Each of
1372 these blocks may have one or more B<Key> blocks.
1374 The B<Key> string argument must be in a path format. Each component is
1375 used to match the key from a JSON map or the index of an JSON
1376 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1377 values for all map keys or array indices will be collectd.
1379 The following options are valid within B<URL> blocks:
1383 =item B<Instance> I<Instance>
1385 Sets the plugin instance to I<Instance>.
1387 =item B<Interval> I<Interval>
1389 Sets the interval (in seconds) in which the values will be collected from this
1390 URL. By default the global B<Interval> setting will be used.
1392 =item B<User> I<Name>
1394 =item B<Password> I<Password>
1396 =item B<Digest> B<true>|B<false>
1398 =item B<VerifyPeer> B<true>|B<false>
1400 =item B<VerifyHost> B<true>|B<false>
1402 =item B<CACert> I<file>
1404 =item B<Header> I<Header>
1406 =item B<Post> I<Body>
1408 These options behave exactly equivalent to the appropriate options of the
1409 I<cURL> plugin. Please see there for a detailed description.
1413 The following options are valid within B<Key> blocks:
1417 =item B<Type> I<Type>
1419 Sets the type used to dispatch the values to the daemon. Detailed information
1420 about types and their configuration can be found in L<types.db(5)>. This
1421 option is mandatory.
1423 =item B<Instance> I<Instance>
1425 Type-instance to use. Defaults to the current map key or current string array element value.
1429 =head2 Plugin C<curl_xml>
1431 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1432 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1435 <URL "http://localhost/stats.xml">
1437 Instance "some_instance"
1442 CACert "/path/to/ca.crt"
1443 Header "X-Custom-Header: foobar"
1446 <XPath "table[@id=\"magic_level\"]/tr">
1448 #InstancePrefix "prefix-"
1449 InstanceFrom "td[1]"
1450 ValuesFrom "td[2]/span[@class=\"level\"]"
1455 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1456 URL to be fetched using libcurl. Within each B<URL> block there are
1457 options which specify the connection parameters, for example authentication
1458 information, and one or more B<XPath> blocks.
1460 Each B<XPath> block specifies how to get one type of information. The
1461 string argument must be a valid XPath expression which returns a list
1462 of "base elements". One value is dispatched for each "base element". The
1463 I<type instance> and values are looked up using further I<XPath> expressions
1464 that should be relative to the base element.
1466 Within the B<URL> block the following options are accepted:
1470 =item B<Host> I<Name>
1472 Use I<Name> as the host name when submitting values. Defaults to the global
1475 =item B<Instance> I<Instance>
1477 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1478 empty string (no plugin instance).
1480 =item B<Namespace> I<Prefix> I<URL>
1482 If an XPath expression references namespaces, they must be specified
1483 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1484 I<URL> is the "namespace name", an URI reference uniquely identifying the
1485 namespace. The option can be repeated to register multiple namespaces.
1489 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1490 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1492 =item B<User> I<User>
1494 =item B<Password> I<Password>
1496 =item B<Digest> B<true>|B<false>
1498 =item B<VerifyPeer> B<true>|B<false>
1500 =item B<VerifyHost> B<true>|B<false>
1502 =item B<CACert> I<CA Cert File>
1504 =item B<Header> I<Header>
1506 =item B<Post> I<Body>
1508 These options behave exactly equivalent to the appropriate options of the
1509 I<cURL plugin>. Please see there for a detailed description.
1511 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1513 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1514 B<XPath> block specifies how to get one type of information. The string
1515 argument must be a valid XPath expression which returns a list of "base
1516 elements". One value is dispatched for each "base element".
1518 Within the B<XPath> block the following options are accepted:
1522 =item B<Type> I<Type>
1524 Specifies the I<Type> used for submitting patches. This determines the number
1525 of values that are required / expected and whether the strings are parsed as
1526 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1527 This option is required.
1529 =item B<InstancePrefix> I<InstancePrefix>
1531 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1532 concatenated together without any separator.
1533 This option is optional.
1535 =item B<InstanceFrom> I<InstanceFrom>
1537 Specifies a XPath expression to use for determining the I<type instance>. The
1538 XPath expression must return exactly one element. The element's value is then
1539 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1541 This value is required. As a special exception, if the "base XPath expression"
1542 (the argument to the B<XPath> block) returns exactly one argument, then this
1543 option may be omitted.
1545 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1547 Specifies one or more XPath expression to use for reading the values. The
1548 number of XPath expressions must match the number of data sources in the
1549 I<type> specified with B<Type> (see above). Each XPath expression must return
1550 exactly one element. The element's value is then parsed as a number and used as
1551 value for the appropriate value in the value list dispatched to the daemon.
1557 =head2 Plugin C<dbi>
1559 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1560 connect to various databases, execute I<SQL> statements and read back the
1561 results. I<dbi> is an acronym for "database interface" in case you were
1562 wondering about the name. You can configure how each column is to be
1563 interpreted and the plugin will generate one or more data sets from each row
1564 returned according to these rules.
1566 Because the plugin is very generic, the configuration is a little more complex
1567 than those of other plugins. It usually looks something like this:
1570 <Query "out_of_stock">
1571 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1572 # Use with MySQL 5.0.0 or later
1576 InstancePrefix "out_of_stock"
1577 InstancesFrom "category"
1581 <Database "product_information">
1583 DriverOption "host" "localhost"
1584 DriverOption "username" "collectd"
1585 DriverOption "password" "aZo6daiw"
1586 DriverOption "dbname" "prod_info"
1587 SelectDB "prod_info"
1588 Query "out_of_stock"
1592 The configuration above defines one query with one result and one database. The
1593 query is then linked to the database with the B<Query> option I<within> the
1594 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1595 and you can also use the B<Include> statement to split up the configuration
1596 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1597 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1600 The following is a complete list of options:
1602 =head3 B<Query> blocks
1604 Query blocks define I<SQL> statements and how the returned data should be
1605 interpreted. They are identified by the name that is given in the opening line
1606 of the block. Thus the name needs to be unique. Other than that, the name is
1607 not used in collectd.
1609 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1610 define which column holds which value or instance information. You can use
1611 multiple B<Result> blocks to create multiple values from one returned row. This
1612 is especially useful, when queries take a long time and sending almost the same
1613 query again and again is not desirable.
1617 <Query "environment">
1618 Statement "select station, temperature, humidity from environment"
1621 # InstancePrefix "foo"
1622 InstancesFrom "station"
1623 ValuesFrom "temperature"
1627 InstancesFrom "station"
1628 ValuesFrom "humidity"
1632 The following options are accepted:
1636 =item B<Statement> I<SQL>
1638 Sets the statement that should be executed on the server. This is B<not>
1639 interpreted by collectd, but simply passed to the database server. Therefore,
1640 the SQL dialect that's used depends on the server collectd is connected to.
1642 The query has to return at least two columns, one for the instance and one
1643 value. You cannot omit the instance, even if the statement is guaranteed to
1644 always return exactly one line. In that case, you can usually specify something
1647 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1649 (That works with MySQL but may not be valid SQL according to the spec. If you
1650 use a more strict database server, you may have to select from a dummy table or
1653 Please note that some databases, for example B<Oracle>, will fail if you
1654 include a semicolon at the end of the statement.
1656 =item B<MinVersion> I<Version>
1658 =item B<MaxVersion> I<Value>
1660 Only use this query for the specified database version. You can use these
1661 options to provide multiple queries with the same name but with a slightly
1662 different syntax. The plugin will use only those queries, where the specified
1663 minimum and maximum versions fit the version of the database in use.
1665 The database version is determined by C<dbi_conn_get_engine_version>, see the
1666 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1667 for details. Basically, each part of the version is assumed to be in the range
1668 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1669 "40102", version "5.0.42" becomes "50042".
1671 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1672 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1673 happen. Don't to it! A valid example would be something along these lines:
1684 In the above example, there are three ranges that don't overlap. The last one
1685 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1686 before "4.0.0" are not specified.
1688 =item B<Type> I<Type>
1690 The B<type> that's used for each line returned. See L<types.db(5)> for more
1691 details on how types are defined. In short: A type is a predefined layout of
1692 data and the number of values and type of values has to match the type
1695 If you specify "temperature" here, you need exactly one gauge column. If you
1696 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1699 There must be exactly one B<Type> option inside each B<Result> block.
1701 =item B<InstancePrefix> I<prefix>
1703 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1704 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1705 all strings returned in the appropriate columns are concatenated together,
1706 separated by dashes I<("-")>.
1708 =item B<InstancesFrom> I<column0> [I<column1> ...]
1710 Specifies the columns whose values will be used to create the "type-instance"
1711 for each row. If you specify more than one column, the value of all columns
1712 will be joined together with dashes I<("-")> as separation characters.
1714 The plugin itself does not check whether or not all built instances are
1715 different. It's your responsibility to assure that each is unique. This is
1716 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1717 sure that only one row is returned in this case.
1719 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1722 =item B<ValuesFrom> I<column0> [I<column1> ...]
1724 Names the columns whose content is used as the actual data for the data sets
1725 that are dispatched to the daemon. How many such columns you need is determined
1726 by the B<Type> setting above. If you specify too many or not enough columns,
1727 the plugin will complain about that and no data will be submitted to the
1730 The actual data type in the columns is not that important. The plugin will
1731 automatically cast the values to the right type if it know how to do that. So
1732 it should be able to handle integer an floating point types, as well as strings
1733 (if they include a number at the beginning).
1735 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1737 =item B<MetadataFrom> [I<column0> I<column1> ...]
1739 Names the columns whose content is used as metadata for the data sets
1740 that are dispatched to the daemon.
1742 The actual data type in the columns is not that important. The plugin will
1743 automatically cast the values to the right type if it know how to do that. So
1744 it should be able to handle integer an floating point types, as well as strings
1745 (if they include a number at the beginning).
1749 =head3 B<Database> blocks
1751 Database blocks define a connection to a database and which queries should be
1752 sent to that database. Since the used "dbi" library can handle a wide variety
1753 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1754 documentationE<nbsp>- we stick as close to the terminology used there.
1756 Each database needs a "name" as string argument in the starting tag of the
1757 block. This name will be used as "PluginInstance" in the values submitted to
1758 the daemon. Other than that, that name is not used.
1762 =item B<Driver> I<Driver>
1764 Specifies the driver to use to connect to the database. In many cases those
1765 drivers are named after the database they can connect to, but this is not a
1766 technical necessity. These drivers are sometimes referred to as "DBD",
1767 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1768 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1769 project at L<http://libdbi-drivers.sourceforge.net/>.
1771 You need to give the driver name as expected by the "dbi" library here. You
1772 should be able to find that in the documentation for each driver. If you
1773 mistype the driver name, the plugin will dump a list of all known driver names
1776 =item B<DriverOption> I<Key> I<Value>
1778 Sets driver-specific options. What option a driver supports can be found in the
1779 documentation for each driver, somewhere at
1780 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1781 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1783 DBDs can register two types of options: String options and numeric options. The
1784 plugin will use the C<dbi_conn_set_option> function when the configuration
1785 provides a string and the C<dbi_conn_require_option_numeric> function when the
1786 configuration provides a number. So these two lines will actually result in
1787 different calls being used:
1789 DriverOption "Port" 1234 # numeric
1790 DriverOption "Port" "1234" # string
1792 Unfortunately, drivers are not too keen to report errors when an unknown option
1793 is passed to them, so invalid settings here may go unnoticed. This is not the
1794 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1795 the driver. If a driver complains about an option, the plugin will dump a
1796 complete list of all options understood by that driver to the log. There is no
1797 way to programatically find out if an option expects a string or a numeric
1798 argument, so you will have to refer to the appropriate DBD's documentation to
1799 find this out. Sorry.
1801 =item B<SelectDB> I<Database>
1803 In some cases, the database name you connect with is not the database name you
1804 want to use for querying data. If this option is set, the plugin will "select"
1805 (switch to) that database after the connection is established.
1807 =item B<Query> I<QueryName>
1809 Associates the query named I<QueryName> with this database connection. The
1810 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1811 blocks you want to refer to must be placed above the database block you want to
1814 =item B<Host> I<Hostname>
1816 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1817 values. Defaults to the global hostname setting.
1825 =item B<Device> I<Device>
1827 Select partitions based on the devicename.
1829 =item B<MountPoint> I<Directory>
1831 Select partitions based on the mountpoint.
1833 =item B<FSType> I<FSType>
1835 Select partitions based on the filesystem type.
1837 =item B<IgnoreSelected> B<true>|B<false>
1839 Invert the selection: If set to true, all partitions B<except> the ones that
1840 match any one of the criteria are collected. By default only selected
1841 partitions are collected if a selection is made. If no selection is configured
1842 at all, B<all> partitions are selected.
1844 =item B<ReportByDevice> B<true>|B<false>
1846 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1847 (the default), it will report a disk as "root", but with it I<true>, it will be
1848 "sda1" (or whichever).
1850 =item B<ReportInodes> B<true>|B<false>
1852 Enables or disables reporting of free, reserved and used inodes. Defaults to
1853 inode collection being disabled.
1855 Enable this option if inodes are a scarce resource for you, usually because
1856 many small files are stored on the disk. This is a usual scenario for mail
1857 transfer agents and web caches.
1859 =item B<ValuesAbsolute> B<true>|B<false>
1861 Enables or disables reporting of free and used disk space in 1K-blocks.
1862 Defaults to B<true>.
1864 =item B<ValuesPercentage> B<false>|B<true>
1866 Enables or disables reporting of free and used disk space in percentage.
1867 Defaults to B<false>.
1869 This is useful for deploying I<collectd> on the cloud, where machines with
1870 different disk size may exist. Then it is more practical to configure
1871 thresholds based on relative disk size.
1875 =head2 Plugin C<disk>
1877 The C<disk> plugin collects information about the usage of physical disks and
1878 logical disks (partitions). Values collected are the number of octets written
1879 to and read from a disk or partition, the number of read/write operations
1880 issued to the disk and a rather complex "time" it took for these commands to be
1883 Using the following two options you can ignore some disks or configure the
1884 collection only of specific disks.
1888 =item B<Disk> I<Name>
1890 Select the disk I<Name>. Whether it is collected or ignored depends on the
1891 B<IgnoreSelected> setting, see below. As with other plugins that use the
1892 daemon's ignorelist functionality, a string that starts and ends with a slash
1893 is interpreted as a regular expression. Examples:
1898 =item B<IgnoreSelected> B<true>|B<false>
1900 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1901 statements, are ignored or if all other disks are ignored. The behavior
1902 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1903 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1904 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1905 is set to B<true>, all disks are collected B<except> the ones matched.
1907 =item B<UseBSDName> B<true>|B<false>
1909 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1910 default major/minor numbers. Requires collectd to be built with Apple's
1913 =item B<UdevNameAttr> I<Attribute>
1915 Attempt to override disk instance name with the value of a specified udev
1916 attribute when built with B<libudev>. If the attribute is not defined for the
1917 given device, the default name is used. Example:
1919 UdevNameAttr "DM_NAME"
1923 =head2 Plugin C<dns>
1927 =item B<Interface> I<Interface>
1929 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1930 option sets the interface that should be used. If this option is not set, or
1931 set to "any", the plugin will try to get packets from B<all> interfaces. This
1932 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1934 =item B<IgnoreSource> I<IP-address>
1936 Ignore packets that originate from this address.
1938 =item B<SelectNumericQueryTypes> B<true>|B<false>
1940 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1944 =head2 Plugin C<email>
1948 =item B<SocketFile> I<Path>
1950 Sets the socket-file which is to be created.
1952 =item B<SocketGroup> I<Group>
1954 If running as root change the group of the UNIX-socket after it has been
1955 created. Defaults to B<collectd>.
1957 =item B<SocketPerms> I<Permissions>
1959 Change the file permissions of the UNIX-socket after it has been created. The
1960 permissions must be given as a numeric, octal value as you would pass to
1961 L<chmod(1)>. Defaults to B<0770>.
1963 =item B<MaxConns> I<Number>
1965 Sets the maximum number of connections that can be handled in parallel. Since
1966 this many threads will be started immediately setting this to a very high
1967 value will waste valuable resources. Defaults to B<5> and will be forced to be
1968 at most B<16384> to prevent typos and dumb mistakes.
1972 =head2 Plugin C<ethstat>
1974 The I<ethstat plugin> collects information about network interface cards (NICs)
1975 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1981 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1982 Map "multicast" "if_multicast"
1989 =item B<Interface> I<Name>
1991 Collect statistical information about interface I<Name>.
1993 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1995 By default, the plugin will submit values as type C<derive> and I<type
1996 instance> set to I<Name>, the name of the metric as reported by the driver. If
1997 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1998 I<TypeInstance> will be used.
2000 =item B<MappedOnly> B<true>|B<false>
2002 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2003 collected, all other metrics will be ignored. Defaults to B<false>.
2007 =head2 Plugin C<exec>
2009 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2010 contains valuable information on when the executable is executed and the
2011 output that is expected from it.
2015 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2017 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2019 Execute the executable I<Executable> as user I<User>. If the user name is
2020 followed by a colon and a group name, the effective group is set to that group.
2021 The real group and saved-set group will be set to the default group of that
2022 user. If no group is given the effective group ID will be the same as the real
2025 Please note that in order to change the user and/or group the daemon needs
2026 superuser privileges. If the daemon is run as an unprivileged user you must
2027 specify the same user/group here. If the daemon is run with superuser
2028 privileges, you must supply a non-root user here.
2030 The executable may be followed by optional arguments that are passed to the
2031 program. Please note that due to the configuration parsing numbers and boolean
2032 values may be changed. If you want to be absolutely sure that something is
2033 passed as-is please enclose it in quotes.
2035 The B<Exec> and B<NotificationExec> statements change the semantics of the
2036 programs executed, i.E<nbsp>e. the data passed to them and the response
2037 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2041 =head2 Plugin C<filecount>
2043 The C<filecount> plugin counts the number of files in a certain directory (and
2044 its subdirectories) and their combined size. The configuration is very straight
2047 <Plugin "filecount">
2048 <Directory "/var/qmail/queue/mess">
2049 Instance "qmail-message"
2051 <Directory "/var/qmail/queue/todo">
2052 Instance "qmail-todo"
2054 <Directory "/var/lib/php5">
2055 Instance "php5-sessions"
2060 The example above counts the number of files in QMail's queue directories and
2061 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2062 QMail has not yet looked at, the "message" queue holds the messages that were
2063 classified into "local" and "remote".
2065 As you can see, the configuration consists of one or more C<Directory> blocks,
2066 each of which specifies a directory in which to count the files. Within those
2067 blocks, the following options are recognized:
2071 =item B<Instance> I<Instance>
2073 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2074 it's your responsibility, the plugin doesn't check for that. If not given, the
2075 instance is set to the directory name with all slashes replaced by underscores
2076 and all leading underscores removed.
2078 =item B<Name> I<Pattern>
2080 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2081 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2082 against the pattern, not the entire path. In case this makes it easier for you:
2083 This option has been named after the B<-name> parameter to L<find(1)>.
2085 =item B<MTime> I<Age>
2087 Count only files of a specific age: If I<Age> is greater than zero, only files
2088 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2089 a negative number, this is inversed. For example, if B<-60> is specified, only
2090 files that have been modified in the last minute will be counted.
2092 The number can also be followed by a "multiplier" to easily specify a larger
2093 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2094 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2095 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2096 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2097 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2100 =item B<Size> I<Size>
2102 Count only files of a specific size. When I<Size> is a positive number, only
2103 files that are at least this big are counted. If I<Size> is a negative number,
2104 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2105 I<Size> are counted.
2107 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2108 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2109 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2110 note that there are 1000 bytes in a kilobyte, not 1024.
2112 =item B<Recursive> I<true>|I<false>
2114 Controls whether or not to recurse into subdirectories. Enabled by default.
2116 =item B<IncludeHidden> I<true>|I<false>
2118 Controls whether or not to include "hidden" files and directories in the count.
2119 "Hidden" files and directories are those, whose name begins with a dot.
2120 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2124 =head2 Plugin C<GenericJMX>
2126 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2127 L<collectd-java(5)>.
2129 =head2 Plugin C<gmond>
2131 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2132 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2133 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2138 MCReceiveFrom "239.2.11.71" "8649"
2139 <Metric "swap_total">
2141 TypeInstance "total"
2144 <Metric "swap_free">
2151 The following metrics are built-in:
2157 load_one, load_five, load_fifteen
2161 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2165 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2177 Available configuration options:
2181 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2183 Sets sets the multicast group and UDP port to which to subscribe.
2185 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2187 =item E<lt>B<Metric> I<Name>E<gt>
2189 These blocks add a new metric conversion to the internal table. I<Name>, the
2190 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2194 =item B<Type> I<Type>
2196 Type to map this metric to. Required.
2198 =item B<TypeInstance> I<Instance>
2200 Type-instance to use. Optional.
2202 =item B<DataSource> I<Name>
2204 Data source to map this metric to. If the configured type has exactly one data
2205 source, this is optional. Otherwise the option is required.
2211 =head2 Plugin C<hddtemp>
2213 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2214 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2215 default values, see below. C<hddtemp> has to be running to work correctly. If
2216 C<hddtemp> is not running timeouts may appear which may interfere with other
2219 The B<hddtemp> homepage can be found at
2220 L<http://www.guzu.net/linux/hddtemp.php>.
2224 =item B<Host> I<Hostname>
2226 Hostname to connect to. Defaults to B<127.0.0.1>.
2228 =item B<Port> I<Port>
2230 TCP-Port to connect to. Defaults to B<7634>.
2234 =head2 Plugin C<interface>
2238 =item B<Interface> I<Interface>
2240 Select this interface. By default these interfaces will then be collected. For
2241 a more detailed description see B<IgnoreSelected> below.
2243 =item B<IgnoreSelected> I<true>|I<false>
2245 If no configuration if given, the B<traffic>-plugin will collect data from
2246 all interfaces. This may not be practical, especially for loopback- and
2247 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2248 interfaces you're interested in. Sometimes, however, it's easier/preferred
2249 to collect all interfaces I<except> a few ones. This option enables you to
2250 do that: By setting B<IgnoreSelected> to I<true> the effect of
2251 B<Interface> is inverted: All selected interfaces are ignored and all
2252 other interfaces are collected.
2256 =head2 Plugin C<ipmi>
2260 =item B<Sensor> I<Sensor>
2262 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2264 =item B<IgnoreSelected> I<true>|I<false>
2266 If no configuration if given, the B<ipmi> plugin will collect data from all
2267 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2268 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2269 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2270 all other sensors are collected.
2272 =item B<NotifySensorAdd> I<true>|I<false>
2274 If a sensor appears after initialization time of a minute a notification
2277 =item B<NotifySensorRemove> I<true>|I<false>
2279 If a sensor disappears a notification is sent.
2281 =item B<NotifySensorNotPresent> I<true>|I<false>
2283 If you have for example dual power supply and one of them is (un)plugged then
2284 a notification is sent.
2288 =head2 Plugin C<iptables>
2292 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2294 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2295 will collect the counters of all rules which have a comment-match. The comment
2296 is then used as type-instance.
2298 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2299 the I<n>th rule will be collected. Again, the comment (or the number) will be
2300 used as the type-instance.
2302 If I<Name> is supplied, it will be used as the type-instance instead of the
2303 comment or the number.
2307 =head2 Plugin C<irq>
2313 Select this irq. By default these irqs will then be collected. For a more
2314 detailed description see B<IgnoreSelected> below.
2316 =item B<IgnoreSelected> I<true>|I<false>
2318 If no configuration if given, the B<irq>-plugin will collect data from all
2319 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2320 can use the B<Irq>-option to pick the interrupt you're interested in.
2321 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2322 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2323 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2324 and all other interrupts are collected.
2328 =head2 Plugin C<java>
2330 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2331 This section only discusses the syntax and semantic of the configuration
2332 options. For more in-depth information on the I<Java> plugin, please read
2333 L<collectd-java(5)>.
2338 JVMArg "-verbose:jni"
2339 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2340 LoadPlugin "org.collectd.java.Foobar"
2341 <Plugin "org.collectd.java.Foobar">
2342 # To be parsed by the plugin
2346 Available configuration options:
2350 =item B<JVMArg> I<Argument>
2352 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2353 exactly the way the arguments to the I<java> binary on the command line work.
2354 Execute C<javaE<nbsp>--help> for details.
2356 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2357 any other options! When another option is found, the JVM will be started and
2358 later options will have to be ignored!
2360 =item B<LoadPlugin> I<JavaClass>
2362 Instantiates a new I<JavaClass> object. The constructor of this object very
2363 likely then registers one or more callback methods with the server.
2365 See L<collectd-java(5)> for details.
2367 When the first such option is found, the virtual machine (JVM) is created. This
2368 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2369 B<LoadPlugin> options!
2371 =item B<Plugin> I<Name>
2373 The entire block is passed to the Java plugin as an
2374 I<org.collectd.api.OConfigItem> object.
2376 For this to work, the plugin has to register a configuration callback first,
2377 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2378 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2379 depends on the (Java) plugin registering the callback and is completely
2380 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2384 =head2 Plugin C<libvirt>
2386 This plugin allows CPU, disk and network load to be collected for virtualized
2387 guests on the machine. This means that these characteristics can be collected
2388 for guest systems without installing any software on them - collectd only runs
2389 on the hosting system. The statistics are collected through libvirt
2390 (L<http://libvirt.org/>).
2392 Only I<Connection> is required.
2396 =item B<Connection> I<uri>
2398 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2400 Connection "xen:///"
2402 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2404 =item B<RefreshInterval> I<seconds>
2406 Refresh the list of domains and devices every I<seconds>. The default is 60
2407 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2408 the list of domains and devices to be refreshed on every iteration.
2410 Refreshing the devices in particular is quite a costly operation, so if your
2411 virtualization setup is static you might consider increasing this. If this
2412 option is set to 0, refreshing is disabled completely.
2414 =item B<Domain> I<name>
2416 =item B<BlockDevice> I<name:dev>
2418 =item B<InterfaceDevice> I<name:dev>
2420 =item B<IgnoreSelected> I<true>|I<false>
2422 Select which domains and devices are collected.
2424 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2425 disk/network devices are collected.
2427 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2428 domains and disk/network devices are ignored, while the rest are collected.
2430 The domain name and device names may use a regular expression, if the name is
2431 surrounded by I</.../> and collectd was compiled with support for regexps.
2433 The default is to collect statistics for all domains and all their devices.
2437 BlockDevice "/:hdb/"
2438 IgnoreSelected "true"
2440 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2443 =item B<HostnameFormat> B<name|uuid|hostname|...>
2445 When the libvirt plugin logs data, it sets the hostname of the collected data
2446 according to this setting. The default is to use the guest name as provided by
2447 the hypervisor, which is equal to setting B<name>.
2449 B<uuid> means use the guest's UUID. This is useful if you want to track the
2450 same guest across migrations.
2452 B<hostname> means to use the global B<Hostname> setting, which is probably not
2453 useful on its own because all guests will appear to have the same name.
2455 You can also specify combinations of these fields. For example B<name uuid>
2456 means to concatenate the guest name and UUID (with a literal colon character
2457 between, thus I<"foo:1234-1234-1234-1234">).
2459 =item B<InterfaceFormat> B<name>|B<address>
2461 When the libvirt plugin logs interface data, it sets the name of the collected
2462 data according to this setting. The default is to use the path as provided by
2463 the hypervisor (the "dev" property of the target node), which is equal to
2466 B<address> means use the interface's mac address. This is useful since the
2467 interface path might change between reboots of a guest or across migrations.
2469 =item B<PluginInstanceFormat> B<name|uuid>
2471 When the libvirt plugin logs data, it sets the plugin_instance of the collected
2472 data according to this setting. The default is to use the guest name as provided
2473 by the hypervisor, which is equal to setting B<name>.
2475 B<uuid> means use the guest's UUID.
2479 =head2 Plugin C<load>
2481 The I<Load plugin> collects the system load. These numbers give a rough overview
2482 over the utilization of a machine. The system load is defined as the number of
2483 runnable tasks in the run-queue and is provided by many operating systems as a
2484 one, five or fifteen minute average.
2486 The following configuration options are available:
2490 =item B<ReportRelative> B<false>|B<true>
2492 When enabled, system load divided by number of available CPU cores is reported
2493 for intervals 1 min, 5 min and 15 min. Defaults to false.
2498 =head2 Plugin C<logfile>
2502 =item B<LogLevel> B<debug|info|notice|warning|err>
2504 Sets the log-level. If, for example, set to B<notice>, then all events with
2505 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2507 Please note that B<debug> is only available if collectd has been compiled with
2510 =item B<File> I<File>
2512 Sets the file to write log messages to. The special strings B<stdout> and
2513 B<stderr> can be used to write to the standard output and standard error
2514 channels, respectively. This, of course, only makes much sense when I<collectd>
2515 is running in foreground- or non-daemon-mode.
2517 =item B<Timestamp> B<true>|B<false>
2519 Prefix all lines printed by the current time. Defaults to B<true>.
2521 =item B<PrintSeverity> B<true>|B<false>
2523 When enabled, all lines are prefixed by the severity of the log message, for
2524 example "warning". Defaults to B<false>.
2528 B<Note>: There is no need to notify the daemon after moving or removing the
2529 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2530 for each line it writes.
2532 =head2 Plugin C<log_logstash>
2534 The I<log logstash plugin> behaves like the logfile plugin but formats
2535 messages as JSON events for logstash to parse and input.
2539 =item B<LogLevel> B<debug|info|notice|warning|err>
2541 Sets the log-level. If, for example, set to B<notice>, then all events with
2542 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2544 Please note that B<debug> is only available if collectd has been compiled with
2547 =item B<File> I<File>
2549 Sets the file to write log messages to. The special strings B<stdout> and
2550 B<stderr> can be used to write to the standard output and standard error
2551 channels, respectively. This, of course, only makes much sense when I<collectd>
2552 is running in foreground- or non-daemon-mode.
2556 B<Note>: There is no need to notify the daemon after moving or removing the
2557 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2558 for each line it writes.
2560 =head2 Plugin C<lpar>
2562 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2563 virtualization technique for IBM POWER processors. It takes into account CPU
2564 time stolen from or donated to a partition, in addition to the usual user,
2565 system, I/O statistics.
2567 The following configuration options are available:
2571 =item B<CpuPoolStats> B<false>|B<true>
2573 When enabled, statistics about the processor pool are read, too. The partition
2574 needs to have pool authority in order to be able to acquire this information.
2577 =item B<ReportBySerial> B<false>|B<true>
2579 If enabled, the serial of the physical machine the partition is currently
2580 running on is reported as I<hostname> and the logical hostname of the machine
2581 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2582 used (just like other plugins) and the I<plugin instance> will be empty.
2587 =head2 Plugin C<mbmon>
2589 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2591 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2592 B<Host> and B<Port> options can be used to change these values, see below.
2593 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2594 timeouts may appear which may interfere with other statistics..
2596 C<mbmon> must be run with the -r option ("print TAG and Value format");
2597 Debian's F</etc/init.d/mbmon> script already does this, other people
2598 will need to ensure that this is the case.
2602 =item B<Host> I<Hostname>
2604 Hostname to connect to. Defaults to B<127.0.0.1>.
2606 =item B<Port> I<Port>
2608 TCP-Port to connect to. Defaults to B<411>.
2614 The C<md plugin> collects information from Linux Software-RAID devices (md).
2616 All reported values are of the type C<md_disks>. Reported type instances are
2617 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2618 I<missing> (physically absent) disks.
2622 =item B<Device> I<Device>
2624 Select md devices based on device name. The I<device name> is the basename of
2625 the device, i.e. the name of the block device without the leading C</dev/>.
2626 See B<IgnoreSelected> for more details.
2628 =item B<IgnoreSelected> B<true>|B<false>
2630 Invert device selection: If set to B<true>, all md devices B<except> those
2631 listed using B<Device> are collected. If B<false> (the default), only those
2632 listed are collected. If no configuration is given, the B<md> plugin will
2633 collect data from all md devices.
2637 =head2 Plugin C<memcachec>
2639 The C<memcachec plugin> connects to a memcached server, queries one or more
2640 given I<pages> and parses the returned data according to user specification.
2641 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2644 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2645 library. Please note that there is another library with a very similar name,
2646 libmemcache (notice the missing `d'), which is not applicable.
2648 Synopsis of the configuration:
2650 <Plugin "memcachec">
2651 <Page "plugin_instance">
2655 Regex "(\\d+) bytes sent"
2658 Instance "type_instance"
2663 The configuration options are:
2667 =item E<lt>B<Page> I<Name>E<gt>
2669 Each B<Page> block defines one I<page> to be queried from the memcached server.
2670 The block requires one string argument which is used as I<plugin instance>.
2672 =item B<Server> I<Address>
2674 Sets the server address to connect to when querying the page. Must be inside a
2679 When connected to the memcached server, asks for the page I<Key>.
2681 =item E<lt>B<Match>E<gt>
2683 Match blocks define which strings to look for and how matches substrings are
2684 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2688 =head2 Plugin C<memcached>
2690 The B<memcached plugin> connects to a memcached server and queries statistics
2691 about cache utilization, memory and bandwidth used.
2692 L<http://www.danga.com/memcached/>
2694 <Plugin "memcached">
2696 Host "memcache.example.com"
2701 The plugin configuration consists of one or more B<Instance> blocks which
2702 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2703 following options are allowed:
2707 =item B<Host> I<Hostname>
2709 Hostname to connect to. Defaults to B<127.0.0.1>.
2711 =item B<Port> I<Port>
2713 TCP-Port to connect to. Defaults to B<11211>.
2715 =item B<Socket> I<Path>
2717 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2718 setting is given, the B<Host> and B<Port> settings are ignored.
2722 =head2 Plugin C<mic>
2724 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2725 Intel's Many Integrated Core (MIC) systems.
2734 ShowTemperatures true
2737 IgnoreSelectedTemperature true
2742 IgnoreSelectedPower true
2745 The following options are valid inside the B<PluginE<nbsp>mic> block:
2749 =item B<ShowCPU> B<true>|B<false>
2751 If enabled (the default) a sum of the CPU usage across all cores is reported.
2753 =item B<ShowCPUCores> B<true>|B<false>
2755 If enabled (the default) per-core CPU usage is reported.
2757 =item B<ShowMemory> B<true>|B<false>
2759 If enabled (the default) the physical memory usage of the MIC system is
2762 =item B<ShowTemperatures> B<true>|B<false>
2764 If enabled (the default) various temperatures of the MIC system are reported.
2766 =item B<Temperature> I<Name>
2768 This option controls which temperatures are being reported. Whether matching
2769 temperatures are being ignored or I<only> matching temperatures are reported
2770 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2771 temperatures are reported.
2773 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2775 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2776 (the default) only temperatures matching a B<Temperature> option are reported
2777 or, if no B<Temperature> option is specified, all temperatures are reported. If
2778 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2781 Known temperature names are:
2815 =item B<ShowPower> B<true>|B<false>
2817 If enabled (the default) various temperatures of the MIC system are reported.
2819 =item B<Power> I<Name>
2821 This option controls which power readings are being reported. Whether matching
2822 power readings are being ignored or I<only> matching power readings are reported
2823 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2824 power readings are reported.
2826 =item B<IgnoreSelectedPower> B<false>|B<true>
2828 Controls the behavior of the B<Power> setting above. If set to B<false>
2829 (the default) only power readings matching a B<Power> option are reported
2830 or, if no B<Power> option is specified, all power readings are reported. If
2831 set to B<true>, matching power readings are I<ignored> and all other power readings
2834 Known power names are:
2840 Total power utilization averaged over Time Window 0 (uWatts).
2844 Total power utilization averaged over Time Window 0 (uWatts).
2848 Instantaneous power (uWatts).
2852 Max instantaneous power (uWatts).
2856 PCI-E connector power (uWatts).
2860 2x3 connector power (uWatts).
2864 2x4 connector power (uWatts).
2872 Uncore rail (uVolts).
2876 Memory subsystem rail (uVolts).
2882 =head2 Plugin C<memory>
2884 The I<memory plugin> provides the following configuration options:
2888 =item B<ValuesAbsolute> B<true>|B<false>
2890 Enables or disables reporting of physical memory usage in absolute numbers,
2891 i.e. bytes. Defaults to B<true>.
2893 =item B<ValuesPercentage> B<false>|B<true>
2895 Enables or disables reporting of physical memory usage in percentages, e.g.
2896 percent of physical memory used. Defaults to B<false>.
2898 This is useful for deploying I<collectd> in a heterogeneous environment in
2899 which the sizes of physical memory vary.
2903 =head2 Plugin C<modbus>
2905 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2906 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2907 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2908 values (two registers interpreted as IEEE floats in big endian notation).
2912 <Data "voltage-input-1">
2919 <Data "voltage-input-2">
2926 <Host "modbus.example.com">
2927 Address "192.168.0.42"
2932 Instance "power-supply"
2933 Collect "voltage-input-1"
2934 Collect "voltage-input-2"
2940 =item E<lt>B<Data> I<Name>E<gt> blocks
2942 Data blocks define a mapping between register numbers and the "types" used by
2945 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2949 =item B<RegisterBase> I<Number>
2951 Configures the base register to read from the device. If the option
2952 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2953 register will be read (the register number is increased by one).
2955 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2957 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2958 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2959 combined into one value. Defaults to B<Uint16>.
2961 =item B<Type> I<Type>
2963 Specifies the "type" (data set) to use when dispatching the value to
2964 I<collectd>. Currently, only data sets with exactly one data source are
2967 =item B<Instance> I<Instance>
2969 Sets the type instance to use when dispatching the value to I<collectd>. If
2970 unset, an empty string (no type instance) is used.
2974 =item E<lt>B<Host> I<Name>E<gt> blocks
2976 Host blocks are used to specify to which hosts to connect and what data to read
2977 from their "slaves". The string argument I<Name> is used as hostname when
2978 dispatching the values to I<collectd>.
2980 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2984 =item B<Address> I<Hostname>
2986 Specifies the node name (the actual network address) used to connect to the
2987 host. This may be an IP address or a hostname. Please note that the used
2988 I<libmodbus> library only supports IPv4 at the moment.
2990 =item B<Port> I<Service>
2992 Specifies the port used to connect to the host. The port can either be given as
2993 a number or as a service name. Please note that the I<Service> argument must be
2994 a string, even if ports are given in their numerical form. Defaults to "502".
2996 =item B<Interval> I<Interval>
2998 Sets the interval (in seconds) in which the values will be collected from this
2999 host. By default the global B<Interval> setting will be used.
3001 =item E<lt>B<Slave> I<ID>E<gt>
3003 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
3004 is used to specify which device should be addressed. For each device you want
3005 to query, one B<Slave> block must be given.
3007 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3011 =item B<Instance> I<Instance>
3013 Specify the plugin instance to use when dispatching the values to I<collectd>.
3014 By default "slave_I<ID>" is used.
3016 =item B<Collect> I<DataName>
3018 Specifies which data to retrieve from the device. I<DataName> must be the same
3019 string as the I<Name> argument passed to a B<Data> block. You can specify this
3020 option multiple times to collect more than one value from a slave. At least one
3021 B<Collect> option is mandatory.
3029 =head2 Plugin C<mysql>
3031 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3032 one or more databases when started and keeps the connection up as long as
3033 possible. When the connection is interrupted for whatever reason it will try
3034 to re-connect. The plugin will complain loudly in case anything goes wrong.
3036 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3037 and collects information about MySQL network traffic, executed statements,
3038 requests, the query cache and threads by evaluating the
3039 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3040 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3041 Status Variables> for an explanation of these values.
3043 Optionally, master and slave statistics may be collected in a MySQL
3044 replication setup. In that case, information about the synchronization state
3045 of the nodes are collected by evaluating the C<Position> return value of the
3046 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3047 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3048 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3049 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3050 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3067 Socket "/var/run/mysql/mysqld.sock"
3069 SlaveNotifications true
3073 A B<Database> block defines one connection to a MySQL database. It accepts a
3074 single argument which specifies the name of the database. None of the other
3075 options are required. MySQL will use default values as documented in the
3076 section "mysql_real_connect()" in the B<MySQL reference manual>.
3080 =item B<Alias> I<Alias>
3082 Alias to use as sender instead of hostname when reporting. This may be useful
3083 when having cryptic hostnames.
3085 =item B<Host> I<Hostname>
3087 Hostname of the database server. Defaults to B<localhost>.
3089 =item B<User> I<Username>
3091 Username to use when connecting to the database. The user does not have to be
3092 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3093 unless you want to collectd replication statistics (see B<MasterStats> and
3094 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3095 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3097 =item B<Password> I<Password>
3099 Password needed to log into the database.
3101 =item B<Database> I<Database>
3103 Select this database. Defaults to I<no database> which is a perfectly reasonable
3104 option for what this plugin does.
3106 =item B<Port> I<Port>
3108 TCP-port to connect to. The port must be specified in its numeric form, but it
3109 must be passed as a string nonetheless. For example:
3113 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3114 See the documentation for the C<mysql_real_connect> function for details.
3116 =item B<Socket> I<Socket>
3118 Specifies the path to the UNIX domain socket of the MySQL server. This option
3119 only has any effect, if B<Host> is set to B<localhost> (the default).
3120 Otherwise, use the B<Port> option above. See the documentation for the
3121 C<mysql_real_connect> function for details.
3123 =item B<InnodbStats> I<true|false>
3125 If enabled, metrics about the InnoDB storage engine are collected.
3126 Disabled by default.
3128 =item B<MasterStats> I<true|false>
3130 =item B<SlaveStats> I<true|false>
3132 Enable the collection of master / slave statistics in a replication setup. In
3133 order to be able to get access to these statistics, the user needs special
3134 privileges. See the B<User> documentation above.
3136 =item B<SlaveNotifications> I<true|false>
3138 If enabled, the plugin sends a notification if the replication slave I/O and /
3139 or SQL threads are not running.
3141 =item B<ConnectTimeout> I<Seconds>
3143 Sets the connect timeout for the MySQL client.
3147 =head2 Plugin C<netapp>
3149 The netapp plugin can collect various performance and capacity information
3150 from a NetApp filer using the NetApp API.
3152 Please note that NetApp has a wide line of products and a lot of different
3153 software versions for each of these products. This plugin was developed for a
3154 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3155 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3156 model and software version but it is very hard to test this.
3157 If you have used this plugin with other models and/or software version, feel
3158 free to send us a mail to tell us about the results, even if it's just a short
3161 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3162 basic authentication.
3164 B<Do not use a regular user for this!> Create a special collectd user with just
3165 the minimum of capabilities needed. The user only needs the "login-http-admin"
3166 capability as well as a few more depending on which data will be collected.
3167 Required capabilities are documented below.
3172 <Host "netapp1.example.com">
3196 IgnoreSelectedIO false
3198 IgnoreSelectedOps false
3199 GetLatency "volume0"
3200 IgnoreSelectedLatency false
3207 IgnoreSelectedCapacity false
3210 IgnoreSelectedSnapshot false
3238 The netapp plugin accepts the following configuration options:
3242 =item B<Host> I<Name>
3244 A host block defines one NetApp filer. It will appear in collectd with the name
3245 you specify here which does not have to be its real name nor its hostname (see
3246 the B<Address> option below).
3248 =item B<VFiler> I<Name>
3250 A B<VFiler> block may only be used inside a host block. It accepts all the
3251 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3252 will execute all NetApp API commands in the context of the specified
3253 VFiler(R). It will appear in collectd with the name you specify here which
3254 does not have to be its real name. The VFiler name may be specified using the
3255 B<VFilerName> option. If this is not specified, it will default to the name
3258 The VFiler block inherits all connection related settings from the surrounding
3259 B<Host> block (which appear before the B<VFiler> block) but they may be
3260 overwritten inside the B<VFiler> block.
3262 This feature is useful, for example, when using a VFiler as SnapVault target
3263 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3264 available in the host filer (vfiler0) but only in the respective VFiler
3267 =item B<Protocol> B<httpd>|B<http>
3269 The protocol collectd will use to query this host.
3277 Valid options: http, https
3279 =item B<Address> I<Address>
3281 The hostname or IP address of the host.
3287 Default: The "host" block's name.
3289 =item B<Port> I<Port>
3291 The TCP port to connect to on the host.
3297 Default: 80 for protocol "http", 443 for protocol "https"
3299 =item B<User> I<User>
3301 =item B<Password> I<Password>
3303 The username and password to use to login to the NetApp.
3309 =item B<VFilerName> I<Name>
3311 The name of the VFiler in which context to execute API commands. If not
3312 specified, the name provided to the B<VFiler> block will be used instead.
3318 Default: name of the B<VFiler> block
3320 B<Note:> This option may only be used inside B<VFiler> blocks.
3322 =item B<Interval> I<Interval>
3328 The following options decide what kind of data will be collected. You can
3329 either use them as a block and fine tune various parameters inside this block,
3330 use them as a single statement to just accept all default values, or omit it to
3331 not collect any data.
3333 The following options are valid inside all blocks:
3337 =item B<Interval> I<Seconds>
3339 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3340 host specific setting.
3344 =head3 The System block
3346 This will collect various performance data about the whole system.
3348 B<Note:> To get this data the collectd user needs the
3349 "api-perf-object-get-instances" capability.
3353 =item B<Interval> I<Seconds>
3355 Collect disk statistics every I<Seconds> seconds.
3357 =item B<GetCPULoad> B<true>|B<false>
3359 If you set this option to true the current CPU usage will be read. This will be
3360 the average usage between all CPUs in your NetApp without any information about
3363 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3364 returns in the "CPU" field.
3372 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3374 =item B<GetInterfaces> B<true>|B<false>
3376 If you set this option to true the current traffic of the network interfaces
3377 will be read. This will be the total traffic over all interfaces of your NetApp
3378 without any information about individual interfaces.
3380 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3381 in the "Net kB/s" field.
3391 Result: One value list of type "if_octects".
3393 =item B<GetDiskIO> B<true>|B<false>
3395 If you set this option to true the current IO throughput will be read. This
3396 will be the total IO of your NetApp without any information about individual
3397 disks, volumes or aggregates.
3399 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3400 in the "DiskE<nbsp>kB/s" field.
3408 Result: One value list of type "disk_octets".
3410 =item B<GetDiskOps> B<true>|B<false>
3412 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3413 iSCSI, etc. operations will be read. This will be the total number of
3414 operations on your NetApp without any information about individual volumes or
3417 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3418 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3426 Result: A variable number of value lists of type "disk_ops_complex". Each type
3427 of operation will result in one value list with the name of the operation as
3432 =head3 The WAFL block
3434 This will collect various performance data about the WAFL file system. At the
3435 moment this just means cache performance.
3437 B<Note:> To get this data the collectd user needs the
3438 "api-perf-object-get-instances" capability.
3440 B<Note:> The interface to get these values is classified as "Diagnostics" by
3441 NetApp. This means that it is not guaranteed to be stable even between minor
3446 =item B<Interval> I<Seconds>
3448 Collect disk statistics every I<Seconds> seconds.
3450 =item B<GetNameCache> B<true>|B<false>
3458 Result: One value list of type "cache_ratio" and type instance
3461 =item B<GetDirCache> B<true>|B<false>
3469 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3471 =item B<GetInodeCache> B<true>|B<false>
3479 Result: One value list of type "cache_ratio" and type instance
3482 =item B<GetBufferCache> B<true>|B<false>
3484 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3485 in the "Cache hit" field.
3493 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3497 =head3 The Disks block
3499 This will collect performance data about the individual disks in the NetApp.
3501 B<Note:> To get this data the collectd user needs the
3502 "api-perf-object-get-instances" capability.
3506 =item B<Interval> I<Seconds>
3508 Collect disk statistics every I<Seconds> seconds.
3510 =item B<GetBusy> B<true>|B<false>
3512 If you set this option to true the busy time of all disks will be calculated
3513 and the value of the busiest disk in the system will be written.
3515 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3516 in the "Disk util" field. Probably.
3524 Result: One value list of type "percent" and type instance "disk_busy".
3528 =head3 The VolumePerf block
3530 This will collect various performance data about the individual volumes.
3532 You can select which data to collect about which volume using the following
3533 options. They follow the standard ignorelist semantic.
3535 B<Note:> To get this data the collectd user needs the
3536 I<api-perf-object-get-instances> capability.
3540 =item B<Interval> I<Seconds>
3542 Collect volume performance data every I<Seconds> seconds.
3544 =item B<GetIO> I<Volume>
3546 =item B<GetOps> I<Volume>
3548 =item B<GetLatency> I<Volume>
3550 Select the given volume for IO, operations or latency statistics collection.
3551 The argument is the name of the volume without the C</vol/> prefix.
3553 Since the standard ignorelist functionality is used here, you can use a string
3554 starting and ending with a slash to specify regular expression matching: To
3555 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3558 GetIO "/^vol[027]$/"
3560 If no regular expression is specified, an exact match is required. Both,
3561 regular and exact matching are case sensitive.
3563 If no volume was specified at all for either of the three options, that data
3564 will be collected for all available volumes.
3566 =item B<IgnoreSelectedIO> B<true>|B<false>
3568 =item B<IgnoreSelectedOps> B<true>|B<false>
3570 =item B<IgnoreSelectedLatency> B<true>|B<false>
3572 When set to B<true>, the volumes selected for IO, operations or latency
3573 statistics collection will be ignored and the data will be collected for all
3576 When set to B<false>, data will only be collected for the specified volumes and
3577 all other volumes will be ignored.
3579 If no volumes have been specified with the above B<Get*> options, all volumes
3580 will be collected regardless of the B<IgnoreSelected*> option.
3582 Defaults to B<false>
3586 =head3 The VolumeUsage block
3588 This will collect capacity data about the individual volumes.
3590 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3595 =item B<Interval> I<Seconds>
3597 Collect volume usage statistics every I<Seconds> seconds.
3599 =item B<GetCapacity> I<VolumeName>
3601 The current capacity of the volume will be collected. This will result in two
3602 to four value lists, depending on the configuration of the volume. All data
3603 sources are of type "df_complex" with the name of the volume as
3606 There will be type_instances "used" and "free" for the number of used and
3607 available bytes on the volume. If the volume has some space reserved for
3608 snapshots, a type_instance "snap_reserved" will be available. If the volume
3609 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3610 number of bytes saved by the SIS feature.
3612 B<Note:> The current NetApp API has a bug that results in this value being
3613 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3614 number which works most of the time. If you see strange values here, bug
3615 NetApp support to fix this.
3617 Repeat this option to specify multiple volumes.
3619 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3621 Specify whether to collect only the volumes selected by the B<GetCapacity>
3622 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3623 B<false>. However, if no B<GetCapacity> option is specified at all, all
3624 capacities will be selected anyway.
3626 =item B<GetSnapshot> I<VolumeName>
3628 Select volumes from which to collect snapshot information.
3630 Usually, the space used for snapshots is included in the space reported as
3631 "used". If snapshot information is collected as well, the space used for
3632 snapshots is subtracted from the used space.
3634 To make things even more interesting, it is possible to reserve space to be
3635 used for snapshots. If the space required for snapshots is less than that
3636 reserved space, there is "reserved free" and "reserved used" space in addition
3637 to "free" and "used". If the space required for snapshots exceeds the reserved
3638 space, that part allocated in the normal space is subtracted from the "used"
3641 Repeat this option to specify multiple volumes.
3643 =item B<IgnoreSelectedSnapshot>
3645 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3646 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3647 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3648 capacities will be selected anyway.
3652 =head3 The Quota block
3654 This will collect (tree) quota statistics (used disk space and number of used
3655 files). This mechanism is useful to get usage information for single qtrees.
3656 In case the quotas are not used for any other purpose, an entry similar to the
3657 following in C</etc/quotas> would be sufficient:
3659 /vol/volA/some_qtree tree - - - - -
3661 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3665 =item B<Interval> I<Seconds>
3667 Collect SnapVault(R) statistics every I<Seconds> seconds.
3671 =head3 The SnapVault block
3673 This will collect statistics about the time and traffic of SnapVault(R)
3678 =item B<Interval> I<Seconds>
3680 Collect SnapVault(R) statistics every I<Seconds> seconds.
3684 =head2 Plugin C<netlink>
3686 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3687 statistics of various interface and routing aspects.
3691 =item B<Interface> I<Interface>
3693 =item B<VerboseInterface> I<Interface>
3695 Instruct the plugin to collect interface statistics. This is basically the same
3696 as the statistics provided by the C<interface> plugin (see above) but
3697 potentially much more detailed.
3699 When configuring with B<Interface> only the basic statistics will be collected,
3700 namely octets, packets, and errors. These statistics are collected by
3701 the C<interface> plugin, too, so using both at the same time is no benefit.
3703 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3704 so that no data needs to be collected twice if you use the C<interface> plugin.
3705 This includes dropped packets, received multicast packets, collisions and a
3706 whole zoo of differentiated RX and TX errors. You can try the following command
3707 to get an idea of what awaits you:
3711 If I<Interface> is B<All>, all interfaces will be selected.
3713 =item B<QDisc> I<Interface> [I<QDisc>]
3715 =item B<Class> I<Interface> [I<Class>]
3717 =item B<Filter> I<Interface> [I<Filter>]
3719 Collect the octets and packets that pass a certain qdisc, class or filter.
3721 QDiscs and classes are identified by their type and handle (or classid).
3722 Filters don't necessarily have a handle, therefore the parent's handle is used.
3723 The notation used in collectd differs from that used in tc(1) in that it
3724 doesn't skip the major or minor number if it's zero and doesn't print special
3725 ids by their name. So, for example, a qdisc may be identified by
3726 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3727 thus not displayed by tc(1).
3729 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3730 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3731 associated with that interface will be collected.
3733 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3734 used. This may lead to problems when more than one filter is attached to a
3735 qdisc or class. This isn't nice, but we don't know how this could be done any
3736 better. If you have a idea, please don't hesitate to tell us.
3738 As with the B<Interface> option you can specify B<All> as the interface,
3739 meaning all interfaces.
3741 Here are some examples to help you understand the above text more easily:
3744 VerboseInterface "All"
3745 QDisc "eth0" "pfifo_fast-1:0"
3747 Class "ppp0" "htb-1:10"
3748 Filter "ppp0" "u32-1:0"
3751 =item B<IgnoreSelected>
3753 The behavior is the same as with all other similar plugins: If nothing is
3754 selected at all, everything is collected. If some things are selected using the
3755 options described above, only these statistics are collected. If you set
3756 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3757 specified statistics will not be collected.
3761 =head2 Plugin C<network>
3763 The Network plugin sends data to a remote instance of collectd, receives data
3764 from a remote instance, or both at the same time. Data which has been received
3765 from the network is usually not transmitted again, but this can be activated, see
3766 the B<Forward> option below.
3768 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3769 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3771 Both, B<Server> and B<Listen> can be used as single option or as block. When
3772 used as block, given options are valid for this socket only. The following
3773 example will export the metrics twice: Once to an "internal" server (without
3774 encryption and signing) and one to an external server (with cryptographic
3778 # Export to an internal server
3779 # (demonstrates usage without additional options)
3780 Server "collectd.internal.tld"
3782 # Export to an external server
3783 # (demonstrates usage with signature options)
3784 <Server "collectd.external.tld">
3785 SecurityLevel "sign"
3786 Username "myhostname"
3793 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3795 The B<Server> statement/block sets the server to send datagrams to. The
3796 statement may occur multiple times to send each datagram to multiple
3799 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3800 optional second argument specifies a port number or a service name. If not
3801 given, the default, B<25826>, is used.
3803 The following options are recognized within B<Server> blocks:
3807 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3809 Set the security you require for network communication. When the security level
3810 has been set to B<Encrypt>, data sent over the network will be encrypted using
3811 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3812 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3813 authentication code. When set to B<None>, data is sent without any security.
3815 This feature is only available if the I<network> plugin was linked with
3818 =item B<Username> I<Username>
3820 Sets the username to transmit. This is used by the server to lookup the
3821 password. See B<AuthFile> below. All security levels except B<None> require
3824 This feature is only available if the I<network> plugin was linked with
3827 =item B<Password> I<Password>
3829 Sets a password (shared secret) for this socket. All security levels except
3830 B<None> require this setting.
3832 This feature is only available if the I<network> plugin was linked with
3835 =item B<Interface> I<Interface name>
3837 Set the outgoing interface for IP packets. This applies at least
3838 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3839 undefined or a non-existent interface name is specified, the default
3840 behavior is to let the kernel choose the appropriate interface. Be warned
3841 that the manual selection of an interface for unicast traffic is only
3842 necessary in rare cases.
3846 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3848 The B<Listen> statement sets the interfaces to bind to. When multiple
3849 statements are found the daemon will bind to multiple interfaces.
3851 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3852 the argument is a multicast address the daemon will join that multicast group.
3853 The optional second argument specifies a port number or a service name. If not
3854 given, the default, B<25826>, is used.
3856 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3860 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3862 Set the security you require for network communication. When the security level
3863 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3864 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3865 signed and encrypted data is accepted. When set to B<None>, all data will be
3866 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3867 decrypted if possible.
3869 This feature is only available if the I<network> plugin was linked with
3872 =item B<AuthFile> I<Filename>
3874 Sets a file in which usernames are mapped to passwords. These passwords are
3875 used to verify signatures and to decrypt encrypted network packets. If
3876 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3877 verified and encrypted packets are decrypted. Otherwise, signed data is
3878 accepted without checking the signature and encrypted data cannot be decrypted.
3879 For the other security levels this option is mandatory.
3881 The file format is very simple: Each line consists of a username followed by a
3882 colon and any number of spaces followed by the password. To demonstrate, an
3883 example file could look like this:
3888 Each time a packet is received, the modification time of the file is checked
3889 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3890 the file is being read, it is locked using L<fcntl(2)>.
3892 =item B<Interface> I<Interface name>
3894 Set the incoming interface for IP packets explicitly. This applies at least
3895 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3896 undefined or a non-existent interface name is specified, the default
3897 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3898 traffic gets only accepted, if it arrives on the given interface.
3902 =item B<TimeToLive> I<1-255>
3904 Set the time-to-live of sent packets. This applies to all, unicast and
3905 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3906 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3909 =item B<MaxPacketSize> I<1024-65535>
3911 Set the maximum size for datagrams received over the network. Packets larger
3912 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3913 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3916 On the server side, this limit should be set to the largest value used on
3917 I<any> client. Likewise, the value on the client must not be larger than the
3918 value on the server, or data will be lost.
3920 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3921 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3922 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3925 =item B<Forward> I<true|false>
3927 If set to I<true>, write packets that were received via the network plugin to
3928 the sending sockets. This should only be activated when the B<Listen>- and
3929 B<Server>-statements differ. Otherwise packets may be send multiple times to
3930 the same multicast group. While this results in more network traffic than
3931 necessary it's not a huge problem since the plugin has a duplicate detection,
3932 so the values will not loop.
3934 =item B<ReportStats> B<true>|B<false>
3936 The network plugin cannot only receive and send statistics, it can also create
3937 statistics about itself. Collected data included the number of received and
3938 sent octets and packets, the length of the receive queue and the number of
3939 values handled. When set to B<true>, the I<Network plugin> will make these
3940 statistics available. Defaults to B<false>.
3944 =head2 Plugin C<nginx>
3946 This plugin collects the number of connections and requests handled by the
3947 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3948 queries the page provided by the C<ngx_http_stub_status_module> module, which
3949 isn't compiled by default. Please refer to
3950 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3951 how to compile and configure nginx and this module.
3953 The following options are accepted by the C<nginx plugin>:
3957 =item B<URL> I<http://host/nginx_status>
3959 Sets the URL of the C<ngx_http_stub_status_module> output.
3961 =item B<User> I<Username>
3963 Optional user name needed for authentication.
3965 =item B<Password> I<Password>
3967 Optional password needed for authentication.
3969 =item B<VerifyPeer> B<true|false>
3971 Enable or disable peer SSL certificate verification. See
3972 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3974 =item B<VerifyHost> B<true|false>
3976 Enable or disable peer host name verification. If enabled, the plugin checks
3977 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3978 certificate matches the host name provided by the B<URL> option. If this
3979 identity check fails, the connection is aborted. Obviously, only works when
3980 connecting to a SSL enabled server. Enabled by default.
3982 =item B<CACert> I<File>
3984 File that holds one or more SSL certificates. If you want to use HTTPS you will
3985 possibly need this option. What CA certificates come bundled with C<libcurl>
3986 and are checked by default depends on the distribution you use.
3990 =head2 Plugin C<notify_desktop>
3992 This plugin sends a desktop notification to a notification daemon, as defined
3993 in the Desktop Notification Specification. To actually display the
3994 notifications, B<notification-daemon> is required and B<collectd> has to be
3995 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3996 environment variables have to be set correctly) and the D-Bus message bus.
3998 The Desktop Notification Specification can be found at
3999 L<http://www.galago-project.org/specs/notification/>.
4003 =item B<OkayTimeout> I<timeout>
4005 =item B<WarningTimeout> I<timeout>
4007 =item B<FailureTimeout> I<timeout>
4009 Set the I<timeout>, in milliseconds, after which to expire the notification
4010 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4011 been specified, the displayed notification will not be closed at all - the
4012 user has to do so herself. These options default to 5000. If a negative number
4013 has been specified, the default is used as well.
4017 =head2 Plugin C<notify_email>
4019 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4020 configured email address.
4022 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4024 Available configuration options:
4028 =item B<From> I<Address>
4030 Email address from which the emails should appear to come from.
4032 Default: C<root@localhost>
4034 =item B<Recipient> I<Address>
4036 Configures the email address(es) to which the notifications should be mailed.
4037 May be repeated to send notifications to multiple addresses.
4039 At least one B<Recipient> must be present for the plugin to work correctly.
4041 =item B<SMTPServer> I<Hostname>
4043 Hostname of the SMTP server to connect to.
4045 Default: C<localhost>
4047 =item B<SMTPPort> I<Port>
4049 TCP port to connect to.
4053 =item B<SMTPUser> I<Username>
4055 Username for ASMTP authentication. Optional.
4057 =item B<SMTPPassword> I<Password>
4059 Password for ASMTP authentication. Optional.
4061 =item B<Subject> I<Subject>
4063 Subject-template to use when sending emails. There must be exactly two
4064 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4065 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4068 Default: C<Collectd notify: %s@%s>
4072 =head2 Plugin C<ntpd>
4076 =item B<Host> I<Hostname>
4078 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4080 =item B<Port> I<Port>
4082 UDP-Port to connect to. Defaults to B<123>.
4084 =item B<ReverseLookups> B<true>|B<false>
4086 Sets whether or not to perform reverse lookups on peers. Since the name or
4087 IP-address may be used in a filename it is recommended to disable reverse
4088 lookups. The default is to do reverse lookups to preserve backwards
4089 compatibility, though.
4091 =item B<IncludeUnitID> B<true>|B<false>
4093 When a peer is a refclock, include the unit ID in the I<type instance>.
4094 Defaults to B<false> for backward compatibility.
4096 If two refclock peers use the same driver and this is B<false>, the plugin will
4097 try to write simultaneous measurements from both to the same type instance.
4098 This will result in error messages in the log and only one set of measurements
4103 =head2 Plugin C<nut>
4107 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4109 Add a UPS to collect data from. The format is identical to the one accepted by
4114 =head2 Plugin C<olsrd>
4116 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4117 the Optimized Link State Routing daemon and reads information about the current
4118 state of the meshed network.
4120 The following configuration options are understood:
4124 =item B<Host> I<Host>
4126 Connect to I<Host>. Defaults to B<"localhost">.
4128 =item B<Port> I<Port>
4130 Specifies the port to connect to. This must be a string, even if you give the
4131 port as a number rather than a service name. Defaults to B<"2006">.
4133 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4135 Specifies what information to collect about links, i.E<nbsp>e. direct
4136 connections of the daemon queried. If set to B<No>, no information is
4137 collected. If set to B<Summary>, the number of links and the average of all
4138 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4139 If set to B<Detail> LQ and NLQ are collected per link.
4141 Defaults to B<Detail>.
4143 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4145 Specifies what information to collect about routes of the daemon queried. If
4146 set to B<No>, no information is collected. If set to B<Summary>, the number of
4147 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4148 metric and ETX are collected per route.
4150 Defaults to B<Summary>.
4152 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4154 Specifies what information to collect about the global topology. If set to
4155 B<No>, no information is collected. If set to B<Summary>, the number of links
4156 in the entire topology and the average I<link quality> (LQ) is calculated.
4157 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4159 Defaults to B<Summary>.
4163 =head2 Plugin C<onewire>
4165 B<EXPERIMENTAL!> See notes below.
4167 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4168 L<http://owfs.org/> to read sensors connected via the onewire bus.
4170 It can be used in two possible modes - standard or advanced.
4172 In the standard mode only temperature sensors (sensors with the family code
4173 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4174 other sensors you would like to have included, please send a sort request to
4175 the mailing list. You can select sensors to be read or to be ignored depending
4176 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4177 walked and all sensors are read.
4179 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4180 experimental, below.
4182 In the advanced mode you can configure any sensor to be read (only numerical
4183 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4184 In this mode you have to list all the sensors. Neither default bus walk nor
4185 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4186 the path automatically and should produce compatible structure with the "standard"
4187 mode (basically the path is expected as for example
4188 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4189 "F10FCA000800" and the rest after the slash is considered the type - here
4191 There are two advantages to this mode - you can access virtually any sensor
4192 (not just temperature), select whether to use cached or directly read values
4193 and it is slighlty faster. The downside is more complex configuration.
4195 The two modes are distinguished automatically by the format of the address.
4196 It is not possible to mix the two modes. Once a full path is detected in any
4197 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4198 (and as standard addresses will fail parsing they will be ignored).
4202 =item B<Device> I<Device>
4204 Sets the device to read the values from. This can either be a "real" hardware
4205 device, such as a serial port or an USB port, or the address of the
4206 L<owserver(1)> socket, usually B<localhost:4304>.
4208 Though the documentation claims to automatically recognize the given address
4209 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4210 with that version, the following configuration worked for us:
4213 Device "-s localhost:4304"
4216 This directive is B<required> and does not have a default value.
4218 =item B<Sensor> I<Sensor>
4220 In the standard mode selects sensors to collect or to ignore
4221 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4222 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4223 and B<not> include the leading C<10.> family byte and point.
4224 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4225 sensors (see above) are read.
4227 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4228 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4229 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4231 As there can be multiple devices on the bus you can list multiple sensor (use
4232 multiple B<Sensor> elements).
4234 =item B<IgnoreSelected> I<true>|I<false>
4236 If no configuration is given, the B<onewire> plugin will collect data from all
4237 sensors found. This may not be practical, especially if sensors are added and
4238 removed regularly. Sometimes, however, it's easier/preferred to collect only
4239 specific sensors or all sensors I<except> a few specified ones. This option
4240 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4241 B<Sensor> is inverted: All selected interfaces are ignored and all other
4242 interfaces are collected.
4244 Used only in the standard mode - see above.
4246 =item B<Interval> I<Seconds>
4248 Sets the interval in which all sensors should be read. If not specified, the
4249 global B<Interval> setting is used.
4253 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4254 work with big setups. It works with one sensor being attached to one
4255 controller, but as soon as you throw in a couple more senors and maybe a hub
4256 or two, reading all values will take more than ten seconds (the default
4257 interval). We will probably add some separate thread for reading the sensors
4258 and some cache or something like that, but it's not done yet. We will try to
4259 maintain backwards compatibility in the future, but we can't promise. So in
4260 short: If it works for you: Great! But keep in mind that the config I<might>
4261 change, though this is unlikely. Oh, and if you want to help improving this
4262 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4264 =head2 Plugin C<openvpn>
4266 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4267 traffic statistics about connected clients.
4269 To set up OpenVPN to write to the status file periodically, use the
4270 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4271 you need to set the required format, too. This is done by setting
4272 B<--status-version> to B<2>.
4274 So, in a nutshell you need:
4276 openvpn $OTHER_OPTIONS \
4277 --status "/var/run/openvpn-status" 10 \
4284 =item B<StatusFile> I<File>
4286 Specifies the location of the status file.
4288 =item B<ImprovedNamingSchema> B<true>|B<false>
4290 When enabled, the filename of the status file will be used as plugin instance
4291 and the client's "common name" will be used as type instance. This is required
4292 when reading multiple status files. Enabling this option is recommended, but to
4293 maintain backwards compatibility this option is disabled by default.
4295 =item B<CollectCompression> B<true>|B<false>
4297 Sets whether or not statistics about the compression used by OpenVPN should be
4298 collected. This information is only available in I<single> mode. Enabled by
4301 =item B<CollectIndividualUsers> B<true>|B<false>
4303 Sets whether or not traffic information is collected for each connected client
4304 individually. If set to false, currently no traffic data is collected at all
4305 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4307 =item B<CollectUserCount> B<true>|B<false>
4309 When enabled, the number of currently connected clients or users is collected.
4310 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4311 can be configured independently from that option. Defaults to B<false>.
4315 =head2 Plugin C<oracle>
4317 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4318 Oracle® Database and lets you execute SQL statements there. It is very similar
4319 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4320 plugin's documentation above for details.
4323 <Query "out_of_stock">
4324 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4327 # InstancePrefix "foo"
4328 InstancesFrom "category"
4332 <Database "product_information">
4336 Query "out_of_stock"
4340 =head3 B<Query> blocks
4342 The Query blocks are handled identically to the Query blocks of the "dbi"
4343 plugin. Please see its documentation above for details on how to specify
4346 =head3 B<Database> blocks
4348 Database blocks define a connection to a database and which queries should be
4349 sent to that database. Each database needs a "name" as string argument in the
4350 starting tag of the block. This name will be used as "PluginInstance" in the
4351 values submitted to the daemon. Other than that, that name is not used.
4355 =item B<ConnectID> I<ID>
4357 Defines the "database alias" or "service name" to connect to. Usually, these
4358 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4360 =item B<Host> I<Host>
4362 Hostname to use when dispatching values for this database. Defaults to using
4363 the global hostname of the I<collectd> instance.
4365 =item B<Username> I<Username>
4367 Username used for authentication.
4369 =item B<Password> I<Password>
4371 Password used for authentication.
4373 =item B<Query> I<QueryName>
4375 Associates the query named I<QueryName> with this database connection. The
4376 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4377 blocks you want to refer to must be placed above the database block you want to
4382 =head2 Plugin C<perl>
4384 This plugin embeds a Perl-interpreter into collectd and provides an interface
4385 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4387 =head2 Plugin C<pinba>
4389 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4390 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4391 PHP-based webpage has been delivered, the extension will send a UDP packet
4392 containing timing information, peak memory usage and so on. The plugin will
4393 wait for such packets, parse them and account the provided information, which
4394 is then dispatched to the daemon once per interval.
4401 # Overall statistics for the website.
4403 Server "www.example.com"
4405 # Statistics for www-a only
4407 Host "www-a.example.com"
4408 Server "www.example.com"
4410 # Statistics for www-b only
4412 Host "www-b.example.com"
4413 Server "www.example.com"
4417 The plugin provides the following configuration options:
4421 =item B<Address> I<Node>
4423 Configures the address used to open a listening socket. By default, plugin will
4424 bind to the I<any> address C<::0>.
4426 =item B<Port> I<Service>
4428 Configures the port (service) to bind to. By default the default Pinba port
4429 "30002" will be used. The option accepts service names in addition to port
4430 numbers and thus requires a I<string> argument.
4432 =item E<lt>B<View> I<Name>E<gt> block
4434 The packets sent by the Pinba extension include the hostname of the server, the
4435 server name (the name of the virtual host) and the script that was executed.
4436 Using B<View> blocks it is possible to separate the data into multiple groups
4437 to get more meaningful statistics. Each packet is added to all matching groups,
4438 so that a packet may be accounted for more than once.
4442 =item B<Host> I<Host>
4444 Matches the hostname of the system the webserver / script is running on. This
4445 will contain the result of the L<gethostname(2)> system call. If not
4446 configured, all hostnames will be accepted.
4448 =item B<Server> I<Server>
4450 Matches the name of the I<virtual host>, i.e. the contents of the
4451 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4452 server names will be accepted.
4454 =item B<Script> I<Script>
4456 Matches the name of the I<script name>, i.e. the contents of the
4457 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4458 script names will be accepted.
4464 =head2 Plugin C<ping>
4466 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4467 configured hosts periodically and measures the network latency. Whenever the
4468 C<read> function of the plugin is called, it submits the average latency, the
4469 standard deviation and the drop rate for each host.
4471 Available configuration options:
4475 =item B<Host> I<IP-address>
4477 Host to ping periodically. This option may be repeated several times to ping
4480 =item B<Interval> I<Seconds>
4482 Sets the interval in which to send ICMP echo packets to the configured hosts.
4483 This is B<not> the interval in which statistics are queries from the plugin but
4484 the interval in which the hosts are "pinged". Therefore, the setting here
4485 should be smaller than or equal to the global B<Interval> setting. Fractional
4486 times, such as "1.24" are allowed.
4490 =item B<Timeout> I<Seconds>
4492 Time to wait for a response from the host to which an ICMP packet had been
4493 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4494 to be down or the packet to be dropped. This setting must be smaller than the
4495 B<Interval> setting above for the plugin to work correctly. Fractional
4496 arguments are accepted.
4500 =item B<TTL> I<0-255>
4502 Sets the Time-To-Live of generated ICMP packets.
4504 =item B<SourceAddress> I<host>
4506 Sets the source address to use. I<host> may either be a numerical network
4507 address or a network hostname.
4509 =item B<Device> I<name>
4511 Sets the outgoing network device to be used. I<name> has to specify an
4512 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4515 =item B<MaxMissed> I<Packets>
4517 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4518 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4520 Default: B<-1> (disabled)
4524 =head2 Plugin C<postgresql>
4526 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4527 keeps a persistent connection to all configured databases and tries to
4528 reconnect if the connection has been interrupted. A database is configured by
4529 specifying a B<Database> block as described below. The default statistics are
4530 collected from PostgreSQL's B<statistics collector> which thus has to be
4531 enabled for this plugin to work correctly. This should usually be the case by
4532 default. See the section "The Statistics Collector" of the B<PostgreSQL
4533 Documentation> for details.
4535 By specifying custom database queries using a B<Query> block as described
4536 below, you may collect any data that is available from some PostgreSQL
4537 database. This way, you are able to access statistics of external daemons
4538 which are available in a PostgreSQL database or use future or special
4539 statistics provided by PostgreSQL without the need to upgrade your collectd
4542 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4543 PostgreSQL databases as well. This has been implemented in a generic way. You
4544 need to specify an SQL statement which will then be executed by collectd in
4545 order to write the data (see below for details). The benefit of that approach
4546 is that there is no fixed database layout. Rather, the layout may be optimized
4547 for the current setup.
4549 The B<PostgreSQL Documentation> manual can be found at
4550 L<http://www.postgresql.org/docs/manuals/>.
4554 Statement "SELECT magic FROM wizard WHERE host = $1;"
4558 InstancePrefix "magic"
4563 <Query rt36_tickets>
4564 Statement "SELECT COUNT(type) AS count, type \
4566 WHEN resolved = 'epoch' THEN 'open' \
4567 ELSE 'resolved' END AS type \
4568 FROM tickets) type \
4572 InstancePrefix "rt36_tickets"
4573 InstancesFrom "type"
4579 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4589 KRBSrvName "kerberos_service_name"
4595 Service "service_name"
4596 Query backend # predefined
4607 The B<Query> block defines one database query which may later be used by a
4608 database definition. It accepts a single mandatory argument which specifies
4609 the name of the query. The names of all queries have to be unique (see the
4610 B<MinVersion> and B<MaxVersion> options below for an exception to this
4611 rule). The following configuration options are available to define the query:
4613 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4614 blocks define how to handle the values returned from the query. They define
4615 which column holds which value and how to dispatch that value to the daemon.
4616 Multiple B<Result> blocks may be used to extract multiple values from a single
4621 =item B<Statement> I<sql query statement>
4623 Specify the I<sql query statement> which the plugin should execute. The string
4624 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4625 first, second, etc. parameter. The value of the parameters is specified by the
4626 B<Param> configuration option - see below for details. To include a literal
4627 B<$> character followed by a number, surround it with single quotes (B<'>).
4629 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4630 allowed. Note, however, that only a single command may be used. Semicolons are
4631 allowed as long as a single non-empty command has been specified only.
4633 The returned lines will be handled separately one after another.
4635 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4637 Specify the parameters which should be passed to the SQL query. The parameters
4638 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4639 they appear in the configuration file. The value of the parameter is
4640 determined depending on the value of the B<Param> option as follows:
4646 The configured hostname of the database connection. If a UNIX domain socket is
4647 used, the parameter expands to "localhost".
4651 The name of the database of the current connection.
4655 The name of the database plugin instance. See the B<Instance> option of the
4656 database specification below for details.
4660 The username used to connect to the database.
4664 The interval with which this database is queried (as specified by the database
4665 specific or global B<Interval> options).
4669 Please note that parameters are only supported by PostgreSQL's protocol
4670 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4672 =item B<Type> I<type>
4674 The I<type> name to be used when dispatching the values. The type describes
4675 how to handle the data and where to store it. See L<types.db(5)> for more
4676 details on types and their configuration. The number and type of values (as
4677 selected by the B<ValuesFrom> option) has to match the type of the given name.
4679 This option is required inside a B<Result> block.
4681 =item B<InstancePrefix> I<prefix>
4683 =item B<InstancesFrom> I<column0> [I<column1> ...]
4685 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4686 B<InstancePrefix> defines a static prefix that will be prepended to all type
4687 instances. B<InstancesFrom> defines the column names whose values will be used
4688 to create the type instance. Multiple values will be joined together using the
4689 hyphen (C<->) as separation character.
4691 The plugin itself does not check whether or not all built instances are
4692 different. It is your responsibility to assure that each is unique.
4694 Both options are optional. If none is specified, the type instance will be
4697 =item B<ValuesFrom> I<column0> [I<column1> ...]
4699 Names the columns whose content is used as the actual data for the data sets
4700 that are dispatched to the daemon. How many such columns you need is
4701 determined by the B<Type> setting as explained above. If you specify too many
4702 or not enough columns, the plugin will complain about that and no data will be
4703 submitted to the daemon.
4705 The actual data type, as seen by PostgreSQL, is not that important as long as
4706 it represents numbers. The plugin will automatically cast the values to the
4707 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4708 L<strtod(3)> functions, so anything supported by those functions is supported
4709 by the plugin as well.
4711 This option is required inside a B<Result> block and may be specified multiple
4712 times. If multiple B<ValuesFrom> options are specified, the columns are read
4715 =item B<MinVersion> I<version>
4717 =item B<MaxVersion> I<version>
4719 Specify the minimum or maximum version of PostgreSQL that this query should be
4720 used with. Some statistics might only be available with certain versions of
4721 PostgreSQL. This allows you to specify multiple queries with the same name but
4722 which apply to different versions, thus allowing you to use the same
4723 configuration in a heterogeneous environment.
4725 The I<version> has to be specified as the concatenation of the major, minor
4726 and patch-level versions, each represented as two-decimal-digit numbers. For
4727 example, version 8.2.3 will become 80203.
4731 The following predefined queries are available (the definitions can be found
4732 in the F<postgresql_default.conf> file which, by default, is available at
4733 C<I<prefix>/share/collectd/>):
4739 This query collects the number of backends, i.E<nbsp>e. the number of
4742 =item B<transactions>
4744 This query collects the numbers of committed and rolled-back transactions of
4749 This query collects the numbers of various table modifications (i.E<nbsp>e.
4750 insertions, updates, deletions) of the user tables.
4752 =item B<query_plans>
4754 This query collects the numbers of various table scans and returned tuples of
4757 =item B<table_states>
4759 This query collects the numbers of live and dead rows in the user tables.
4763 This query collects disk block access counts for user tables.
4767 This query collects the on-disk size of the database in bytes.
4771 In addition, the following detailed queries are available by default. Please
4772 note that each of those queries collects information B<by table>, thus,
4773 potentially producing B<a lot> of data. For details see the description of the
4774 non-by_table queries above.
4778 =item B<queries_by_table>
4780 =item B<query_plans_by_table>
4782 =item B<table_states_by_table>
4784 =item B<disk_io_by_table>
4788 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4789 mandatory argument specifying the name of the writer. This will then be used
4790 in the B<Database> specification in order to activate the writer instance. The
4791 names of all writers have to be unique. The following options may be
4796 =item B<Statement> I<sql statement>
4798 This mandatory option specifies the SQL statement that will be executed for
4799 each submitted value. A single SQL statement is allowed only. Anything after
4800 the first semicolon will be ignored.
4802 Nine parameters will be passed to the statement and should be specified as
4803 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4804 values are made available through those parameters:
4810 The timestamp of the queried value as a floating point number.
4814 The hostname of the queried value.
4818 The plugin name of the queried value.
4822 The plugin instance of the queried value. This value may be B<NULL> if there
4823 is no plugin instance.
4827 The type of the queried value (cf. L<types.db(5)>).
4831 The type instance of the queried value. This value may be B<NULL> if there is
4836 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4837 sources of the submitted value-list).
4841 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4842 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4843 B<StoreRates> is enabled (which is the default, see below), all types will be
4848 An array of the submitted values. The dimensions of the value name and value
4853 In general, it is advisable to create and call a custom function in the
4854 PostgreSQL database for this purpose. Any procedural language supported by
4855 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4858 =item B<StoreRates> B<false>|B<true>
4860 If set to B<true> (the default), convert counter values to rates. If set to
4861 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4866 The B<Database> block defines one PostgreSQL database for which to collect
4867 statistics. It accepts a single mandatory argument which specifies the
4868 database name. None of the other options are required. PostgreSQL will use
4869 default values as documented in the section "CONNECTING TO A DATABASE" in the
4870 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4871 the user collectd is run as and special environment variables. See the manpage
4876 =item B<Interval> I<seconds>
4878 Specify the interval with which the database should be queried. The default is
4879 to use the global B<Interval> setting.
4881 =item B<CommitInterval> I<seconds>
4883 This option may be used for database connections which have "writers" assigned
4884 (see above). If specified, it causes a writer to put several updates into a
4885 single transaction. This transaction will last for the specified amount of
4886 time. By default, each update will be executed in a separate transaction. Each
4887 transaction generates a fair amount of overhead which can, thus, be reduced by
4888 activating this option. The draw-back is, that data covering the specified
4889 amount of time will be lost, for example, if a single statement within the
4890 transaction fails or if the database server crashes.
4892 =item B<Host> I<hostname>
4894 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4895 value begins with a slash, it is interpreted as the directory name in which to
4896 look for the UNIX domain socket.
4898 This option is also used to determine the hostname that is associated with a
4899 collected data set. If it has been omitted or either begins with with a slash
4900 or equals B<localhost> it will be replaced with the global hostname definition
4901 of collectd. Any other value will be passed literally to collectd when
4902 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4904 =item B<Port> I<port>
4906 Specify the TCP port or the local UNIX domain socket file extension of the
4909 =item B<User> I<username>
4911 Specify the username to be used when connecting to the server.
4913 =item B<Password> I<password>
4915 Specify the password to be used when connecting to the server.
4917 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4919 Specify whether to use an SSL connection when contacting the server. The
4920 following modes are supported:
4926 Do not use SSL at all.
4930 First, try to connect without using SSL. If that fails, try using SSL.
4932 =item I<prefer> (default)
4934 First, try to connect using SSL. If that fails, try without using SSL.
4942 =item B<Instance> I<name>
4944 Specify the plugin instance name that should be used instead of the database
4945 name (which is the default, if this option has not been specified). This
4946 allows to query multiple databases of the same name on the same host (e.g.
4947 when running multiple database server versions in parallel).
4949 =item B<KRBSrvName> I<kerberos_service_name>
4951 Specify the Kerberos service name to use when authenticating with Kerberos 5
4952 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4953 B<PostgreSQL Documentation> for details.
4955 =item B<Service> I<service_name>
4957 Specify the PostgreSQL service name to use for additional parameters. That
4958 service has to be defined in F<pg_service.conf> and holds additional
4959 connection parameters. See the section "The Connection Service File" in the
4960 B<PostgreSQL Documentation> for details.
4962 =item B<Query> I<query>
4964 Specifies a I<query> which should be executed in the context of the database
4965 connection. This may be any of the predefined or user-defined queries. If no
4966 such option is given, it defaults to "backends", "transactions", "queries",
4967 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4968 has been specified). Else, the specified queries are used only.
4970 =item B<Writer> I<writer>
4972 Assigns the specified I<writer> backend to the database connection. This
4973 causes all collected data to be send to the database using the settings
4974 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4975 below for details on how to selectively send data to certain plugins).
4977 Each writer will register a flush callback which may be used when having long
4978 transactions enabled (see the B<CommitInterval> option above). When issuing
4979 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4980 transaction will be committed right away. Two different kinds of flush
4981 callbacks are available with the C<postgresql> plugin:
4987 Flush all writer backends.
4989 =item B<postgresql->I<database>
4991 Flush all writers of the specified I<database> only.
4997 =head2 Plugin C<powerdns>
4999 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5000 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5001 values, many of which are probably meaningless to most users, but may be useful
5002 for some. So you may chose which values to collect, but if you don't, some
5003 reasonable defaults will be collected.
5006 <Server "server_name">
5008 Collect "udp-answers" "udp-queries"
5009 Socket "/var/run/pdns.controlsocket"
5011 <Recursor "recursor_name">
5013 Collect "cache-hits" "cache-misses"
5014 Socket "/var/run/pdns_recursor.controlsocket"
5016 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5021 =item B<Server> and B<Recursor> block
5023 The B<Server> block defines one authoritative server to query, the B<Recursor>
5024 does the same for an recursing server. The possible options in both blocks are
5025 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5030 =item B<Collect> I<Field>
5032 Using the B<Collect> statement you can select which values to collect. Here,
5033 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5034 C<dlg-only-drops>, C<answers10-100>.
5036 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5037 When querying the server a C<SHOW *> command is issued in any case, because
5038 that's the only way of getting multiple values out of the server at once.
5039 collectd then picks out the values you have selected. When querying the
5040 recursor, a command is generated to query exactly these values. So if you
5041 specify invalid fields when querying the recursor, a syntax error may be
5042 returned by the daemon and collectd may not collect any values at all.
5044 If no B<Collect> statement is given, the following B<Server> values will be
5051 =item packetcache-hit
5053 =item packetcache-miss
5055 =item packetcache-size
5057 =item query-cache-hit
5059 =item query-cache-miss
5061 =item recursing-answers
5063 =item recursing-questions
5075 The following B<Recursor> values will be collected by default:
5079 =item noerror-answers
5081 =item nxdomain-answers
5083 =item servfail-answers
5101 Please note that up to that point collectd doesn't know what values are
5102 available on the server and values that are added do not need a change of the
5103 mechanism so far. However, the values must be mapped to collectd's naming
5104 scheme, which is done using a lookup table that lists all known values. If
5105 values are added in the future and collectd does not know about them, you will
5106 get an error much like this:
5108 powerdns plugin: submit: Not found in lookup table: foobar = 42
5110 In this case please file a bug report with the collectd team.
5112 =item B<Socket> I<Path>
5114 Configures the path to the UNIX domain socket to be used when connecting to the
5115 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5116 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5117 will be used for the recursor.
5121 =item B<LocalSocket> I<Path>
5123 Querying the recursor is done using UDP. When using UDP over UNIX domain
5124 sockets, the client socket needs a name in the file system, too. You can set
5125 this local name to I<Path> using the B<LocalSocket> option. The default is
5126 C<I<prefix>/var/run/collectd-powerdns>.
5130 =head2 Plugin C<processes>
5134 =item B<Process> I<Name>
5136 Select more detailed statistics of processes matching this name. The statistics
5137 collected for these selected processes are size of the resident segment size
5138 (RSS), user- and system-time used, number of processes and number of threads,
5139 io data (where available) and minor and major pagefaults.
5141 =item B<ProcessMatch> I<name> I<regex>
5143 Similar to the B<Process> option this allows to select more detailed
5144 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5145 details). The statistics of all matching processes are summed up and
5146 dispatched to the daemon using the specified I<name> as an identifier. This
5147 allows to "group" several processes together. I<name> must not contain
5152 =head2 Plugin C<protocols>
5154 Collects a lot of information about various network protocols, such as I<IP>,
5155 I<TCP>, I<UDP>, etc.
5157 Available configuration options:
5161 =item B<Value> I<Selector>
5163 Selects whether or not to select a specific value. The string being matched is
5164 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5165 plugin instance and I<ValueName> will be used as type instance. An example of
5166 the string being used would be C<Tcp:RetransSegs>.
5168 You can use regular expressions to match a large number of values with just one
5169 configuration option. To select all "extended" I<TCP> values, you could use the
5170 following statement:
5174 Whether only matched values are selected or all matched values are ignored
5175 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5176 If no value is configured at all, all values will be selected.
5178 =item B<IgnoreSelected> B<true>|B<false>
5180 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5181 matching values will be ignored.
5185 =head2 Plugin C<python>
5187 This plugin embeds a Python-interpreter into collectd and provides an interface
5188 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5190 =head2 Plugin C<routeros>
5192 The C<routeros> plugin connects to a device running I<RouterOS>, the
5193 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5194 I<librouteros> to connect and reads information about the interfaces and
5195 wireless connections of the device. The configuration supports querying
5200 Host "router0.example.com"
5203 CollectInterface true
5208 Host "router1.example.com"
5211 CollectInterface true
5212 CollectRegistrationTable true
5218 As you can see above, the configuration of the I<routeros> plugin consists of
5219 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5220 options are understood:
5224 =item B<Host> I<Host>
5226 Hostname or IP-address of the router to connect to.
5228 =item B<Port> I<Port>
5230 Port name or port number used when connecting. If left unspecified, the default
5231 will be chosen by I<librouteros>, currently "8728". This option expects a
5232 string argument, even when a numeric port number is given.
5234 =item B<User> I<User>
5236 Use the user name I<User> to authenticate. Defaults to "admin".
5238 =item B<Password> I<Password>
5240 Set the password used to authenticate.
5242 =item B<CollectInterface> B<true>|B<false>
5244 When set to B<true>, interface statistics will be collected for all interfaces
5245 present on the device. Defaults to B<false>.
5247 =item B<CollectRegistrationTable> B<true>|B<false>
5249 When set to B<true>, information about wireless LAN connections will be
5250 collected. Defaults to B<false>.
5252 =item B<CollectCPULoad> B<true>|B<false>
5254 When set to B<true>, information about the CPU usage will be collected. The
5255 number is a dimensionless value where zero indicates no CPU usage at all.
5256 Defaults to B<false>.
5258 =item B<CollectMemory> B<true>|B<false>
5260 When enabled, the amount of used and free memory will be collected. How used
5261 memory is calculated is unknown, for example whether or not caches are counted
5263 Defaults to B<false>.
5265 =item B<CollectDF> B<true>|B<false>
5267 When enabled, the amount of used and free disk space will be collected.
5268 Defaults to B<false>.
5270 =item B<CollectDisk> B<true>|B<false>
5272 When enabled, the number of sectors written and bad blocks will be collected.
5273 Defaults to B<false>.
5277 =head2 Plugin C<redis>
5279 The I<Redis plugin> connects to one or more Redis servers and gathers
5280 information about each server's state. For each server there is a I<Node> block
5281 which configures the connection parameters for this node.
5291 The information shown in the synopsis above is the I<default configuration>
5292 which is used by the plugin if no configuration is present.
5296 =item B<Node> I<Nodename>
5298 The B<Node> block identifies a new Redis node, that is a new Redis instance
5299 running in an specified host and port. The name for node is a canonical
5300 identifier which is used as I<plugin instance>. It is limited to
5301 64E<nbsp>characters in length.
5303 =item B<Host> I<Hostname>
5305 The B<Host> option is the hostname or IP-address where the Redis instance is
5308 =item B<Port> I<Port>
5310 The B<Port> option is the TCP port on which the Redis instance accepts
5311 connections. Either a service name of a port number may be given. Please note
5312 that numerical port numbers must be given as a string, too.
5314 =item B<Password> I<Password>
5316 Use I<Password> to authenticate when connecting to I<Redis>.
5318 =item B<Timeout> I<Timeout in miliseconds>
5320 The B<Timeout> option set the socket timeout for node response. Since the Redis
5321 read function is blocking, you should keep this value as low as possible. Keep
5322 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5323 than B<Interval> defined globally.
5327 =head2 Plugin C<rrdcached>
5329 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5330 to store values to RRD files in an efficient manner. The combination of the
5331 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5332 way the C<rrdtool> plugin works (see below). The added abstraction layer
5333 provides a number of benefits, though: Because the cache is not within
5334 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5335 restarted. This results in much shorter (if any) gaps in graphs, especially
5336 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5337 daemon so that it can flush values to disk automatically when needed. This
5338 allows to integrate automated flushing of values into graphing solutions much
5341 There are disadvantages, though: The daemon may reside on a different host, so
5342 it may not be possible for C<collectd> to create the appropriate RRD files
5343 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5344 different base directory, so relative paths may do weird stuff if you're not
5347 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5348 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5349 setting should be set to an absolute path, so that a changed base directory
5350 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5354 =item B<DaemonAddress> I<Address>
5356 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5357 library. See L<rrdcached(1)> for details. Example:
5359 <Plugin "rrdcached">
5360 DaemonAddress "unix:/var/run/rrdcached.sock"
5363 =item B<DataDir> I<Directory>
5365 Set the base directory in which the RRD files reside. If this is a relative
5366 path, it is relative to the working base directory of the C<rrdcached> daemon!
5367 Use of an absolute path is recommended.
5369 =item B<CreateFiles> B<true>|B<false>
5371 Enables or disables the creation of RRD files. If the daemon is not running
5372 locally, or B<DataDir> is set to a relative path, this will not work as
5373 expected. Default is B<true>.
5375 =item B<CreateFilesAsync> B<false>|B<true>
5377 When enabled, new RRD files are enabled asynchronously, using a separate thread
5378 that runs in the background. This prevents writes to block, which is a problem
5379 especially when many hundreds of files need to be created at once. However,
5380 since the purpose of creating the files asynchronously is I<not> to block until
5381 the file is available, values before the file is available will be discarded.
5382 When disabled (the default) files are created synchronously, blocking for a
5383 short while, while the file is being written.
5385 =item B<StepSize> I<Seconds>
5387 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5388 this setting is unset and the stepsize is set to the interval in which the data
5389 is collected. Do not use this option unless you absolutely have to for some
5390 reason. Setting this option may cause problems with the C<snmp plugin>, the
5391 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5393 =item B<HeartBeat> I<Seconds>
5395 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5396 in which case the heartbeat is set to twice the B<StepSize> which should equal
5397 the interval in which data is collected. Do not set this option unless you have
5398 a very good reason to do so.
5400 =item B<RRARows> I<NumRows>
5402 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5403 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5404 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5405 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5406 week, one month, and one year.
5408 So for each timespan, it calculates how many PDPs need to be consolidated into
5409 one CDP by calculating:
5410 number of PDPs = timespan / (stepsize * rrarows)
5412 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5415 =item B<RRATimespan> I<Seconds>
5417 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5418 more then one RRA. If this option is never used, the built-in default of (3600,
5419 86400, 604800, 2678400, 31622400) is used.
5421 For more information on how RRA-sizes are calculated see B<RRARows> above.
5423 =item B<XFF> I<Factor>
5425 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5426 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5431 =head2 Plugin C<rrdtool>
5433 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5434 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5435 using these settings. If you don't want to dive into the depths of RRDtool, you
5436 can safely ignore these settings.
5440 =item B<DataDir> I<Directory>
5442 Set the directory to store RRD files under. By default RRD files are generated
5443 beneath the daemon's working directory, i.e. the B<BaseDir>.
5445 =item B<CreateFilesAsync> B<false>|B<true>
5447 When enabled, new RRD files are enabled asynchronously, using a separate thread
5448 that runs in the background. This prevents writes to block, which is a problem
5449 especially when many hundreds of files need to be created at once. However,
5450 since the purpose of creating the files asynchronously is I<not> to block until
5451 the file is available, values before the file is available will be discarded.
5452 When disabled (the default) files are created synchronously, blocking for a
5453 short while, while the file is being written.
5455 =item B<StepSize> I<Seconds>
5457 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5458 this setting is unset and the stepsize is set to the interval in which the data
5459 is collected. Do not use this option unless you absolutely have to for some
5460 reason. Setting this option may cause problems with the C<snmp plugin>, the
5461 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5463 =item B<HeartBeat> I<Seconds>
5465 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5466 in which case the heartbeat is set to twice the B<StepSize> which should equal
5467 the interval in which data is collected. Do not set this option unless you have
5468 a very good reason to do so.
5470 =item B<RRARows> I<NumRows>
5472 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5473 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5474 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5475 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5476 week, one month, and one year.
5478 So for each timespan, it calculates how many PDPs need to be consolidated into
5479 one CDP by calculating:
5480 number of PDPs = timespan / (stepsize * rrarows)
5482 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5485 =item B<RRATimespan> I<Seconds>
5487 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5488 more then one RRA. If this option is never used, the built-in default of (3600,
5489 86400, 604800, 2678400, 31622400) is used.
5491 For more information on how RRA-sizes are calculated see B<RRARows> above.
5493 =item B<XFF> I<Factor>
5495 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5496 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5499 =item B<CacheFlush> I<Seconds>
5501 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5502 it writes all values for a certain RRD-file if the oldest value is older than
5503 (or equal to) the number of seconds specified. If some RRD-file is not updated
5504 anymore for some reason (the computer was shut down, the network is broken,
5505 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5506 entire cache is searched for entries older than B<CacheTimeout> seconds and
5507 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5508 does nothing under normal circumstances, this value should not be too small.
5509 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5510 normally do much harm either.
5512 =item B<CacheTimeout> I<Seconds>
5514 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5515 save values in a cache, as described above. Writing multiple values at once
5516 reduces IO-operations and thus lessens the load produced by updating the files.
5517 The trade off is that the graphs kind of "drag behind" and that more memory is
5520 =item B<WritesPerSecond> I<Updates>
5522 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5523 will run serious performance problems. The B<CacheFlush> setting and the
5524 internal update queue assert that collectd continues to work just fine even
5525 under heavy load, but the system may become very unresponsive and slow. This is
5526 a problem especially if you create graphs from the RRD files on the same
5527 machine, for example using the C<graph.cgi> script included in the
5528 C<contrib/collection3/> directory.
5530 This setting is designed for very large setups. Setting this option to a value
5531 between 25 and 80 updates per second, depending on your hardware, will leave
5532 the server responsive enough to draw graphs even while all the cached values
5533 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5534 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5535 written as fast as possible, so that web frontends have up to date data when
5538 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5539 updates per second, writing all values to disk will take approximately
5540 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5541 "collection3" you'll end up with a responsive and fast system, up to date
5542 graphs and basically a "backup" of your values every hour.
5544 =item B<RandomTimeout> I<Seconds>
5546 When set, the actual timeout for each value is chosen randomly between
5547 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5548 intention is to avoid high load situations that appear when many values timeout
5549 at the same time. This is especially a problem shortly after the daemon starts,
5550 because all values were added to the internal cache at roughly the same time.
5554 =head2 Plugin C<sensors>
5556 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5557 that all the needed modules have to be loaded and lm_sensors has to be
5558 configured (most likely by editing F</etc/sensors.conf>. Read
5559 L<sensors.conf(5)> for details.
5561 The B<lm_sensors> homepage can be found at
5562 L<http://secure.netroedge.com/~lm78/>.
5566 =item B<SensorConfigFile> I<File>
5568 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5569 the library's default will be used.
5571 =item B<Sensor> I<chip-bus-address/type-feature>
5573 Selects the name of the sensor which you want to collect or ignore, depending
5574 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5575 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5576 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5578 =item B<IgnoreSelected> I<true>|I<false>
5580 If no configuration if given, the B<sensors>-plugin will collect data from all
5581 sensors. This may not be practical, especially for uninteresting sensors.
5582 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5583 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5584 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5585 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5586 and all other sensors are collected.
5590 =head2 Plugin C<sigrok>
5592 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5593 supported by the L<sigrok|http://sigrok.org/> project.
5599 <Device "AC Voltage">
5604 <Device "Sound Level">
5605 Driver "cem-dt-885x"
5612 =item B<LogLevel> B<0-5>
5614 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5615 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5616 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5617 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5618 their level, are always submitted to I<collectd> at its INFO log level.
5620 =item E<lt>B<Device> I<Name>E<gt>
5622 A sigrok-supported device, uniquely identified by this section's options. The
5623 I<Name> is passed to I<collectd> as the I<plugin instance>.
5625 =item B<Driver> I<DriverName>
5627 The sigrok driver to use for this device.
5629 =item B<Conn> I<ConnectionSpec>
5631 If the device cannot be auto-discovered, or more than one might be discovered
5632 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5633 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5634 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5635 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5636 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5638 =item B<SerialComm> I<SerialSpec>
5640 For serial devices with non-standard port settings, this option can be used
5641 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5642 This should not be necessary; drivers know how to communicate with devices they
5645 =item B<MinimumInterval> I<Seconds>
5647 Specifies the minimum time between measurement dispatches to I<collectd>, in
5648 seconds. Since some I<sigrok> supported devices can acquire measurements many
5649 times per second, it may be necessary to throttle these. For example, the
5650 I<RRD plugin> cannot process writes more than once per second.
5652 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5653 device are always dispatched to I<collectd>. When throttled, unused
5654 measurements are discarded.
5658 =head2 Plugin C<snmp>
5660 Since the configuration of the C<snmp plugin> is a little more complicated than
5661 other plugins, its documentation has been moved to an own manpage,
5662 L<collectd-snmp(5)>. Please see there for details.
5664 =head2 Plugin C<statsd>
5666 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5667 protocol and dispatches rates or other aggregates of these numbers
5670 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5671 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5672 C<objects> respectively.
5674 The following configuration options are valid:
5678 =item B<Host> I<Host>
5680 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5681 "any" address, i.e. accept packets sent to any of the hosts addresses.
5683 =item B<Port> I<Port>
5685 UDP port to listen to. This can be either a service name or a port number.
5686 Defaults to C<8125>.
5688 =item B<DeleteCounters> B<false>|B<true>
5690 =item B<DeleteTimers> B<false>|B<true>
5692 =item B<DeleteGauges> B<false>|B<true>
5694 =item B<DeleteSets> B<false>|B<true>
5696 These options control what happens if metrics are not updated in an interval.
5697 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5698 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5699 are unchanged. If set to B<True>, the such metrics are not dispatched and
5700 removed from the internal cache.
5702 =item B<TimerPercentile> I<Percent>
5704 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5705 that I<Percent> of all reported timers are smaller than or equal to the
5706 computed latency. This is useful for cutting off the long tail latency, as it's
5707 often done in I<Service Level Agreements> (SLAs).
5709 If not specified, no percentile is calculated / dispatched.
5713 =head2 Plugin C<swap>
5715 The I<Swap plugin> collects information about used and available swap space. On
5716 I<Linux> and I<Solaris>, the following options are available:
5720 =item B<ReportByDevice> B<false>|B<true>
5722 Configures how to report physical swap devices. If set to B<false> (the
5723 default), the summary over all swap devices is reported only, i.e. the globally
5724 used and available space over all devices. If B<true> is configured, the used
5725 and available space of each device will be reported separately.
5727 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5728 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5730 =item B<ReportBytes> B<false>|B<true>
5732 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5733 I<swap I/O> is reported in pages. This option is available under Linux only.
5735 =item B<ValuesAbsolute> B<true>|B<false>
5737 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5738 available and used. Defaults to B<true>.
5740 =item B<ValuesPercentage> B<false>|B<true>
5742 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5743 available and free. Defaults to B<false>.
5745 This is useful for deploying I<collectd> in a heterogeneous environment, where
5746 swap sizes differ and you want to specify generic thresholds or similar.
5750 =head2 Plugin C<syslog>
5754 =item B<LogLevel> B<debug|info|notice|warning|err>
5756 Sets the log-level. If, for example, set to B<notice>, then all events with
5757 severity B<notice>, B<warning>, or B<err> will be submitted to the
5760 Please note that B<debug> is only available if collectd has been compiled with
5763 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5765 Controls which notifications should be sent to syslog. The default behaviour is
5766 not to send any. Less severe notifications always imply logging more severe
5767 notifications: Setting this to B<OKAY> means all notifications will be sent to
5768 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5769 notifications but will dismiss B<OKAY> notifications. Setting this option to
5770 B<FAILURE> will only send failures to syslog.
5774 =head2 Plugin C<table>
5776 The C<table plugin> provides generic means to parse tabular data and dispatch
5777 user specified values. Values are selected based on column numbers. For
5778 example, this plugin may be used to get values from the Linux L<proc(5)>
5779 filesystem or CSV (comma separated values) files.
5782 <Table "/proc/slabinfo">
5787 InstancePrefix "active_objs"
5793 InstancePrefix "objperslab"
5800 The configuration consists of one or more B<Table> blocks, each of which
5801 configures one file to parse. Within each B<Table> block, there are one or
5802 more B<Result> blocks, which configure which data to select and how to
5805 The following options are available inside a B<Table> block:
5809 =item B<Instance> I<instance>
5811 If specified, I<instance> is used as the plugin instance. So, in the above
5812 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5813 filename of the table is used instead, with all special characters replaced
5814 with an underscore (C<_>).
5816 =item B<Separator> I<string>
5818 Any character of I<string> is interpreted as a delimiter between the different
5819 columns of the table. A sequence of two or more contiguous delimiters in the
5820 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5821 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5822 of a table - see its documentation for more details. This option is mandatory.
5824 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5825 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5826 required because of collectd's config parsing.
5830 The following options are available inside a B<Result> block:
5834 =item B<Type> I<type>
5836 Sets the type used to dispatch the values to the daemon. Detailed information
5837 about types and their configuration can be found in L<types.db(5)>. This
5838 option is mandatory.
5840 =item B<InstancePrefix> I<prefix>
5842 If specified, prepend I<prefix> to the type instance. If omitted, only the
5843 B<InstancesFrom> option is considered for the type instance.
5845 =item B<InstancesFrom> I<column0> [I<column1> ...]
5847 If specified, the content of the given columns (identified by the column
5848 number starting at zero) will be used to create the type instance for each
5849 row. Multiple values (and the instance prefix) will be joined together with
5850 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5851 option is considered for the type instance.
5853 The plugin itself does not check whether or not all built instances are
5854 different. It’s your responsibility to assure that each is unique. This is
5855 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5856 sure that the table only contains one row.
5858 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5861 =item B<ValuesFrom> I<column0> [I<column1> ...]
5863 Specifies the columns (identified by the column numbers starting at zero)
5864 whose content is used as the actual data for the data sets that are dispatched
5865 to the daemon. How many such columns you need is determined by the B<Type>
5866 setting above. If you specify too many or not enough columns, the plugin will
5867 complain about that and no data will be submitted to the daemon. The plugin
5868 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5869 respectively, so anything supported by those functions is supported by the
5870 plugin as well. This option is mandatory.
5874 =head2 Plugin C<tail>
5876 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5877 each line and dispatches found values. What is matched can be configured by the
5878 user using (extended) regular expressions, as described in L<regex(7)>.
5881 <File "/var/log/exim4/mainlog">
5885 Regex "S=([1-9][0-9]*)"
5891 Regex "\\<R=local_user\\>"
5892 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5895 Instance "local_user"
5900 The config consists of one or more B<File> blocks, each of which configures one
5901 logfile to parse. Within each B<File> block, there are one or more B<Match>
5902 blocks, which configure a regular expression to search for.
5904 The B<Instance> option in the B<File> block may be used to set the plugin
5905 instance. So in the above example the plugin name C<tail-foo> would be used.
5906 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5907 next B<Instance> option. This way you can extract several plugin instances from
5908 one logfile, handy when parsing syslog and the like.
5910 The B<Interval> option allows you to define the length of time between reads. If
5911 this is not set, the default Interval will be used.
5913 Each B<Match> block has the following options to describe how the match should
5918 =item B<Regex> I<regex>
5920 Sets the regular expression to use for matching against a line. The first
5921 subexpression has to match something that can be turned into a number by
5922 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5923 below. Because B<extended> regular expressions are used, you do not need to use
5924 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5925 collectd's config parsing you need to escape backslashes, though. So if you
5926 want to match literal parentheses you need to do the following:
5928 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5930 =item B<ExcludeRegex> I<regex>
5932 Sets an optional regular expression to use for excluding lines from the match.
5933 An example which excludes all connections from localhost from the match:
5935 ExcludeRegex "127\\.0\\.0\\.1"
5937 =item B<DSType> I<Type>
5939 Sets how the values are cumulated. I<Type> is one of:
5943 =item B<GaugeAverage>
5945 Calculate the average.
5949 Use the smallest number only.
5953 Use the greatest number only.
5957 Use the last number found.
5963 =item B<AbsoluteSet>
5965 The matched number is a counter. Simply I<sets> the internal counter to this
5966 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5972 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5973 matched number may be negative, which will effectively subtract from the
5980 Increase the internal counter by one. These B<DSType> are the only ones that do
5981 not use the matched subexpression, but simply count the number of matched
5982 lines. Thus, you may use a regular expression without submatch in this case.
5986 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5987 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5988 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5989 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5990 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5993 =item B<Type> I<Type>
5995 Sets the type used to dispatch this value. Detailed information about types and
5996 their configuration can be found in L<types.db(5)>.
5998 =item B<Instance> I<TypeInstance>
6000 This optional setting sets the type instance to use.
6004 =head2 Plugin C<tail_csv>
6006 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6007 written by I<Snort>.
6012 <Metric "snort-dropped">
6017 <File "/var/log/snort/snort.stats">
6018 Instance "snort-eth0"
6020 Collect "snort-dropped"
6024 The configuration consists of one or more B<Metric> blocks that define an index
6025 into the line of the CSV file and how this value is mapped to I<collectd's>
6026 internal representation. These are followed by one or more B<Instance> blocks
6027 which configure which file to read, in which interval and which metrics to
6032 =item E<lt>B<Metric> I<Name>E<gt>
6034 The B<Metric> block configures a new metric to be extracted from the statistics
6035 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6036 only used inside the B<Instance> blocks to refer to this block, so you can use
6037 one B<Metric> block for multiple CSV files.
6041 =item B<Type> I<Type>
6043 Configures which I<Type> to use when dispatching this metric. Types are defined
6044 in the L<types.db(5)> file, see the appropriate manual page for more
6045 information on specifying types. Only types with a single I<data source> are
6046 supported by the I<tail_csv plugin>. The information whether the value is an
6047 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6048 I<Type's> definition.
6050 =item B<Instance> I<TypeInstance>
6052 If set, I<TypeInstance> is used to populate the type instance field of the
6053 created value lists. Otherwise, no type instance is used.
6055 =item B<ValueFrom> I<Index>
6057 Configure to read the value from the field with the zero-based index I<Index>.
6058 If the value is parsed as signed integer, unsigned integer or double depends on
6059 the B<Type> setting, see above.
6063 =item E<lt>B<File> I<Path>E<gt>
6065 Each B<File> block represents one CSV file to read. There must be at least one
6066 I<File> block but there can be multiple if you have multiple CSV files.
6070 =item B<Instance> I<PluginInstance>
6072 Sets the I<plugin instance> used when dispatching the values.
6074 =item B<Collect> I<Metric>
6076 Specifies which I<Metric> to collect. This option must be specified at least
6077 once, and you can use this option multiple times to specify more than one
6078 metric to be extracted from this statistic file.
6080 =item B<Interval> I<Seconds>
6082 Configures the interval in which to read values from this instance / file.
6083 Defaults to the plugin's default interval.
6085 =item B<TimeFrom> I<Index>
6087 Rather than using the local time when dispatching a value, read the timestamp
6088 from the field with the zero-based index I<Index>. The value is interpreted as
6089 seconds since epoch. The value is parsed as a double and may be factional.
6095 =head2 Plugin C<teamspeak2>
6097 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6098 polls interesting global and virtual server data. The plugin can query only one
6099 physical server but unlimited virtual servers. You can use the following
6100 options to configure it:
6104 =item B<Host> I<hostname/ip>
6106 The hostname or ip which identifies the physical server.
6109 =item B<Port> I<port>
6111 The query port of the physical server. This needs to be a string.
6114 =item B<Server> I<port>
6116 This option has to be added once for every virtual server the plugin should
6117 query. If you want to query the virtual server on port 8767 this is what the
6118 option would look like:
6122 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6123 use quotes around it! If no such statement is given only global information
6128 =head2 Plugin C<ted>
6130 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6131 measure power consumption. These devices are usually connected to a serial
6132 (RS232) or USB port. The plugin opens a configured device and tries to read the
6133 current energy readings. For more information on TED, visit
6134 L<http://www.theenergydetective.com/>.
6136 Available configuration options:
6140 =item B<Device> I<Path>
6142 Path to the device on which TED is connected. collectd will need read and write
6143 permissions on that file.
6145 Default: B</dev/ttyUSB0>
6147 =item B<Retries> I<Num>
6149 Apparently reading from TED is not that reliable. You can therefore configure a
6150 number of retries here. You only configure the I<retries> here, to if you
6151 specify zero, one reading will be performed (but no retries if that fails); if
6152 you specify three, a maximum of four readings are performed. Negative values
6159 =head2 Plugin C<tcpconns>
6161 The C<tcpconns plugin> counts the number of currently established TCP
6162 connections based on the local port and/or the remote port. Since there may be
6163 a lot of connections the default if to count all connections with a local port,
6164 for which a listening socket is opened. You can use the following options to
6165 fine-tune the ports you are interested in:
6169 =item B<ListeningPorts> I<true>|I<false>
6171 If this option is set to I<true>, statistics for all local ports for which a
6172 listening socket exists are collected. The default depends on B<LocalPort> and
6173 B<RemotePort> (see below): If no port at all is specifically selected, the
6174 default is to collect listening ports. If specific ports (no matter if local or
6175 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6176 the selected ports will be collected unless this option is set to I<true>
6179 =item B<LocalPort> I<Port>
6181 Count the connections to a specific local port. This can be used to see how
6182 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6183 You have to specify the port in numeric form, so for the mailserver example
6184 you'd need to set B<25>.
6186 =item B<RemotePort> I<Port>
6188 Count the connections to a specific remote port. This is useful to see how
6189 much a remote service is used. This is most useful if you want to know how many
6190 connections a local service has opened to remote services, e.E<nbsp>g. how many
6191 connections a mail server or news server has to other mail or news servers, or
6192 how many connections a web proxy holds to web servers. You have to give the
6193 port in numeric form.
6197 =head2 Plugin C<thermal>
6201 =item B<ForceUseProcfs> I<true>|I<false>
6203 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6204 C<sysfs> interface. If that is not available, the plugin falls back to the
6205 C<procfs> interface. By setting this option to I<true>, you can force the
6206 plugin to use the latter. This option defaults to I<false>.
6208 =item B<Device> I<Device>
6210 Selects the name of the thermal device that you want to collect or ignore,
6211 depending on the value of the B<IgnoreSelected> option. This option may be
6212 used multiple times to specify a list of devices.
6214 =item B<IgnoreSelected> I<true>|I<false>
6216 Invert the selection: If set to true, all devices B<except> the ones that
6217 match the device names specified by the B<Device> option are collected. By
6218 default only selected devices are collected if a selection is made. If no
6219 selection is configured at all, B<all> devices are selected.
6223 =head2 Plugin C<threshold>
6225 The I<Threshold plugin> checks values collected or received by I<collectd>
6226 against a configurable I<threshold> and issues I<notifications> if values are
6229 Documentation for this plugin is available in the L<collectd-threshold(5)>
6232 =head2 Plugin C<tokyotyrant>
6234 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6235 couple metrics: number of records, and database size on disk.
6239 =item B<Host> I<Hostname/IP>
6241 The hostname or ip which identifies the server.
6242 Default: B<127.0.0.1>
6244 =item B<Port> I<Service/Port>
6246 The query port of the server. This needs to be a string, even if the port is
6247 given in its numeric form.
6252 =head2 Plugin C<unixsock>
6256 =item B<SocketFile> I<Path>
6258 Sets the socket-file which is to be created.
6260 =item B<SocketGroup> I<Group>
6262 If running as root change the group of the UNIX-socket after it has been
6263 created. Defaults to B<collectd>.
6265 =item B<SocketPerms> I<Permissions>
6267 Change the file permissions of the UNIX-socket after it has been created. The
6268 permissions must be given as a numeric, octal value as you would pass to
6269 L<chmod(1)>. Defaults to B<0770>.
6271 =item B<DeleteSocket> B<false>|B<true>
6273 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6274 with the given name already exists. If I<collectd> crashes a socket file may be
6275 left over, preventing the daemon from opening a new socket when restarted.
6276 Since this is potentially dangerous, this defaults to B<false>.
6280 =head2 Plugin C<uuid>
6282 This plugin, if loaded, causes the Hostname to be taken from the machine's
6283 UUID. The UUID is a universally unique designation for the machine, usually
6284 taken from the machine's BIOS. This is most useful if the machine is running in
6285 a virtual environment such as Xen, in which case the UUID is preserved across
6286 shutdowns and migration.
6288 The following methods are used to find the machine's UUID, in order:
6294 Check I</etc/uuid> (or I<UUIDFile>).
6298 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6303 Check for UUID from C<dmidecode> / SMBIOS.
6307 Check for UUID from Xen hypervisor.
6311 If no UUID can be found then the hostname is not modified.
6315 =item B<UUIDFile> I<Path>
6317 Take the UUID from the given file (default I</etc/uuid>).
6321 =head2 Plugin C<varnish>
6323 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6328 <Instance "example">
6330 CollectConnections true
6340 CollectWorkers false
6344 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6345 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6346 will collectd statistics from the default "varnishd" instance (this should work
6347 fine in most cases).
6349 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6353 =item B<CollectCache> B<true>|B<false>
6355 Cache hits and misses. True by default.
6357 =item B<CollectConnections> B<true>|B<false>
6359 Number of client connections received, accepted and dropped. True by default.
6361 =item B<CollectBackend> B<true>|B<false>
6363 Back-end connection statistics, such as successful, reused,
6364 and closed connections. True by default.
6366 =item B<CollectSHM> B<true>|B<false>
6368 Statistics about the shared memory log, a memory region to store
6369 log messages which is flushed to disk when full. True by default.
6371 =item B<CollectBan> B<true>|B<false>
6373 Statistics about ban operations, such as number of bans added, retired, and
6374 number of objects tested against ban operations. Only available with Varnish
6375 3.x. False by default.
6377 =item B<CollectDirectorDNS> B<true>|B<false>
6379 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6382 =item B<CollectESI> B<true>|B<false>
6384 Edge Side Includes (ESI) parse statistics. False by default.
6386 =item B<CollectFetch> B<true>|B<false>
6388 Statistics about fetches (HTTP requests sent to the backend). False by default.
6390 =item B<CollectHCB> B<true>|B<false>
6392 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6393 divided into locked and unlocked look-ups. False by default.
6395 =item B<CollectObjects> B<true>|B<false>
6397 Statistics on cached objects: number of objects expired, nuked (prematurely
6398 expired), saved, moved, etc. False by default.
6400 =item B<CollectPurge> B<true>|B<false>
6402 Statistics about purge operations, such as number of purges added, retired, and
6403 number of objects tested against purge operations. Only available with Varnish
6404 2.x. False by default.
6406 =item B<CollectSession> B<true>|B<false>
6408 Client session statistics. Number of past and current sessions, session herd and
6409 linger counters, etc. False by default.
6411 =item B<CollectSMA> B<true>|B<false>
6413 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6414 component is Solaris specific. Only available with Varnish 2.x. False by
6417 =item B<CollectSMS> B<true>|B<false>
6419 synth (synthetic content) storage statistics. This storage
6420 component is used internally only. False by default.
6422 =item B<CollectSM> B<true>|B<false>
6424 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6427 =item B<CollectStruct> B<true>|B<false>
6429 Current varnish internal state statistics. Number of current sessions, objects
6430 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6433 =item B<CollectTotals> B<true>|B<false>
6435 Collects overview counters, such as the number of sessions created,
6436 the number of requests and bytes transferred. False by default.
6438 =item B<CollectUptime> B<true>|B<false>
6440 Varnish uptime. False by default.
6442 =item B<CollectVCL> B<true>|B<false>
6444 Number of total (available + discarded) VCL (config files). False by default.
6446 =item B<CollectWorkers> B<true>|B<false>
6448 Collect statistics about worker threads. False by default.
6452 =head2 Plugin C<vmem>
6454 The C<vmem> plugin collects information about the usage of virtual memory.
6455 Since the statistics provided by the Linux kernel are very detailed, they are
6456 collected very detailed. However, to get all the details, you have to switch
6457 them on manually. Most people just want an overview over, such as the number of
6458 pages read from swap space.
6462 =item B<Verbose> B<true>|B<false>
6464 Enables verbose collection of information. This will start collecting page
6465 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6466 Part of these statistics are collected on a "per zone" basis.
6470 =head2 Plugin C<vserver>
6472 This plugin doesn't have any options. B<VServer> support is only available for
6473 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6474 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6475 need to apply the patches and compile your own kernel, which will then provide
6476 the F</proc/virtual> filesystem that is required by this plugin.
6478 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6480 B<Note>: The traffic collected by this plugin accounts for the amount of
6481 traffic passing a socket which might be a lot less than the actual on-wire
6482 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6483 collect on-wire traffic you could, for example, use the logging facilities of
6484 iptables to feed data for the guest IPs into the iptables plugin.
6486 =head2 Plugin C<write_graphite>
6488 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6489 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6490 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6491 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6492 of at most 1428 bytes to minimize the number of network packets.
6496 <Plugin write_graphite>
6506 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6507 blocks. Inside the B<Node> blocks, the following options are recognized:
6511 =item B<Host> I<Address>
6513 Hostname or address to connect to. Defaults to C<localhost>.
6515 =item B<Port> I<Service>
6517 Service name or port number to connect to. Defaults to C<2003>.
6519 =item B<Protocol> I<String>
6521 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6523 =item B<LogSendErrors> B<false>|B<true>
6525 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6526 If set to B<false>, it will not log the errors. This is especially useful when
6527 using Protocol UDP since many times we want to use the "fire-and-forget"
6528 approach and logging errors fills syslog with unneeded messages.
6530 =item B<Prefix> I<String>
6532 When set, I<String> is added in front of the host name. Dots and whitespace are
6533 I<not> escaped in this string (see B<EscapeCharacter> below).
6535 =item B<Postfix> I<String>
6537 When set, I<String> is appended to the host name. Dots and whitespace are
6538 I<not> escaped in this string (see B<EscapeCharacter> below).
6540 =item B<EscapeCharacter> I<Char>
6542 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6543 in the identifier. The B<EscapeCharacter> option determines which character
6544 dots, whitespace and control characters are replaced with. Defaults to
6547 =item B<StoreRates> B<false>|B<true>
6549 If set to B<true> (the default), convert counter values to rates. If set to
6550 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6553 =item B<SeparateInstances> B<false>|B<true>
6555 If set to B<true>, the plugin instance and type instance will be in their own
6556 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6557 default), the plugin and plugin instance (and likewise the type and type
6558 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6560 =item B<AlwaysAppendDS> B<false>|B<true>
6562 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6563 identifier. If set to B<false> (the default), this is only done when there is
6568 =head2 Plugin C<write_tsdb>
6570 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6571 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6572 state daemon that ingests metrics and stores them in HBase. The plugin uses
6573 I<TCP> over the "line based" protocol with a default port 4242. The data will
6574 be sent in blocks of at most 1428 bytes to minimize the number of network
6581 Host "tsd-1.my.domain"
6583 HostTags "status=production"
6587 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6588 blocks. Inside the B<Node> blocks, the following options are recognized:
6592 =item B<Host> I<Address>
6594 Hostname or address to connect to. Defaults to C<localhost>.
6596 =item B<Port> I<Service>
6598 Service name or port number to connect to. Defaults to C<4242>.
6601 =item B<HostTags> I<String>
6603 When set, I<HostTags> is added to the end of the metric. It is intended to be
6604 used for name=value pairs that the TSD will tag the metric with. Dots and
6605 whitespace are I<not> escaped in this string.
6607 =item B<StoreRates> B<false>|B<true>
6609 If set to B<true>, convert counter values to rates. If set to B<false>
6610 (the default) counter values are stored as is, as an increasing
6613 =item B<AlwaysAppendDS> B<false>|B<true>
6615 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6616 identifier. If set to B<false> (the default), this is only done when there is
6621 =head2 Plugin C<write_mongodb>
6623 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6628 <Plugin "write_mongodb">
6637 The plugin can send values to multiple instances of I<MongoDB> by specifying
6638 one B<Node> block for each instance. Within the B<Node> blocks, the following
6639 options are available:
6643 =item B<Host> I<Address>
6645 Hostname or address to connect to. Defaults to C<localhost>.
6647 =item B<Port> I<Service>
6649 Service name or port number to connect to. Defaults to C<27017>.
6651 =item B<Timeout> I<Timeout>
6653 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6654 Setting this option to zero means no timeout, which is the default.
6656 =item B<StoreRates> B<false>|B<true>
6658 If set to B<true> (the default), convert counter values to rates. If set to
6659 B<false> counter values are stored as is, i.e. as an increasing integer
6662 =item B<Database> I<Database>
6664 =item B<User> I<User>
6666 =item B<Password> I<Password>
6668 Sets the information used when authenticating to a I<MongoDB> database. The
6669 fields are optional (in which case no authentication is attempted), but if you
6670 want to use authentication all three fields must be set.
6674 =head2 Plugin C<write_http>
6676 This output plugin submits values to an HTTP server using POST requests and
6677 encoding metrics with JSON or using the C<PUTVAL> command described in
6678 L<collectd-unixsock(5)>. Each destination you want to post data to needs to
6679 have one B<URL> block, within which the destination can be configured further,
6680 for example by specifying authentication data.
6684 <Plugin "write_http">
6685 <URL "http://example.com/post-collectd">
6692 B<URL> blocks need one string argument which is used as the URL to which data
6693 is posted. The following options are understood within B<URL> blocks.
6697 =item B<User> I<Username>
6699 Optional user name needed for authentication.
6701 =item B<Password> I<Password>
6703 Optional password needed for authentication.
6705 =item B<VerifyPeer> B<true>|B<false>
6707 Enable or disable peer SSL certificate verification. See
6708 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6710 =item B<VerifyHost> B<true|false>
6712 Enable or disable peer host name verification. If enabled, the plugin checks if
6713 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6714 matches the host name provided by the B<URL> option. If this identity check
6715 fails, the connection is aborted. Obviously, only works when connecting to a
6716 SSL enabled server. Enabled by default.
6718 =item B<CACert> I<File>
6720 File that holds one or more SSL certificates. If you want to use HTTPS you will
6721 possibly need this option. What CA certificates come bundled with C<libcurl>
6722 and are checked by default depends on the distribution you use.
6724 =item B<CAPath> I<Directory>
6726 Directory holding one or more CA certificate files. You can use this if for
6727 some reason all the needed CA certificates aren't in the same file and can't be
6728 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
6731 =item B<ClientKey> I<File>
6733 File that holds the private key in PEM format to be used for certificate-based
6736 =item B<ClientCert> I<File>
6738 File that holds the SSL certificate to be used for certificate-based
6741 =item B<ClientKeyPass> I<Password>
6743 Password required to load the private key in B<ClientKey>.
6745 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
6747 Define which SSL protocol version must be used. By default C<libcurl> will
6748 attempt to figure out the remote SSL protocol version. See
6749 L<curl_easy_setopt(3)> for more details.
6751 =item B<Format> B<Command>|B<JSON>
6753 Format of the output to generate. If set to B<Command>, will create output that
6754 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6755 create output in the I<JavaScript Object Notation> (JSON).
6757 Defaults to B<Command>.
6759 =item B<StoreRates> B<true|false>
6761 If set to B<true>, convert counter values to rates. If set to B<false> (the
6762 default) counter values are stored as is, i.e. as an increasing integer number.
6764 =item B<BufferSize> I<Bytes>
6766 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
6767 requests will be generated, but more metrics will be batched / metrics are
6768 cached for longer before being sent, introducing additional delay until they
6769 are available on the server side. I<Bytes> must be at least 1024 and cannot
6770 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
6771 Defaults to C<4096>.
6775 =head2 Plugin C<write_kafka>
6777 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
6781 <Plugin "write_kafka">
6782 Property "metadata.broker.list" "broker1:9092,broker2:9092"
6788 The following options are understood by the I<write_kafka plugin>:
6792 =item E<lt>B<Topic> I<Name>E<gt>
6794 The plugin's configuration consists of one or more B<Topic> blocks. Each block
6795 is given a unique I<Name> and specifies one kafka producer.
6796 Inside the B<Topic> block, the following per-topic options are
6801 =item B<Property> I<String> I<String>
6803 Configure the named property for the current topic. Properties are
6804 forwarded to the kafka producer library B<librdkafka>.
6806 =item B<Key> I<String>
6808 Use the specified string as a partioning key for the topic. Kafka breaks
6809 topic into partitions and guarantees that for a given topology, the same
6810 consumer will be used for a specific key. The special (case insensitive)
6811 string B<Random> can be used to specify that an arbitrary partition should
6814 =item B<Format> B<Command>|B<JSON>|B<Graphite>
6816 Selects the format in which messages are sent to the broker. If set to
6817 B<Command> (the default), values are sent as C<PUTVAL> commands which are
6818 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
6820 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
6821 an easy and straight forward exchange format.
6823 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
6824 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
6826 =item B<StoreRates> B<true>|B<false>
6828 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
6829 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
6830 default), no conversion is performed. Otherwise the conversion is performed
6831 using the internal value cache.
6833 Please note that currently this option is only used if the B<Format> option has
6834 been set to B<JSON>.
6836 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
6838 A prefix can be added in the metric name when outputting in the I<Graphite>
6839 format. It's added before the I<Host> name.
6841 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>>
6843 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
6845 A postfix can be added in the metric name when outputting in the I<Graphite>
6846 format. It's added after the I<Host> name.
6848 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>>
6850 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
6852 Specify a character to replace dots (.) in the host part of the metric name.
6853 In I<Graphite> metric name, dots are used as separators between different
6854 metric parts (host, plugin, type).
6855 Default is C<_> (I<Underscore>).
6857 =item B<GraphiteSeparateInstances> B<false>|B<true>
6859 If set to B<true>, the plugin instance and type instance will be in their own
6860 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6861 default), the plugin and plugin instance (and likewise the type and type
6862 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6864 =item B<StoreRates> B<true>|B<false>
6866 If set to B<true> (the default), convert counter values to rates. If set to
6867 B<false> counter values are stored as is, i.e. as an increasing integer number.
6869 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6870 converted values will have "rate" appended to the data source type, e.g.
6871 C<ds_type:derive:rate>.
6875 =item B<Property> I<String> I<String>
6877 Configure the kafka producer through properties, you almost always will
6878 want to set B<metadata.broker.list> to your Kafka broker list.
6882 =head2 Plugin C<write_riemann>
6884 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
6885 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6886 I<Riemann> using UDP packets.
6890 <Plugin "write_riemann">
6896 AlwaysAppendDS false
6900 Attribute "foo" "bar"
6903 The following options are understood by the I<write_riemann plugin>:
6907 =item E<lt>B<Node> I<Name>E<gt>
6909 The plugin's configuration consists of one or more B<Node> blocks. Each block
6910 is given a unique I<Name> and specifies one connection to an instance of
6911 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6916 =item B<Host> I<Address>
6918 Hostname or address to connect to. Defaults to C<localhost>.
6920 =item B<Port> I<Service>
6922 Service name or port number to connect to. Defaults to C<5555>.
6924 =item B<Protocol> B<UDP>|B<TCP>
6926 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6929 =item B<StoreRates> B<true>|B<false>
6931 If set to B<true> (the default), convert counter values to rates. If set to
6932 B<false> counter values are stored as is, i.e. as an increasing integer number.
6934 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6935 converted values will have "rate" appended to the data source type, e.g.
6936 C<ds_type:derive:rate>.
6938 =item B<AlwaysAppendDS> B<false>|B<true>
6940 If set the B<true>, append the name of the I<Data Source> (DS) to the
6941 "service", i.e. the field that, together with the "host" field, uniquely
6942 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6943 only done when there is more than one DS.
6945 =item B<TTLFactor> I<Factor>
6947 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6948 event is considered active. I<collectd> populates this field based on the
6949 metrics interval setting. This setting controls the factor with which the
6950 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6951 know exactly what you're doing, you should only increase this setting from its
6954 =item B<Notifications> B<false>|B<true>
6956 If set to B<true>, create riemann events for notifications. This is B<true>
6957 by default. When processing thresholds from write_riemann, it might prove
6958 useful to avoid getting notification events.
6960 =item B<CheckThresholds> B<false>|B<true>
6962 If set to B<true>, attach state to events based on thresholds defined
6963 in the B<Threshold> plugin. Defaults to B<false>.
6965 =item B<EventServicePrefix> I<String>
6967 Add the given string as a prefix to the event service name.
6968 If B<EventServicePrefix> not set or set to an empty string (""),
6969 no prefix will be used.
6973 =item B<Tag> I<String>
6975 Add the given string as an additional tag to the metric being sent to
6978 =item B<Attribute> I<String> I<String>
6980 Consider the two given strings to be the key and value of an additional
6981 attribute for each metric being sent out to I<Riemann>.
6985 =head1 THRESHOLD CONFIGURATION
6987 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6988 we mean that the values are not only stored or sent somewhere, but that they
6989 are judged and, if a problem is recognized, acted upon. The only action
6990 collectd takes itself is to generate and dispatch a "notification". Plugins can
6991 register to receive notifications and perform appropriate further actions.
6993 Since systems and what you expect them to do differ a lot, you can configure
6994 B<thresholds> for your values freely. This gives you a lot of flexibility but
6995 also a lot of responsibility.
6997 Every time a value is out of range a notification is dispatched. This means
6998 that the idle percentage of your CPU needs to be less then the configured
6999 threshold only once for a notification to be generated. There's no such thing
7000 as a moving average or similar - at least not now.
7002 Also, all values that match a threshold are considered to be relevant or
7003 "interesting". As a consequence collectd will issue a notification if they are
7004 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7005 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7006 "2" (the default) and some hosts sends it's CPU statistics to the server every
7007 60 seconds, a notification will be dispatched after about 120 seconds. It may
7008 take a little longer because the timeout is checked only once each B<Interval>
7011 When a value comes within range again or is received after it was missing, an
7012 "OKAY-notification" is dispatched.
7014 Here is a configuration example to get you started. Read below for more
7027 <Plugin "interface">
7044 WarningMin 100000000
7050 There are basically two types of configuration statements: The C<Host>,
7051 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7052 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7053 C<Instance> option. You can combine the block by nesting the blocks, though
7054 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7055 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7056 C<Type> may not contain other blocks. If multiple blocks apply to the same
7057 value the most specific block is used.
7059 The other statements specify the threshold to configure. They B<must> be
7060 included in a C<Type> block. Currently the following statements are recognized:
7064 =item B<FailureMax> I<Value>
7066 =item B<WarningMax> I<Value>
7068 Sets the upper bound of acceptable values. If unset defaults to positive
7069 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7070 will be created. If the value is greater than B<WarningMax> but less than (or
7071 equal to) B<FailureMax> a B<WARNING> notification will be created.
7073 =item B<FailureMin> I<Value>
7075 =item B<WarningMin> I<Value>
7077 Sets the lower bound of acceptable values. If unset defaults to negative
7078 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7079 be created. If the value is less than B<WarningMin> but greater than (or equal
7080 to) B<FailureMin> a B<WARNING> notification will be created.
7082 =item B<DataSource> I<DSName>
7084 Some data sets have more than one "data source". Interesting examples are the
7085 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7086 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7087 system load data set, C<load>, even has three data sources: C<shortterm>,
7088 C<midterm>, and C<longterm>.
7090 Normally, all data sources are checked against a configured threshold. If this
7091 is undesirable, or if you want to specify different limits for each data
7092 source, you can use the B<DataSource> option to have a threshold apply only to
7095 =item B<Invert> B<true>|B<false>
7097 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7098 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7099 B<WarningMax>) are not okay. Defaults to B<false>.
7101 =item B<Persist> B<true>|B<false>
7103 Sets how often notifications are generated. If set to B<true> one notification
7104 will be generated for each value that is out of the acceptable range. If set to
7105 B<false> (the default) then a notification is only generated if a value is out
7106 of range but the previous value was okay.
7108 This applies to missing values, too: If set to B<true> a notification about a
7109 missing value is generated once every B<Interval> seconds. If set to B<false>
7110 only one such notification is generated until the value appears again.
7112 =item B<Percentage> B<true>|B<false>
7114 If set to B<true>, the minimum and maximum values given are interpreted as
7115 percentage value, relative to the other data sources. This is helpful for
7116 example for the "df" type, where you may want to issue a warning when less than
7117 5E<nbsp>% of the total space is available. Defaults to B<false>.
7119 =item B<Hits> I<Number>
7121 Delay creating the notification until the threshold has been passed I<Number>
7122 times. When a notification has been generated, or when a subsequent value is
7123 inside the threshold, the counter is reset. If, for example, a value is
7124 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7125 will be dispatched at most once every 30E<nbsp>seconds.
7127 This is useful when short bursts are not a problem. If, for example, 100% CPU
7128 usage for up to a minute is normal (and data is collected every
7129 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7131 =item B<Hysteresis> I<Number>
7133 When set to non-zero, a hysteresis value is applied when checking minimum and
7134 maximum bounds. This is useful for values that increase slowly and fluctuate a
7135 bit while doing so. When these values come close to the threshold, they may
7136 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7138 If, for example, the threshold is configures as
7143 then a I<Warning> notification is created when the value exceeds I<101> and the
7144 corresponding I<Okay> notification is only created once the value falls below
7145 I<99>, thus avoiding the "flapping".
7149 =head1 FILTER CONFIGURATION
7151 Starting with collectd 4.6 there is a powerful filtering infrastructure
7152 implemented in the daemon. The concept has mostly been copied from
7153 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7154 terminology, so that users that are familiar with iptables feel right at home.
7158 The following are the terms used in the remainder of the filter configuration
7159 documentation. For an ASCII-art schema of the mechanism, see
7160 L<"General structure"> below.
7166 A I<match> is a criteria to select specific values. Examples are, of course, the
7167 name of the value or it's current value.
7169 Matches are implemented in plugins which you have to load prior to using the
7170 match. The name of such plugins starts with the "match_" prefix.
7174 A I<target> is some action that is to be performed with data. Such actions
7175 could, for example, be to change part of the value's identifier or to ignore
7176 the value completely.
7178 Some of these targets are built into the daemon, see L<"Built-in targets">
7179 below. Other targets are implemented in plugins which you have to load prior to
7180 using the target. The name of such plugins starts with the "target_" prefix.
7184 The combination of any number of matches and at least one target is called a
7185 I<rule>. The target actions will be performed for all values for which B<all>
7186 matches apply. If the rule does not have any matches associated with it, the
7187 target action will be performed for all values.
7191 A I<chain> is a list of rules and possibly default targets. The rules are tried
7192 in order and if one matches, the associated target will be called. If a value
7193 is handled by a rule, it depends on the target whether or not any subsequent
7194 rules are considered or if traversal of the chain is aborted, see
7195 L<"Flow control"> below. After all rules have been checked, the default targets
7200 =head2 General structure
7202 The following shows the resulting structure:
7209 +---------+ +---------+ +---------+ +---------+
7210 ! Rule !->! Match !->! Match !->! Target !
7211 +---------+ +---------+ +---------+ +---------+
7214 +---------+ +---------+ +---------+
7215 ! Rule !->! Target !->! Target !
7216 +---------+ +---------+ +---------+
7223 +---------+ +---------+ +---------+
7224 ! Rule !->! Match !->! Target !
7225 +---------+ +---------+ +---------+
7235 There are four ways to control which way a value takes through the filter
7242 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7243 process the value with another chain. When the called chain finishes, usually
7244 the next target or rule after the jump is executed.
7248 The stop condition, signaled for example by the built-in target B<stop>, causes
7249 all processing of the value to be stopped immediately.
7253 Causes processing in the current chain to be aborted, but processing of the
7254 value generally will continue. This means that if the chain was called via
7255 B<Jump>, the next target or rule after the jump will be executed. If the chain
7256 was not called by another chain, control will be returned to the daemon and it
7257 may pass the value to another chain.
7261 Most targets will signal the B<continue> condition, meaning that processing
7262 should continue normally. There is no special built-in target for this
7269 The configuration reflects this structure directly:
7271 PostCacheChain "PostCache"
7273 <Rule "ignore_mysql_show">
7276 Type "^mysql_command$"
7277 TypeInstance "^show_"
7287 The above configuration example will ignore all values where the plugin field
7288 is "mysql", the type is "mysql_command" and the type instance begins with
7289 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7290 default target of the chain. Since this chain is run after the value has been
7291 added to the cache, the MySQL C<show_*> command statistics will be available
7292 via the C<unixsock> plugin.
7294 =head2 List of configuration options
7298 =item B<PreCacheChain> I<ChainName>
7300 =item B<PostCacheChain> I<ChainName>
7302 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7303 argument is the name of a I<chain> that should be executed before and/or after
7304 the values have been added to the cache.
7306 To understand the implications, it's important you know what is going on inside
7307 I<collectd>. The following diagram shows how values are passed from the
7308 read-plugins to the write-plugins:
7314 + - - - - V - - - - +
7315 : +---------------+ :
7318 : +-------+-------+ :
7321 : +-------+-------+ : +---------------+
7322 : ! Cache !--->! Value Cache !
7323 : ! insert ! : +---+---+-------+
7324 : +-------+-------+ : ! !
7325 : ! ,------------' !
7327 : +-------+---+---+ : +-------+-------+
7328 : ! Post-Cache +--->! Write-Plugins !
7329 : ! Chain ! : +---------------+
7330 : +---------------+ :
7333 + - - - - - - - - - +
7335 After the values are passed from the "read" plugins to the dispatch functions,
7336 the pre-cache chain is run first. The values are added to the internal cache
7337 afterwards. The post-cache chain is run after the values have been added to the
7338 cache. So why is it such a huge deal if chains are run before or after the
7339 values have been added to this cache?
7341 Targets that change the identifier of a value list should be executed before
7342 the values are added to the cache, so that the name in the cache matches the
7343 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7344 this cache to receive a list of all available values. If you change the
7345 identifier after the value list has been added to the cache, this may easily
7346 lead to confusion, but it's not forbidden of course.
7348 The cache is also used to convert counter values to rates. These rates are, for
7349 example, used by the C<value> match (see below). If you use the rate stored in
7350 the cache B<before> the new value is added, you will use the old, B<previous>
7351 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7352 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7355 Last but not last, the B<stop> target makes a difference: If the pre-cache
7356 chain returns the stop condition, the value will not be added to the cache and
7357 the post-cache chain will not be run.
7359 =item B<Chain> I<Name>
7361 Adds a new chain with a certain name. This name can be used to refer to a
7362 specific chain, for example to jump to it.
7364 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7366 =item B<Rule> [I<Name>]
7368 Adds a new rule to the current chain. The name of the rule is optional and
7369 currently has no meaning for the daemon.
7371 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7372 must be at least one B<Target> block.
7374 =item B<Match> I<Name>
7376 Adds a match to a B<Rule> block. The name specifies what kind of match should
7377 be performed. Available matches depend on the plugins that have been loaded.
7379 The arguments inside the B<Match> block are passed to the plugin implementing
7380 the match, so which arguments are valid here depends on the plugin being used.
7381 If you do not need any to pass any arguments to a match, you can use the
7386 Which is equivalent to:
7391 =item B<Target> I<Name>
7393 Add a target to a rule or a default target to a chain. The name specifies what
7394 kind of target is to be added. Which targets are available depends on the
7395 plugins being loaded.
7397 The arguments inside the B<Target> block are passed to the plugin implementing
7398 the target, so which arguments are valid here depends on the plugin being used.
7399 If you do not need any to pass any arguments to a target, you can use the
7404 This is the same as writing:
7411 =head2 Built-in targets
7413 The following targets are built into the core daemon and therefore need no
7414 plugins to be loaded:
7420 Signals the "return" condition, see the L<"Flow control"> section above. This
7421 causes the current chain to stop processing the value and returns control to
7422 the calling chain. The calling chain will continue processing targets and rules
7423 just after the B<jump> target (see below). This is very similar to the
7424 B<RETURN> target of iptables, see L<iptables(8)>.
7426 This target does not have any options.
7434 Signals the "stop" condition, see the L<"Flow control"> section above. This
7435 causes processing of the value to be aborted immediately. This is similar to
7436 the B<DROP> target of iptables, see L<iptables(8)>.
7438 This target does not have any options.
7446 Sends the value to "write" plugins.
7452 =item B<Plugin> I<Name>
7454 Name of the write plugin to which the data should be sent. This option may be
7455 given multiple times to send the data to more than one write plugin. If the
7456 plugin supports multiple instances, the plugin's instance(s) must also be
7461 If no plugin is explicitly specified, the values will be sent to all available
7464 Single-instance plugin example:
7470 Multi-instance plugin example:
7472 <Plugin "write_graphite">
7482 Plugin "write_graphite/foo"
7487 Starts processing the rules of another chain, see L<"Flow control"> above. If
7488 the end of that chain is reached, or a stop condition is encountered,
7489 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7490 next target or the next rule. This is similar to the B<-j> command line option
7491 of iptables, see L<iptables(8)>.
7497 =item B<Chain> I<Name>
7499 Jumps to the chain I<Name>. This argument is required and may appear only once.
7511 =head2 Available matches
7517 Matches a value using regular expressions.
7523 =item B<Host> I<Regex>
7525 =item B<Plugin> I<Regex>
7527 =item B<PluginInstance> I<Regex>
7529 =item B<Type> I<Regex>
7531 =item B<TypeInstance> I<Regex>
7533 Match values where the given regular expressions match the various fields of
7534 the identifier of a value. If multiple regular expressions are given, B<all>
7535 regexen must match for a value to match.
7537 =item B<Invert> B<false>|B<true>
7539 When set to B<true>, the result of the match is inverted, i.e. all value lists
7540 where all regular expressions apply are not matched, all other value lists are
7541 matched. Defaults to B<false>.
7548 Host "customer[0-9]+"
7554 Matches values that have a time which differs from the time on the server.
7556 This match is mainly intended for servers that receive values over the
7557 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7558 is very sensitive to the timestamp used when updating the RRD files. In
7559 particular, the time must be ever increasing. If a misbehaving client sends one
7560 packet with a timestamp far in the future, all further packets with a correct
7561 time will be ignored because of that one packet. What's worse, such corrupted
7562 RRD files are hard to fix.
7564 This match lets one match all values B<outside> a specified time range
7565 (relative to the server's time), so you can use the B<stop> target (see below)
7566 to ignore the value, for example.
7572 =item B<Future> I<Seconds>
7574 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7575 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7578 =item B<Past> I<Seconds>
7580 Matches all values that are I<behind> of the server's time by I<Seconds> or
7581 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7593 This example matches all values that are five minutes or more ahead of the
7594 server or one hour (or more) lagging behind.
7598 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7599 values. If a data-set consists of more than one data-source, all data-sources
7600 must match the specified ranges for a positive match.
7606 =item B<Min> I<Value>
7608 Sets the smallest value which still results in a match. If unset, behaves like
7611 =item B<Max> I<Value>
7613 Sets the largest value which still results in a match. If unset, behaves like
7616 =item B<Invert> B<true>|B<false>
7618 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7619 no-match is returned and vice versa. Please note that the B<Invert> setting
7620 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7621 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7623 =item B<DataSource> I<DSName> [I<DSName> ...]
7625 Select one or more of the data sources. If no data source is configured, all
7626 data sources will be checked. If the type handled by the match does not have a
7627 data source of the specified name(s), this will always result in no match
7628 (independent of the B<Invert> setting).
7630 =item B<Satisfy> B<Any>|B<All>
7632 Specifies how checking with several data sources is performed. If set to
7633 B<Any>, the match succeeds if one of the data sources is in the configured
7634 range. If set to B<All> the match only succeeds if all data sources are within
7635 the configured range. Default is B<All>.
7637 Usually B<All> is used for positive matches, B<Any> is used for negative
7638 matches. This means that with B<All> you usually check that all values are in a
7639 "good" range, while with B<Any> you check if any value is within a "bad" range
7640 (or outside the "good" range).
7644 Either B<Min> or B<Max>, but not both, may be unset.
7648 # Match all values smaller than or equal to 100. Matches only if all data
7649 # sources are below 100.
7655 # Match if the value of any data source is outside the range of 0 - 100.
7663 =item B<empty_counter>
7665 Matches all values with one or more data sources of type B<COUNTER> and where
7666 all counter values are zero. These counters usually I<never> increased since
7667 they started existing (and are therefore uninteresting), or got reset recently
7668 or overflowed and you had really, I<really> bad luck.
7670 Please keep in mind that ignoring such counters can result in confusing
7671 behavior: Counters which hardly ever increase will be zero for long periods of
7672 time. If the counter is reset for some reason (machine or service restarted,
7673 usually), the graph will be empty (NAN) for a long time. People may not
7678 Calculates a hash value of the host name and matches values according to that
7679 hash value. This makes it possible to divide all hosts into groups and match
7680 only values that are in a specific group. The intended use is in load
7681 balancing, where you want to handle only part of all data and leave the rest
7684 The hashing function used tries to distribute the hosts evenly. First, it
7685 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7688 for (i = 0; host[i] != 0; i++)
7689 hash_value = (hash_value * 251) + host[i];
7691 The constant 251 is a prime number which is supposed to make this hash value
7692 more random. The code then checks the group for this host according to the
7693 I<Total> and I<Match> arguments:
7695 if ((hash_value % Total) == Match)
7700 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7701 groups), then the least significant bit of the hash value will be the XOR of
7702 all least significant bits in the host name. One consequence is that when you
7703 have two hosts, "server0.example.com" and "server1.example.com", where the host
7704 name differs in one digit only and the digits differ by one, those hosts will
7705 never end up in the same group.
7711 =item B<Match> I<Match> I<Total>
7713 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7714 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7715 be smaller than I<Total>. I<Total> must be at least one, although only values
7716 greater than one really do make any sense.
7718 You can repeat this option to match multiple groups, for example:
7723 The above config will divide the data into seven groups and match groups three
7724 and five. One use would be to keep every value on two hosts so that if one
7725 fails the missing data can later be reconstructed from the second host.
7731 # Operate on the pre-cache chain, so that ignored values are not even in the
7736 # Divide all received hosts in seven groups and accept all hosts in
7740 # If matched: Return and continue.
7743 # If not matched: Return and stop.
7749 =head2 Available targets
7753 =item B<notification>
7755 Creates and dispatches a notification.
7761 =item B<Message> I<String>
7763 This required option sets the message of the notification. The following
7764 placeholders will be replaced by an appropriate value:
7772 =item B<%{plugin_instance}>
7776 =item B<%{type_instance}>
7778 These placeholders are replaced by the identifier field of the same name.
7780 =item B<%{ds:>I<name>B<}>
7782 These placeholders are replaced by a (hopefully) human readable representation
7783 of the current rate of this data source. If you changed the instance name
7784 (using the B<set> or B<replace> targets, see below), it may not be possible to
7785 convert counter values to rates.
7789 Please note that these placeholders are B<case sensitive>!
7791 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7793 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7800 <Target "notification">
7801 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7807 Replaces parts of the identifier using regular expressions.
7813 =item B<Host> I<Regex> I<Replacement>
7815 =item B<Plugin> I<Regex> I<Replacement>
7817 =item B<PluginInstance> I<Regex> I<Replacement>
7819 =item B<TypeInstance> I<Regex> I<Replacement>
7821 Match the appropriate field with the given regular expression I<Regex>. If the
7822 regular expression matches, that part that matches is replaced with
7823 I<Replacement>. If multiple places of the input buffer match a given regular
7824 expression, only the first occurrence will be replaced.
7826 You can specify each option multiple times to use multiple regular expressions
7834 # Replace "example.net" with "example.com"
7835 Host "\\<example.net\\>" "example.com"
7837 # Strip "www." from hostnames
7843 Sets part of the identifier of a value to a given string.
7849 =item B<Host> I<String>
7851 =item B<Plugin> I<String>
7853 =item B<PluginInstance> I<String>
7855 =item B<TypeInstance> I<String>
7857 Set the appropriate field to the given string. The strings for plugin instance
7858 and type instance may be empty, the strings for host and plugin may not be
7859 empty. It's currently not possible to set the type of a value this way.
7866 PluginInstance "coretemp"
7867 TypeInstance "core3"
7872 =head2 Backwards compatibility
7874 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7875 B<Chain> block, it will behave as it used to. This is equivalent to the
7876 following configuration:
7882 If you specify a B<PostCacheChain>, the B<write> target will not be added
7883 anywhere and you will have to make sure that it is called where appropriate. We
7884 suggest to add the above snippet as default target to your "PostCache" chain.
7888 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7904 L<collectd-exec(5)>,
7905 L<collectd-perl(5)>,
7906 L<collectd-unixsock(5)>,
7919 Florian Forster E<lt>octo@collectd.orgE<gt>