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<Timeout> I<Iterations>
223 Consider a value list "missing" when no update has been read or received for
224 I<Iterations> iterations. By default, I<collectd> considers a value list
225 missing when no update has been received for twice the update interval. Since
226 this setting uses iterations, the maximum allowed time without update depends
227 on the I<Interval> information contained in each value list. This is used in
228 the I<Threshold> configuration to dispatch notifications about missing values,
229 see L<collectd-threshold(5)> for details.
231 =item B<ReadThreads> I<Num>
233 Number of threads to start for reading plugins. The default value is B<5>, but
234 you may want to increase this if you have more than five plugins that take a
235 long time to read. Mostly those are plugins that do network-IO. Setting this to
236 a value higher than the number of registered read callbacks is not recommended.
238 =item B<WriteThreads> I<Num>
240 Number of threads to start for dispatching value lists to write plugins. The
241 default value is B<5>, but you may want to increase this if you have more than
242 five plugins that may take relatively long to write to.
244 =item B<WriteQueueLimitHigh> I<HighNum>
246 =item B<WriteQueueLimitLow> I<LowNum>
248 Metrics are read by the I<read threads> and then put into a queue to be handled
249 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
250 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
251 running into memory issues in such a case, you can limit the size of this
254 By default, there is no limit and memory may grow indefinitely. This is most
255 likely not an issue for clients, i.e. instances that only handle the local
256 metrics. For servers it is recommended to set this to a non-zero value, though.
258 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
259 Each of them takes a numerical argument which is the number of metrics in the
260 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
261 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
262 I<will> be enqueued. If the number of metrics currently in the queue is between
263 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
264 proportional to the number of metrics in the queue (i.e. it increases linearly
265 until it reaches 100%.)
267 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
268 unset, the latter will default to half of B<WriteQueueLimitHigh>.
270 If you do not want to randomly drop values when the queue size is between
271 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
272 B<WriteQueueLimitLow> to same value.
274 =item B<Hostname> I<Name>
276 Sets the hostname that identifies a host. If you omit this setting, the
277 hostname will be determined using the L<gethostname(2)> system call.
279 =item B<FQDNLookup> B<true|false>
281 If B<Hostname> is determined automatically this setting controls whether or not
282 the daemon should try to figure out the "fully qualified domain name", FQDN.
283 This is done using a lookup of the name returned by C<gethostname>. This option
284 is enabled by default.
286 =item B<PreCacheChain> I<ChainName>
288 =item B<PostCacheChain> I<ChainName>
290 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
291 see L<FILTER CONFIGURATION> below on information on chains and how these
292 setting change the daemon's behavior.
296 =head1 PLUGIN OPTIONS
298 Some plugins may register own options. These options must be enclosed in a
299 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
300 require external configuration, too. The C<apache plugin>, for example,
301 required C<mod_status> to be configured in the webserver you're going to
302 collect data from. These plugins are listed below as well, even if they don't
303 require any configuration within collectd's configuration file.
305 A list of all plugins and a short summary for each plugin can be found in the
306 F<README> file shipped with the sourcecode and hopefully binary packets as
309 =head2 Plugin C<aggregation>
311 The I<Aggregation plugin> makes it possible to aggregate several values into
312 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
313 This can be put to a wide variety of uses, e.g. average and total CPU
314 statistics for your entire fleet.
316 The grouping is powerful but, as with many powerful tools, may be a bit
317 difficult to wrap your head around. The grouping will therefore be
318 demonstrated using an example: The average and sum of the CPU usage across
319 all CPUs of each host is to be calculated.
321 To select all the affected values for our example, set C<Plugin cpu> and
322 C<Type cpu>. The other values are left unspecified, meaning "all values". The
323 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
324 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
330 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
331 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
332 example, the intention is to have a new value for each host / type instance
333 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
334 It can be specified multiple times to group by more than one field.
337 GroupBy "TypeInstance"
339 We do neither specify nor group by I<plugin instance> (the CPU number), so all
340 metrics that differ in the CPU number only will be aggregated. Each
341 aggregation needs I<at least one> such field, otherwise no aggregation would
344 The full example configuration looks like this:
346 <Plugin "aggregation">
352 GroupBy "TypeInstance"
355 CalculateAverage true
359 There are a couple of limitations you should be aware of:
365 The I<Type> cannot be left unspecified, because it is not reasonable to add
366 apples to oranges. Also, the internal lookup structure won't work if you try
371 There must be at least one unspecified, ungrouped field. Otherwise nothing
376 As you can see in the example above, each aggregation has its own
377 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
378 blocks may match the same values, i.e. one value list can update multiple
379 aggregations. The following options are valid inside B<Aggregation> blocks:
383 =item B<Host> I<Host>
385 =item B<Plugin> I<Plugin>
387 =item B<PluginInstance> I<PluginInstance>
389 =item B<Type> I<Type>
391 =item B<TypeInstance> I<TypeInstance>
393 Selects the value lists to be added to this aggregation. B<Type> must be a
394 valid data set name, see L<types.db(5)> for details.
396 If the string starts with and ends with a slash (C</>), the string is
397 interpreted as a I<regular expression>. The regex flavor used are POSIX
398 extended regular expressions as described in L<regex(7)>. Example usage:
400 Host "/^db[0-9]\\.example\\.com$/"
402 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
404 Group valued by the specified field. The B<GroupBy> option may be repeated to
405 group by multiple fields.
407 =item B<SetHost> I<Host>
409 =item B<SetPlugin> I<Plugin>
411 =item B<SetPluginInstance> I<PluginInstance>
413 =item B<SetTypeInstance> I<TypeInstance>
415 Sets the appropriate part of the identifier to the provided string.
417 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
418 will be replaced with the aggregation function, e.g. "average". Not including
419 the placeholder will result in duplication warnings and/or messed up values if
420 more than one aggregation function are enabled.
422 The following example calculates the average usage of all "even" CPUs:
424 <Plugin "aggregation">
427 PluginInstance "/[0,2,4,6,8]$/"
431 SetPluginInstance "even-%{aggregation}"
434 GroupBy "TypeInstance"
436 CalculateAverage true
440 This will create the files:
446 foo.example.com/cpu-even-average/cpu-idle
450 foo.example.com/cpu-even-average/cpu-system
454 foo.example.com/cpu-even-average/cpu-user
462 =item B<CalculateNum> B<true>|B<false>
464 =item B<CalculateSum> B<true>|B<false>
466 =item B<CalculateAverage> B<true>|B<false>
468 =item B<CalculateMinimum> B<true>|B<false>
470 =item B<CalculateMaximum> B<true>|B<false>
472 =item B<CalculateStddev> B<true>|B<false>
474 Boolean options for enabling calculation of the number of value lists, their
475 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
476 are disabled by default.
480 =head2 Plugin C<amqp>
482 The I<AMQMP plugin> can be used to communicate with other instances of
483 I<collectd> or third party applications using an AMQP message broker. Values
484 are sent to or received from the broker, which handles routing, queueing and
485 possibly filtering or messages.
488 # Send values to an AMQP broker
489 <Publish "some_name">
495 Exchange "amq.fanout"
496 # ExchangeType "fanout"
497 # RoutingKey "collectd"
501 # GraphitePrefix "collectd."
502 # GraphiteEscapeChar "_"
503 # GraphiteSeparateInstances false
504 # GraphiteAlwaysAppendDS false
507 # Receive values from an AMQP broker
508 <Subscribe "some_name">
514 Exchange "amq.fanout"
515 # ExchangeType "fanout"
518 # QueueAutoDelete true
519 # RoutingKey "collectd.#"
523 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
524 blocks, which configure sending and receiving of values respectively. The two
525 blocks are very similar, so unless otherwise noted, an option can be used in
526 either block. The name given in the blocks starting tag is only used for
527 reporting messages, but may be used to support I<flushing> of certain
528 I<Publish> blocks in the future.
532 =item B<Host> I<Host>
534 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
535 the underlying communications library, I<rabbitmq-c>, which is "localhost".
537 =item B<Port> I<Port>
539 Service name or port number on which the AMQP broker accepts connections. This
540 argument must be a string, even if the numeric form is used. Defaults to
543 =item B<VHost> I<VHost>
545 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
547 =item B<User> I<User>
549 =item B<Password> I<Password>
551 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
554 =item B<Exchange> I<Exchange>
556 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
557 By default, "amq.fanout" will be used.
559 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
560 the given exchange and the I<queue> is created, using the I<routing key> if
561 configured. See the B<Queue> and B<RoutingKey> options below.
563 =item B<ExchangeType> I<Type>
565 If given, the plugin will try to create the configured I<exchange> with this
566 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
567 be bound to this exchange.
569 =item B<Queue> I<Queue> (Subscribe only)
571 Configures the I<queue> name to subscribe to. If no queue name was configured
572 explicitly, a unique queue name will be created by the broker.
574 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
576 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
577 or transient (will disappear if the AMQP broker is restarted). Defaults to
580 This option should be used in conjunction with the I<Persistent> option on the
583 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
585 Defines if the I<queue> subscribed to will be deleted once the last consumer
586 unsubscribes. Defaults to "true".
588 =item B<RoutingKey> I<Key>
590 In I<Publish> blocks, this configures the routing key to set on all outgoing
591 messages. If not given, the routing key will be computed from the I<identifier>
592 of the value. The host, plugin, type and the two instances are concatenated
593 together using dots as the separator and all containing dots replaced with
594 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
595 possible to receive only specific values using a "topic" exchange.
597 In I<Subscribe> blocks, configures the I<routing key> used when creating a
598 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
599 used to filter messages when using a "topic" exchange. If you're only
600 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
603 =item B<Persistent> B<true>|B<false> (Publish only)
605 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
606 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
607 default), the I<transient> delivery mode will be used, i.e. messages may be
608 lost due to high load, overflowing queues or similar issues.
610 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
612 Selects the format in which messages are sent to the broker. If set to
613 B<Command> (the default), values are sent as C<PUTVAL> commands which are
614 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
615 case, the C<Content-Type> header field will be set to C<text/collectd>.
617 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
618 an easy and straight forward exchange format. The C<Content-Type> header field
619 will be set to C<application/json>.
621 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
622 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
625 A subscribing client I<should> use the C<Content-Type> header field to
626 determine how to decode the values. Currently, the I<AMQP plugin> itself can
627 only decode the B<Command> format.
629 =item B<StoreRates> B<true>|B<false> (Publish only)
631 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
632 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
633 default), no conversion is performed. Otherwise the conversion is performed
634 using the internal value cache.
636 Please note that currently this option is only used if the B<Format> option has
639 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
641 A prefix can be added in the metric name when outputting in the I<Graphite> format.
642 It's added before the I<Host> name.
643 Metric name will be "<prefix><host><postfix><plugin><type><name>"
645 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
647 A postfix can be added in the metric name when outputting in the I<Graphite> format.
648 It's added after the I<Host> name.
649 Metric name will be "<prefix><host><postfix><plugin><type><name>"
651 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
653 Specify a character to replace dots (.) in the host part of the metric name.
654 In I<Graphite> metric name, dots are used as separators between different
655 metric parts (host, plugin, type).
656 Default is "_" (I<Underscore>).
658 =item B<GraphiteSeparateInstances> B<true>|B<false>
660 If set to B<true>, the plugin instance and type instance will be in their own
661 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
662 default), the plugin and plugin instance (and likewise the type and type
663 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
665 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
667 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
668 identifier. If set to B<false> (the default), this is only done when there is
673 =head2 Plugin C<apache>
675 To configure the C<apache>-plugin you first need to configure the Apache
676 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
677 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
678 the following snipped to base your Apache config upon:
681 <IfModule mod_status.c>
682 <Location /mod_status>
683 SetHandler server-status
687 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
688 also supported. It introduces a new field, called C<BusyServers>, to count the
689 number of currently connected clients. This field is also supported.
691 The configuration of the I<Apache> plugin consists of one or more
692 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
693 as the instance name. For example:
697 URL "http://www1.example.com/mod_status?auto"
700 URL "http://www2.example.com/mod_status?auto"
704 The instance name will be used as the I<plugin instance>. To emulate the old
705 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
706 plugin to work correctly, each instance name must be unique. This is not
707 enforced by the plugin and it is your responsibility to ensure it.
709 The following options are accepted within each I<Instance> block:
713 =item B<URL> I<http://host/mod_status?auto>
715 Sets the URL of the C<mod_status> output. This needs to be the output generated
716 by C<ExtendedStatus on> and it needs to be the machine readable output
717 generated by appending the C<?auto> argument. This option is I<mandatory>.
719 =item B<User> I<Username>
721 Optional user name needed for authentication.
723 =item B<Password> I<Password>
725 Optional password needed for authentication.
727 =item B<VerifyPeer> B<true|false>
729 Enable or disable peer SSL certificate verification. See
730 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
732 =item B<VerifyHost> B<true|false>
734 Enable or disable peer host name verification. If enabled, the plugin checks
735 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
736 certificate matches the host name provided by the B<URL> option. If this
737 identity check fails, the connection is aborted. Obviously, only works when
738 connecting to a SSL enabled server. Enabled by default.
740 =item B<CACert> I<File>
742 File that holds one or more SSL certificates. If you want to use HTTPS you will
743 possibly need this option. What CA certificates come bundled with C<libcurl>
744 and are checked by default depends on the distribution you use.
748 =head2 Plugin C<apcups>
752 =item B<Host> I<Hostname>
754 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
755 that IPv6 support has been disabled unless someone can confirm or decline that
756 B<apcupsd> can handle it.
758 =item B<Port> I<Port>
760 TCP-Port to connect to. Defaults to B<3551>.
762 =item B<ReportSeconds> B<true|false>
764 If set to B<true>, the time reported in the C<timeleft> metric will be
765 converted to seconds. This is the recommended setting. If set to B<false>, the
766 default for backwards compatibility, the time will be reported in minutes.
770 =head2 Plugin C<aquaero>
772 This plugin collects the value of the available sensors in an
773 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
774 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
775 connection for monitoring and configuration. The board can handle multiple
776 temperature sensors, fans, water pumps and water level sensors and adjust the
777 output settings such as fan voltage or power used by the water pump based on
778 the available inputs using a configurable controller included in the board.
779 This plugin collects all the available inputs as well as some of the output
780 values chosen by this controller. The plugin is based on the I<libaquaero5>
781 library provided by I<aquatools-ng>.
785 =item B<Device> I<DevicePath>
787 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
788 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
789 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
793 =head2 Plugin C<ascent>
795 This plugin collects information about an Ascent server, a free server for the
796 "World of Warcraft" game. This plugin gathers the information by fetching the
797 XML status page using C<libcurl> and parses it using C<libxml2>.
799 The configuration options are the same as for the C<apache> plugin above:
803 =item B<URL> I<http://localhost/ascent/status/>
805 Sets the URL of the XML status output.
807 =item B<User> I<Username>
809 Optional user name needed for authentication.
811 =item B<Password> I<Password>
813 Optional password needed for authentication.
815 =item B<VerifyPeer> B<true|false>
817 Enable or disable peer SSL certificate verification. See
818 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
820 =item B<VerifyHost> B<true|false>
822 Enable or disable peer host name verification. If enabled, the plugin checks
823 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
824 certificate matches the host name provided by the B<URL> option. If this
825 identity check fails, the connection is aborted. Obviously, only works when
826 connecting to a SSL enabled server. Enabled by default.
828 =item B<CACert> I<File>
830 File that holds one or more SSL certificates. If you want to use HTTPS you will
831 possibly need this option. What CA certificates come bundled with C<libcurl>
832 and are checked by default depends on the distribution you use.
836 =head2 Plugin C<barometer>
838 This plugin reads absolute air pressure using digital barometer sensor MPL115A2
839 or MPL3115 from Freescale (sensor attached to any I2C bus available in
840 the computer, for HW details see
841 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A> or
842 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>).
843 The sensor type - one fo these two - is detected automatically by the plugin
844 and indicated in the plugin_instance (typically you will see subdirectory
845 "barometer-mpl115" or "barometer-mpl3115").
847 The plugin provides absolute barometric pressure, air pressure reduced to sea
848 level (several possible approximations) and as an auxiliary value also internal
849 sensor temperature. It uses (expects/provides) typical metric units - pressure
850 in [hPa], temperature in [C], altitude in [m].
852 It was developed and tested under Linux only. The only platform dependency is
853 the standard Linux i2c-dev interface (the particular bus driver has to
854 support the SM Bus command subset).
856 The reduction or normalization to mean sea level pressure requires (depedning on
857 selected method/approximation) also altitude and reference to temperature sensor(s).
858 When multiple temperature sensors are configured the minumum of their values is
859 always used (expecting that the warmer ones are affected by e.g. direct sun light
868 TemperatureOffset 0.0
871 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
876 =item B<Device> I<device>
878 Device name of the I2C bus to which the sensor is connected. Note that typically
879 you need to have loaded the i2c-dev module.
880 Using i2c-tools you can check/list i2c buses available on your system by:
884 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
888 This way you should be able to verify that the pressure sensor (either type) is
889 connected and detected on address 0x60.
891 =item B<Oversampling> I<value>
893 For MPL115 this is the size of the averaging window. To filter out sensor noise
894 a simple averaging using floating window of configurable size is used. The plugin
895 will use average of the last C<value> measurements (value of 1 means no averaging).
896 Minimal size is 1, maximal 1024.
898 For MPL3115 this is the oversampling value. The actual oversampling is performed
899 by the sensor and the higher value the higher accuracy and longer conversion time
900 (although nothing to worry about in the collectd context). Supported values are:
901 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
902 the closest supported one. Default is 128.
904 =item B<PressureOffset> I<offset>
906 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
907 This is added to the measured/caclulated value (i.e. if the measured value is too high
908 then use negative offset).
909 In hPa, default is 0.0.
911 =item B<TemperatureOffset> I<offset>
913 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
914 This is added to the measured/caclulated value (i.e. if the measured value is too high
915 then use negative offset).
916 In C, default is 0.0.
918 =item B<Normalization> I<method>
920 Normalization method - what approximation/model is used to compute mean sea
921 level pressure from the air absolute pressure.
923 Supported values of the C<method> (integer between from 0 to 2) are:
927 =item B<0> - no conversion, absolute pressrure is simply copied over. For this method you
928 do not need to configure C<Altitude> or C<TemperatureSensor>.
930 =item B<1> - international formula for conversion ,
931 See I<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
932 For this method you have to configure C<Altitude> but do not need C<TemperatureSensor>
933 (uses fixed global temperature average instead).
935 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
936 Meteorological Service).
937 See I<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
938 For this method you have to configure both C<Altitude> and C<TemperatureSensor>.
943 =item B<Altitude> I<altitude>
945 The altitude (in meters) of the location where you meassure the pressure.
947 =item B<TemperatureSensor> I<reference>
949 Temperature sensor which should be used as a reference when normalizing the pressure.
950 When specified more sensors a minumum is found and uses each time.
951 The temperature reading directly from this pressure sensor/plugin
952 is typically not suitable as the pressure sensor
953 will be probably inside while we want outside temperature.
954 The collectd reference name is something like
955 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
956 (<type_instance> is usually omitted when there is just single value type).
957 Or you can figure it out from the path of the output data files.
961 =head2 Plugin C<bind>
963 Starting with BIND 9.5.0, the most widely used DNS server software provides
964 extensive statistics about queries, responses and lots of other information.
965 The bind plugin retrieves this information that's encoded in XML and provided
966 via HTTP and submits the values to collectd.
968 To use this plugin, you first need to tell BIND to make this information
969 available. This is done with the C<statistics-channels> configuration option:
971 statistics-channels {
972 inet localhost port 8053;
975 The configuration follows the grouping that can be seen when looking at the
976 data with an XSLT compatible viewer, such as a modern web browser. It's
977 probably a good idea to make yourself familiar with the provided values, so you
978 can understand what the collected statistics actually mean.
983 URL "http://localhost:8053/"
998 Zone "127.in-addr.arpa/IN"
1002 The bind plugin accepts the following configuration options:
1008 URL from which to retrieve the XML data. If not specified,
1009 C<http://localhost:8053/> will be used.
1011 =item B<ParseTime> B<true>|B<false>
1013 When set to B<true>, the time provided by BIND will be parsed and used to
1014 dispatch the values. When set to B<false>, the local time source is queried.
1016 This setting is set to B<true> by default for backwards compatibility; setting
1017 this to B<false> is I<recommended> to avoid problems with timezones and
1020 =item B<OpCodes> B<true>|B<false>
1022 When enabled, statistics about the I<"OpCodes">, for example the number of
1023 C<QUERY> packets, are collected.
1027 =item B<QTypes> B<true>|B<false>
1029 When enabled, the number of I<incoming> queries by query types (for example
1030 C<A>, C<MX>, C<AAAA>) is collected.
1034 =item B<ServerStats> B<true>|B<false>
1036 Collect global server statistics, such as requests received over IPv4 and IPv6,
1037 successful queries, and failed updates.
1041 =item B<ZoneMaintStats> B<true>|B<false>
1043 Collect zone maintenance statistics, mostly information about notifications
1044 (zone updates) and zone transfers.
1048 =item B<ResolverStats> B<true>|B<false>
1050 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1051 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1052 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1053 default. Use the B<ResolverStats> option within a B<View "_default"> block
1054 instead for the same functionality.
1058 =item B<MemoryStats>
1060 Collect global memory statistics.
1064 =item B<View> I<Name>
1066 Collect statistics about a specific I<"view">. BIND can behave different,
1067 mostly depending on the source IP-address of the request. These different
1068 configurations are called "views". If you don't use this feature, you most
1069 likely are only interested in the C<_default> view.
1071 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1072 information you want to collect about a view. If no B<View> block is
1073 configured, no detailed view statistics will be collected.
1077 =item B<QTypes> B<true>|B<false>
1079 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1080 C<MX>) is collected.
1084 =item B<ResolverStats> B<true>|B<false>
1086 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1087 (e.E<nbsp>g. queries over IPv4, lame servers).
1091 =item B<CacheRRSets> B<true>|B<false>
1093 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1094 type is collected. Negative entries (queries which resulted in an error, for
1095 example names that do not exist) are reported with a leading exclamation mark,
1100 =item B<Zone> I<Name>
1102 When given, collect detailed information about the given zone in the view. The
1103 information collected if very similar to the global B<ServerStats> information
1106 You can repeat this option to collect detailed information about multiple
1109 By default no detailed zone information is collected.
1115 =head2 Plugin C<cgroups>
1117 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1118 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1119 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1123 =item B<CGroup> I<Directory>
1125 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1126 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1129 =item B<IgnoreSelected> B<true>|B<false>
1131 Invert the selection: If set to true, all cgroups I<except> the ones that
1132 match any one of the criteria are collected. By default only selected
1133 cgroups are collected if a selection is made. If no selection is configured
1134 at all, B<all> cgroups are selected.
1138 =head2 Plugin C<conntrack>
1140 This plugin collects IP conntrack statistics.
1146 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1147 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1151 =head2 Plugin C<cpu>
1153 The I<CPU plugin> collects CPU usage metrics.
1155 The following configuration options are available:
1159 =item B<ReportActive> B<false>|B<true>
1161 Reports non-idle CPU usage as the "active" value. Defaults to false.
1163 =item B<ReportByCpu> B<false>|B<true>
1165 When true reports usage for all cores. When false, reports cpu usage
1166 aggregated over all cores.
1169 =item B<ValuesPercentage> B<false>|B<true>
1171 When true report percentage usage instead of tick values. Defaults to false.
1176 =head2 Plugin C<cpufreq>
1178 This plugin doesn't have any options. It reads
1179 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1180 installed) to get the current CPU frequency. If this file does not exist make
1181 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1182 installed and an "cpu governor" (that's a kernel module) is loaded.
1184 =head2 Plugin C<csv>
1188 =item B<DataDir> I<Directory>
1190 Set the directory to store CSV-files under. Per default CSV-files are generated
1191 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1192 The special strings B<stdout> and B<stderr> can be used to write to the standard
1193 output and standard error channels, respectively. This, of course, only makes
1194 much sense when collectd is running in foreground- or non-daemon-mode.
1196 =item B<StoreRates> B<true|false>
1198 If set to B<true>, convert counter values to rates. If set to B<false> (the
1199 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1204 =head2 Plugin C<curl>
1206 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1207 and the match infrastructure (the same code used by the tail plugin) to use
1208 regular expressions with the received data.
1210 The following example will read the current value of AMD stock from Google's
1211 finance page and dispatch the value to collectd.
1214 <Page "stock_quotes">
1215 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1221 CACert "/path/to/ca.crt"
1222 Header "X-Custom-Header: foobar"
1225 MeasureResponseTime false
1226 MeasureResponseCode false
1229 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1230 DSType "GaugeAverage"
1231 # Note: `stock_value' is not a standard type.
1238 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1239 a web page and one or more "matches" to be performed on the returned data. The
1240 string argument to the B<Page> block is used as plugin instance.
1242 The following options are valid within B<Page> blocks:
1248 URL of the web site to retrieve. Since a regular expression will be used to
1249 extract information from this data, non-binary data is a big plus here ;)
1251 =item B<User> I<Name>
1253 Username to use if authorization is required to read the page.
1255 =item B<Password> I<Password>
1257 Password to use if authorization is required to read the page.
1259 =item B<Digest> B<true>|B<false>
1261 Enable HTTP digest authentication.
1263 =item B<VerifyPeer> B<true>|B<false>
1265 Enable or disable peer SSL certificate verification. See
1266 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1268 =item B<VerifyHost> B<true>|B<false>
1270 Enable or disable peer host name verification. If enabled, the plugin checks if
1271 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1272 matches the host name provided by the B<URL> option. If this identity check
1273 fails, the connection is aborted. Obviously, only works when connecting to a
1274 SSL enabled server. Enabled by default.
1276 =item B<CACert> I<file>
1278 File that holds one or more SSL certificates. If you want to use HTTPS you will
1279 possibly need this option. What CA certificates come bundled with C<libcurl>
1280 and are checked by default depends on the distribution you use.
1282 =item B<Header> I<Header>
1284 A HTTP header to add to the request. Multiple headers are added if this option
1285 is specified more than once.
1287 =item B<Post> I<Body>
1289 Specifies that the HTTP operation should be a POST instead of a GET. The
1290 complete data to be posted is given as the argument. This option will usually
1291 need to be accompanied by a B<Header> option to set an appropriate
1292 C<Content-Type> for the post body (e.g. to
1293 C<application/x-www-form-urlencoded>).
1295 =item B<MeasureResponseTime> B<true>|B<false>
1297 Measure response time for the request. If this setting is enabled, B<Match>
1298 blocks (see below) are optional. Disabled by default.
1300 =item B<MeasureResponseCode> B<true>|B<false>
1302 Measure response code for the request. If this setting is enabled, B<Match>
1303 blocks (see below) are optional. Disabled by default.
1305 =item B<E<lt>MatchE<gt>>
1307 One or more B<Match> blocks that define how to match information in the data
1308 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1309 used by the C<tail> plugin, so please see the documentation of the C<tail>
1310 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1311 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1316 =head2 Plugin C<curl_json>
1318 The B<curl_json plugin> collects values from JSON data to be parsed by
1319 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1320 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1321 unix socket. The former can be used, for example, to collect values
1322 from CouchDB documents (which are stored JSON notation), and the
1323 latter to collect values from a uWSGI stats socket.
1325 The following example will collect several values from the built-in
1326 C<_stats> runtime statistics module of I<CouchDB>
1327 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1330 <URL "http://localhost:5984/_stats">
1332 <Key "httpd/requests/count">
1333 Type "http_requests"
1336 <Key "httpd_request_methods/*/count">
1337 Type "http_request_methods"
1340 <Key "httpd_status_codes/*/count">
1341 Type "http_response_codes"
1346 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1349 <Sock "/var/run/uwsgi.stats.sock">
1351 <Key "workers/*/requests">
1352 Type "http_requests"
1355 <Key "workers/*/apps/*/requests">
1356 Type "http_requests"
1361 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1362 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1363 blocks defining a unix socket to read JSON from directly. Each of
1364 these blocks may have one or more B<Key> blocks.
1366 The B<Key> string argument must be in a path format. Each component is
1367 used to match the key from a JSON map or the index of an JSON
1368 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1369 values for all map keys or array indices will be collectd.
1371 The following options are valid within B<URL> blocks:
1375 =item B<Instance> I<Instance>
1377 Sets the plugin instance to I<Instance>.
1379 =item B<Interval> I<Interval>
1381 Sets the interval (in seconds) in which the values will be collected from this
1382 URL. By default the global B<Interval> setting will be used.
1384 =item B<User> I<Name>
1386 =item B<Password> I<Password>
1388 =item B<Digest> B<true>|B<false>
1390 =item B<VerifyPeer> B<true>|B<false>
1392 =item B<VerifyHost> B<true>|B<false>
1394 =item B<CACert> I<file>
1396 =item B<Header> I<Header>
1398 =item B<Post> I<Body>
1400 These options behave exactly equivalent to the appropriate options of the
1401 I<cURL> plugin. Please see there for a detailed description.
1405 The following options are valid within B<Key> blocks:
1409 =item B<Type> I<Type>
1411 Sets the type used to dispatch the values to the daemon. Detailed information
1412 about types and their configuration can be found in L<types.db(5)>. This
1413 option is mandatory.
1415 =item B<Instance> I<Instance>
1417 Type-instance to use. Defaults to the current map key or current string array element value.
1421 =head2 Plugin C<curl_xml>
1423 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1424 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1427 <URL "http://localhost/stats.xml">
1429 Instance "some_instance"
1434 CACert "/path/to/ca.crt"
1435 Header "X-Custom-Header: foobar"
1438 <XPath "table[@id=\"magic_level\"]/tr">
1440 #InstancePrefix "prefix-"
1441 InstanceFrom "td[1]"
1442 ValuesFrom "td[2]/span[@class=\"level\"]"
1447 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1448 URL to be fetched using libcurl. Within each B<URL> block there are
1449 options which specify the connection parameters, for example authentication
1450 information, and one or more B<XPath> blocks.
1452 Each B<XPath> block specifies how to get one type of information. The
1453 string argument must be a valid XPath expression which returns a list
1454 of "base elements". One value is dispatched for each "base element". The
1455 I<type instance> and values are looked up using further I<XPath> expressions
1456 that should be relative to the base element.
1458 Within the B<URL> block the following options are accepted:
1462 =item B<Host> I<Name>
1464 Use I<Name> as the host name when submitting values. Defaults to the global
1467 =item B<Instance> I<Instance>
1469 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1470 empty string (no plugin instance).
1472 =item B<Namespace> I<Prefix> I<URL>
1474 If an XPath expression references namespaces, they must be specified
1475 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1476 I<URL> is the "namespace name", an URI reference uniquely identifying the
1477 namespace. The option can be repeated to register multiple namespaces.
1481 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1482 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1484 =item B<User> I<User>
1486 =item B<Password> I<Password>
1488 =item B<Digest> B<true>|B<false>
1490 =item B<VerifyPeer> B<true>|B<false>
1492 =item B<VerifyHost> B<true>|B<false>
1494 =item B<CACert> I<CA Cert File>
1496 =item B<Header> I<Header>
1498 =item B<Post> I<Body>
1500 These options behave exactly equivalent to the appropriate options of the
1501 I<cURL plugin>. Please see there for a detailed description.
1503 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1505 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1506 B<XPath> block specifies how to get one type of information. The string
1507 argument must be a valid XPath expression which returns a list of "base
1508 elements". One value is dispatched for each "base element".
1510 Within the B<XPath> block the following options are accepted:
1514 =item B<Type> I<Type>
1516 Specifies the I<Type> used for submitting patches. This determines the number
1517 of values that are required / expected and whether the strings are parsed as
1518 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1519 This option is required.
1521 =item B<InstancePrefix> I<InstancePrefix>
1523 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1524 concatenated together without any separator.
1525 This option is optional.
1527 =item B<InstanceFrom> I<InstanceFrom>
1529 Specifies a XPath expression to use for determining the I<type instance>. The
1530 XPath expression must return exactly one element. The element's value is then
1531 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1533 This value is required. As a special exception, if the "base XPath expression"
1534 (the argument to the B<XPath> block) returns exactly one argument, then this
1535 option may be omitted.
1537 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1539 Specifies one or more XPath expression to use for reading the values. The
1540 number of XPath expressions must match the number of data sources in the
1541 I<type> specified with B<Type> (see above). Each XPath expression must return
1542 exactly one element. The element's value is then parsed as a number and used as
1543 value for the appropriate value in the value list dispatched to the daemon.
1549 =head2 Plugin C<dbi>
1551 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1552 connect to various databases, execute I<SQL> statements and read back the
1553 results. I<dbi> is an acronym for "database interface" in case you were
1554 wondering about the name. You can configure how each column is to be
1555 interpreted and the plugin will generate one or more data sets from each row
1556 returned according to these rules.
1558 Because the plugin is very generic, the configuration is a little more complex
1559 than those of other plugins. It usually looks something like this:
1562 <Query "out_of_stock">
1563 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1564 # Use with MySQL 5.0.0 or later
1568 InstancePrefix "out_of_stock"
1569 InstancesFrom "category"
1573 <Database "product_information">
1575 DriverOption "host" "localhost"
1576 DriverOption "username" "collectd"
1577 DriverOption "password" "aZo6daiw"
1578 DriverOption "dbname" "prod_info"
1579 SelectDB "prod_info"
1580 Query "out_of_stock"
1584 The configuration above defines one query with one result and one database. The
1585 query is then linked to the database with the B<Query> option I<within> the
1586 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1587 and you can also use the B<Include> statement to split up the configuration
1588 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1589 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1592 The following is a complete list of options:
1594 =head3 B<Query> blocks
1596 Query blocks define I<SQL> statements and how the returned data should be
1597 interpreted. They are identified by the name that is given in the opening line
1598 of the block. Thus the name needs to be unique. Other than that, the name is
1599 not used in collectd.
1601 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1602 define which column holds which value or instance information. You can use
1603 multiple B<Result> blocks to create multiple values from one returned row. This
1604 is especially useful, when queries take a long time and sending almost the same
1605 query again and again is not desirable.
1609 <Query "environment">
1610 Statement "select station, temperature, humidity from environment"
1613 # InstancePrefix "foo"
1614 InstancesFrom "station"
1615 ValuesFrom "temperature"
1619 InstancesFrom "station"
1620 ValuesFrom "humidity"
1624 The following options are accepted:
1628 =item B<Statement> I<SQL>
1630 Sets the statement that should be executed on the server. This is B<not>
1631 interpreted by collectd, but simply passed to the database server. Therefore,
1632 the SQL dialect that's used depends on the server collectd is connected to.
1634 The query has to return at least two columns, one for the instance and one
1635 value. You cannot omit the instance, even if the statement is guaranteed to
1636 always return exactly one line. In that case, you can usually specify something
1639 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1641 (That works with MySQL but may not be valid SQL according to the spec. If you
1642 use a more strict database server, you may have to select from a dummy table or
1645 Please note that some databases, for example B<Oracle>, will fail if you
1646 include a semicolon at the end of the statement.
1648 =item B<MinVersion> I<Version>
1650 =item B<MaxVersion> I<Value>
1652 Only use this query for the specified database version. You can use these
1653 options to provide multiple queries with the same name but with a slightly
1654 different syntax. The plugin will use only those queries, where the specified
1655 minimum and maximum versions fit the version of the database in use.
1657 The database version is determined by C<dbi_conn_get_engine_version>, see the
1658 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1659 for details. Basically, each part of the version is assumed to be in the range
1660 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1661 "40102", version "5.0.42" becomes "50042".
1663 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1664 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1665 happen. Don't to it! A valid example would be something along these lines:
1676 In the above example, there are three ranges that don't overlap. The last one
1677 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1678 before "4.0.0" are not specified.
1680 =item B<Type> I<Type>
1682 The B<type> that's used for each line returned. See L<types.db(5)> for more
1683 details on how types are defined. In short: A type is a predefined layout of
1684 data and the number of values and type of values has to match the type
1687 If you specify "temperature" here, you need exactly one gauge column. If you
1688 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1691 There must be exactly one B<Type> option inside each B<Result> block.
1693 =item B<InstancePrefix> I<prefix>
1695 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1696 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1697 all strings returned in the appropriate columns are concatenated together,
1698 separated by dashes I<("-")>.
1700 =item B<InstancesFrom> I<column0> [I<column1> ...]
1702 Specifies the columns whose values will be used to create the "type-instance"
1703 for each row. If you specify more than one column, the value of all columns
1704 will be joined together with dashes I<("-")> as separation characters.
1706 The plugin itself does not check whether or not all built instances are
1707 different. It's your responsibility to assure that each is unique. This is
1708 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1709 sure that only one row is returned in this case.
1711 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1714 =item B<ValuesFrom> I<column0> [I<column1> ...]
1716 Names the columns whose content is used as the actual data for the data sets
1717 that are dispatched to the daemon. How many such columns you need is determined
1718 by the B<Type> setting above. If you specify too many or not enough columns,
1719 the plugin will complain about that and no data will be submitted to the
1722 The actual data type in the columns is not that important. The plugin will
1723 automatically cast the values to the right type if it know how to do that. So
1724 it should be able to handle integer an floating point types, as well as strings
1725 (if they include a number at the beginning).
1727 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1729 =item B<MetadataFrom> [I<column0> I<column1> ...]
1731 Names the columns whose content is used as metadata for the data sets
1732 that are dispatched to the daemon.
1734 The actual data type in the columns is not that important. The plugin will
1735 automatically cast the values to the right type if it know how to do that. So
1736 it should be able to handle integer an floating point types, as well as strings
1737 (if they include a number at the beginning).
1741 =head3 B<Database> blocks
1743 Database blocks define a connection to a database and which queries should be
1744 sent to that database. Since the used "dbi" library can handle a wide variety
1745 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1746 documentationE<nbsp>- we stick as close to the terminology used there.
1748 Each database needs a "name" as string argument in the starting tag of the
1749 block. This name will be used as "PluginInstance" in the values submitted to
1750 the daemon. Other than that, that name is not used.
1754 =item B<Driver> I<Driver>
1756 Specifies the driver to use to connect to the database. In many cases those
1757 drivers are named after the database they can connect to, but this is not a
1758 technical necessity. These drivers are sometimes referred to as "DBD",
1759 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1760 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1761 project at L<http://libdbi-drivers.sourceforge.net/>.
1763 You need to give the driver name as expected by the "dbi" library here. You
1764 should be able to find that in the documentation for each driver. If you
1765 mistype the driver name, the plugin will dump a list of all known driver names
1768 =item B<DriverOption> I<Key> I<Value>
1770 Sets driver-specific options. What option a driver supports can be found in the
1771 documentation for each driver, somewhere at
1772 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1773 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1775 DBDs can register two types of options: String options and numeric options. The
1776 plugin will use the C<dbi_conn_set_option> function when the configuration
1777 provides a string and the C<dbi_conn_require_option_numeric> function when the
1778 configuration provides a number. So these two lines will actually result in
1779 different calls being used:
1781 DriverOption "Port" 1234 # numeric
1782 DriverOption "Port" "1234" # string
1784 Unfortunately, drivers are not too keen to report errors when an unknown option
1785 is passed to them, so invalid settings here may go unnoticed. This is not the
1786 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1787 the driver. If a driver complains about an option, the plugin will dump a
1788 complete list of all options understood by that driver to the log. There is no
1789 way to programatically find out if an option expects a string or a numeric
1790 argument, so you will have to refer to the appropriate DBD's documentation to
1791 find this out. Sorry.
1793 =item B<SelectDB> I<Database>
1795 In some cases, the database name you connect with is not the database name you
1796 want to use for querying data. If this option is set, the plugin will "select"
1797 (switch to) that database after the connection is established.
1799 =item B<Query> I<QueryName>
1801 Associates the query named I<QueryName> with this database connection. The
1802 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1803 blocks you want to refer to must be placed above the database block you want to
1806 =item B<Host> I<Hostname>
1808 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1809 values. Defaults to the global hostname setting.
1817 =item B<Device> I<Device>
1819 Select partitions based on the devicename.
1821 =item B<MountPoint> I<Directory>
1823 Select partitions based on the mountpoint.
1825 =item B<FSType> I<FSType>
1827 Select partitions based on the filesystem type.
1829 =item B<IgnoreSelected> B<true>|B<false>
1831 Invert the selection: If set to true, all partitions B<except> the ones that
1832 match any one of the criteria are collected. By default only selected
1833 partitions are collected if a selection is made. If no selection is configured
1834 at all, B<all> partitions are selected.
1836 =item B<ReportByDevice> B<true>|B<false>
1838 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1839 (the default), it will report a disk as "root", but with it I<true>, it will be
1840 "sda1" (or whichever).
1842 =item B<ReportInodes> B<true>|B<false>
1844 Enables or disables reporting of free, reserved and used inodes. Defaults to
1845 inode collection being disabled.
1847 Enable this option if inodes are a scarce resource for you, usually because
1848 many small files are stored on the disk. This is a usual scenario for mail
1849 transfer agents and web caches.
1851 =item B<ValuesAbsolute> B<true>|B<false>
1853 Enables or disables reporting of free and used disk space in 1K-blocks.
1854 Defaults to B<true>.
1856 =item B<ValuesPercentage> B<false>|B<true>
1858 Enables or disables reporting of free and used disk space in percentage.
1859 Defaults to B<false>.
1861 This is useful for deploying I<collectd> on the cloud, where machines with
1862 different disk size may exist. Then it is more practical to configure
1863 thresholds based on relative disk size.
1867 =head2 Plugin C<disk>
1869 The C<disk> plugin collects information about the usage of physical disks and
1870 logical disks (partitions). Values collected are the number of octets written
1871 to and read from a disk or partition, the number of read/write operations
1872 issued to the disk and a rather complex "time" it took for these commands to be
1875 Using the following two options you can ignore some disks or configure the
1876 collection only of specific disks.
1880 =item B<Disk> I<Name>
1882 Select the disk I<Name>. Whether it is collected or ignored depends on the
1883 B<IgnoreSelected> setting, see below. As with other plugins that use the
1884 daemon's ignorelist functionality, a string that starts and ends with a slash
1885 is interpreted as a regular expression. Examples:
1890 =item B<IgnoreSelected> B<true>|B<false>
1892 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1893 statements, are ignored or if all other disks are ignored. The behavior
1894 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1895 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1896 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1897 is set to B<true>, all disks are collected B<except> the ones matched.
1899 =item B<UseBSDName> B<true>|B<false>
1901 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1902 default major/minor numbers. Requires collectd to be built with Apple's
1905 =item B<UdevNameAttr> I<Attribute>
1907 Attempt to override disk instance name with the value of a specified udev
1908 attribute when built with B<libudev>. If the attribute is not defined for the
1909 given device, the default name is used. Example:
1911 UdevNameAttr "DM_NAME"
1915 =head2 Plugin C<dns>
1919 =item B<Interface> I<Interface>
1921 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1922 option sets the interface that should be used. If this option is not set, or
1923 set to "any", the plugin will try to get packets from B<all> interfaces. This
1924 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1926 =item B<IgnoreSource> I<IP-address>
1928 Ignore packets that originate from this address.
1930 =item B<SelectNumericQueryTypes> B<true>|B<false>
1932 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1936 =head2 Plugin C<email>
1940 =item B<SocketFile> I<Path>
1942 Sets the socket-file which is to be created.
1944 =item B<SocketGroup> I<Group>
1946 If running as root change the group of the UNIX-socket after it has been
1947 created. Defaults to B<collectd>.
1949 =item B<SocketPerms> I<Permissions>
1951 Change the file permissions of the UNIX-socket after it has been created. The
1952 permissions must be given as a numeric, octal value as you would pass to
1953 L<chmod(1)>. Defaults to B<0770>.
1955 =item B<MaxConns> I<Number>
1957 Sets the maximum number of connections that can be handled in parallel. Since
1958 this many threads will be started immediately setting this to a very high
1959 value will waste valuable resources. Defaults to B<5> and will be forced to be
1960 at most B<16384> to prevent typos and dumb mistakes.
1964 =head2 Plugin C<ethstat>
1966 The I<ethstat plugin> collects information about network interface cards (NICs)
1967 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1973 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1974 Map "multicast" "if_multicast"
1981 =item B<Interface> I<Name>
1983 Collect statistical information about interface I<Name>.
1985 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1987 By default, the plugin will submit values as type C<derive> and I<type
1988 instance> set to I<Name>, the name of the metric as reported by the driver. If
1989 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1990 I<TypeInstance> will be used.
1992 =item B<MappedOnly> B<true>|B<false>
1994 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1995 collected, all other metrics will be ignored. Defaults to B<false>.
1999 =head2 Plugin C<exec>
2001 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2002 contains valuable information on when the executable is executed and the
2003 output that is expected from it.
2007 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2009 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2011 Execute the executable I<Executable> as user I<User>. If the user name is
2012 followed by a colon and a group name, the effective group is set to that group.
2013 The real group and saved-set group will be set to the default group of that
2014 user. If no group is given the effective group ID will be the same as the real
2017 Please note that in order to change the user and/or group the daemon needs
2018 superuser privileges. If the daemon is run as an unprivileged user you must
2019 specify the same user/group here. If the daemon is run with superuser
2020 privileges, you must supply a non-root user here.
2022 The executable may be followed by optional arguments that are passed to the
2023 program. Please note that due to the configuration parsing numbers and boolean
2024 values may be changed. If you want to be absolutely sure that something is
2025 passed as-is please enclose it in quotes.
2027 The B<Exec> and B<NotificationExec> statements change the semantics of the
2028 programs executed, i.E<nbsp>e. the data passed to them and the response
2029 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2033 =head2 Plugin C<filecount>
2035 The C<filecount> plugin counts the number of files in a certain directory (and
2036 its subdirectories) and their combined size. The configuration is very straight
2039 <Plugin "filecount">
2040 <Directory "/var/qmail/queue/mess">
2041 Instance "qmail-message"
2043 <Directory "/var/qmail/queue/todo">
2044 Instance "qmail-todo"
2046 <Directory "/var/lib/php5">
2047 Instance "php5-sessions"
2052 The example above counts the number of files in QMail's queue directories and
2053 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2054 QMail has not yet looked at, the "message" queue holds the messages that were
2055 classified into "local" and "remote".
2057 As you can see, the configuration consists of one or more C<Directory> blocks,
2058 each of which specifies a directory in which to count the files. Within those
2059 blocks, the following options are recognized:
2063 =item B<Instance> I<Instance>
2065 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2066 it's your responsibility, the plugin doesn't check for that. If not given, the
2067 instance is set to the directory name with all slashes replaced by underscores
2068 and all leading underscores removed.
2070 =item B<Name> I<Pattern>
2072 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2073 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2074 against the pattern, not the entire path. In case this makes it easier for you:
2075 This option has been named after the B<-name> parameter to L<find(1)>.
2077 =item B<MTime> I<Age>
2079 Count only files of a specific age: If I<Age> is greater than zero, only files
2080 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2081 a negative number, this is inversed. For example, if B<-60> is specified, only
2082 files that have been modified in the last minute will be counted.
2084 The number can also be followed by a "multiplier" to easily specify a larger
2085 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2086 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2087 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2088 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2089 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2092 =item B<Size> I<Size>
2094 Count only files of a specific size. When I<Size> is a positive number, only
2095 files that are at least this big are counted. If I<Size> is a negative number,
2096 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2097 I<Size> are counted.
2099 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2100 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2101 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2102 note that there are 1000 bytes in a kilobyte, not 1024.
2104 =item B<Recursive> I<true>|I<false>
2106 Controls whether or not to recurse into subdirectories. Enabled by default.
2108 =item B<IncludeHidden> I<true>|I<false>
2110 Controls whether or not to include "hidden" files and directories in the count.
2111 "Hidden" files and directories are those, whose name begins with a dot.
2112 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2116 =head2 Plugin C<GenericJMX>
2118 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2119 L<collectd-java(5)>.
2121 =head2 Plugin C<gmond>
2123 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2124 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2125 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2130 MCReceiveFrom "239.2.11.71" "8649"
2131 <Metric "swap_total">
2133 TypeInstance "total"
2136 <Metric "swap_free">
2143 The following metrics are built-in:
2149 load_one, load_five, load_fifteen
2153 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2157 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2169 Available configuration options:
2173 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2175 Sets sets the multicast group and UDP port to which to subscribe.
2177 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2179 =item E<lt>B<Metric> I<Name>E<gt>
2181 These blocks add a new metric conversion to the internal table. I<Name>, the
2182 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2186 =item B<Type> I<Type>
2188 Type to map this metric to. Required.
2190 =item B<TypeInstance> I<Instance>
2192 Type-instance to use. Optional.
2194 =item B<DataSource> I<Name>
2196 Data source to map this metric to. If the configured type has exactly one data
2197 source, this is optional. Otherwise the option is required.
2203 =head2 Plugin C<hddtemp>
2205 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2206 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2207 default values, see below. C<hddtemp> has to be running to work correctly. If
2208 C<hddtemp> is not running timeouts may appear which may interfere with other
2211 The B<hddtemp> homepage can be found at
2212 L<http://www.guzu.net/linux/hddtemp.php>.
2216 =item B<Host> I<Hostname>
2218 Hostname to connect to. Defaults to B<127.0.0.1>.
2220 =item B<Port> I<Port>
2222 TCP-Port to connect to. Defaults to B<7634>.
2226 =head2 Plugin C<interface>
2230 =item B<Interface> I<Interface>
2232 Select this interface. By default these interfaces will then be collected. For
2233 a more detailed description see B<IgnoreSelected> below.
2235 =item B<IgnoreSelected> I<true>|I<false>
2237 If no configuration if given, the B<traffic>-plugin will collect data from
2238 all interfaces. This may not be practical, especially for loopback- and
2239 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2240 interfaces you're interested in. Sometimes, however, it's easier/preferred
2241 to collect all interfaces I<except> a few ones. This option enables you to
2242 do that: By setting B<IgnoreSelected> to I<true> the effect of
2243 B<Interface> is inverted: All selected interfaces are ignored and all
2244 other interfaces are collected.
2248 =head2 Plugin C<ipmi>
2252 =item B<Sensor> I<Sensor>
2254 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2256 =item B<IgnoreSelected> I<true>|I<false>
2258 If no configuration if given, the B<ipmi> plugin will collect data from all
2259 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2260 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2261 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2262 all other sensors are collected.
2264 =item B<NotifySensorAdd> I<true>|I<false>
2266 If a sensor appears after initialization time of a minute a notification
2269 =item B<NotifySensorRemove> I<true>|I<false>
2271 If a sensor disappears a notification is sent.
2273 =item B<NotifySensorNotPresent> I<true>|I<false>
2275 If you have for example dual power supply and one of them is (un)plugged then
2276 a notification is sent.
2280 =head2 Plugin C<iptables>
2284 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2286 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2287 will collect the counters of all rules which have a comment-match. The comment
2288 is then used as type-instance.
2290 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2291 the I<n>th rule will be collected. Again, the comment (or the number) will be
2292 used as the type-instance.
2294 If I<Name> is supplied, it will be used as the type-instance instead of the
2295 comment or the number.
2299 =head2 Plugin C<irq>
2305 Select this irq. By default these irqs will then be collected. For a more
2306 detailed description see B<IgnoreSelected> below.
2308 =item B<IgnoreSelected> I<true>|I<false>
2310 If no configuration if given, the B<irq>-plugin will collect data from all
2311 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2312 can use the B<Irq>-option to pick the interrupt you're interested in.
2313 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2314 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2315 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2316 and all other interrupts are collected.
2320 =head2 Plugin C<java>
2322 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2323 This section only discusses the syntax and semantic of the configuration
2324 options. For more in-depth information on the I<Java> plugin, please read
2325 L<collectd-java(5)>.
2330 JVMArg "-verbose:jni"
2331 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2332 LoadPlugin "org.collectd.java.Foobar"
2333 <Plugin "org.collectd.java.Foobar">
2334 # To be parsed by the plugin
2338 Available configuration options:
2342 =item B<JVMArg> I<Argument>
2344 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2345 exactly the way the arguments to the I<java> binary on the command line work.
2346 Execute C<javaE<nbsp>--help> for details.
2348 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2349 any other options! When another option is found, the JVM will be started and
2350 later options will have to be ignored!
2352 =item B<LoadPlugin> I<JavaClass>
2354 Instantiates a new I<JavaClass> object. The constructor of this object very
2355 likely then registers one or more callback methods with the server.
2357 See L<collectd-java(5)> for details.
2359 When the first such option is found, the virtual machine (JVM) is created. This
2360 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2361 B<LoadPlugin> options!
2363 =item B<Plugin> I<Name>
2365 The entire block is passed to the Java plugin as an
2366 I<org.collectd.api.OConfigItem> object.
2368 For this to work, the plugin has to register a configuration callback first,
2369 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2370 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2371 depends on the (Java) plugin registering the callback and is completely
2372 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2376 =head2 Plugin C<libvirt>
2378 This plugin allows CPU, disk and network load to be collected for virtualized
2379 guests on the machine. This means that these characteristics can be collected
2380 for guest systems without installing any software on them - collectd only runs
2381 on the hosting system. The statistics are collected through libvirt
2382 (L<http://libvirt.org/>).
2384 Only I<Connection> is required.
2388 =item B<Connection> I<uri>
2390 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2392 Connection "xen:///"
2394 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2396 =item B<RefreshInterval> I<seconds>
2398 Refresh the list of domains and devices every I<seconds>. The default is 60
2399 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2400 the list of domains and devices to be refreshed on every iteration.
2402 Refreshing the devices in particular is quite a costly operation, so if your
2403 virtualization setup is static you might consider increasing this. If this
2404 option is set to 0, refreshing is disabled completely.
2406 =item B<Domain> I<name>
2408 =item B<BlockDevice> I<name:dev>
2410 =item B<InterfaceDevice> I<name:dev>
2412 =item B<IgnoreSelected> I<true>|I<false>
2414 Select which domains and devices are collected.
2416 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2417 disk/network devices are collected.
2419 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2420 domains and disk/network devices are ignored, while the rest are collected.
2422 The domain name and device names may use a regular expression, if the name is
2423 surrounded by I</.../> and collectd was compiled with support for regexps.
2425 The default is to collect statistics for all domains and all their devices.
2429 BlockDevice "/:hdb/"
2430 IgnoreSelected "true"
2432 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2435 =item B<HostnameFormat> B<name|uuid|hostname|...>
2437 When the libvirt plugin logs data, it sets the hostname of the collected data
2438 according to this setting. The default is to use the guest name as provided by
2439 the hypervisor, which is equal to setting B<name>.
2441 B<uuid> means use the guest's UUID. This is useful if you want to track the
2442 same guest across migrations.
2444 B<hostname> means to use the global B<Hostname> setting, which is probably not
2445 useful on its own because all guests will appear to have the same name.
2447 You can also specify combinations of these fields. For example B<name uuid>
2448 means to concatenate the guest name and UUID (with a literal colon character
2449 between, thus I<"foo:1234-1234-1234-1234">).
2451 =item B<InterfaceFormat> B<name>|B<address>
2453 When the libvirt plugin logs interface data, it sets the name of the collected
2454 data according to this setting. The default is to use the path as provided by
2455 the hypervisor (the "dev" property of the target node), which is equal to
2458 B<address> means use the interface's mac address. This is useful since the
2459 interface path might change between reboots of a guest or across migrations.
2461 =item B<PluginInstanceFormat> B<name|uuid>
2463 When the libvirt plugin logs data, it sets the plugin_instance of the collected
2464 data according to this setting. The default is to use the guest name as provided
2465 by the hypervisor, which is equal to setting B<name>.
2467 B<uuid> means use the guest's UUID.
2471 =head2 Plugin C<load>
2473 The I<Load plugin> collects the system load. These numbers give a rough overview
2474 over the utilization of a machine. The system load is defined as the number of
2475 runnable tasks in the run-queue and is provided by many operating systems as a
2476 one, five or fifteen minute average.
2478 The following configuration options are available:
2482 =item B<ReportRelative> B<false>|B<true>
2484 When enabled, system load divided by number of available CPU cores is reported
2485 for intervals 1 min, 5 min and 15 min. Defaults to false.
2490 =head2 Plugin C<logfile>
2494 =item B<LogLevel> B<debug|info|notice|warning|err>
2496 Sets the log-level. If, for example, set to B<notice>, then all events with
2497 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2499 Please note that B<debug> is only available if collectd has been compiled with
2502 =item B<File> I<File>
2504 Sets the file to write log messages to. The special strings B<stdout> and
2505 B<stderr> can be used to write to the standard output and standard error
2506 channels, respectively. This, of course, only makes much sense when I<collectd>
2507 is running in foreground- or non-daemon-mode.
2509 =item B<Timestamp> B<true>|B<false>
2511 Prefix all lines printed by the current time. Defaults to B<true>.
2513 =item B<PrintSeverity> B<true>|B<false>
2515 When enabled, all lines are prefixed by the severity of the log message, for
2516 example "warning". Defaults to B<false>.
2520 B<Note>: There is no need to notify the daemon after moving or removing the
2521 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2522 for each line it writes.
2524 =head2 Plugin C<log_logstash>
2526 The I<log logstash plugin> behaves like the logfile plugin but formats
2527 messages as JSON events for logstash to parse and input.
2531 =item B<LogLevel> B<debug|info|notice|warning|err>
2533 Sets the log-level. If, for example, set to B<notice>, then all events with
2534 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2536 Please note that B<debug> is only available if collectd has been compiled with
2539 =item B<File> I<File>
2541 Sets the file to write log messages to. The special strings B<stdout> and
2542 B<stderr> can be used to write to the standard output and standard error
2543 channels, respectively. This, of course, only makes much sense when I<collectd>
2544 is running in foreground- or non-daemon-mode.
2548 B<Note>: There is no need to notify the daemon after moving or removing the
2549 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2550 for each line it writes.
2552 =head2 Plugin C<lpar>
2554 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2555 virtualization technique for IBM POWER processors. It takes into account CPU
2556 time stolen from or donated to a partition, in addition to the usual user,
2557 system, I/O statistics.
2559 The following configuration options are available:
2563 =item B<CpuPoolStats> B<false>|B<true>
2565 When enabled, statistics about the processor pool are read, too. The partition
2566 needs to have pool authority in order to be able to acquire this information.
2569 =item B<ReportBySerial> B<false>|B<true>
2571 If enabled, the serial of the physical machine the partition is currently
2572 running on is reported as I<hostname> and the logical hostname of the machine
2573 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2574 used (just like other plugins) and the I<plugin instance> will be empty.
2579 =head2 Plugin C<mbmon>
2581 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2583 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2584 B<Host> and B<Port> options can be used to change these values, see below.
2585 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2586 timeouts may appear which may interfere with other statistics..
2588 C<mbmon> must be run with the -r option ("print TAG and Value format");
2589 Debian's F</etc/init.d/mbmon> script already does this, other people
2590 will need to ensure that this is the case.
2594 =item B<Host> I<Hostname>
2596 Hostname to connect to. Defaults to B<127.0.0.1>.
2598 =item B<Port> I<Port>
2600 TCP-Port to connect to. Defaults to B<411>.
2606 The C<md plugin> collects information from Linux Software-RAID devices (md).
2608 All reported values are of the type C<md_disks>. Reported type instances are
2609 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2610 I<missing> (physically absent) disks.
2614 =item B<Device> I<Device>
2616 Select md devices based on device name. The I<device name> is the basename of
2617 the device, i.e. the name of the block device without the leading C</dev/>.
2618 See B<IgnoreSelected> for more details.
2620 =item B<IgnoreSelected> B<true>|B<false>
2622 Invert device selection: If set to B<true>, all md devices B<except> those
2623 listed using B<Device> are collected. If B<false> (the default), only those
2624 listed are collected. If no configuration is given, the B<md> plugin will
2625 collect data from all md devices.
2629 =head2 Plugin C<memcachec>
2631 The C<memcachec plugin> connects to a memcached server, queries one or more
2632 given I<pages> and parses the returned data according to user specification.
2633 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2636 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2637 library. Please note that there is another library with a very similar name,
2638 libmemcache (notice the missing `d'), which is not applicable.
2640 Synopsis of the configuration:
2642 <Plugin "memcachec">
2643 <Page "plugin_instance">
2647 Regex "(\\d+) bytes sent"
2650 Instance "type_instance"
2655 The configuration options are:
2659 =item E<lt>B<Page> I<Name>E<gt>
2661 Each B<Page> block defines one I<page> to be queried from the memcached server.
2662 The block requires one string argument which is used as I<plugin instance>.
2664 =item B<Server> I<Address>
2666 Sets the server address to connect to when querying the page. Must be inside a
2671 When connected to the memcached server, asks for the page I<Key>.
2673 =item E<lt>B<Match>E<gt>
2675 Match blocks define which strings to look for and how matches substrings are
2676 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2680 =head2 Plugin C<memcached>
2682 The B<memcached plugin> connects to a memcached server and queries statistics
2683 about cache utilization, memory and bandwidth used.
2684 L<http://www.danga.com/memcached/>
2686 <Plugin "memcached">
2688 Host "memcache.example.com"
2693 The plugin configuration consists of one or more B<Instance> blocks which
2694 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2695 following options are allowed:
2699 =item B<Host> I<Hostname>
2701 Hostname to connect to. Defaults to B<127.0.0.1>.
2703 =item B<Port> I<Port>
2705 TCP-Port to connect to. Defaults to B<11211>.
2707 =item B<Socket> I<Path>
2709 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2710 setting is given, the B<Host> and B<Port> settings are ignored.
2714 =head2 Plugin C<mic>
2716 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2717 Intel's Many Integrated Core (MIC) systems.
2726 ShowTemperatures true
2729 IgnoreSelectedTemperature true
2734 IgnoreSelectedPower true
2737 The following options are valid inside the B<PluginE<nbsp>mic> block:
2741 =item B<ShowCPU> B<true>|B<false>
2743 If enabled (the default) a sum of the CPU usage across all cores is reported.
2745 =item B<ShowCPUCores> B<true>|B<false>
2747 If enabled (the default) per-core CPU usage is reported.
2749 =item B<ShowMemory> B<true>|B<false>
2751 If enabled (the default) the physical memory usage of the MIC system is
2754 =item B<ShowTemperatures> B<true>|B<false>
2756 If enabled (the default) various temperatures of the MIC system are reported.
2758 =item B<Temperature> I<Name>
2760 This option controls which temperatures are being reported. Whether matching
2761 temperatures are being ignored or I<only> matching temperatures are reported
2762 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2763 temperatures are reported.
2765 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2767 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2768 (the default) only temperatures matching a B<Temperature> option are reported
2769 or, if no B<Temperature> option is specified, all temperatures are reported. If
2770 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2773 Known temperature names are:
2807 =item B<ShowPower> B<true>|B<false>
2809 If enabled (the default) various temperatures of the MIC system are reported.
2811 =item B<Power> I<Name>
2813 This option controls which power readings are being reported. Whether matching
2814 power readings are being ignored or I<only> matching power readings are reported
2815 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2816 power readings are reported.
2818 =item B<IgnoreSelectedPower> B<false>|B<true>
2820 Controls the behavior of the B<Power> setting above. If set to B<false>
2821 (the default) only power readings matching a B<Power> option are reported
2822 or, if no B<Power> option is specified, all power readings are reported. If
2823 set to B<true>, matching power readings are I<ignored> and all other power readings
2826 Known power names are:
2832 Total power utilization averaged over Time Window 0 (uWatts).
2836 Total power utilization averaged over Time Window 0 (uWatts).
2840 Instantaneous power (uWatts).
2844 Max instantaneous power (uWatts).
2848 PCI-E connector power (uWatts).
2852 2x3 connector power (uWatts).
2856 2x4 connector power (uWatts).
2864 Uncore rail (uVolts).
2868 Memory subsystem rail (uVolts).
2874 =head2 Plugin C<memory>
2876 The I<memory plugin> provides the following configuration options:
2880 =item B<ValuesAbsolute> B<true>|B<false>
2882 Enables or disables reporting of physical memory usage in absolute numbers,
2883 i.e. bytes. Defaults to B<true>.
2885 =item B<ValuesPercentage> B<false>|B<true>
2887 Enables or disables reporting of physical memory usage in percentages, e.g.
2888 percent of physical memory used. Defaults to B<false>.
2890 This is useful for deploying I<collectd> in a heterogeneous environment in
2891 which the sizes of physical memory vary.
2895 =head2 Plugin C<modbus>
2897 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2898 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2899 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2900 values (two registers interpreted as IEEE floats in big endian notation).
2904 <Data "voltage-input-1">
2911 <Data "voltage-input-2">
2918 <Host "modbus.example.com">
2919 Address "192.168.0.42"
2924 Instance "power-supply"
2925 Collect "voltage-input-1"
2926 Collect "voltage-input-2"
2932 =item E<lt>B<Data> I<Name>E<gt> blocks
2934 Data blocks define a mapping between register numbers and the "types" used by
2937 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2941 =item B<RegisterBase> I<Number>
2943 Configures the base register to read from the device. If the option
2944 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2945 register will be read (the register number is increased by one).
2947 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2949 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2950 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2951 combined into one value. Defaults to B<Uint16>.
2953 =item B<Type> I<Type>
2955 Specifies the "type" (data set) to use when dispatching the value to
2956 I<collectd>. Currently, only data sets with exactly one data source are
2959 =item B<Instance> I<Instance>
2961 Sets the type instance to use when dispatching the value to I<collectd>. If
2962 unset, an empty string (no type instance) is used.
2966 =item E<lt>B<Host> I<Name>E<gt> blocks
2968 Host blocks are used to specify to which hosts to connect and what data to read
2969 from their "slaves". The string argument I<Name> is used as hostname when
2970 dispatching the values to I<collectd>.
2972 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2976 =item B<Address> I<Hostname>
2978 Specifies the node name (the actual network address) used to connect to the
2979 host. This may be an IP address or a hostname. Please note that the used
2980 I<libmodbus> library only supports IPv4 at the moment.
2982 =item B<Port> I<Service>
2984 Specifies the port used to connect to the host. The port can either be given as
2985 a number or as a service name. Please note that the I<Service> argument must be
2986 a string, even if ports are given in their numerical form. Defaults to "502".
2988 =item B<Interval> I<Interval>
2990 Sets the interval (in seconds) in which the values will be collected from this
2991 host. By default the global B<Interval> setting will be used.
2993 =item E<lt>B<Slave> I<ID>E<gt>
2995 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2996 is used to specify which device should be addressed. For each device you want
2997 to query, one B<Slave> block must be given.
2999 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3003 =item B<Instance> I<Instance>
3005 Specify the plugin instance to use when dispatching the values to I<collectd>.
3006 By default "slave_I<ID>" is used.
3008 =item B<Collect> I<DataName>
3010 Specifies which data to retrieve from the device. I<DataName> must be the same
3011 string as the I<Name> argument passed to a B<Data> block. You can specify this
3012 option multiple times to collect more than one value from a slave. At least one
3013 B<Collect> option is mandatory.
3021 =head2 Plugin C<mysql>
3023 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3024 one or more databases when started and keeps the connection up as long as
3025 possible. When the connection is interrupted for whatever reason it will try
3026 to re-connect. The plugin will complain loudly in case anything goes wrong.
3028 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3029 and collects information about MySQL network traffic, executed statements,
3030 requests, the query cache and threads by evaluating the
3031 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3032 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3033 Status Variables> for an explanation of these values.
3035 Optionally, master and slave statistics may be collected in a MySQL
3036 replication setup. In that case, information about the synchronization state
3037 of the nodes are collected by evaluating the C<Position> return value of the
3038 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3039 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3040 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3041 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3042 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3059 Socket "/var/run/mysql/mysqld.sock"
3061 SlaveNotifications true
3065 A B<Database> block defines one connection to a MySQL database. It accepts a
3066 single argument which specifies the name of the database. None of the other
3067 options are required. MySQL will use default values as documented in the
3068 section "mysql_real_connect()" in the B<MySQL reference manual>.
3072 =item B<Alias> I<Alias>
3074 Alias to use as sender instead of hostname when reporting. This may be useful
3075 when having cryptic hostnames.
3077 =item B<Host> I<Hostname>
3079 Hostname of the database server. Defaults to B<localhost>.
3081 =item B<User> I<Username>
3083 Username to use when connecting to the database. The user does not have to be
3084 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3085 unless you want to collectd replication statistics (see B<MasterStats> and
3086 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3087 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3089 =item B<Password> I<Password>
3091 Password needed to log into the database.
3093 =item B<Database> I<Database>
3095 Select this database. Defaults to I<no database> which is a perfectly reasonable
3096 option for what this plugin does.
3098 =item B<Port> I<Port>
3100 TCP-port to connect to. The port must be specified in its numeric form, but it
3101 must be passed as a string nonetheless. For example:
3105 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3106 See the documentation for the C<mysql_real_connect> function for details.
3108 =item B<Socket> I<Socket>
3110 Specifies the path to the UNIX domain socket of the MySQL server. This option
3111 only has any effect, if B<Host> is set to B<localhost> (the default).
3112 Otherwise, use the B<Port> option above. See the documentation for the
3113 C<mysql_real_connect> function for details.
3115 =item B<InnodbStats> I<true|false>
3117 If enabled, metrics about the InnoDB storage engine are collected.
3118 Disabled by default.
3120 =item B<MasterStats> I<true|false>
3122 =item B<SlaveStats> I<true|false>
3124 Enable the collection of master / slave statistics in a replication setup. In
3125 order to be able to get access to these statistics, the user needs special
3126 privileges. See the B<User> documentation above.
3128 =item B<SlaveNotifications> I<true|false>
3130 If enabled, the plugin sends a notification if the replication slave I/O and /
3131 or SQL threads are not running.
3133 =item B<ConnectTimeout> I<Seconds>
3135 Sets the connect timeout for the MySQL client.
3139 =head2 Plugin C<netapp>
3141 The netapp plugin can collect various performance and capacity information
3142 from a NetApp filer using the NetApp API.
3144 Please note that NetApp has a wide line of products and a lot of different
3145 software versions for each of these products. This plugin was developed for a
3146 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3147 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3148 model and software version but it is very hard to test this.
3149 If you have used this plugin with other models and/or software version, feel
3150 free to send us a mail to tell us about the results, even if it's just a short
3153 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3154 basic authentication.
3156 B<Do not use a regular user for this!> Create a special collectd user with just
3157 the minimum of capabilities needed. The user only needs the "login-http-admin"
3158 capability as well as a few more depending on which data will be collected.
3159 Required capabilities are documented below.
3164 <Host "netapp1.example.com">
3188 IgnoreSelectedIO false
3190 IgnoreSelectedOps false
3191 GetLatency "volume0"
3192 IgnoreSelectedLatency false
3199 IgnoreSelectedCapacity false
3202 IgnoreSelectedSnapshot false
3230 The netapp plugin accepts the following configuration options:
3234 =item B<Host> I<Name>
3236 A host block defines one NetApp filer. It will appear in collectd with the name
3237 you specify here which does not have to be its real name nor its hostname (see
3238 the B<Address> option below).
3240 =item B<VFiler> I<Name>
3242 A B<VFiler> block may only be used inside a host block. It accepts all the
3243 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3244 will execute all NetApp API commands in the context of the specified
3245 VFiler(R). It will appear in collectd with the name you specify here which
3246 does not have to be its real name. The VFiler name may be specified using the
3247 B<VFilerName> option. If this is not specified, it will default to the name
3250 The VFiler block inherits all connection related settings from the surrounding
3251 B<Host> block (which appear before the B<VFiler> block) but they may be
3252 overwritten inside the B<VFiler> block.
3254 This feature is useful, for example, when using a VFiler as SnapVault target
3255 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3256 available in the host filer (vfiler0) but only in the respective VFiler
3259 =item B<Protocol> B<httpd>|B<http>
3261 The protocol collectd will use to query this host.
3269 Valid options: http, https
3271 =item B<Address> I<Address>
3273 The hostname or IP address of the host.
3279 Default: The "host" block's name.
3281 =item B<Port> I<Port>
3283 The TCP port to connect to on the host.
3289 Default: 80 for protocol "http", 443 for protocol "https"
3291 =item B<User> I<User>
3293 =item B<Password> I<Password>
3295 The username and password to use to login to the NetApp.
3301 =item B<VFilerName> I<Name>
3303 The name of the VFiler in which context to execute API commands. If not
3304 specified, the name provided to the B<VFiler> block will be used instead.
3310 Default: name of the B<VFiler> block
3312 B<Note:> This option may only be used inside B<VFiler> blocks.
3314 =item B<Interval> I<Interval>
3320 The following options decide what kind of data will be collected. You can
3321 either use them as a block and fine tune various parameters inside this block,
3322 use them as a single statement to just accept all default values, or omit it to
3323 not collect any data.
3325 The following options are valid inside all blocks:
3329 =item B<Interval> I<Seconds>
3331 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3332 host specific setting.
3336 =head3 The System block
3338 This will collect various performance data about the whole system.
3340 B<Note:> To get this data the collectd user needs the
3341 "api-perf-object-get-instances" capability.
3345 =item B<Interval> I<Seconds>
3347 Collect disk statistics every I<Seconds> seconds.
3349 =item B<GetCPULoad> B<true>|B<false>
3351 If you set this option to true the current CPU usage will be read. This will be
3352 the average usage between all CPUs in your NetApp without any information about
3355 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3356 returns in the "CPU" field.
3364 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3366 =item B<GetInterfaces> B<true>|B<false>
3368 If you set this option to true the current traffic of the network interfaces
3369 will be read. This will be the total traffic over all interfaces of your NetApp
3370 without any information about individual interfaces.
3372 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3373 in the "Net kB/s" field.
3383 Result: One value list of type "if_octects".
3385 =item B<GetDiskIO> B<true>|B<false>
3387 If you set this option to true the current IO throughput will be read. This
3388 will be the total IO of your NetApp without any information about individual
3389 disks, volumes or aggregates.
3391 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3392 in the "DiskE<nbsp>kB/s" field.
3400 Result: One value list of type "disk_octets".
3402 =item B<GetDiskOps> B<true>|B<false>
3404 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3405 iSCSI, etc. operations will be read. This will be the total number of
3406 operations on your NetApp without any information about individual volumes or
3409 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3410 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3418 Result: A variable number of value lists of type "disk_ops_complex". Each type
3419 of operation will result in one value list with the name of the operation as
3424 =head3 The WAFL block
3426 This will collect various performance data about the WAFL file system. At the
3427 moment this just means cache performance.
3429 B<Note:> To get this data the collectd user needs the
3430 "api-perf-object-get-instances" capability.
3432 B<Note:> The interface to get these values is classified as "Diagnostics" by
3433 NetApp. This means that it is not guaranteed to be stable even between minor
3438 =item B<Interval> I<Seconds>
3440 Collect disk statistics every I<Seconds> seconds.
3442 =item B<GetNameCache> B<true>|B<false>
3450 Result: One value list of type "cache_ratio" and type instance
3453 =item B<GetDirCache> B<true>|B<false>
3461 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3463 =item B<GetInodeCache> B<true>|B<false>
3471 Result: One value list of type "cache_ratio" and type instance
3474 =item B<GetBufferCache> B<true>|B<false>
3476 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3477 in the "Cache hit" field.
3485 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3489 =head3 The Disks block
3491 This will collect performance data about the individual disks in the NetApp.
3493 B<Note:> To get this data the collectd user needs the
3494 "api-perf-object-get-instances" capability.
3498 =item B<Interval> I<Seconds>
3500 Collect disk statistics every I<Seconds> seconds.
3502 =item B<GetBusy> B<true>|B<false>
3504 If you set this option to true the busy time of all disks will be calculated
3505 and the value of the busiest disk in the system will be written.
3507 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3508 in the "Disk util" field. Probably.
3516 Result: One value list of type "percent" and type instance "disk_busy".
3520 =head3 The VolumePerf block
3522 This will collect various performance data about the individual volumes.
3524 You can select which data to collect about which volume using the following
3525 options. They follow the standard ignorelist semantic.
3527 B<Note:> To get this data the collectd user needs the
3528 I<api-perf-object-get-instances> capability.
3532 =item B<Interval> I<Seconds>
3534 Collect volume performance data every I<Seconds> seconds.
3536 =item B<GetIO> I<Volume>
3538 =item B<GetOps> I<Volume>
3540 =item B<GetLatency> I<Volume>
3542 Select the given volume for IO, operations or latency statistics collection.
3543 The argument is the name of the volume without the C</vol/> prefix.
3545 Since the standard ignorelist functionality is used here, you can use a string
3546 starting and ending with a slash to specify regular expression matching: To
3547 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3550 GetIO "/^vol[027]$/"
3552 If no regular expression is specified, an exact match is required. Both,
3553 regular and exact matching are case sensitive.
3555 If no volume was specified at all for either of the three options, that data
3556 will be collected for all available volumes.
3558 =item B<IgnoreSelectedIO> B<true>|B<false>
3560 =item B<IgnoreSelectedOps> B<true>|B<false>
3562 =item B<IgnoreSelectedLatency> B<true>|B<false>
3564 When set to B<true>, the volumes selected for IO, operations or latency
3565 statistics collection will be ignored and the data will be collected for all
3568 When set to B<false>, data will only be collected for the specified volumes and
3569 all other volumes will be ignored.
3571 If no volumes have been specified with the above B<Get*> options, all volumes
3572 will be collected regardless of the B<IgnoreSelected*> option.
3574 Defaults to B<false>
3578 =head3 The VolumeUsage block
3580 This will collect capacity data about the individual volumes.
3582 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3587 =item B<Interval> I<Seconds>
3589 Collect volume usage statistics every I<Seconds> seconds.
3591 =item B<GetCapacity> I<VolumeName>
3593 The current capacity of the volume will be collected. This will result in two
3594 to four value lists, depending on the configuration of the volume. All data
3595 sources are of type "df_complex" with the name of the volume as
3598 There will be type_instances "used" and "free" for the number of used and
3599 available bytes on the volume. If the volume has some space reserved for
3600 snapshots, a type_instance "snap_reserved" will be available. If the volume
3601 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3602 number of bytes saved by the SIS feature.
3604 B<Note:> The current NetApp API has a bug that results in this value being
3605 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3606 number which works most of the time. If you see strange values here, bug
3607 NetApp support to fix this.
3609 Repeat this option to specify multiple volumes.
3611 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3613 Specify whether to collect only the volumes selected by the B<GetCapacity>
3614 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3615 B<false>. However, if no B<GetCapacity> option is specified at all, all
3616 capacities will be selected anyway.
3618 =item B<GetSnapshot> I<VolumeName>
3620 Select volumes from which to collect snapshot information.
3622 Usually, the space used for snapshots is included in the space reported as
3623 "used". If snapshot information is collected as well, the space used for
3624 snapshots is subtracted from the used space.
3626 To make things even more interesting, it is possible to reserve space to be
3627 used for snapshots. If the space required for snapshots is less than that
3628 reserved space, there is "reserved free" and "reserved used" space in addition
3629 to "free" and "used". If the space required for snapshots exceeds the reserved
3630 space, that part allocated in the normal space is subtracted from the "used"
3633 Repeat this option to specify multiple volumes.
3635 =item B<IgnoreSelectedSnapshot>
3637 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3638 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3639 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3640 capacities will be selected anyway.
3644 =head3 The Quota block
3646 This will collect (tree) quota statistics (used disk space and number of used
3647 files). This mechanism is useful to get usage information for single qtrees.
3648 In case the quotas are not used for any other purpose, an entry similar to the
3649 following in C</etc/quotas> would be sufficient:
3651 /vol/volA/some_qtree tree - - - - -
3653 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3657 =item B<Interval> I<Seconds>
3659 Collect SnapVault(R) statistics every I<Seconds> seconds.
3663 =head3 The SnapVault block
3665 This will collect statistics about the time and traffic of SnapVault(R)
3670 =item B<Interval> I<Seconds>
3672 Collect SnapVault(R) statistics every I<Seconds> seconds.
3676 =head2 Plugin C<netlink>
3678 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3679 statistics of various interface and routing aspects.
3683 =item B<Interface> I<Interface>
3685 =item B<VerboseInterface> I<Interface>
3687 Instruct the plugin to collect interface statistics. This is basically the same
3688 as the statistics provided by the C<interface> plugin (see above) but
3689 potentially much more detailed.
3691 When configuring with B<Interface> only the basic statistics will be collected,
3692 namely octets, packets, and errors. These statistics are collected by
3693 the C<interface> plugin, too, so using both at the same time is no benefit.
3695 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3696 so that no data needs to be collected twice if you use the C<interface> plugin.
3697 This includes dropped packets, received multicast packets, collisions and a
3698 whole zoo of differentiated RX and TX errors. You can try the following command
3699 to get an idea of what awaits you:
3703 If I<Interface> is B<All>, all interfaces will be selected.
3705 =item B<QDisc> I<Interface> [I<QDisc>]
3707 =item B<Class> I<Interface> [I<Class>]
3709 =item B<Filter> I<Interface> [I<Filter>]
3711 Collect the octets and packets that pass a certain qdisc, class or filter.
3713 QDiscs and classes are identified by their type and handle (or classid).
3714 Filters don't necessarily have a handle, therefore the parent's handle is used.
3715 The notation used in collectd differs from that used in tc(1) in that it
3716 doesn't skip the major or minor number if it's zero and doesn't print special
3717 ids by their name. So, for example, a qdisc may be identified by
3718 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3719 thus not displayed by tc(1).
3721 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3722 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3723 associated with that interface will be collected.
3725 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3726 used. This may lead to problems when more than one filter is attached to a
3727 qdisc or class. This isn't nice, but we don't know how this could be done any
3728 better. If you have a idea, please don't hesitate to tell us.
3730 As with the B<Interface> option you can specify B<All> as the interface,
3731 meaning all interfaces.
3733 Here are some examples to help you understand the above text more easily:
3736 VerboseInterface "All"
3737 QDisc "eth0" "pfifo_fast-1:0"
3739 Class "ppp0" "htb-1:10"
3740 Filter "ppp0" "u32-1:0"
3743 =item B<IgnoreSelected>
3745 The behavior is the same as with all other similar plugins: If nothing is
3746 selected at all, everything is collected. If some things are selected using the
3747 options described above, only these statistics are collected. If you set
3748 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3749 specified statistics will not be collected.
3753 =head2 Plugin C<network>
3755 The Network plugin sends data to a remote instance of collectd, receives data
3756 from a remote instance, or both at the same time. Data which has been received
3757 from the network is usually not transmitted again, but this can be activated, see
3758 the B<Forward> option below.
3760 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3761 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3763 Both, B<Server> and B<Listen> can be used as single option or as block. When
3764 used as block, given options are valid for this socket only. The following
3765 example will export the metrics twice: Once to an "internal" server (without
3766 encryption and signing) and one to an external server (with cryptographic
3770 # Export to an internal server
3771 # (demonstrates usage without additional options)
3772 Server "collectd.internal.tld"
3774 # Export to an external server
3775 # (demonstrates usage with signature options)
3776 <Server "collectd.external.tld">
3777 SecurityLevel "sign"
3778 Username "myhostname"
3785 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3787 The B<Server> statement/block sets the server to send datagrams to. The
3788 statement may occur multiple times to send each datagram to multiple
3791 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3792 optional second argument specifies a port number or a service name. If not
3793 given, the default, B<25826>, is used.
3795 The following options are recognized within B<Server> blocks:
3799 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3801 Set the security you require for network communication. When the security level
3802 has been set to B<Encrypt>, data sent over the network will be encrypted using
3803 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3804 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3805 authentication code. When set to B<None>, data is sent without any security.
3807 This feature is only available if the I<network> plugin was linked with
3810 =item B<Username> I<Username>
3812 Sets the username to transmit. This is used by the server to lookup the
3813 password. See B<AuthFile> below. All security levels except B<None> require
3816 This feature is only available if the I<network> plugin was linked with
3819 =item B<Password> I<Password>
3821 Sets a password (shared secret) for this socket. All security levels except
3822 B<None> require this setting.
3824 This feature is only available if the I<network> plugin was linked with
3827 =item B<Interface> I<Interface name>
3829 Set the outgoing interface for IP packets. This applies at least
3830 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3831 undefined or a non-existent interface name is specified, the default
3832 behavior is to let the kernel choose the appropriate interface. Be warned
3833 that the manual selection of an interface for unicast traffic is only
3834 necessary in rare cases.
3838 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3840 The B<Listen> statement sets the interfaces to bind to. When multiple
3841 statements are found the daemon will bind to multiple interfaces.
3843 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3844 the argument is a multicast address the daemon will join that multicast group.
3845 The optional second argument specifies a port number or a service name. If not
3846 given, the default, B<25826>, is used.
3848 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3852 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3854 Set the security you require for network communication. When the security level
3855 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3856 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3857 signed and encrypted data is accepted. When set to B<None>, all data will be
3858 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3859 decrypted if possible.
3861 This feature is only available if the I<network> plugin was linked with
3864 =item B<AuthFile> I<Filename>
3866 Sets a file in which usernames are mapped to passwords. These passwords are
3867 used to verify signatures and to decrypt encrypted network packets. If
3868 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3869 verified and encrypted packets are decrypted. Otherwise, signed data is
3870 accepted without checking the signature and encrypted data cannot be decrypted.
3871 For the other security levels this option is mandatory.
3873 The file format is very simple: Each line consists of a username followed by a
3874 colon and any number of spaces followed by the password. To demonstrate, an
3875 example file could look like this:
3880 Each time a packet is received, the modification time of the file is checked
3881 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3882 the file is being read, it is locked using L<fcntl(2)>.
3884 =item B<Interface> I<Interface name>
3886 Set the incoming interface for IP packets explicitly. This applies at least
3887 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3888 undefined or a non-existent interface name is specified, the default
3889 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3890 traffic gets only accepted, if it arrives on the given interface.
3894 =item B<TimeToLive> I<1-255>
3896 Set the time-to-live of sent packets. This applies to all, unicast and
3897 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3898 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3901 =item B<MaxPacketSize> I<1024-65535>
3903 Set the maximum size for datagrams received over the network. Packets larger
3904 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3905 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3908 On the server side, this limit should be set to the largest value used on
3909 I<any> client. Likewise, the value on the client must not be larger than the
3910 value on the server, or data will be lost.
3912 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3913 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3914 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3917 =item B<Forward> I<true|false>
3919 If set to I<true>, write packets that were received via the network plugin to
3920 the sending sockets. This should only be activated when the B<Listen>- and
3921 B<Server>-statements differ. Otherwise packets may be send multiple times to
3922 the same multicast group. While this results in more network traffic than
3923 necessary it's not a huge problem since the plugin has a duplicate detection,
3924 so the values will not loop.
3926 =item B<ReportStats> B<true>|B<false>
3928 The network plugin cannot only receive and send statistics, it can also create
3929 statistics about itself. Collected data included the number of received and
3930 sent octets and packets, the length of the receive queue and the number of
3931 values handled. When set to B<true>, the I<Network plugin> will make these
3932 statistics available. Defaults to B<false>.
3936 =head2 Plugin C<nginx>
3938 This plugin collects the number of connections and requests handled by the
3939 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3940 queries the page provided by the C<ngx_http_stub_status_module> module, which
3941 isn't compiled by default. Please refer to
3942 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3943 how to compile and configure nginx and this module.
3945 The following options are accepted by the C<nginx plugin>:
3949 =item B<URL> I<http://host/nginx_status>
3951 Sets the URL of the C<ngx_http_stub_status_module> output.
3953 =item B<User> I<Username>
3955 Optional user name needed for authentication.
3957 =item B<Password> I<Password>
3959 Optional password needed for authentication.
3961 =item B<VerifyPeer> B<true|false>
3963 Enable or disable peer SSL certificate verification. See
3964 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3966 =item B<VerifyHost> B<true|false>
3968 Enable or disable peer host name verification. If enabled, the plugin checks
3969 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3970 certificate matches the host name provided by the B<URL> option. If this
3971 identity check fails, the connection is aborted. Obviously, only works when
3972 connecting to a SSL enabled server. Enabled by default.
3974 =item B<CACert> I<File>
3976 File that holds one or more SSL certificates. If you want to use HTTPS you will
3977 possibly need this option. What CA certificates come bundled with C<libcurl>
3978 and are checked by default depends on the distribution you use.
3982 =head2 Plugin C<notify_desktop>
3984 This plugin sends a desktop notification to a notification daemon, as defined
3985 in the Desktop Notification Specification. To actually display the
3986 notifications, B<notification-daemon> is required and B<collectd> has to be
3987 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3988 environment variables have to be set correctly) and the D-Bus message bus.
3990 The Desktop Notification Specification can be found at
3991 L<http://www.galago-project.org/specs/notification/>.
3995 =item B<OkayTimeout> I<timeout>
3997 =item B<WarningTimeout> I<timeout>
3999 =item B<FailureTimeout> I<timeout>
4001 Set the I<timeout>, in milliseconds, after which to expire the notification
4002 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4003 been specified, the displayed notification will not be closed at all - the
4004 user has to do so herself. These options default to 5000. If a negative number
4005 has been specified, the default is used as well.
4009 =head2 Plugin C<notify_email>
4011 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4012 configured email address.
4014 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4016 Available configuration options:
4020 =item B<From> I<Address>
4022 Email address from which the emails should appear to come from.
4024 Default: C<root@localhost>
4026 =item B<Recipient> I<Address>
4028 Configures the email address(es) to which the notifications should be mailed.
4029 May be repeated to send notifications to multiple addresses.
4031 At least one B<Recipient> must be present for the plugin to work correctly.
4033 =item B<SMTPServer> I<Hostname>
4035 Hostname of the SMTP server to connect to.
4037 Default: C<localhost>
4039 =item B<SMTPPort> I<Port>
4041 TCP port to connect to.
4045 =item B<SMTPUser> I<Username>
4047 Username for ASMTP authentication. Optional.
4049 =item B<SMTPPassword> I<Password>
4051 Password for ASMTP authentication. Optional.
4053 =item B<Subject> I<Subject>
4055 Subject-template to use when sending emails. There must be exactly two
4056 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4057 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4060 Default: C<Collectd notify: %s@%s>
4064 =head2 Plugin C<ntpd>
4068 =item B<Host> I<Hostname>
4070 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4072 =item B<Port> I<Port>
4074 UDP-Port to connect to. Defaults to B<123>.
4076 =item B<ReverseLookups> B<true>|B<false>
4078 Sets whether or not to perform reverse lookups on peers. Since the name or
4079 IP-address may be used in a filename it is recommended to disable reverse
4080 lookups. The default is to do reverse lookups to preserve backwards
4081 compatibility, though.
4083 =item B<IncludeUnitID> B<true>|B<false>
4085 When a peer is a refclock, include the unit ID in the I<type instance>.
4086 Defaults to B<false> for backward compatibility.
4088 If two refclock peers use the same driver and this is B<false>, the plugin will
4089 try to write simultaneous measurements from both to the same type instance.
4090 This will result in error messages in the log and only one set of measurements
4095 =head2 Plugin C<nut>
4099 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4101 Add a UPS to collect data from. The format is identical to the one accepted by
4106 =head2 Plugin C<olsrd>
4108 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4109 the Optimized Link State Routing daemon and reads information about the current
4110 state of the meshed network.
4112 The following configuration options are understood:
4116 =item B<Host> I<Host>
4118 Connect to I<Host>. Defaults to B<"localhost">.
4120 =item B<Port> I<Port>
4122 Specifies the port to connect to. This must be a string, even if you give the
4123 port as a number rather than a service name. Defaults to B<"2006">.
4125 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4127 Specifies what information to collect about links, i.E<nbsp>e. direct
4128 connections of the daemon queried. If set to B<No>, no information is
4129 collected. If set to B<Summary>, the number of links and the average of all
4130 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4131 If set to B<Detail> LQ and NLQ are collected per link.
4133 Defaults to B<Detail>.
4135 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4137 Specifies what information to collect about routes of the daemon queried. If
4138 set to B<No>, no information is collected. If set to B<Summary>, the number of
4139 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4140 metric and ETX are collected per route.
4142 Defaults to B<Summary>.
4144 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4146 Specifies what information to collect about the global topology. If set to
4147 B<No>, no information is collected. If set to B<Summary>, the number of links
4148 in the entire topology and the average I<link quality> (LQ) is calculated.
4149 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4151 Defaults to B<Summary>.
4155 =head2 Plugin C<onewire>
4157 B<EXPERIMENTAL!> See notes below.
4159 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4160 L<http://owfs.org/> to read sensors connected via the onewire bus.
4162 It can be used in two possible modes - standard or advanced.
4164 In the standard mode only temperature sensors (sensors with the family code
4165 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4166 other sensors you would like to have included, please send a sort request to
4167 the mailing list. You can select sensors to be read or to be ignored depending
4168 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4169 walked and all sensors are read.
4171 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4172 experimental, below.
4174 In the advanced mode you can configure any sensor to be read (only numerical
4175 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4176 In this mode you have to list all the sensors. Neither default bus walk nor
4177 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4178 the path automatically and should produce compatible structure with the "standard"
4179 mode (basically the path is expected as for example
4180 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4181 "F10FCA000800" and the rest after the slash is considered the type - here
4183 There are two advantages to this mode - you can access virtually any sensor
4184 (not just temperature), select whether to use cached or directly read values
4185 and it is slighlty faster. The downside is more complex configuration.
4187 The two modes are distinguished automatically by the format of the address.
4188 It is not possible to mix the two modes. Once a full path is detected in any
4189 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4190 (and as standard addresses will fail parsing they will be ignored).
4194 =item B<Device> I<Device>
4196 Sets the device to read the values from. This can either be a "real" hardware
4197 device, such as a serial port or an USB port, or the address of the
4198 L<owserver(1)> socket, usually B<localhost:4304>.
4200 Though the documentation claims to automatically recognize the given address
4201 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4202 with that version, the following configuration worked for us:
4205 Device "-s localhost:4304"
4208 This directive is B<required> and does not have a default value.
4210 =item B<Sensor> I<Sensor>
4212 In the standard mode selects sensors to collect or to ignore
4213 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4214 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4215 and B<not> include the leading C<10.> family byte and point.
4216 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4217 sensors (see above) are read.
4219 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4220 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4221 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4223 As there can be multiple devices on the bus you can list multiple sensor (use
4224 multiple B<Sensor> elements).
4226 =item B<IgnoreSelected> I<true>|I<false>
4228 If no configuration is given, the B<onewire> plugin will collect data from all
4229 sensors found. This may not be practical, especially if sensors are added and
4230 removed regularly. Sometimes, however, it's easier/preferred to collect only
4231 specific sensors or all sensors I<except> a few specified ones. This option
4232 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4233 B<Sensor> is inverted: All selected interfaces are ignored and all other
4234 interfaces are collected.
4236 Used only in the standard mode - see above.
4238 =item B<Interval> I<Seconds>
4240 Sets the interval in which all sensors should be read. If not specified, the
4241 global B<Interval> setting is used.
4245 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4246 work with big setups. It works with one sensor being attached to one
4247 controller, but as soon as you throw in a couple more senors and maybe a hub
4248 or two, reading all values will take more than ten seconds (the default
4249 interval). We will probably add some separate thread for reading the sensors
4250 and some cache or something like that, but it's not done yet. We will try to
4251 maintain backwards compatibility in the future, but we can't promise. So in
4252 short: If it works for you: Great! But keep in mind that the config I<might>
4253 change, though this is unlikely. Oh, and if you want to help improving this
4254 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4256 =head2 Plugin C<openvpn>
4258 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4259 traffic statistics about connected clients.
4261 To set up OpenVPN to write to the status file periodically, use the
4262 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4263 you need to set the required format, too. This is done by setting
4264 B<--status-version> to B<2>.
4266 So, in a nutshell you need:
4268 openvpn $OTHER_OPTIONS \
4269 --status "/var/run/openvpn-status" 10 \
4276 =item B<StatusFile> I<File>
4278 Specifies the location of the status file.
4280 =item B<ImprovedNamingSchema> B<true>|B<false>
4282 When enabled, the filename of the status file will be used as plugin instance
4283 and the client's "common name" will be used as type instance. This is required
4284 when reading multiple status files. Enabling this option is recommended, but to
4285 maintain backwards compatibility this option is disabled by default.
4287 =item B<CollectCompression> B<true>|B<false>
4289 Sets whether or not statistics about the compression used by OpenVPN should be
4290 collected. This information is only available in I<single> mode. Enabled by
4293 =item B<CollectIndividualUsers> B<true>|B<false>
4295 Sets whether or not traffic information is collected for each connected client
4296 individually. If set to false, currently no traffic data is collected at all
4297 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4299 =item B<CollectUserCount> B<true>|B<false>
4301 When enabled, the number of currently connected clients or users is collected.
4302 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4303 can be configured independently from that option. Defaults to B<false>.
4307 =head2 Plugin C<oracle>
4309 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4310 Oracle® Database and lets you execute SQL statements there. It is very similar
4311 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4312 plugin's documentation above for details.
4315 <Query "out_of_stock">
4316 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4319 # InstancePrefix "foo"
4320 InstancesFrom "category"
4324 <Database "product_information">
4328 Query "out_of_stock"
4332 =head3 B<Query> blocks
4334 The Query blocks are handled identically to the Query blocks of the "dbi"
4335 plugin. Please see its documentation above for details on how to specify
4338 =head3 B<Database> blocks
4340 Database blocks define a connection to a database and which queries should be
4341 sent to that database. Each database needs a "name" as string argument in the
4342 starting tag of the block. This name will be used as "PluginInstance" in the
4343 values submitted to the daemon. Other than that, that name is not used.
4347 =item B<ConnectID> I<ID>
4349 Defines the "database alias" or "service name" to connect to. Usually, these
4350 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4352 =item B<Host> I<Host>
4354 Hostname to use when dispatching values for this database. Defaults to using
4355 the global hostname of the I<collectd> instance.
4357 =item B<Username> I<Username>
4359 Username used for authentication.
4361 =item B<Password> I<Password>
4363 Password used for authentication.
4365 =item B<Query> I<QueryName>
4367 Associates the query named I<QueryName> with this database connection. The
4368 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4369 blocks you want to refer to must be placed above the database block you want to
4374 =head2 Plugin C<perl>
4376 This plugin embeds a Perl-interpreter into collectd and provides an interface
4377 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4379 =head2 Plugin C<pinba>
4381 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4382 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4383 PHP-based webpage has been delivered, the extension will send a UDP packet
4384 containing timing information, peak memory usage and so on. The plugin will
4385 wait for such packets, parse them and account the provided information, which
4386 is then dispatched to the daemon once per interval.
4393 # Overall statistics for the website.
4395 Server "www.example.com"
4397 # Statistics for www-a only
4399 Host "www-a.example.com"
4400 Server "www.example.com"
4402 # Statistics for www-b only
4404 Host "www-b.example.com"
4405 Server "www.example.com"
4409 The plugin provides the following configuration options:
4413 =item B<Address> I<Node>
4415 Configures the address used to open a listening socket. By default, plugin will
4416 bind to the I<any> address C<::0>.
4418 =item B<Port> I<Service>
4420 Configures the port (service) to bind to. By default the default Pinba port
4421 "30002" will be used. The option accepts service names in addition to port
4422 numbers and thus requires a I<string> argument.
4424 =item E<lt>B<View> I<Name>E<gt> block
4426 The packets sent by the Pinba extension include the hostname of the server, the
4427 server name (the name of the virtual host) and the script that was executed.
4428 Using B<View> blocks it is possible to separate the data into multiple groups
4429 to get more meaningful statistics. Each packet is added to all matching groups,
4430 so that a packet may be accounted for more than once.
4434 =item B<Host> I<Host>
4436 Matches the hostname of the system the webserver / script is running on. This
4437 will contain the result of the L<gethostname(2)> system call. If not
4438 configured, all hostnames will be accepted.
4440 =item B<Server> I<Server>
4442 Matches the name of the I<virtual host>, i.e. the contents of the
4443 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4444 server names will be accepted.
4446 =item B<Script> I<Script>
4448 Matches the name of the I<script name>, i.e. the contents of the
4449 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4450 script names will be accepted.
4456 =head2 Plugin C<ping>
4458 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4459 configured hosts periodically and measures the network latency. Whenever the
4460 C<read> function of the plugin is called, it submits the average latency, the
4461 standard deviation and the drop rate for each host.
4463 Available configuration options:
4467 =item B<Host> I<IP-address>
4469 Host to ping periodically. This option may be repeated several times to ping
4472 =item B<Interval> I<Seconds>
4474 Sets the interval in which to send ICMP echo packets to the configured hosts.
4475 This is B<not> the interval in which statistics are queries from the plugin but
4476 the interval in which the hosts are "pinged". Therefore, the setting here
4477 should be smaller than or equal to the global B<Interval> setting. Fractional
4478 times, such as "1.24" are allowed.
4482 =item B<Timeout> I<Seconds>
4484 Time to wait for a response from the host to which an ICMP packet had been
4485 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4486 to be down or the packet to be dropped. This setting must be smaller than the
4487 B<Interval> setting above for the plugin to work correctly. Fractional
4488 arguments are accepted.
4492 =item B<TTL> I<0-255>
4494 Sets the Time-To-Live of generated ICMP packets.
4496 =item B<SourceAddress> I<host>
4498 Sets the source address to use. I<host> may either be a numerical network
4499 address or a network hostname.
4501 =item B<Device> I<name>
4503 Sets the outgoing network device to be used. I<name> has to specify an
4504 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4507 =item B<MaxMissed> I<Packets>
4509 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4510 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4512 Default: B<-1> (disabled)
4516 =head2 Plugin C<postgresql>
4518 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4519 keeps a persistent connection to all configured databases and tries to
4520 reconnect if the connection has been interrupted. A database is configured by
4521 specifying a B<Database> block as described below. The default statistics are
4522 collected from PostgreSQL's B<statistics collector> which thus has to be
4523 enabled for this plugin to work correctly. This should usually be the case by
4524 default. See the section "The Statistics Collector" of the B<PostgreSQL
4525 Documentation> for details.
4527 By specifying custom database queries using a B<Query> block as described
4528 below, you may collect any data that is available from some PostgreSQL
4529 database. This way, you are able to access statistics of external daemons
4530 which are available in a PostgreSQL database or use future or special
4531 statistics provided by PostgreSQL without the need to upgrade your collectd
4534 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4535 PostgreSQL databases as well. This has been implemented in a generic way. You
4536 need to specify an SQL statement which will then be executed by collectd in
4537 order to write the data (see below for details). The benefit of that approach
4538 is that there is no fixed database layout. Rather, the layout may be optimized
4539 for the current setup.
4541 The B<PostgreSQL Documentation> manual can be found at
4542 L<http://www.postgresql.org/docs/manuals/>.
4546 Statement "SELECT magic FROM wizard WHERE host = $1;"
4550 InstancePrefix "magic"
4555 <Query rt36_tickets>
4556 Statement "SELECT COUNT(type) AS count, type \
4558 WHEN resolved = 'epoch' THEN 'open' \
4559 ELSE 'resolved' END AS type \
4560 FROM tickets) type \
4564 InstancePrefix "rt36_tickets"
4565 InstancesFrom "type"
4571 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4581 KRBSrvName "kerberos_service_name"
4587 Service "service_name"
4588 Query backend # predefined
4599 The B<Query> block defines one database query which may later be used by a
4600 database definition. It accepts a single mandatory argument which specifies
4601 the name of the query. The names of all queries have to be unique (see the
4602 B<MinVersion> and B<MaxVersion> options below for an exception to this
4603 rule). The following configuration options are available to define the query:
4605 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4606 blocks define how to handle the values returned from the query. They define
4607 which column holds which value and how to dispatch that value to the daemon.
4608 Multiple B<Result> blocks may be used to extract multiple values from a single
4613 =item B<Statement> I<sql query statement>
4615 Specify the I<sql query statement> which the plugin should execute. The string
4616 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4617 first, second, etc. parameter. The value of the parameters is specified by the
4618 B<Param> configuration option - see below for details. To include a literal
4619 B<$> character followed by a number, surround it with single quotes (B<'>).
4621 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4622 allowed. Note, however, that only a single command may be used. Semicolons are
4623 allowed as long as a single non-empty command has been specified only.
4625 The returned lines will be handled separately one after another.
4627 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4629 Specify the parameters which should be passed to the SQL query. The parameters
4630 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4631 they appear in the configuration file. The value of the parameter is
4632 determined depending on the value of the B<Param> option as follows:
4638 The configured hostname of the database connection. If a UNIX domain socket is
4639 used, the parameter expands to "localhost".
4643 The name of the database of the current connection.
4647 The name of the database plugin instance. See the B<Instance> option of the
4648 database specification below for details.
4652 The username used to connect to the database.
4656 The interval with which this database is queried (as specified by the database
4657 specific or global B<Interval> options).
4661 Please note that parameters are only supported by PostgreSQL's protocol
4662 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4664 =item B<Type> I<type>
4666 The I<type> name to be used when dispatching the values. The type describes
4667 how to handle the data and where to store it. See L<types.db(5)> for more
4668 details on types and their configuration. The number and type of values (as
4669 selected by the B<ValuesFrom> option) has to match the type of the given name.
4671 This option is required inside a B<Result> block.
4673 =item B<InstancePrefix> I<prefix>
4675 =item B<InstancesFrom> I<column0> [I<column1> ...]
4677 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4678 B<InstancePrefix> defines a static prefix that will be prepended to all type
4679 instances. B<InstancesFrom> defines the column names whose values will be used
4680 to create the type instance. Multiple values will be joined together using the
4681 hyphen (C<->) as separation character.
4683 The plugin itself does not check whether or not all built instances are
4684 different. It is your responsibility to assure that each is unique.
4686 Both options are optional. If none is specified, the type instance will be
4689 =item B<ValuesFrom> I<column0> [I<column1> ...]
4691 Names the columns whose content is used as the actual data for the data sets
4692 that are dispatched to the daemon. How many such columns you need is
4693 determined by the B<Type> setting as explained above. If you specify too many
4694 or not enough columns, the plugin will complain about that and no data will be
4695 submitted to the daemon.
4697 The actual data type, as seen by PostgreSQL, is not that important as long as
4698 it represents numbers. The plugin will automatically cast the values to the
4699 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4700 L<strtod(3)> functions, so anything supported by those functions is supported
4701 by the plugin as well.
4703 This option is required inside a B<Result> block and may be specified multiple
4704 times. If multiple B<ValuesFrom> options are specified, the columns are read
4707 =item B<MinVersion> I<version>
4709 =item B<MaxVersion> I<version>
4711 Specify the minimum or maximum version of PostgreSQL that this query should be
4712 used with. Some statistics might only be available with certain versions of
4713 PostgreSQL. This allows you to specify multiple queries with the same name but
4714 which apply to different versions, thus allowing you to use the same
4715 configuration in a heterogeneous environment.
4717 The I<version> has to be specified as the concatenation of the major, minor
4718 and patch-level versions, each represented as two-decimal-digit numbers. For
4719 example, version 8.2.3 will become 80203.
4723 The following predefined queries are available (the definitions can be found
4724 in the F<postgresql_default.conf> file which, by default, is available at
4725 C<I<prefix>/share/collectd/>):
4731 This query collects the number of backends, i.E<nbsp>e. the number of
4734 =item B<transactions>
4736 This query collects the numbers of committed and rolled-back transactions of
4741 This query collects the numbers of various table modifications (i.E<nbsp>e.
4742 insertions, updates, deletions) of the user tables.
4744 =item B<query_plans>
4746 This query collects the numbers of various table scans and returned tuples of
4749 =item B<table_states>
4751 This query collects the numbers of live and dead rows in the user tables.
4755 This query collects disk block access counts for user tables.
4759 This query collects the on-disk size of the database in bytes.
4763 In addition, the following detailed queries are available by default. Please
4764 note that each of those queries collects information B<by table>, thus,
4765 potentially producing B<a lot> of data. For details see the description of the
4766 non-by_table queries above.
4770 =item B<queries_by_table>
4772 =item B<query_plans_by_table>
4774 =item B<table_states_by_table>
4776 =item B<disk_io_by_table>
4780 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4781 mandatory argument specifying the name of the writer. This will then be used
4782 in the B<Database> specification in order to activate the writer instance. The
4783 names of all writers have to be unique. The following options may be
4788 =item B<Statement> I<sql statement>
4790 This mandatory option specifies the SQL statement that will be executed for
4791 each submitted value. A single SQL statement is allowed only. Anything after
4792 the first semicolon will be ignored.
4794 Nine parameters will be passed to the statement and should be specified as
4795 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4796 values are made available through those parameters:
4802 The timestamp of the queried value as a floating point number.
4806 The hostname of the queried value.
4810 The plugin name of the queried value.
4814 The plugin instance of the queried value. This value may be B<NULL> if there
4815 is no plugin instance.
4819 The type of the queried value (cf. L<types.db(5)>).
4823 The type instance of the queried value. This value may be B<NULL> if there is
4828 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4829 sources of the submitted value-list).
4833 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4834 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4835 B<StoreRates> is enabled (which is the default, see below), all types will be
4840 An array of the submitted values. The dimensions of the value name and value
4845 In general, it is advisable to create and call a custom function in the
4846 PostgreSQL database for this purpose. Any procedural language supported by
4847 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4850 =item B<StoreRates> B<false>|B<true>
4852 If set to B<true> (the default), convert counter values to rates. If set to
4853 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4858 The B<Database> block defines one PostgreSQL database for which to collect
4859 statistics. It accepts a single mandatory argument which specifies the
4860 database name. None of the other options are required. PostgreSQL will use
4861 default values as documented in the section "CONNECTING TO A DATABASE" in the
4862 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4863 the user collectd is run as and special environment variables. See the manpage
4868 =item B<Interval> I<seconds>
4870 Specify the interval with which the database should be queried. The default is
4871 to use the global B<Interval> setting.
4873 =item B<CommitInterval> I<seconds>
4875 This option may be used for database connections which have "writers" assigned
4876 (see above). If specified, it causes a writer to put several updates into a
4877 single transaction. This transaction will last for the specified amount of
4878 time. By default, each update will be executed in a separate transaction. Each
4879 transaction generates a fair amount of overhead which can, thus, be reduced by
4880 activating this option. The draw-back is, that data covering the specified
4881 amount of time will be lost, for example, if a single statement within the
4882 transaction fails or if the database server crashes.
4884 =item B<Host> I<hostname>
4886 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4887 value begins with a slash, it is interpreted as the directory name in which to
4888 look for the UNIX domain socket.
4890 This option is also used to determine the hostname that is associated with a
4891 collected data set. If it has been omitted or either begins with with a slash
4892 or equals B<localhost> it will be replaced with the global hostname definition
4893 of collectd. Any other value will be passed literally to collectd when
4894 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4896 =item B<Port> I<port>
4898 Specify the TCP port or the local UNIX domain socket file extension of the
4901 =item B<User> I<username>
4903 Specify the username to be used when connecting to the server.
4905 =item B<Password> I<password>
4907 Specify the password to be used when connecting to the server.
4909 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4911 Specify whether to use an SSL connection when contacting the server. The
4912 following modes are supported:
4918 Do not use SSL at all.
4922 First, try to connect without using SSL. If that fails, try using SSL.
4924 =item I<prefer> (default)
4926 First, try to connect using SSL. If that fails, try without using SSL.
4934 =item B<Instance> I<name>
4936 Specify the plugin instance name that should be used instead of the database
4937 name (which is the default, if this option has not been specified). This
4938 allows to query multiple databases of the same name on the same host (e.g.
4939 when running multiple database server versions in parallel).
4941 =item B<KRBSrvName> I<kerberos_service_name>
4943 Specify the Kerberos service name to use when authenticating with Kerberos 5
4944 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4945 B<PostgreSQL Documentation> for details.
4947 =item B<Service> I<service_name>
4949 Specify the PostgreSQL service name to use for additional parameters. That
4950 service has to be defined in F<pg_service.conf> and holds additional
4951 connection parameters. See the section "The Connection Service File" in the
4952 B<PostgreSQL Documentation> for details.
4954 =item B<Query> I<query>
4956 Specifies a I<query> which should be executed in the context of the database
4957 connection. This may be any of the predefined or user-defined queries. If no
4958 such option is given, it defaults to "backends", "transactions", "queries",
4959 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4960 has been specified). Else, the specified queries are used only.
4962 =item B<Writer> I<writer>
4964 Assigns the specified I<writer> backend to the database connection. This
4965 causes all collected data to be send to the database using the settings
4966 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4967 below for details on how to selectively send data to certain plugins).
4969 Each writer will register a flush callback which may be used when having long
4970 transactions enabled (see the B<CommitInterval> option above). When issuing
4971 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4972 transaction will be committed right away. Two different kinds of flush
4973 callbacks are available with the C<postgresql> plugin:
4979 Flush all writer backends.
4981 =item B<postgresql->I<database>
4983 Flush all writers of the specified I<database> only.
4989 =head2 Plugin C<powerdns>
4991 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4992 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4993 values, many of which are probably meaningless to most users, but may be useful
4994 for some. So you may chose which values to collect, but if you don't, some
4995 reasonable defaults will be collected.
4998 <Server "server_name">
5000 Collect "udp-answers" "udp-queries"
5001 Socket "/var/run/pdns.controlsocket"
5003 <Recursor "recursor_name">
5005 Collect "cache-hits" "cache-misses"
5006 Socket "/var/run/pdns_recursor.controlsocket"
5008 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5013 =item B<Server> and B<Recursor> block
5015 The B<Server> block defines one authoritative server to query, the B<Recursor>
5016 does the same for an recursing server. The possible options in both blocks are
5017 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5022 =item B<Collect> I<Field>
5024 Using the B<Collect> statement you can select which values to collect. Here,
5025 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5026 C<dlg-only-drops>, C<answers10-100>.
5028 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5029 When querying the server a C<SHOW *> command is issued in any case, because
5030 that's the only way of getting multiple values out of the server at once.
5031 collectd then picks out the values you have selected. When querying the
5032 recursor, a command is generated to query exactly these values. So if you
5033 specify invalid fields when querying the recursor, a syntax error may be
5034 returned by the daemon and collectd may not collect any values at all.
5036 If no B<Collect> statement is given, the following B<Server> values will be
5043 =item packetcache-hit
5045 =item packetcache-miss
5047 =item packetcache-size
5049 =item query-cache-hit
5051 =item query-cache-miss
5053 =item recursing-answers
5055 =item recursing-questions
5067 The following B<Recursor> values will be collected by default:
5071 =item noerror-answers
5073 =item nxdomain-answers
5075 =item servfail-answers
5093 Please note that up to that point collectd doesn't know what values are
5094 available on the server and values that are added do not need a change of the
5095 mechanism so far. However, the values must be mapped to collectd's naming
5096 scheme, which is done using a lookup table that lists all known values. If
5097 values are added in the future and collectd does not know about them, you will
5098 get an error much like this:
5100 powerdns plugin: submit: Not found in lookup table: foobar = 42
5102 In this case please file a bug report with the collectd team.
5104 =item B<Socket> I<Path>
5106 Configures the path to the UNIX domain socket to be used when connecting to the
5107 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5108 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5109 will be used for the recursor.
5113 =item B<LocalSocket> I<Path>
5115 Querying the recursor is done using UDP. When using UDP over UNIX domain
5116 sockets, the client socket needs a name in the file system, too. You can set
5117 this local name to I<Path> using the B<LocalSocket> option. The default is
5118 C<I<prefix>/var/run/collectd-powerdns>.
5122 =head2 Plugin C<processes>
5126 =item B<Process> I<Name>
5128 Select more detailed statistics of processes matching this name. The statistics
5129 collected for these selected processes are size of the resident segment size
5130 (RSS), user- and system-time used, number of processes and number of threads,
5131 io data (where available) and minor and major pagefaults.
5133 =item B<ProcessMatch> I<name> I<regex>
5135 Similar to the B<Process> option this allows to select more detailed
5136 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5137 details). The statistics of all matching processes are summed up and
5138 dispatched to the daemon using the specified I<name> as an identifier. This
5139 allows to "group" several processes together. I<name> must not contain
5144 =head2 Plugin C<protocols>
5146 Collects a lot of information about various network protocols, such as I<IP>,
5147 I<TCP>, I<UDP>, etc.
5149 Available configuration options:
5153 =item B<Value> I<Selector>
5155 Selects whether or not to select a specific value. The string being matched is
5156 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5157 plugin instance and I<ValueName> will be used as type instance. An example of
5158 the string being used would be C<Tcp:RetransSegs>.
5160 You can use regular expressions to match a large number of values with just one
5161 configuration option. To select all "extended" I<TCP> values, you could use the
5162 following statement:
5166 Whether only matched values are selected or all matched values are ignored
5167 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5168 If no value is configured at all, all values will be selected.
5170 =item B<IgnoreSelected> B<true>|B<false>
5172 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5173 matching values will be ignored.
5177 =head2 Plugin C<python>
5179 This plugin embeds a Python-interpreter into collectd and provides an interface
5180 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5182 =head2 Plugin C<routeros>
5184 The C<routeros> plugin connects to a device running I<RouterOS>, the
5185 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5186 I<librouteros> to connect and reads information about the interfaces and
5187 wireless connections of the device. The configuration supports querying
5192 Host "router0.example.com"
5195 CollectInterface true
5200 Host "router1.example.com"
5203 CollectInterface true
5204 CollectRegistrationTable true
5210 As you can see above, the configuration of the I<routeros> plugin consists of
5211 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5212 options are understood:
5216 =item B<Host> I<Host>
5218 Hostname or IP-address of the router to connect to.
5220 =item B<Port> I<Port>
5222 Port name or port number used when connecting. If left unspecified, the default
5223 will be chosen by I<librouteros>, currently "8728". This option expects a
5224 string argument, even when a numeric port number is given.
5226 =item B<User> I<User>
5228 Use the user name I<User> to authenticate. Defaults to "admin".
5230 =item B<Password> I<Password>
5232 Set the password used to authenticate.
5234 =item B<CollectInterface> B<true>|B<false>
5236 When set to B<true>, interface statistics will be collected for all interfaces
5237 present on the device. Defaults to B<false>.
5239 =item B<CollectRegistrationTable> B<true>|B<false>
5241 When set to B<true>, information about wireless LAN connections will be
5242 collected. Defaults to B<false>.
5244 =item B<CollectCPULoad> B<true>|B<false>
5246 When set to B<true>, information about the CPU usage will be collected. The
5247 number is a dimensionless value where zero indicates no CPU usage at all.
5248 Defaults to B<false>.
5250 =item B<CollectMemory> B<true>|B<false>
5252 When enabled, the amount of used and free memory will be collected. How used
5253 memory is calculated is unknown, for example whether or not caches are counted
5255 Defaults to B<false>.
5257 =item B<CollectDF> B<true>|B<false>
5259 When enabled, the amount of used and free disk space will be collected.
5260 Defaults to B<false>.
5262 =item B<CollectDisk> B<true>|B<false>
5264 When enabled, the number of sectors written and bad blocks will be collected.
5265 Defaults to B<false>.
5269 =head2 Plugin C<redis>
5271 The I<Redis plugin> connects to one or more Redis servers and gathers
5272 information about each server's state. For each server there is a I<Node> block
5273 which configures the connection parameters for this node.
5283 The information shown in the synopsis above is the I<default configuration>
5284 which is used by the plugin if no configuration is present.
5288 =item B<Node> I<Nodename>
5290 The B<Node> block identifies a new Redis node, that is a new Redis instance
5291 running in an specified host and port. The name for node is a canonical
5292 identifier which is used as I<plugin instance>. It is limited to
5293 64E<nbsp>characters in length.
5295 =item B<Host> I<Hostname>
5297 The B<Host> option is the hostname or IP-address where the Redis instance is
5300 =item B<Port> I<Port>
5302 The B<Port> option is the TCP port on which the Redis instance accepts
5303 connections. Either a service name of a port number may be given. Please note
5304 that numerical port numbers must be given as a string, too.
5306 =item B<Password> I<Password>
5308 Use I<Password> to authenticate when connecting to I<Redis>.
5310 =item B<Timeout> I<Timeout in miliseconds>
5312 The B<Timeout> option set the socket timeout for node response. Since the Redis
5313 read function is blocking, you should keep this value as low as possible. Keep
5314 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5315 than B<Interval> defined globally.
5319 =head2 Plugin C<rrdcached>
5321 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5322 to store values to RRD files in an efficient manner. The combination of the
5323 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5324 way the C<rrdtool> plugin works (see below). The added abstraction layer
5325 provides a number of benefits, though: Because the cache is not within
5326 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5327 restarted. This results in much shorter (if any) gaps in graphs, especially
5328 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5329 daemon so that it can flush values to disk automatically when needed. This
5330 allows to integrate automated flushing of values into graphing solutions much
5333 There are disadvantages, though: The daemon may reside on a different host, so
5334 it may not be possible for C<collectd> to create the appropriate RRD files
5335 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5336 different base directory, so relative paths may do weird stuff if you're not
5339 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5340 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5341 setting should be set to an absolute path, so that a changed base directory
5342 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5346 =item B<DaemonAddress> I<Address>
5348 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5349 library. See L<rrdcached(1)> for details. Example:
5351 <Plugin "rrdcached">
5352 DaemonAddress "unix:/var/run/rrdcached.sock"
5355 =item B<DataDir> I<Directory>
5357 Set the base directory in which the RRD files reside. If this is a relative
5358 path, it is relative to the working base directory of the C<rrdcached> daemon!
5359 Use of an absolute path is recommended.
5361 =item B<CreateFiles> B<true>|B<false>
5363 Enables or disables the creation of RRD files. If the daemon is not running
5364 locally, or B<DataDir> is set to a relative path, this will not work as
5365 expected. Default is B<true>.
5367 =item B<CreateFilesAsync> B<false>|B<true>
5369 When enabled, new RRD files are enabled asynchronously, using a separate thread
5370 that runs in the background. This prevents writes to block, which is a problem
5371 especially when many hundreds of files need to be created at once. However,
5372 since the purpose of creating the files asynchronously is I<not> to block until
5373 the file is available, values before the file is available will be discarded.
5374 When disabled (the default) files are created synchronously, blocking for a
5375 short while, while the file is being written.
5377 =item B<StepSize> I<Seconds>
5379 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5380 this setting is unset and the stepsize is set to the interval in which the data
5381 is collected. Do not use this option unless you absolutely have to for some
5382 reason. Setting this option may cause problems with the C<snmp plugin>, the
5383 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5385 =item B<HeartBeat> I<Seconds>
5387 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5388 in which case the heartbeat is set to twice the B<StepSize> which should equal
5389 the interval in which data is collected. Do not set this option unless you have
5390 a very good reason to do so.
5392 =item B<RRARows> I<NumRows>
5394 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5395 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5396 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5397 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5398 week, one month, and one year.
5400 So for each timespan, it calculates how many PDPs need to be consolidated into
5401 one CDP by calculating:
5402 number of PDPs = timespan / (stepsize * rrarows)
5404 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5407 =item B<RRATimespan> I<Seconds>
5409 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5410 more then one RRA. If this option is never used, the built-in default of (3600,
5411 86400, 604800, 2678400, 31622400) is used.
5413 For more information on how RRA-sizes are calculated see B<RRARows> above.
5415 =item B<XFF> I<Factor>
5417 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5418 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5423 =head2 Plugin C<rrdtool>
5425 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5426 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5427 using these settings. If you don't want to dive into the depths of RRDtool, you
5428 can safely ignore these settings.
5432 =item B<DataDir> I<Directory>
5434 Set the directory to store RRD files under. By default RRD files are generated
5435 beneath the daemon's working directory, i.e. the B<BaseDir>.
5437 =item B<CreateFilesAsync> B<false>|B<true>
5439 When enabled, new RRD files are enabled asynchronously, using a separate thread
5440 that runs in the background. This prevents writes to block, which is a problem
5441 especially when many hundreds of files need to be created at once. However,
5442 since the purpose of creating the files asynchronously is I<not> to block until
5443 the file is available, values before the file is available will be discarded.
5444 When disabled (the default) files are created synchronously, blocking for a
5445 short while, while the file is being written.
5447 =item B<StepSize> I<Seconds>
5449 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5450 this setting is unset and the stepsize is set to the interval in which the data
5451 is collected. Do not use this option unless you absolutely have to for some
5452 reason. Setting this option may cause problems with the C<snmp plugin>, the
5453 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5455 =item B<HeartBeat> I<Seconds>
5457 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5458 in which case the heartbeat is set to twice the B<StepSize> which should equal
5459 the interval in which data is collected. Do not set this option unless you have
5460 a very good reason to do so.
5462 =item B<RRARows> I<NumRows>
5464 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5465 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5466 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5467 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5468 week, one month, and one year.
5470 So for each timespan, it calculates how many PDPs need to be consolidated into
5471 one CDP by calculating:
5472 number of PDPs = timespan / (stepsize * rrarows)
5474 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5477 =item B<RRATimespan> I<Seconds>
5479 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5480 more then one RRA. If this option is never used, the built-in default of (3600,
5481 86400, 604800, 2678400, 31622400) is used.
5483 For more information on how RRA-sizes are calculated see B<RRARows> above.
5485 =item B<XFF> I<Factor>
5487 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5488 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5491 =item B<CacheFlush> I<Seconds>
5493 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5494 it writes all values for a certain RRD-file if the oldest value is older than
5495 (or equal to) the number of seconds specified. If some RRD-file is not updated
5496 anymore for some reason (the computer was shut down, the network is broken,
5497 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5498 entire cache is searched for entries older than B<CacheTimeout> seconds and
5499 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5500 does nothing under normal circumstances, this value should not be too small.
5501 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5502 normally do much harm either.
5504 =item B<CacheTimeout> I<Seconds>
5506 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5507 save values in a cache, as described above. Writing multiple values at once
5508 reduces IO-operations and thus lessens the load produced by updating the files.
5509 The trade off is that the graphs kind of "drag behind" and that more memory is
5512 =item B<WritesPerSecond> I<Updates>
5514 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5515 will run serious performance problems. The B<CacheFlush> setting and the
5516 internal update queue assert that collectd continues to work just fine even
5517 under heavy load, but the system may become very unresponsive and slow. This is
5518 a problem especially if you create graphs from the RRD files on the same
5519 machine, for example using the C<graph.cgi> script included in the
5520 C<contrib/collection3/> directory.
5522 This setting is designed for very large setups. Setting this option to a value
5523 between 25 and 80 updates per second, depending on your hardware, will leave
5524 the server responsive enough to draw graphs even while all the cached values
5525 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5526 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5527 written as fast as possible, so that web frontends have up to date data when
5530 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5531 updates per second, writing all values to disk will take approximately
5532 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5533 "collection3" you'll end up with a responsive and fast system, up to date
5534 graphs and basically a "backup" of your values every hour.
5536 =item B<RandomTimeout> I<Seconds>
5538 When set, the actual timeout for each value is chosen randomly between
5539 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5540 intention is to avoid high load situations that appear when many values timeout
5541 at the same time. This is especially a problem shortly after the daemon starts,
5542 because all values were added to the internal cache at roughly the same time.
5546 =head2 Plugin C<sensors>
5548 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5549 that all the needed modules have to be loaded and lm_sensors has to be
5550 configured (most likely by editing F</etc/sensors.conf>. Read
5551 L<sensors.conf(5)> for details.
5553 The B<lm_sensors> homepage can be found at
5554 L<http://secure.netroedge.com/~lm78/>.
5558 =item B<SensorConfigFile> I<File>
5560 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5561 the library's default will be used.
5563 =item B<Sensor> I<chip-bus-address/type-feature>
5565 Selects the name of the sensor which you want to collect or ignore, depending
5566 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5567 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5568 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5570 =item B<IgnoreSelected> I<true>|I<false>
5572 If no configuration if given, the B<sensors>-plugin will collect data from all
5573 sensors. This may not be practical, especially for uninteresting sensors.
5574 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5575 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5576 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5577 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5578 and all other sensors are collected.
5582 =head2 Plugin C<sigrok>
5584 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5585 supported by the L<sigrok|http://sigrok.org/> project.
5591 <Device "AC Voltage">
5596 <Device "Sound Level">
5597 Driver "cem-dt-885x"
5604 =item B<LogLevel> B<0-5>
5606 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5607 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5608 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5609 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5610 their level, are always submitted to I<collectd> at its INFO log level.
5612 =item E<lt>B<Device> I<Name>E<gt>
5614 A sigrok-supported device, uniquely identified by this section's options. The
5615 I<Name> is passed to I<collectd> as the I<plugin instance>.
5617 =item B<Driver> I<DriverName>
5619 The sigrok driver to use for this device.
5621 =item B<Conn> I<ConnectionSpec>
5623 If the device cannot be auto-discovered, or more than one might be discovered
5624 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5625 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5626 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5627 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5628 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5630 =item B<SerialComm> I<SerialSpec>
5632 For serial devices with non-standard port settings, this option can be used
5633 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5634 This should not be necessary; drivers know how to communicate with devices they
5637 =item B<MinimumInterval> I<Seconds>
5639 Specifies the minimum time between measurement dispatches to I<collectd>, in
5640 seconds. Since some I<sigrok> supported devices can acquire measurements many
5641 times per second, it may be necessary to throttle these. For example, the
5642 I<RRD plugin> cannot process writes more than once per second.
5644 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5645 device are always dispatched to I<collectd>. When throttled, unused
5646 measurements are discarded.
5650 =head2 Plugin C<snmp>
5652 Since the configuration of the C<snmp plugin> is a little more complicated than
5653 other plugins, its documentation has been moved to an own manpage,
5654 L<collectd-snmp(5)>. Please see there for details.
5656 =head2 Plugin C<statsd>
5658 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5659 protocol and dispatches rates or other aggregates of these numbers
5662 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5663 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5664 C<objects> respectively.
5666 The following configuration options are valid:
5670 =item B<Host> I<Host>
5672 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5673 "any" address, i.e. accept packets sent to any of the hosts addresses.
5675 =item B<Port> I<Port>
5677 UDP port to listen to. This can be either a service name or a port number.
5678 Defaults to C<8125>.
5680 =item B<DeleteCounters> B<false>|B<true>
5682 =item B<DeleteTimers> B<false>|B<true>
5684 =item B<DeleteGauges> B<false>|B<true>
5686 =item B<DeleteSets> B<false>|B<true>
5688 These options control what happens if metrics are not updated in an interval.
5689 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5690 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5691 are unchanged. If set to B<True>, the such metrics are not dispatched and
5692 removed from the internal cache.
5694 =item B<TimerPercentile> I<Percent>
5696 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5697 that I<Percent> of all reported timers are smaller than or equal to the
5698 computed latency. This is useful for cutting off the long tail latency, as it's
5699 often done in I<Service Level Agreements> (SLAs).
5701 If not specified, no percentile is calculated / dispatched.
5705 =head2 Plugin C<swap>
5707 The I<Swap plugin> collects information about used and available swap space. On
5708 I<Linux> and I<Solaris>, the following options are available:
5712 =item B<ReportByDevice> B<false>|B<true>
5714 Configures how to report physical swap devices. If set to B<false> (the
5715 default), the summary over all swap devices is reported only, i.e. the globally
5716 used and available space over all devices. If B<true> is configured, the used
5717 and available space of each device will be reported separately.
5719 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5720 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5722 =item B<ReportBytes> B<false>|B<true>
5724 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5725 I<swap I/O> is reported in pages. This option is available under Linux only.
5727 =item B<ValuesAbsolute> B<true>|B<false>
5729 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5730 available and used. Defaults to B<true>.
5732 =item B<ValuesPercentage> B<false>|B<true>
5734 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5735 available and free. Defaults to B<false>.
5737 This is useful for deploying I<collectd> in a heterogeneous environment, where
5738 swap sizes differ and you want to specify generic thresholds or similar.
5742 =head2 Plugin C<syslog>
5746 =item B<LogLevel> B<debug|info|notice|warning|err>
5748 Sets the log-level. If, for example, set to B<notice>, then all events with
5749 severity B<notice>, B<warning>, or B<err> will be submitted to the
5752 Please note that B<debug> is only available if collectd has been compiled with
5755 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5757 Controls which notifications should be sent to syslog. The default behaviour is
5758 not to send any. Less severe notifications always imply logging more severe
5759 notifications: Setting this to B<OKAY> means all notifications will be sent to
5760 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5761 notifications but will dismiss B<OKAY> notifications. Setting this option to
5762 B<FAILURE> will only send failures to syslog.
5766 =head2 Plugin C<table>
5768 The C<table plugin> provides generic means to parse tabular data and dispatch
5769 user specified values. Values are selected based on column numbers. For
5770 example, this plugin may be used to get values from the Linux L<proc(5)>
5771 filesystem or CSV (comma separated values) files.
5774 <Table "/proc/slabinfo">
5779 InstancePrefix "active_objs"
5785 InstancePrefix "objperslab"
5792 The configuration consists of one or more B<Table> blocks, each of which
5793 configures one file to parse. Within each B<Table> block, there are one or
5794 more B<Result> blocks, which configure which data to select and how to
5797 The following options are available inside a B<Table> block:
5801 =item B<Instance> I<instance>
5803 If specified, I<instance> is used as the plugin instance. So, in the above
5804 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5805 filename of the table is used instead, with all special characters replaced
5806 with an underscore (C<_>).
5808 =item B<Separator> I<string>
5810 Any character of I<string> is interpreted as a delimiter between the different
5811 columns of the table. A sequence of two or more contiguous delimiters in the
5812 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5813 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5814 of a table - see its documentation for more details. This option is mandatory.
5816 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5817 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5818 required because of collectd's config parsing.
5822 The following options are available inside a B<Result> block:
5826 =item B<Type> I<type>
5828 Sets the type used to dispatch the values to the daemon. Detailed information
5829 about types and their configuration can be found in L<types.db(5)>. This
5830 option is mandatory.
5832 =item B<InstancePrefix> I<prefix>
5834 If specified, prepend I<prefix> to the type instance. If omitted, only the
5835 B<InstancesFrom> option is considered for the type instance.
5837 =item B<InstancesFrom> I<column0> [I<column1> ...]
5839 If specified, the content of the given columns (identified by the column
5840 number starting at zero) will be used to create the type instance for each
5841 row. Multiple values (and the instance prefix) will be joined together with
5842 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5843 option is considered for the type instance.
5845 The plugin itself does not check whether or not all built instances are
5846 different. It’s your responsibility to assure that each is unique. This is
5847 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5848 sure that the table only contains one row.
5850 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5853 =item B<ValuesFrom> I<column0> [I<column1> ...]
5855 Specifies the columns (identified by the column numbers starting at zero)
5856 whose content is used as the actual data for the data sets that are dispatched
5857 to the daemon. How many such columns you need is determined by the B<Type>
5858 setting above. If you specify too many or not enough columns, the plugin will
5859 complain about that and no data will be submitted to the daemon. The plugin
5860 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5861 respectively, so anything supported by those functions is supported by the
5862 plugin as well. This option is mandatory.
5866 =head2 Plugin C<tail>
5868 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5869 each line and dispatches found values. What is matched can be configured by the
5870 user using (extended) regular expressions, as described in L<regex(7)>.
5873 <File "/var/log/exim4/mainlog">
5877 Regex "S=([1-9][0-9]*)"
5883 Regex "\\<R=local_user\\>"
5884 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5887 Instance "local_user"
5892 The config consists of one or more B<File> blocks, each of which configures one
5893 logfile to parse. Within each B<File> block, there are one or more B<Match>
5894 blocks, which configure a regular expression to search for.
5896 The B<Instance> option in the B<File> block may be used to set the plugin
5897 instance. So in the above example the plugin name C<tail-foo> would be used.
5898 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5899 next B<Instance> option. This way you can extract several plugin instances from
5900 one logfile, handy when parsing syslog and the like.
5902 The B<Interval> option allows you to define the length of time between reads. If
5903 this is not set, the default Interval will be used.
5905 Each B<Match> block has the following options to describe how the match should
5910 =item B<Regex> I<regex>
5912 Sets the regular expression to use for matching against a line. The first
5913 subexpression has to match something that can be turned into a number by
5914 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5915 below. Because B<extended> regular expressions are used, you do not need to use
5916 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5917 collectd's config parsing you need to escape backslashes, though. So if you
5918 want to match literal parentheses you need to do the following:
5920 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5922 =item B<ExcludeRegex> I<regex>
5924 Sets an optional regular expression to use for excluding lines from the match.
5925 An example which excludes all connections from localhost from the match:
5927 ExcludeRegex "127\\.0\\.0\\.1"
5929 =item B<DSType> I<Type>
5931 Sets how the values are cumulated. I<Type> is one of:
5935 =item B<GaugeAverage>
5937 Calculate the average.
5941 Use the smallest number only.
5945 Use the greatest number only.
5949 Use the last number found.
5955 =item B<AbsoluteSet>
5957 The matched number is a counter. Simply I<sets> the internal counter to this
5958 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5964 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5965 matched number may be negative, which will effectively subtract from the
5972 Increase the internal counter by one. These B<DSType> are the only ones that do
5973 not use the matched subexpression, but simply count the number of matched
5974 lines. Thus, you may use a regular expression without submatch in this case.
5978 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5979 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5980 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5981 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5982 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5985 =item B<Type> I<Type>
5987 Sets the type used to dispatch this value. Detailed information about types and
5988 their configuration can be found in L<types.db(5)>.
5990 =item B<Instance> I<TypeInstance>
5992 This optional setting sets the type instance to use.
5996 =head2 Plugin C<tail_csv>
5998 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5999 written by I<Snort>.
6004 <Metric "snort-dropped">
6009 <File "/var/log/snort/snort.stats">
6010 Instance "snort-eth0"
6012 Collect "snort-dropped"
6016 The configuration consists of one or more B<Metric> blocks that define an index
6017 into the line of the CSV file and how this value is mapped to I<collectd's>
6018 internal representation. These are followed by one or more B<Instance> blocks
6019 which configure which file to read, in which interval and which metrics to
6024 =item E<lt>B<Metric> I<Name>E<gt>
6026 The B<Metric> block configures a new metric to be extracted from the statistics
6027 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6028 only used inside the B<Instance> blocks to refer to this block, so you can use
6029 one B<Metric> block for multiple CSV files.
6033 =item B<Type> I<Type>
6035 Configures which I<Type> to use when dispatching this metric. Types are defined
6036 in the L<types.db(5)> file, see the appropriate manual page for more
6037 information on specifying types. Only types with a single I<data source> are
6038 supported by the I<tail_csv plugin>. The information whether the value is an
6039 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6040 I<Type's> definition.
6042 =item B<Instance> I<TypeInstance>
6044 If set, I<TypeInstance> is used to populate the type instance field of the
6045 created value lists. Otherwise, no type instance is used.
6047 =item B<ValueFrom> I<Index>
6049 Configure to read the value from the field with the zero-based index I<Index>.
6050 If the value is parsed as signed integer, unsigned integer or double depends on
6051 the B<Type> setting, see above.
6055 =item E<lt>B<File> I<Path>E<gt>
6057 Each B<File> block represents one CSV file to read. There must be at least one
6058 I<File> block but there can be multiple if you have multiple CSV files.
6062 =item B<Instance> I<PluginInstance>
6064 Sets the I<plugin instance> used when dispatching the values.
6066 =item B<Collect> I<Metric>
6068 Specifies which I<Metric> to collect. This option must be specified at least
6069 once, and you can use this option multiple times to specify more than one
6070 metric to be extracted from this statistic file.
6072 =item B<Interval> I<Seconds>
6074 Configures the interval in which to read values from this instance / file.
6075 Defaults to the plugin's default interval.
6077 =item B<TimeFrom> I<Index>
6079 Rather than using the local time when dispatching a value, read the timestamp
6080 from the field with the zero-based index I<Index>. The value is interpreted as
6081 seconds since epoch. The value is parsed as a double and may be factional.
6087 =head2 Plugin C<teamspeak2>
6089 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6090 polls interesting global and virtual server data. The plugin can query only one
6091 physical server but unlimited virtual servers. You can use the following
6092 options to configure it:
6096 =item B<Host> I<hostname/ip>
6098 The hostname or ip which identifies the physical server.
6101 =item B<Port> I<port>
6103 The query port of the physical server. This needs to be a string.
6106 =item B<Server> I<port>
6108 This option has to be added once for every virtual server the plugin should
6109 query. If you want to query the virtual server on port 8767 this is what the
6110 option would look like:
6114 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6115 use quotes around it! If no such statement is given only global information
6120 =head2 Plugin C<ted>
6122 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6123 measure power consumption. These devices are usually connected to a serial
6124 (RS232) or USB port. The plugin opens a configured device and tries to read the
6125 current energy readings. For more information on TED, visit
6126 L<http://www.theenergydetective.com/>.
6128 Available configuration options:
6132 =item B<Device> I<Path>
6134 Path to the device on which TED is connected. collectd will need read and write
6135 permissions on that file.
6137 Default: B</dev/ttyUSB0>
6139 =item B<Retries> I<Num>
6141 Apparently reading from TED is not that reliable. You can therefore configure a
6142 number of retries here. You only configure the I<retries> here, to if you
6143 specify zero, one reading will be performed (but no retries if that fails); if
6144 you specify three, a maximum of four readings are performed. Negative values
6151 =head2 Plugin C<tcpconns>
6153 The C<tcpconns plugin> counts the number of currently established TCP
6154 connections based on the local port and/or the remote port. Since there may be
6155 a lot of connections the default if to count all connections with a local port,
6156 for which a listening socket is opened. You can use the following options to
6157 fine-tune the ports you are interested in:
6161 =item B<ListeningPorts> I<true>|I<false>
6163 If this option is set to I<true>, statistics for all local ports for which a
6164 listening socket exists are collected. The default depends on B<LocalPort> and
6165 B<RemotePort> (see below): If no port at all is specifically selected, the
6166 default is to collect listening ports. If specific ports (no matter if local or
6167 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6168 the selected ports will be collected unless this option is set to I<true>
6171 =item B<LocalPort> I<Port>
6173 Count the connections to a specific local port. This can be used to see how
6174 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6175 You have to specify the port in numeric form, so for the mailserver example
6176 you'd need to set B<25>.
6178 =item B<RemotePort> I<Port>
6180 Count the connections to a specific remote port. This is useful to see how
6181 much a remote service is used. This is most useful if you want to know how many
6182 connections a local service has opened to remote services, e.E<nbsp>g. how many
6183 connections a mail server or news server has to other mail or news servers, or
6184 how many connections a web proxy holds to web servers. You have to give the
6185 port in numeric form.
6189 =head2 Plugin C<thermal>
6193 =item B<ForceUseProcfs> I<true>|I<false>
6195 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6196 C<sysfs> interface. If that is not available, the plugin falls back to the
6197 C<procfs> interface. By setting this option to I<true>, you can force the
6198 plugin to use the latter. This option defaults to I<false>.
6200 =item B<Device> I<Device>
6202 Selects the name of the thermal device that you want to collect or ignore,
6203 depending on the value of the B<IgnoreSelected> option. This option may be
6204 used multiple times to specify a list of devices.
6206 =item B<IgnoreSelected> I<true>|I<false>
6208 Invert the selection: If set to true, all devices B<except> the ones that
6209 match the device names specified by the B<Device> option are collected. By
6210 default only selected devices are collected if a selection is made. If no
6211 selection is configured at all, B<all> devices are selected.
6215 =head2 Plugin C<threshold>
6217 The I<Threshold plugin> checks values collected or received by I<collectd>
6218 against a configurable I<threshold> and issues I<notifications> if values are
6221 Documentation for this plugin is available in the L<collectd-threshold(5)>
6224 =head2 Plugin C<tokyotyrant>
6226 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6227 couple metrics: number of records, and database size on disk.
6231 =item B<Host> I<Hostname/IP>
6233 The hostname or ip which identifies the server.
6234 Default: B<127.0.0.1>
6236 =item B<Port> I<Service/Port>
6238 The query port of the server. This needs to be a string, even if the port is
6239 given in its numeric form.
6244 =head2 Plugin C<unixsock>
6248 =item B<SocketFile> I<Path>
6250 Sets the socket-file which is to be created.
6252 =item B<SocketGroup> I<Group>
6254 If running as root change the group of the UNIX-socket after it has been
6255 created. Defaults to B<collectd>.
6257 =item B<SocketPerms> I<Permissions>
6259 Change the file permissions of the UNIX-socket after it has been created. The
6260 permissions must be given as a numeric, octal value as you would pass to
6261 L<chmod(1)>. Defaults to B<0770>.
6263 =item B<DeleteSocket> B<false>|B<true>
6265 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6266 with the given name already exists. If I<collectd> crashes a socket file may be
6267 left over, preventing the daemon from opening a new socket when restarted.
6268 Since this is potentially dangerous, this defaults to B<false>.
6272 =head2 Plugin C<uuid>
6274 This plugin, if loaded, causes the Hostname to be taken from the machine's
6275 UUID. The UUID is a universally unique designation for the machine, usually
6276 taken from the machine's BIOS. This is most useful if the machine is running in
6277 a virtual environment such as Xen, in which case the UUID is preserved across
6278 shutdowns and migration.
6280 The following methods are used to find the machine's UUID, in order:
6286 Check I</etc/uuid> (or I<UUIDFile>).
6290 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6295 Check for UUID from C<dmidecode> / SMBIOS.
6299 Check for UUID from Xen hypervisor.
6303 If no UUID can be found then the hostname is not modified.
6307 =item B<UUIDFile> I<Path>
6309 Take the UUID from the given file (default I</etc/uuid>).
6313 =head2 Plugin C<varnish>
6315 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6320 <Instance "example">
6322 CollectConnections true
6332 CollectWorkers false
6336 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6337 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6338 will collectd statistics from the default "varnishd" instance (this should work
6339 fine in most cases).
6341 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6345 =item B<CollectCache> B<true>|B<false>
6347 Cache hits and misses. True by default.
6349 =item B<CollectConnections> B<true>|B<false>
6351 Number of client connections received, accepted and dropped. True by default.
6353 =item B<CollectBackend> B<true>|B<false>
6355 Back-end connection statistics, such as successful, reused,
6356 and closed connections. True by default.
6358 =item B<CollectSHM> B<true>|B<false>
6360 Statistics about the shared memory log, a memory region to store
6361 log messages which is flushed to disk when full. True by default.
6363 =item B<CollectBan> B<true>|B<false>
6365 Statistics about ban operations, such as number of bans added, retired, and
6366 number of objects tested against ban operations. Only available with Varnish
6367 3.x. False by default.
6369 =item B<CollectDirectorDNS> B<true>|B<false>
6371 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6374 =item B<CollectESI> B<true>|B<false>
6376 Edge Side Includes (ESI) parse statistics. False by default.
6378 =item B<CollectFetch> B<true>|B<false>
6380 Statistics about fetches (HTTP requests sent to the backend). False by default.
6382 =item B<CollectHCB> B<true>|B<false>
6384 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6385 divided into locked and unlocked look-ups. False by default.
6387 =item B<CollectObjects> B<true>|B<false>
6389 Statistics on cached objects: number of objects expired, nuked (prematurely
6390 expired), saved, moved, etc. False by default.
6392 =item B<CollectPurge> B<true>|B<false>
6394 Statistics about purge operations, such as number of purges added, retired, and
6395 number of objects tested against purge operations. Only available with Varnish
6396 2.x. False by default.
6398 =item B<CollectSession> B<true>|B<false>
6400 Client session statistics. Number of past and current sessions, session herd and
6401 linger counters, etc. False by default.
6403 =item B<CollectSMA> B<true>|B<false>
6405 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6406 component is Solaris specific. Only available with Varnish 2.x. False by
6409 =item B<CollectSMS> B<true>|B<false>
6411 synth (synthetic content) storage statistics. This storage
6412 component is used internally only. False by default.
6414 =item B<CollectSM> B<true>|B<false>
6416 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6419 =item B<CollectStruct> B<true>|B<false>
6421 Current varnish internal state statistics. Number of current sessions, objects
6422 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6425 =item B<CollectTotals> B<true>|B<false>
6427 Collects overview counters, such as the number of sessions created,
6428 the number of requests and bytes transferred. False by default.
6430 =item B<CollectUptime> B<true>|B<false>
6432 Varnish uptime. False by default.
6434 =item B<CollectVCL> B<true>|B<false>
6436 Number of total (available + discarded) VCL (config files). False by default.
6438 =item B<CollectWorkers> B<true>|B<false>
6440 Collect statistics about worker threads. False by default.
6444 =head2 Plugin C<vmem>
6446 The C<vmem> plugin collects information about the usage of virtual memory.
6447 Since the statistics provided by the Linux kernel are very detailed, they are
6448 collected very detailed. However, to get all the details, you have to switch
6449 them on manually. Most people just want an overview over, such as the number of
6450 pages read from swap space.
6454 =item B<Verbose> B<true>|B<false>
6456 Enables verbose collection of information. This will start collecting page
6457 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6458 Part of these statistics are collected on a "per zone" basis.
6462 =head2 Plugin C<vserver>
6464 This plugin doesn't have any options. B<VServer> support is only available for
6465 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6466 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6467 need to apply the patches and compile your own kernel, which will then provide
6468 the F</proc/virtual> filesystem that is required by this plugin.
6470 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6472 B<Note>: The traffic collected by this plugin accounts for the amount of
6473 traffic passing a socket which might be a lot less than the actual on-wire
6474 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6475 collect on-wire traffic you could, for example, use the logging facilities of
6476 iptables to feed data for the guest IPs into the iptables plugin.
6478 =head2 Plugin C<write_graphite>
6480 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6481 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6482 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6483 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6484 of at most 1428 bytes to minimize the number of network packets.
6488 <Plugin write_graphite>
6498 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6499 blocks. Inside the B<Node> blocks, the following options are recognized:
6503 =item B<Host> I<Address>
6505 Hostname or address to connect to. Defaults to C<localhost>.
6507 =item B<Port> I<Service>
6509 Service name or port number to connect to. Defaults to C<2003>.
6511 =item B<Protocol> I<String>
6513 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6515 =item B<LogSendErrors> B<false>|B<true>
6517 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6518 If set to B<false>, it will not log the errors. This is especially useful when
6519 using Protocol UDP since many times we want to use the "fire-and-forget"
6520 approach and logging errors fills syslog with unneeded messages.
6522 =item B<Prefix> I<String>
6524 When set, I<String> is added in front of the host name. Dots and whitespace are
6525 I<not> escaped in this string (see B<EscapeCharacter> below).
6527 =item B<Postfix> I<String>
6529 When set, I<String> is appended to the host name. Dots and whitespace are
6530 I<not> escaped in this string (see B<EscapeCharacter> below).
6532 =item B<EscapeCharacter> I<Char>
6534 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6535 in the identifier. The B<EscapeCharacter> option determines which character
6536 dots, whitespace and control characters are replaced with. Defaults to
6539 =item B<StoreRates> B<false>|B<true>
6541 If set to B<true> (the default), convert counter values to rates. If set to
6542 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6545 =item B<SeparateInstances> B<false>|B<true>
6547 If set to B<true>, the plugin instance and type instance will be in their own
6548 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6549 default), the plugin and plugin instance (and likewise the type and type
6550 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6552 =item B<AlwaysAppendDS> B<false>|B<true>
6554 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6555 identifier. If set to B<false> (the default), this is only done when there is
6560 =head2 Plugin C<write_tsdb>
6562 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6563 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6564 state daemon that ingests metrics and stores them in HBase. The plugin uses
6565 I<TCP> over the "line based" protocol with a default port 4242. The data will
6566 be sent in blocks of at most 1428 bytes to minimize the number of network
6573 Host "tsd-1.my.domain"
6575 HostTags "status=production"
6579 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6580 blocks. Inside the B<Node> blocks, the following options are recognized:
6584 =item B<Host> I<Address>
6586 Hostname or address to connect to. Defaults to C<localhost>.
6588 =item B<Port> I<Service>
6590 Service name or port number to connect to. Defaults to C<4242>.
6593 =item B<HostTags> I<String>
6595 When set, I<HostTags> is added to the end of the metric. It is intended to be
6596 used for name=value pairs that the TSD will tag the metric with. Dots and
6597 whitespace are I<not> escaped in this string.
6599 =item B<StoreRates> B<false>|B<true>
6601 If set to B<true>, convert counter values to rates. If set to B<false>
6602 (the default) counter values are stored as is, as an increasing
6605 =item B<AlwaysAppendDS> B<false>|B<true>
6607 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6608 identifier. If set to B<false> (the default), this is only done when there is
6613 =head2 Plugin C<write_mongodb>
6615 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6620 <Plugin "write_mongodb">
6629 The plugin can send values to multiple instances of I<MongoDB> by specifying
6630 one B<Node> block for each instance. Within the B<Node> blocks, the following
6631 options are available:
6635 =item B<Host> I<Address>
6637 Hostname or address to connect to. Defaults to C<localhost>.
6639 =item B<Port> I<Service>
6641 Service name or port number to connect to. Defaults to C<27017>.
6643 =item B<Timeout> I<Timeout>
6645 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6646 Setting this option to zero means no timeout, which is the default.
6648 =item B<StoreRates> B<false>|B<true>
6650 If set to B<true> (the default), convert counter values to rates. If set to
6651 B<false> counter values are stored as is, i.e. as an increasing integer
6654 =item B<Database> I<Database>
6656 =item B<User> I<User>
6658 =item B<Password> I<Password>
6660 Sets the information used when authenticating to a I<MongoDB> database. The
6661 fields are optional (in which case no authentication is attempted), but if you
6662 want to use authentication all three fields must be set.
6666 =head2 Plugin C<write_http>
6668 This output plugin submits values to an HTTP server using POST requests and
6669 encoding metrics with JSON or using the C<PUTVAL> command described in
6670 L<collectd-unixsock(5)>. Each destination you want to post data to needs to
6671 have one B<URL> block, within which the destination can be configured further,
6672 for example by specifying authentication data.
6676 <Plugin "write_http">
6677 <URL "http://example.com/post-collectd">
6684 B<URL> blocks need one string argument which is used as the URL to which data
6685 is posted. The following options are understood within B<URL> blocks.
6689 =item B<User> I<Username>
6691 Optional user name needed for authentication.
6693 =item B<Password> I<Password>
6695 Optional password needed for authentication.
6697 =item B<VerifyPeer> B<true>|B<false>
6699 Enable or disable peer SSL certificate verification. See
6700 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6702 =item B<VerifyHost> B<true|false>
6704 Enable or disable peer host name verification. If enabled, the plugin checks if
6705 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6706 matches the host name provided by the B<URL> option. If this identity check
6707 fails, the connection is aborted. Obviously, only works when connecting to a
6708 SSL enabled server. Enabled by default.
6710 =item B<CACert> I<File>
6712 File that holds one or more SSL certificates. If you want to use HTTPS you will
6713 possibly need this option. What CA certificates come bundled with C<libcurl>
6714 and are checked by default depends on the distribution you use.
6716 =item B<CAPath> I<Directory>
6718 Directory holding one or more CA certificate files. You can use this if for
6719 some reason all the needed CA certificates aren't in the same file and can't be
6720 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
6723 =item B<ClientKey> I<File>
6725 File that holds the private key in PEM format to be used for certificate-based
6728 =item B<ClientCert> I<File>
6730 File that holds the SSL certificate to be used for certificate-based
6733 =item B<ClientKeyPass> I<Password>
6735 Password required to load the private key in B<ClientKey>.
6737 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
6739 Define which SSL protocol version must be used. By default C<libcurl> will
6740 attempt to figure out the remote SSL protocol version. See
6741 L<curl_easy_setopt(3)> for more details.
6743 =item B<Format> B<Command>|B<JSON>
6745 Format of the output to generate. If set to B<Command>, will create output that
6746 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6747 create output in the I<JavaScript Object Notation> (JSON).
6749 Defaults to B<Command>.
6751 =item B<StoreRates> B<true|false>
6753 If set to B<true>, convert counter values to rates. If set to B<false> (the
6754 default) counter values are stored as is, i.e. as an increasing integer number.
6756 =item B<BufferSize> I<Bytes>
6758 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
6759 requests will be generated, but more metrics will be batched / metrics are
6760 cached for longer before being sent, introducing additional delay until they
6761 are available on the server side. I<Bytes> must be at least 1024 and cannot
6762 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
6763 Defaults to C<4096>.
6767 =head2 Plugin C<write_kafka>
6769 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
6773 <Plugin "write_kafka">
6774 Property "metadata.broker.list" "broker1:9092,broker2:9092"
6780 The following options are understood by the I<write_kafka plugin>:
6784 =item E<lt>B<Topic> I<Name>E<gt>
6786 The plugin's configuration consists of one or more B<Topic> blocks. Each block
6787 is given a unique I<Name> and specifies one kafka producer.
6788 Inside the B<Topic> block, the following per-topic options are
6793 =item B<Property> I<String> I<String>
6795 Configure the named property for the current topic. Properties are
6796 forwarded to the kafka producer library B<librdkafka>.
6798 =item B<Key> I<String>
6800 Use the specified string as a partioning key for the topic. Kafka breaks
6801 topic into partitions and guarantees that for a given topology, the same
6802 consumer will be used for a specific key. The special (case insensitive)
6803 string B<Random> can be used to specify that an arbitrary partition should
6806 =item B<Format> B<Command>|B<JSON>|B<Graphite>
6808 Selects the format in which messages are sent to the broker. If set to
6809 B<Command> (the default), values are sent as C<PUTVAL> commands which are
6810 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
6812 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
6813 an easy and straight forward exchange format.
6815 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
6816 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
6818 =item B<StoreRates> B<true>|B<false>
6820 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
6821 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
6822 default), no conversion is performed. Otherwise the conversion is performed
6823 using the internal value cache.
6825 Please note that currently this option is only used if the B<Format> option has
6826 been set to B<JSON>.
6828 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
6830 A prefix can be added in the metric name when outputting in the I<Graphite>
6831 format. It's added before the I<Host> name.
6833 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>>
6835 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
6837 A postfix can be added in the metric name when outputting in the I<Graphite>
6838 format. It's added after the I<Host> name.
6840 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>>
6842 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
6844 Specify a character to replace dots (.) in the host part of the metric name.
6845 In I<Graphite> metric name, dots are used as separators between different
6846 metric parts (host, plugin, type).
6847 Default is C<_> (I<Underscore>).
6849 =item B<GraphiteSeparateInstances> B<false>|B<true>
6851 If set to B<true>, the plugin instance and type instance will be in their own
6852 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6853 default), the plugin and plugin instance (and likewise the type and type
6854 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6856 =item B<StoreRates> B<true>|B<false>
6858 If set to B<true> (the default), convert counter values to rates. If set to
6859 B<false> counter values are stored as is, i.e. as an increasing integer number.
6861 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6862 converted values will have "rate" appended to the data source type, e.g.
6863 C<ds_type:derive:rate>.
6867 =item B<Property> I<String> I<String>
6869 Configure the kafka producer through properties, you almost always will
6870 want to set B<metadata.broker.list> to your Kafka broker list.
6874 =head2 Plugin C<write_riemann>
6876 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
6877 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6878 I<Riemann> using UDP packets.
6882 <Plugin "write_riemann">
6888 AlwaysAppendDS false
6892 Attribute "foo" "bar"
6895 The following options are understood by the I<write_riemann plugin>:
6899 =item E<lt>B<Node> I<Name>E<gt>
6901 The plugin's configuration consists of one or more B<Node> blocks. Each block
6902 is given a unique I<Name> and specifies one connection to an instance of
6903 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6908 =item B<Host> I<Address>
6910 Hostname or address to connect to. Defaults to C<localhost>.
6912 =item B<Port> I<Service>
6914 Service name or port number to connect to. Defaults to C<5555>.
6916 =item B<Protocol> B<UDP>|B<TCP>
6918 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6921 =item B<StoreRates> B<true>|B<false>
6923 If set to B<true> (the default), convert counter values to rates. If set to
6924 B<false> counter values are stored as is, i.e. as an increasing integer number.
6926 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6927 converted values will have "rate" appended to the data source type, e.g.
6928 C<ds_type:derive:rate>.
6930 =item B<AlwaysAppendDS> B<false>|B<true>
6932 If set the B<true>, append the name of the I<Data Source> (DS) to the
6933 "service", i.e. the field that, together with the "host" field, uniquely
6934 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6935 only done when there is more than one DS.
6937 =item B<TTLFactor> I<Factor>
6939 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6940 event is considered active. I<collectd> populates this field based on the
6941 metrics interval setting. This setting controls the factor with which the
6942 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6943 know exactly what you're doing, you should only increase this setting from its
6946 =item B<Notifications> B<false>|B<true>
6948 If set to B<true>, create riemann events for notifications. This is B<true>
6949 by default. When processing thresholds from write_riemann, it might prove
6950 useful to avoid getting notification events.
6952 =item B<CheckThresholds> B<false>|B<true>
6954 If set to B<true>, attach state to events based on thresholds defined
6955 in the B<Threshold> plugin. Defaults to B<false>.
6957 =item B<EventServicePrefix> I<String>
6959 Add the given string as a prefix to the event service name.
6960 If B<EventServicePrefix> not set or set to an empty string (""),
6961 no prefix will be used.
6965 =item B<Tag> I<String>
6967 Add the given string as an additional tag to the metric being sent to
6970 =item B<Attribute> I<String> I<String>
6972 Consider the two given strings to be the key and value of an additional
6973 attribute for each metric being sent out to I<Riemann>.
6977 =head1 THRESHOLD CONFIGURATION
6979 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6980 we mean that the values are not only stored or sent somewhere, but that they
6981 are judged and, if a problem is recognized, acted upon. The only action
6982 collectd takes itself is to generate and dispatch a "notification". Plugins can
6983 register to receive notifications and perform appropriate further actions.
6985 Since systems and what you expect them to do differ a lot, you can configure
6986 B<thresholds> for your values freely. This gives you a lot of flexibility but
6987 also a lot of responsibility.
6989 Every time a value is out of range a notification is dispatched. This means
6990 that the idle percentage of your CPU needs to be less then the configured
6991 threshold only once for a notification to be generated. There's no such thing
6992 as a moving average or similar - at least not now.
6994 Also, all values that match a threshold are considered to be relevant or
6995 "interesting". As a consequence collectd will issue a notification if they are
6996 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6997 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6998 "2" (the default) and some hosts sends it's CPU statistics to the server every
6999 60 seconds, a notification will be dispatched after about 120 seconds. It may
7000 take a little longer because the timeout is checked only once each B<Interval>
7003 When a value comes within range again or is received after it was missing, an
7004 "OKAY-notification" is dispatched.
7006 Here is a configuration example to get you started. Read below for more
7019 <Plugin "interface">
7036 WarningMin 100000000
7042 There are basically two types of configuration statements: The C<Host>,
7043 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7044 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7045 C<Instance> option. You can combine the block by nesting the blocks, though
7046 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7047 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7048 C<Type> may not contain other blocks. If multiple blocks apply to the same
7049 value the most specific block is used.
7051 The other statements specify the threshold to configure. They B<must> be
7052 included in a C<Type> block. Currently the following statements are recognized:
7056 =item B<FailureMax> I<Value>
7058 =item B<WarningMax> I<Value>
7060 Sets the upper bound of acceptable values. If unset defaults to positive
7061 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7062 will be created. If the value is greater than B<WarningMax> but less than (or
7063 equal to) B<FailureMax> a B<WARNING> notification will be created.
7065 =item B<FailureMin> I<Value>
7067 =item B<WarningMin> I<Value>
7069 Sets the lower bound of acceptable values. If unset defaults to negative
7070 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7071 be created. If the value is less than B<WarningMin> but greater than (or equal
7072 to) B<FailureMin> a B<WARNING> notification will be created.
7074 =item B<DataSource> I<DSName>
7076 Some data sets have more than one "data source". Interesting examples are the
7077 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7078 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7079 system load data set, C<load>, even has three data sources: C<shortterm>,
7080 C<midterm>, and C<longterm>.
7082 Normally, all data sources are checked against a configured threshold. If this
7083 is undesirable, or if you want to specify different limits for each data
7084 source, you can use the B<DataSource> option to have a threshold apply only to
7087 =item B<Invert> B<true>|B<false>
7089 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7090 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7091 B<WarningMax>) are not okay. Defaults to B<false>.
7093 =item B<Persist> B<true>|B<false>
7095 Sets how often notifications are generated. If set to B<true> one notification
7096 will be generated for each value that is out of the acceptable range. If set to
7097 B<false> (the default) then a notification is only generated if a value is out
7098 of range but the previous value was okay.
7100 This applies to missing values, too: If set to B<true> a notification about a
7101 missing value is generated once every B<Interval> seconds. If set to B<false>
7102 only one such notification is generated until the value appears again.
7104 =item B<Percentage> B<true>|B<false>
7106 If set to B<true>, the minimum and maximum values given are interpreted as
7107 percentage value, relative to the other data sources. This is helpful for
7108 example for the "df" type, where you may want to issue a warning when less than
7109 5E<nbsp>% of the total space is available. Defaults to B<false>.
7111 =item B<Hits> I<Number>
7113 Delay creating the notification until the threshold has been passed I<Number>
7114 times. When a notification has been generated, or when a subsequent value is
7115 inside the threshold, the counter is reset. If, for example, a value is
7116 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7117 will be dispatched at most once every 30E<nbsp>seconds.
7119 This is useful when short bursts are not a problem. If, for example, 100% CPU
7120 usage for up to a minute is normal (and data is collected every
7121 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7123 =item B<Hysteresis> I<Number>
7125 When set to non-zero, a hysteresis value is applied when checking minimum and
7126 maximum bounds. This is useful for values that increase slowly and fluctuate a
7127 bit while doing so. When these values come close to the threshold, they may
7128 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7130 If, for example, the threshold is configures as
7135 then a I<Warning> notification is created when the value exceeds I<101> and the
7136 corresponding I<Okay> notification is only created once the value falls below
7137 I<99>, thus avoiding the "flapping".
7141 =head1 FILTER CONFIGURATION
7143 Starting with collectd 4.6 there is a powerful filtering infrastructure
7144 implemented in the daemon. The concept has mostly been copied from
7145 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7146 terminology, so that users that are familiar with iptables feel right at home.
7150 The following are the terms used in the remainder of the filter configuration
7151 documentation. For an ASCII-art schema of the mechanism, see
7152 L<"General structure"> below.
7158 A I<match> is a criteria to select specific values. Examples are, of course, the
7159 name of the value or it's current value.
7161 Matches are implemented in plugins which you have to load prior to using the
7162 match. The name of such plugins starts with the "match_" prefix.
7166 A I<target> is some action that is to be performed with data. Such actions
7167 could, for example, be to change part of the value's identifier or to ignore
7168 the value completely.
7170 Some of these targets are built into the daemon, see L<"Built-in targets">
7171 below. Other targets are implemented in plugins which you have to load prior to
7172 using the target. The name of such plugins starts with the "target_" prefix.
7176 The combination of any number of matches and at least one target is called a
7177 I<rule>. The target actions will be performed for all values for which B<all>
7178 matches apply. If the rule does not have any matches associated with it, the
7179 target action will be performed for all values.
7183 A I<chain> is a list of rules and possibly default targets. The rules are tried
7184 in order and if one matches, the associated target will be called. If a value
7185 is handled by a rule, it depends on the target whether or not any subsequent
7186 rules are considered or if traversal of the chain is aborted, see
7187 L<"Flow control"> below. After all rules have been checked, the default targets
7192 =head2 General structure
7194 The following shows the resulting structure:
7201 +---------+ +---------+ +---------+ +---------+
7202 ! Rule !->! Match !->! Match !->! Target !
7203 +---------+ +---------+ +---------+ +---------+
7206 +---------+ +---------+ +---------+
7207 ! Rule !->! Target !->! Target !
7208 +---------+ +---------+ +---------+
7215 +---------+ +---------+ +---------+
7216 ! Rule !->! Match !->! Target !
7217 +---------+ +---------+ +---------+
7227 There are four ways to control which way a value takes through the filter
7234 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7235 process the value with another chain. When the called chain finishes, usually
7236 the next target or rule after the jump is executed.
7240 The stop condition, signaled for example by the built-in target B<stop>, causes
7241 all processing of the value to be stopped immediately.
7245 Causes processing in the current chain to be aborted, but processing of the
7246 value generally will continue. This means that if the chain was called via
7247 B<Jump>, the next target or rule after the jump will be executed. If the chain
7248 was not called by another chain, control will be returned to the daemon and it
7249 may pass the value to another chain.
7253 Most targets will signal the B<continue> condition, meaning that processing
7254 should continue normally. There is no special built-in target for this
7261 The configuration reflects this structure directly:
7263 PostCacheChain "PostCache"
7265 <Rule "ignore_mysql_show">
7268 Type "^mysql_command$"
7269 TypeInstance "^show_"
7279 The above configuration example will ignore all values where the plugin field
7280 is "mysql", the type is "mysql_command" and the type instance begins with
7281 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7282 default target of the chain. Since this chain is run after the value has been
7283 added to the cache, the MySQL C<show_*> command statistics will be available
7284 via the C<unixsock> plugin.
7286 =head2 List of configuration options
7290 =item B<PreCacheChain> I<ChainName>
7292 =item B<PostCacheChain> I<ChainName>
7294 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7295 argument is the name of a I<chain> that should be executed before and/or after
7296 the values have been added to the cache.
7298 To understand the implications, it's important you know what is going on inside
7299 I<collectd>. The following diagram shows how values are passed from the
7300 read-plugins to the write-plugins:
7306 + - - - - V - - - - +
7307 : +---------------+ :
7310 : +-------+-------+ :
7313 : +-------+-------+ : +---------------+
7314 : ! Cache !--->! Value Cache !
7315 : ! insert ! : +---+---+-------+
7316 : +-------+-------+ : ! !
7317 : ! ,------------' !
7319 : +-------+---+---+ : +-------+-------+
7320 : ! Post-Cache +--->! Write-Plugins !
7321 : ! Chain ! : +---------------+
7322 : +---------------+ :
7325 + - - - - - - - - - +
7327 After the values are passed from the "read" plugins to the dispatch functions,
7328 the pre-cache chain is run first. The values are added to the internal cache
7329 afterwards. The post-cache chain is run after the values have been added to the
7330 cache. So why is it such a huge deal if chains are run before or after the
7331 values have been added to this cache?
7333 Targets that change the identifier of a value list should be executed before
7334 the values are added to the cache, so that the name in the cache matches the
7335 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7336 this cache to receive a list of all available values. If you change the
7337 identifier after the value list has been added to the cache, this may easily
7338 lead to confusion, but it's not forbidden of course.
7340 The cache is also used to convert counter values to rates. These rates are, for
7341 example, used by the C<value> match (see below). If you use the rate stored in
7342 the cache B<before> the new value is added, you will use the old, B<previous>
7343 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7344 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7347 Last but not last, the B<stop> target makes a difference: If the pre-cache
7348 chain returns the stop condition, the value will not be added to the cache and
7349 the post-cache chain will not be run.
7351 =item B<Chain> I<Name>
7353 Adds a new chain with a certain name. This name can be used to refer to a
7354 specific chain, for example to jump to it.
7356 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7358 =item B<Rule> [I<Name>]
7360 Adds a new rule to the current chain. The name of the rule is optional and
7361 currently has no meaning for the daemon.
7363 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7364 must be at least one B<Target> block.
7366 =item B<Match> I<Name>
7368 Adds a match to a B<Rule> block. The name specifies what kind of match should
7369 be performed. Available matches depend on the plugins that have been loaded.
7371 The arguments inside the B<Match> block are passed to the plugin implementing
7372 the match, so which arguments are valid here depends on the plugin being used.
7373 If you do not need any to pass any arguments to a match, you can use the
7378 Which is equivalent to:
7383 =item B<Target> I<Name>
7385 Add a target to a rule or a default target to a chain. The name specifies what
7386 kind of target is to be added. Which targets are available depends on the
7387 plugins being loaded.
7389 The arguments inside the B<Target> block are passed to the plugin implementing
7390 the target, so which arguments are valid here depends on the plugin being used.
7391 If you do not need any to pass any arguments to a target, you can use the
7396 This is the same as writing:
7403 =head2 Built-in targets
7405 The following targets are built into the core daemon and therefore need no
7406 plugins to be loaded:
7412 Signals the "return" condition, see the L<"Flow control"> section above. This
7413 causes the current chain to stop processing the value and returns control to
7414 the calling chain. The calling chain will continue processing targets and rules
7415 just after the B<jump> target (see below). This is very similar to the
7416 B<RETURN> target of iptables, see L<iptables(8)>.
7418 This target does not have any options.
7426 Signals the "stop" condition, see the L<"Flow control"> section above. This
7427 causes processing of the value to be aborted immediately. This is similar to
7428 the B<DROP> target of iptables, see L<iptables(8)>.
7430 This target does not have any options.
7438 Sends the value to "write" plugins.
7444 =item B<Plugin> I<Name>
7446 Name of the write plugin to which the data should be sent. This option may be
7447 given multiple times to send the data to more than one write plugin. If the
7448 plugin supports multiple instances, the plugin's instance(s) must also be
7453 If no plugin is explicitly specified, the values will be sent to all available
7456 Single-instance plugin example:
7462 Multi-instance plugin example:
7464 <Plugin "write_graphite">
7474 Plugin "write_graphite/foo"
7479 Starts processing the rules of another chain, see L<"Flow control"> above. If
7480 the end of that chain is reached, or a stop condition is encountered,
7481 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7482 next target or the next rule. This is similar to the B<-j> command line option
7483 of iptables, see L<iptables(8)>.
7489 =item B<Chain> I<Name>
7491 Jumps to the chain I<Name>. This argument is required and may appear only once.
7503 =head2 Available matches
7509 Matches a value using regular expressions.
7515 =item B<Host> I<Regex>
7517 =item B<Plugin> I<Regex>
7519 =item B<PluginInstance> I<Regex>
7521 =item B<Type> I<Regex>
7523 =item B<TypeInstance> I<Regex>
7525 Match values where the given regular expressions match the various fields of
7526 the identifier of a value. If multiple regular expressions are given, B<all>
7527 regexen must match for a value to match.
7529 =item B<Invert> B<false>|B<true>
7531 When set to B<true>, the result of the match is inverted, i.e. all value lists
7532 where all regular expressions apply are not matched, all other value lists are
7533 matched. Defaults to B<false>.
7540 Host "customer[0-9]+"
7546 Matches values that have a time which differs from the time on the server.
7548 This match is mainly intended for servers that receive values over the
7549 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7550 is very sensitive to the timestamp used when updating the RRD files. In
7551 particular, the time must be ever increasing. If a misbehaving client sends one
7552 packet with a timestamp far in the future, all further packets with a correct
7553 time will be ignored because of that one packet. What's worse, such corrupted
7554 RRD files are hard to fix.
7556 This match lets one match all values B<outside> a specified time range
7557 (relative to the server's time), so you can use the B<stop> target (see below)
7558 to ignore the value, for example.
7564 =item B<Future> I<Seconds>
7566 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7567 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7570 =item B<Past> I<Seconds>
7572 Matches all values that are I<behind> of the server's time by I<Seconds> or
7573 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7585 This example matches all values that are five minutes or more ahead of the
7586 server or one hour (or more) lagging behind.
7590 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7591 values. If a data-set consists of more than one data-source, all data-sources
7592 must match the specified ranges for a positive match.
7598 =item B<Min> I<Value>
7600 Sets the smallest value which still results in a match. If unset, behaves like
7603 =item B<Max> I<Value>
7605 Sets the largest value which still results in a match. If unset, behaves like
7608 =item B<Invert> B<true>|B<false>
7610 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7611 no-match is returned and vice versa. Please note that the B<Invert> setting
7612 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7613 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7615 =item B<DataSource> I<DSName> [I<DSName> ...]
7617 Select one or more of the data sources. If no data source is configured, all
7618 data sources will be checked. If the type handled by the match does not have a
7619 data source of the specified name(s), this will always result in no match
7620 (independent of the B<Invert> setting).
7622 =item B<Satisfy> B<Any>|B<All>
7624 Specifies how checking with several data sources is performed. If set to
7625 B<Any>, the match succeeds if one of the data sources is in the configured
7626 range. If set to B<All> the match only succeeds if all data sources are within
7627 the configured range. Default is B<All>.
7629 Usually B<All> is used for positive matches, B<Any> is used for negative
7630 matches. This means that with B<All> you usually check that all values are in a
7631 "good" range, while with B<Any> you check if any value is within a "bad" range
7632 (or outside the "good" range).
7636 Either B<Min> or B<Max>, but not both, may be unset.
7640 # Match all values smaller than or equal to 100. Matches only if all data
7641 # sources are below 100.
7647 # Match if the value of any data source is outside the range of 0 - 100.
7655 =item B<empty_counter>
7657 Matches all values with one or more data sources of type B<COUNTER> and where
7658 all counter values are zero. These counters usually I<never> increased since
7659 they started existing (and are therefore uninteresting), or got reset recently
7660 or overflowed and you had really, I<really> bad luck.
7662 Please keep in mind that ignoring such counters can result in confusing
7663 behavior: Counters which hardly ever increase will be zero for long periods of
7664 time. If the counter is reset for some reason (machine or service restarted,
7665 usually), the graph will be empty (NAN) for a long time. People may not
7670 Calculates a hash value of the host name and matches values according to that
7671 hash value. This makes it possible to divide all hosts into groups and match
7672 only values that are in a specific group. The intended use is in load
7673 balancing, where you want to handle only part of all data and leave the rest
7676 The hashing function used tries to distribute the hosts evenly. First, it
7677 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7680 for (i = 0; host[i] != 0; i++)
7681 hash_value = (hash_value * 251) + host[i];
7683 The constant 251 is a prime number which is supposed to make this hash value
7684 more random. The code then checks the group for this host according to the
7685 I<Total> and I<Match> arguments:
7687 if ((hash_value % Total) == Match)
7692 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7693 groups), then the least significant bit of the hash value will be the XOR of
7694 all least significant bits in the host name. One consequence is that when you
7695 have two hosts, "server0.example.com" and "server1.example.com", where the host
7696 name differs in one digit only and the digits differ by one, those hosts will
7697 never end up in the same group.
7703 =item B<Match> I<Match> I<Total>
7705 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7706 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7707 be smaller than I<Total>. I<Total> must be at least one, although only values
7708 greater than one really do make any sense.
7710 You can repeat this option to match multiple groups, for example:
7715 The above config will divide the data into seven groups and match groups three
7716 and five. One use would be to keep every value on two hosts so that if one
7717 fails the missing data can later be reconstructed from the second host.
7723 # Operate on the pre-cache chain, so that ignored values are not even in the
7728 # Divide all received hosts in seven groups and accept all hosts in
7732 # If matched: Return and continue.
7735 # If not matched: Return and stop.
7741 =head2 Available targets
7745 =item B<notification>
7747 Creates and dispatches a notification.
7753 =item B<Message> I<String>
7755 This required option sets the message of the notification. The following
7756 placeholders will be replaced by an appropriate value:
7764 =item B<%{plugin_instance}>
7768 =item B<%{type_instance}>
7770 These placeholders are replaced by the identifier field of the same name.
7772 =item B<%{ds:>I<name>B<}>
7774 These placeholders are replaced by a (hopefully) human readable representation
7775 of the current rate of this data source. If you changed the instance name
7776 (using the B<set> or B<replace> targets, see below), it may not be possible to
7777 convert counter values to rates.
7781 Please note that these placeholders are B<case sensitive>!
7783 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7785 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7792 <Target "notification">
7793 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7799 Replaces parts of the identifier using regular expressions.
7805 =item B<Host> I<Regex> I<Replacement>
7807 =item B<Plugin> I<Regex> I<Replacement>
7809 =item B<PluginInstance> I<Regex> I<Replacement>
7811 =item B<TypeInstance> I<Regex> I<Replacement>
7813 Match the appropriate field with the given regular expression I<Regex>. If the
7814 regular expression matches, that part that matches is replaced with
7815 I<Replacement>. If multiple places of the input buffer match a given regular
7816 expression, only the first occurrence will be replaced.
7818 You can specify each option multiple times to use multiple regular expressions
7826 # Replace "example.net" with "example.com"
7827 Host "\\<example.net\\>" "example.com"
7829 # Strip "www." from hostnames
7835 Sets part of the identifier of a value to a given string.
7841 =item B<Host> I<String>
7843 =item B<Plugin> I<String>
7845 =item B<PluginInstance> I<String>
7847 =item B<TypeInstance> I<String>
7849 Set the appropriate field to the given string. The strings for plugin instance
7850 and type instance may be empty, the strings for host and plugin may not be
7851 empty. It's currently not possible to set the type of a value this way.
7858 PluginInstance "coretemp"
7859 TypeInstance "core3"
7864 =head2 Backwards compatibility
7866 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7867 B<Chain> block, it will behave as it used to. This is equivalent to the
7868 following configuration:
7874 If you specify a B<PostCacheChain>, the B<write> target will not be added
7875 anywhere and you will have to make sure that it is called where appropriate. We
7876 suggest to add the above snippet as default target to your "PostCache" chain.
7880 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7896 L<collectd-exec(5)>,
7897 L<collectd-perl(5)>,
7898 L<collectd-unixsock(5)>,
7911 Florian Forster E<lt>octo@collectd.orgE<gt>