3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
7 BaseDir "/path/to/data/"
8 PIDFile "/path/to/pidfile/collectd.pid"
9 Server "123.123.123.123" 12345
22 This config file controls how the system statistics collection daemon
23 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
24 controls which plugins to load. These plugins ultimately define collectd's
27 The syntax of this config file is similar to the config file of the famous
28 B<Apache Webserver>. Each line contains either a key-value-pair or a
29 section-start or -end. Empty lines and everything after the hash-symbol `#' is
30 ignored. Values are either string, enclosed in double-quotes,
31 (floating-point-)numbers or a boolean expression, i.E<nbsp>e. either B<true> or
32 B<false>. String containing of only alphanumeric characters and underscores do
33 not need to be quoted. Lines may be wrapped by using `\' as the last character
34 before the newline. This allows long lines to be split into multiple lines.
35 Quoted strings may be wrapped as well. However, those are treated special in
36 that whitespace at the beginning of the following lines will be ignored, which
37 allows for nicely indenting the wrapped lines.
39 The configuration is read and processed in order, i.E<nbsp>e. from top to
40 bottom. So the plugins are loaded in the order listed in this config file. It
41 is a good idea to load any logging plugins first in order to catch messages
42 from plugins during configuration. Also, the C<LoadPlugin> option B<must> occur
43 B<before> the C<E<lt>Plugin ...E<gt>> block.
49 =item B<BaseDir> I<Directory>
51 Sets the base directory. This is the directory beneath all RRD-files are
52 created. Possibly more subdirectories are created. This is also the working
53 directory for the daemon.
55 =item B<LoadPlugin> I<Plugin>
57 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
58 will be mostly useless.
60 Starting with collectd 4.9, this may also be a block in which further options
61 affecting the behavior of B<LoadPlugin> may be specified. The following
62 options are allowed inside a B<LoadPlugin> block:
70 =item B<Globals> B<true|false>
72 If enabled, collectd will export all global symbols of the plugin (and of all
73 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
74 available for resolving unresolved symbols in subsequently loaded plugins if
75 that is supported by your system.
77 This is useful (or possibly even required), e.g., when loading a plugin that
78 embeds some scripting language into the daemon (e.g. the I<Perl> and
79 I<Python plugins>). Scripting languages usually provide means to load
80 extensions written in C. Those extensions require symbols provided by the
81 interpreter, which is loaded as a dependency of the respective collectd plugin.
82 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
83 L<collectd-python(5)>) for details.
85 By default, this is disabled. As a special exception, if the plugin name is
86 either C<perl> or C<python>, the default is changed to enabled in order to keep
87 the average user from ever having to deal with this low level linking stuff.
91 =item B<Include> I<Path>
93 If I<Path> points to a file, includes that file. If I<Path> points to a
94 directory, recursively includes all files within that directory and its
95 subdirectories. If the C<wordexp> function is available on your system,
96 shell-like wildcards are expanded before files are included. This means you can
97 use statements like the following:
99 Include "/etc/collectd.d/*.conf"
101 If more than one files are included by a single B<Include> option, the files
102 will be included in lexicographical order (as defined by the C<strcmp>
103 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
104 order in which the files are loaded.
106 To prevent loops and shooting yourself in the foot in interesting ways the
107 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
108 most uses. Since symlinks are followed it is still possible to crash the daemon
109 by looping symlinks. In our opinion significant stupidity should result in an
110 appropriate amount of pain.
112 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
113 file, but you cannot include files from within blocks.
115 =item B<PIDFile> I<File>
117 Sets where to write the PID file to. This file is overwritten when it exists
118 and deleted when the program is stopped. Some init-scripts might override this
119 setting using the B<-P> command-line option.
121 =item B<PluginDir> I<Directory>
123 Path to the plugins (shared objects) of collectd.
125 =item B<TypesDB> I<File> [I<File> ...]
127 Set one or more files that contain the data-set descriptions. See
128 L<types.db(5)> for a description of the format of this file.
130 =item B<Interval> I<Seconds>
132 Configures the interval in which to query the read plugins. Obviously smaller
133 values lead to a higher system load produced by collectd, while higher values
134 lead to more coarse statistics.
136 B<Warning:> You should set this once and then never touch it again. If you do,
137 I<you will have to delete all your RRD files> or know some serious RRDtool
138 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
140 =item B<Timeout> I<Iterations>
142 Consider a value list "missing" when no update has been read or received for
143 I<Iterations> iterations. By default, I<collectd> considers a value list
144 missing when no update has been received for twice the update interval. Since
145 this setting uses iterations, the maximum allowed time without update depends
146 on the I<Interval> information contained in each value list. This is used in
147 the I<Threshold> configuration to dispatch notifications about missing values,
148 see L<collectd-threshold(5)> for details.
150 =item B<ReadThreads> I<Num>
152 Number of threads to start for reading plugins. The default value is B<5>, but
153 you may want to increase this if you have more than five plugins that take a
154 long time to read. Mostly those are plugin that do network-IO. Setting this to
155 a value higher than the number of plugins you've loaded is totally useless.
157 =item B<Hostname> I<Name>
159 Sets the hostname that identifies a host. If you omit this setting, the
160 hostname will be determined using the L<gethostname(2)> system call.
162 =item B<FQDNLookup> B<true|false>
164 If B<Hostname> is determined automatically this setting controls whether or not
165 the daemon should try to figure out the "fully qualified domain name", FQDN.
166 This is done using a lookup of the name returned by C<gethostname>. This option
167 is enabled by default.
169 =item B<PreCacheChain> I<ChainName>
171 =item B<PostCacheChain> I<ChainName>
173 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
174 see L<FILTER CONFIGURATION> below on information on chains and how these
175 setting change the daemon's behavior.
179 =head1 PLUGIN OPTIONS
181 Some plugins may register own options. These options must be enclosed in a
182 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
183 require external configuration, too. The C<apache plugin>, for example,
184 required C<mod_status> to be configured in the webserver you're going to
185 collect data from. These plugins are listed below as well, even if they don't
186 require any configuration within collectd's configuration file.
188 A list of all plugins and a short summary for each plugin can be found in the
189 F<README> file shipped with the sourcecode and hopefully binary packets as
192 =head2 Plugin C<aggregation>
194 The I<Aggregation plugin> makes it possible to aggregate several values into
195 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
196 This can be put to a wide variety of uses, e.g. average and total CPU
197 statistics for your entire fleet.
199 The grouping is powerful but, as with many powerful tools, may be a bit
200 difficult to wrap your head around. The grouping will therefore be
201 demonstrated using an example: The average and sum of the CPU usage across
202 CPUs of each client is to be calculated.
204 To select all the affected values for our example, set C<plugin=cpu> and
205 C<type=cpu>. The other values, we set to a wildcard. There are two different
206 wildcard tokens: C</all/> and C</any/>. C</any/> works like a
207 C<GROUPE<nbsp>BY> clause in SQL, i.e. if host is set to C</any/>, a separate
208 aggregation will be calculated for each host. In the example, we need to group
209 by I<Host> and I<Type Instance> (user, system, idle, ...) but we don't group
210 by I<Plugin Instance> (CPU number).
212 The full example configuration looks like this:
214 <Plugin "aggregation">
218 PluginInstance "/all/"
222 CalculateAverage true
226 There are a couple of limitations you should be aware of:
232 The I<Type> cannot be a wildcard, because it is not reasonable to add apples
233 to oranges. Also, the internal lookup structure won't work if you set it to
234 C</any/> or C</all/>.
238 There must be at least one C</all/> wildcard, otherwise nothing will be
243 As you can see in the example above, each aggregation has its own
244 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
245 blocks may match the same values, i.e. one value list can update multiple
246 aggregations. The following options are valid inside B<Aggregation> blocks:
250 =item B<Host> I<Host>
252 =item B<Plugin> I<Plugin>
254 =item B<PluginInstance> I<PluginInstance>
256 =item B<Type> I<Type>
258 =item B<TypeInstance> I<TypeInstance>
260 Selects the value lists to be added to this aggregation. Each field, with the
261 exception of B<Type>, can hold either a fixed string, or one of the wildcard
262 tokens C</all/> and C</any/>. B<Type> must be a valid data set name, see
263 L<types.db(5)> for details.
265 =item B<CalculateNum> B<true>|B<false>
267 =item B<CalculateSum> B<true>|B<false>
269 =item B<CalculateAverage> B<true>|B<false>
271 =item B<CalculateMinimum> B<true>|B<false>
273 =item B<CalculateMaximum> B<true>|B<false>
275 =item B<CalculateStddev> B<true>|B<false>
277 Boolean options for enabling calculation of the number of value lists, their
278 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
279 are disabled by default.
283 =head2 Plugin C<amqp>
285 The I<AMQMP plugin> can be used to communicate with other instances of
286 I<collectd> or third party applications using an AMQP message broker. Values
287 are sent to or received from the broker, which handles routing, queueing and
288 possibly filtering or messages.
291 # Send values to an AMQP broker
292 <Publish "some_name">
298 Exchange "amq.fanout"
299 # ExchangeType "fanout"
300 # RoutingKey "collectd"
306 # Receive values from an AMQP broker
307 <Subscribe "some_name">
313 Exchange "amq.fanout"
314 # ExchangeType "fanout"
316 # RoutingKey "collectd.#"
320 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
321 blocks, which configure sending and receiving of values respectively. The two
322 blocks are very similar, so unless otherwise noted, an option can be used in
323 either block. The name given in the blocks starting tag is only used for
324 reporting messages, but may be used to support I<flushing> of certain
325 I<Publish> blocks in the future.
329 =item B<Host> I<Host>
331 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
332 the underlying communications library, I<rabbitmq-c>, which is "localhost".
334 =item B<Port> I<Port>
336 Service name or port number on which the AMQP broker accepts connections. This
337 argument must be a string, even if the numeric form is used. Defaults to
340 =item B<VHost> I<VHost>
342 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
344 =item B<User> I<User>
346 =item B<Password> I<Password>
348 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
351 =item B<Exchange> I<Exchange>
353 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
354 By default, "amq.fanout" will be used.
356 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
357 the given exchange and the I<queue> is created, using the I<routing key> if
358 configured. See the B<Queue> and B<RoutingKey> options below.
360 =item B<ExchangeType> I<Type>
362 If given, the plugin will try to create the configured I<exchange> with this
363 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
364 be bound to this exchange.
366 =item B<Queue> I<Queue> (Subscribe only)
368 Configures the I<queue> name to subscribe to. If no queue name was configures
369 explicitly, a unique queue name will be created by the broker.
371 =item B<RoutingKey> I<Key>
373 In I<Publish> blocks, this configures the routing key to set on all outgoing
374 messages. If not given, the routing key will be computed from the I<identifier>
375 of the value. The host, plugin, type and the two instances are concatenated
376 together using dots as the separator and all containing dots replaced with
377 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
378 possible to receive only specific values using a "topic" exchange.
380 In I<Subscribe> blocks, configures the I<routing key> used when creating a
381 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
382 used to filter messages when using a "topic" exchange. If you're only
383 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
386 =item B<Persistent> B<true>|B<false> (Publish only)
388 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
389 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
390 default), the I<transient> delivery mode will be used, i.e. messages may be
391 lost due to high load, overflowing queues or similar issues.
393 =item B<Format> B<Command>|B<JSON> (Publish only)
395 Selects the format in which messages are sent to the broker. If set to
396 B<Command> (the default), values are sent as C<PUTVAL> commands which are
397 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
398 case, the C<Content-Type> header field will be set to C<text/collectd>.
400 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
401 an easy and straight forward exchange format. The C<Content-Type> header field
402 will be set to C<application/json>.
404 A subscribing client I<should> use the C<Content-Type> header field to
405 determine how to decode the values. Currently, the I<AMQP plugin> itself can
406 only decode the B<Command> format.
408 =item B<StoreRates> B<true>|B<false> (Publish only)
410 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
411 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
412 default), no conversion is performed. Otherwise the conversion is performed
413 using the internal value cache.
415 Please note that currently this option is only used if the B<Format> option has
420 =head2 Plugin C<apache>
422 To configure the C<apache>-plugin you first need to configure the Apache
423 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
424 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
425 the following snipped to base your Apache config upon:
428 <IfModule mod_status.c>
429 <Location /mod_status>
430 SetHandler server-status
434 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
435 also supported. It introduces a new field, called C<BusyServers>, to count the
436 number of currently connected clients. This field is also supported.
438 The configuration of the I<Apache> plugin consists of one or more
439 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
440 as the instance name. For example:
444 URL "http://www1.example.com/mod_status?auto"
447 URL "http://www2.example.com/mod_status?auto"
451 The instance name will be used as the I<plugin instance>. To emulate the old
452 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
453 plugin to work correctly, each instance name must be unique. This is not
454 enforced by the plugin and it is your responsibility to ensure it.
456 The following options are accepted within each I<Instance> block:
460 =item B<URL> I<http://host/mod_status?auto>
462 Sets the URL of the C<mod_status> output. This needs to be the output generated
463 by C<ExtendedStatus on> and it needs to be the machine readable output
464 generated by appending the C<?auto> argument. This option is I<mandatory>.
466 =item B<User> I<Username>
468 Optional user name needed for authentication.
470 =item B<Password> I<Password>
472 Optional password needed for authentication.
474 =item B<VerifyPeer> B<true|false>
476 Enable or disable peer SSL certificate verification. See
477 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
479 =item B<VerifyHost> B<true|false>
481 Enable or disable peer host name verification. If enabled, the plugin checks
482 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
483 certificate matches the host name provided by the B<URL> option. If this
484 identity check fails, the connection is aborted. Obviously, only works when
485 connecting to a SSL enabled server. Enabled by default.
487 =item B<CACert> I<File>
489 File that holds one or more SSL certificates. If you want to use HTTPS you will
490 possibly need this option. What CA certificates come bundled with C<libcurl>
491 and are checked by default depends on the distribution you use.
495 =head2 Plugin C<apcups>
499 =item B<Host> I<Hostname>
501 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
502 that IPv6 support has been disabled unless someone can confirm or decline that
503 B<apcupsd> can handle it.
505 =item B<Port> I<Port>
507 TCP-Port to connect to. Defaults to B<3551>.
511 =head2 Plugin C<ascent>
513 This plugin collects information about an Ascent server, a free server for the
514 "World of Warcraft" game. This plugin gathers the information by fetching the
515 XML status page using C<libcurl> and parses it using C<libxml2>.
517 The configuration options are the same as for the C<apache> plugin above:
521 =item B<URL> I<http://localhost/ascent/status/>
523 Sets the URL of the XML status output.
525 =item B<User> I<Username>
527 Optional user name needed for authentication.
529 =item B<Password> I<Password>
531 Optional password needed for authentication.
533 =item B<VerifyPeer> B<true|false>
535 Enable or disable peer SSL certificate verification. See
536 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
538 =item B<VerifyHost> B<true|false>
540 Enable or disable peer host name verification. If enabled, the plugin checks
541 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
542 certificate matches the host name provided by the B<URL> option. If this
543 identity check fails, the connection is aborted. Obviously, only works when
544 connecting to a SSL enabled server. Enabled by default.
546 =item B<CACert> I<File>
548 File that holds one or more SSL certificates. If you want to use HTTPS you will
549 possibly need this option. What CA certificates come bundled with C<libcurl>
550 and are checked by default depends on the distribution you use.
554 =head2 Plugin C<bind>
556 Starting with BIND 9.5.0, the most widely used DNS server software provides
557 extensive statistics about queries, responses and lots of other information.
558 The bind plugin retrieves this information that's encoded in XML and provided
559 via HTTP and submits the values to collectd.
561 To use this plugin, you first need to tell BIND to make this information
562 available. This is done with the C<statistics-channels> configuration option:
564 statistics-channels {
565 inet localhost port 8053;
568 The configuration follows the grouping that can be seen when looking at the
569 data with an XSLT compatible viewer, such as a modern web browser. It's
570 probably a good idea to make yourself familiar with the provided values, so you
571 can understand what the collected statistics actually mean.
576 URL "http://localhost:8053/"
591 Zone "127.in-addr.arpa/IN"
595 The bind plugin accepts the following configuration options:
601 URL from which to retrieve the XML data. If not specified,
602 C<http://localhost:8053/> will be used.
604 =item B<ParseTime> B<true>|B<false>
606 When set to B<true>, the time provided by BIND will be parsed and used to
607 dispatch the values. When set to B<false>, the local time source is queried.
609 This setting is set to B<true> by default for backwards compatibility; setting
610 this to B<false> is I<recommended> to avoid problems with timezones and
613 =item B<OpCodes> B<true>|B<false>
615 When enabled, statistics about the I<"OpCodes">, for example the number of
616 C<QUERY> packets, are collected.
620 =item B<QTypes> B<true>|B<false>
622 When enabled, the number of I<incoming> queries by query types (for example
623 C<A>, C<MX>, C<AAAA>) is collected.
627 =item B<ServerStats> B<true>|B<false>
629 Collect global server statistics, such as requests received over IPv4 and IPv6,
630 successful queries, and failed updates.
634 =item B<ZoneMaintStats> B<true>|B<false>
636 Collect zone maintenance statistics, mostly information about notifications
637 (zone updates) and zone transfers.
641 =item B<ResolverStats> B<true>|B<false>
643 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
644 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
645 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
646 default. Use the B<ResolverStats> option within a B<View "_default"> block
647 instead for the same functionality.
653 Collect global memory statistics.
657 =item B<View> I<Name>
659 Collect statistics about a specific I<"view">. BIND can behave different,
660 mostly depending on the source IP-address of the request. These different
661 configurations are called "views". If you don't use this feature, you most
662 likely are only interested in the C<_default> view.
664 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
665 information you want to collect about a view. If no B<View> block is
666 configured, no detailed view statistics will be collected.
670 =item B<QTypes> B<true>|B<false>
672 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
677 =item B<ResolverStats> B<true>|B<false>
679 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
680 (e.E<nbsp>g. queries over IPv4, lame servers).
684 =item B<CacheRRSets> B<true>|B<false>
686 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
687 type is collected. Negative entries (queries which resulted in an error, for
688 example names that do not exist) are reported with a leading exclamation mark,
693 =item B<Zone> I<Name>
695 When given, collect detailed information about the given zone in the view. The
696 information collected if very similar to the global B<ServerStats> information
699 You can repeat this option to collect detailed information about multiple
702 By default no detailed zone information is collected.
708 =head2 Plugin C<cpufreq>
710 This plugin doesn't have any options. It reads
711 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
712 installed) to get the current CPU frequency. If this file does not exist make
713 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
714 installed and an "cpu governor" (that's a kernel module) is loaded.
720 =item B<DataDir> I<Directory>
722 Set the directory to store CSV-files under. Per default CSV-files are generated
723 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
724 The special strings B<stdout> and B<stderr> can be used to write to the standard
725 output and standard error channels, respectively. This, of course, only makes
726 much sense when collectd is running in foreground- or non-daemon-mode.
728 =item B<StoreRates> B<true|false>
730 If set to B<true>, convert counter values to rates. If set to B<false> (the
731 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
736 =head2 Plugin C<curl>
738 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
739 and the match infrastructure (the same code used by the tail plugin) to use
740 regular expressions with the received data.
742 The following example will read the current value of AMD stock from Google's
743 finance page and dispatch the value to collectd.
746 <Page "stock_quotes">
747 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
751 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
752 DSType "GaugeAverage"
753 # Note: `stock_value' is not a standard type.
760 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
761 a web page and one or more "matches" to be performed on the returned data. The
762 string argument to the B<Page> block is used as plugin instance.
764 The following options are valid within B<Page> blocks:
770 URL of the web site to retrieve. Since a regular expression will be used to
771 extract information from this data, non-binary data is a big plus here ;)
773 =item B<User> I<Name>
775 Username to use if authorization is required to read the page.
777 =item B<Password> I<Password>
779 Password to use if authorization is required to read the page.
781 =item B<VerifyPeer> B<true>|B<false>
783 Enable or disable peer SSL certificate verification. See
784 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
786 =item B<VerifyHost> B<true>|B<false>
788 Enable or disable peer host name verification. If enabled, the plugin checks if
789 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
790 matches the host name provided by the B<URL> option. If this identity check
791 fails, the connection is aborted. Obviously, only works when connecting to a
792 SSL enabled server. Enabled by default.
794 =item B<CACert> I<file>
796 File that holds one or more SSL certificates. If you want to use HTTPS you will
797 possibly need this option. What CA certificates come bundled with C<libcurl>
798 and are checked by default depends on the distribution you use.
800 =item B<MeasureResponseTime> B<true>|B<false>
802 Measure response time for the request. If this setting is enabled, B<Match>
803 blocks (see below) are optional. Disabled by default.
805 =item B<E<lt>MatchE<gt>>
807 One or more B<Match> blocks that define how to match information in the data
808 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
809 used by the C<tail> plugin, so please see the documentation of the C<tail>
810 plugin below on how matches are defined. If the B<MeasureResponseTime> option
811 is set to B<true>, B<Match> blocks are optional.
815 =head2 Plugin C<curl_json>
817 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
818 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
819 via cURL. This can be used to collect values from CouchDB documents (which are
820 stored JSON notation), for example.
822 The following example will collect several values from the built-in `_stats'
823 runtime statistics module of CouchDB
824 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
827 <URL "http://localhost:5984/_stats">
829 <Key "httpd/requests/count">
833 <Key "httpd_request_methods/*/count">
834 Type "http_request_methods"
837 <Key "httpd_status_codes/*/count">
838 Type "http_response_codes"
843 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
844 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
845 The B<Key> string argument must be in a path format, which is used to collect a
846 value from a JSON map object. If a path element of B<Key> is the
847 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
849 The following options are valid within B<URL> blocks:
853 =item B<Instance> I<Instance>
855 Sets the plugin instance to I<Instance>.
857 =item B<User> I<Name>
859 Username to use if authorization is required to read the page.
861 =item B<Password> I<Password>
863 Password to use if authorization is required to read the page.
865 =item B<VerifyPeer> B<true>|B<false>
867 Enable or disable peer SSL certificate verification. See
868 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
870 =item B<VerifyHost> B<true>|B<false>
872 Enable or disable peer host name verification. If enabled, the plugin checks if
873 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
874 matches the host name provided by the B<URL> option. If this identity check
875 fails, the connection is aborted. Obviously, only works when connecting to a
876 SSL enabled server. Enabled by default.
878 =item B<CACert> I<file>
880 File that holds one or more SSL certificates. If you want to use HTTPS you will
881 possibly need this option. What CA certificates come bundled with C<libcurl>
882 and are checked by default depends on the distribution you use.
886 The following options are valid within B<Key> blocks:
890 =item B<Type> I<Type>
892 Sets the type used to dispatch the values to the daemon. Detailed information
893 about types and their configuration can be found in L<types.db(5)>. This
896 =item B<Instance> I<Instance>
898 Type-instance to use. Defaults to the current map key or current string array element value.
902 =head2 Plugin C<curl_xml>
904 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
905 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
908 <URL "http://localhost/stats.xml">
910 Instance "some_instance"
915 CACert "/path/to/ca.crt"
917 <XPath "table[@id=\"magic_level\"]/tr">
919 #InstancePrefix "prefix-"
921 ValuesFrom "td[2]/span[@class=\"level\"]"
926 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
927 URL to be fetched using libcurl. Within each B<URL> block there are
928 options which specify the connection parameters, for example authentication
929 information, and one or more B<XPath> blocks.
931 Each B<XPath> block specifies how to get one type of information. The
932 string argument must be a valid XPath expression which returns a list
933 of "base elements". One value is dispatched for each "base element". The
934 I<type instance> and values are looked up using further I<XPath> expressions
935 that should be relative to the base element.
937 Within the B<URL> block the following options are accepted:
941 =item B<Host> I<Name>
943 Use I<Name> as the host name when submitting values. Defaults to the global
946 =item B<Instance> I<Instance>
948 Use I<Instance> as the plugin instance when submitting values. Defaults to an
949 empty string (no plugin instance).
951 =item B<User> I<User>
952 =item B<Password> I<Password>
953 =item B<VerifyPeer> B<true>|B<false>
954 =item B<VerifyHost> B<true>|B<false>
955 =item B<CACert> I<CA Cert File>
957 These options behave exactly equivalent to the appropriate options of the
958 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
960 =item E<lt>B<XPath> I<XPath-expression>E<gt>
962 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
963 B<XPath> block specifies how to get one type of information. The string
964 argument must be a valid XPath expression which returns a list of "base
965 elements". One value is dispatched for each "base element".
967 Within the B<XPath> block the following options are accepted:
971 =item B<Type> I<Type>
973 Specifies the I<Type> used for submitting patches. This determines the number
974 of values that are required / expected and whether the strings are parsed as
975 signed or unsigned integer or as double values. See L<types.db(5)> for details.
976 This option is required.
978 =item B<InstancePrefix> I<InstancePrefix>
980 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
981 concatenated together without any separator.
982 This option is optional.
984 =item B<InstanceFrom> I<InstanceFrom>
986 Specifies a XPath expression to use for determining the I<type instance>. The
987 XPath expression must return exactly one element. The element's value is then
988 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
990 This value is required. As a special exception, if the "base XPath expression"
991 (the argument to the B<XPath> block) returns exactly one argument, then this
992 option may be omitted.
994 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
996 Specifies one or more XPath expression to use for reading the values. The
997 number of XPath expressions must match the number of data sources in the
998 I<type> specified with B<Type> (see above). Each XPath expression must return
999 exactly one element. The element's value is then parsed as a number and used as
1000 value for the appropriate value in the value list dispatched to the daemon.
1006 =head2 Plugin C<dbi>
1008 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1009 connect to various databases, execute I<SQL> statements and read back the
1010 results. I<dbi> is an acronym for "database interface" in case you were
1011 wondering about the name. You can configure how each column is to be
1012 interpreted and the plugin will generate one or more data sets from each row
1013 returned according to these rules.
1015 Because the plugin is very generic, the configuration is a little more complex
1016 than those of other plugins. It usually looks something like this:
1019 <Query "out_of_stock">
1020 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1021 # Use with MySQL 5.0.0 or later
1025 InstancePrefix "out_of_stock"
1026 InstancesFrom "category"
1030 <Database "product_information">
1032 DriverOption "host" "localhost"
1033 DriverOption "username" "collectd"
1034 DriverOption "password" "aZo6daiw"
1035 DriverOption "dbname" "prod_info"
1036 SelectDB "prod_info"
1037 Query "out_of_stock"
1041 The configuration above defines one query with one result and one database. The
1042 query is then linked to the database with the B<Query> option I<within> the
1043 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1044 and you can also use the B<Include> statement to split up the configuration
1045 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1046 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1049 The following is a complete list of options:
1051 =head3 B<Query> blocks
1053 Query blocks define I<SQL> statements and how the returned data should be
1054 interpreted. They are identified by the name that is given in the opening line
1055 of the block. Thus the name needs to be unique. Other than that, the name is
1056 not used in collectd.
1058 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1059 define which column holds which value or instance information. You can use
1060 multiple B<Result> blocks to create multiple values from one returned row. This
1061 is especially useful, when queries take a long time and sending almost the same
1062 query again and again is not desirable.
1066 <Query "environment">
1067 Statement "select station, temperature, humidity from environment"
1070 # InstancePrefix "foo"
1071 InstancesFrom "station"
1072 ValuesFrom "temperature"
1076 InstancesFrom "station"
1077 ValuesFrom "humidity"
1081 The following options are accepted:
1085 =item B<Statement> I<SQL>
1087 Sets the statement that should be executed on the server. This is B<not>
1088 interpreted by collectd, but simply passed to the database server. Therefore,
1089 the SQL dialect that's used depends on the server collectd is connected to.
1091 The query has to return at least two columns, one for the instance and one
1092 value. You cannot omit the instance, even if the statement is guaranteed to
1093 always return exactly one line. In that case, you can usually specify something
1096 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1098 (That works with MySQL but may not be valid SQL according to the spec. If you
1099 use a more strict database server, you may have to select from a dummy table or
1102 Please note that some databases, for example B<Oracle>, will fail if you
1103 include a semicolon at the end of the statement.
1105 =item B<MinVersion> I<Version>
1107 =item B<MaxVersion> I<Value>
1109 Only use this query for the specified database version. You can use these
1110 options to provide multiple queries with the same name but with a slightly
1111 different syntax. The plugin will use only those queries, where the specified
1112 minimum and maximum versions fit the version of the database in use.
1114 The database version is determined by C<dbi_conn_get_engine_version>, see the
1115 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1116 for details. Basically, each part of the version is assumed to be in the range
1117 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1118 "40102", version "5.0.42" becomes "50042".
1120 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1121 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1122 happen. Don't to it! A valid example would be something along these lines:
1133 In the above example, there are three ranges that don't overlap. The last one
1134 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1135 before "4.0.0" are not specified.
1137 =item B<Type> I<Type>
1139 The B<type> that's used for each line returned. See L<types.db(5)> for more
1140 details on how types are defined. In short: A type is a predefined layout of
1141 data and the number of values and type of values has to match the type
1144 If you specify "temperature" here, you need exactly one gauge column. If you
1145 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1148 There must be exactly one B<Type> option inside each B<Result> block.
1150 =item B<InstancePrefix> I<prefix>
1152 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1153 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1154 all strings returned in the appropriate columns are concatenated together,
1155 separated by dashes I<("-")>.
1157 =item B<InstancesFrom> I<column0> [I<column1> ...]
1159 Specifies the columns whose values will be used to create the "type-instance"
1160 for each row. If you specify more than one column, the value of all columns
1161 will be joined together with dashes I<("-")> as separation characters.
1163 The plugin itself does not check whether or not all built instances are
1164 different. It's your responsibility to assure that each is unique. This is
1165 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1166 sure that only one row is returned in this case.
1168 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1171 =item B<ValuesFrom> I<column0> [I<column1> ...]
1173 Names the columns whose content is used as the actual data for the data sets
1174 that are dispatched to the daemon. How many such columns you need is determined
1175 by the B<Type> setting above. If you specify too many or not enough columns,
1176 the plugin will complain about that and no data will be submitted to the
1179 The actual data type in the columns is not that important. The plugin will
1180 automatically cast the values to the right type if it know how to do that. So
1181 it should be able to handle integer an floating point types, as well as strings
1182 (if they include a number at the beginning).
1184 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1188 =head3 B<Database> blocks
1190 Database blocks define a connection to a database and which queries should be
1191 sent to that database. Since the used "dbi" library can handle a wide variety
1192 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1193 documentationE<nbsp>- we stick as close to the terminology used there.
1195 Each database needs a "name" as string argument in the starting tag of the
1196 block. This name will be used as "PluginInstance" in the values submitted to
1197 the daemon. Other than that, that name is not used.
1201 =item B<Driver> I<Driver>
1203 Specifies the driver to use to connect to the database. In many cases those
1204 drivers are named after the database they can connect to, but this is not a
1205 technical necessity. These drivers are sometimes referred to as "DBD",
1206 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1207 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1208 project at L<http://libdbi-drivers.sourceforge.net/>.
1210 You need to give the driver name as expected by the "dbi" library here. You
1211 should be able to find that in the documentation for each driver. If you
1212 mistype the driver name, the plugin will dump a list of all known driver names
1215 =item B<DriverOption> I<Key> I<Value>
1217 Sets driver-specific options. What option a driver supports can be found in the
1218 documentation for each driver, somewhere at
1219 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1220 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1222 Unfortunately, drivers are not too keen to report errors when an unknown option
1223 is passed to them, so invalid settings here may go unnoticed. This is not the
1224 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1225 the driver. If a driver complains about an option, the plugin will dump a
1226 complete list of all options understood by that driver to the log.
1228 =item B<SelectDB> I<Database>
1230 In some cases, the database name you connect with is not the database name you
1231 want to use for querying data. If this option is set, the plugin will "select"
1232 (switch to) that database after the connection is established.
1234 =item B<Query> I<QueryName>
1236 Associates the query named I<QueryName> with this database connection. The
1237 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1238 blocks you want to refer to must be placed above the database block you want to
1247 =item B<Device> I<Device>
1249 Select partitions based on the devicename.
1251 =item B<MountPoint> I<Directory>
1253 Select partitions based on the mountpoint.
1255 =item B<FSType> I<FSType>
1257 Select partitions based on the filesystem type.
1259 =item B<IgnoreSelected> B<true>|B<false>
1261 Invert the selection: If set to true, all partitions B<except> the ones that
1262 match any one of the criteria are collected. By default only selected
1263 partitions are collected if a selection is made. If no selection is configured
1264 at all, B<all> partitions are selected.
1266 =item B<ReportByDevice> B<true>|B<false>
1268 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1269 (the default), it will report a disk as "root", but with it I<true>, it will be
1270 "sda1" (or whichever).
1272 =item B<ReportInodes> B<true>|B<false>
1274 Enables or disables reporting of free, reserved and used inodes. Defaults to
1275 inode collection being disabled.
1277 Enable this option if inodes are a scarce resource for you, usually because
1278 many small files are stored on the disk. This is a usual scenario for mail
1279 transfer agents and web caches.
1283 =head2 Plugin C<disk>
1285 The C<disk> plugin collects information about the usage of physical disks and
1286 logical disks (partitions). Values collected are the number of octets written
1287 to and read from a disk or partition, the number of read/write operations
1288 issued to the disk and a rather complex "time" it took for these commands to be
1291 Using the following two options you can ignore some disks or configure the
1292 collection only of specific disks.
1296 =item B<Disk> I<Name>
1298 Select the disk I<Name>. Whether it is collected or ignored depends on the
1299 B<IgnoreSelected> setting, see below. As with other plugins that use the
1300 daemon's ignorelist functionality, a string that starts and ends with a slash
1301 is interpreted as a regular expression. Examples:
1306 =item B<IgnoreSelected> B<true>|B<false>
1308 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1309 statements, are ignored or if all other disks are ignored. The behavior
1310 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1311 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1312 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1313 is set to B<true>, all disks are collected B<except> the ones matched.
1317 =head2 Plugin C<dns>
1321 =item B<Interface> I<Interface>
1323 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1324 option sets the interface that should be used. If this option is not set, or
1325 set to "any", the plugin will try to get packets from B<all> interfaces. This
1326 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1328 =item B<IgnoreSource> I<IP-address>
1330 Ignore packets that originate from this address.
1332 =item B<SelectNumericQueryTypes> B<true>|B<false>
1334 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1338 =head2 Plugin C<email>
1342 =item B<SocketFile> I<Path>
1344 Sets the socket-file which is to be created.
1346 =item B<SocketGroup> I<Group>
1348 If running as root change the group of the UNIX-socket after it has been
1349 created. Defaults to B<collectd>.
1351 =item B<SocketPerms> I<Permissions>
1353 Change the file permissions of the UNIX-socket after it has been created. The
1354 permissions must be given as a numeric, octal value as you would pass to
1355 L<chmod(1)>. Defaults to B<0770>.
1357 =item B<MaxConns> I<Number>
1359 Sets the maximum number of connections that can be handled in parallel. Since
1360 this many threads will be started immediately setting this to a very high
1361 value will waste valuable resources. Defaults to B<5> and will be forced to be
1362 at most B<16384> to prevent typos and dumb mistakes.
1366 =head2 Plugin C<ethstat>
1368 The I<ethstat plugin> collects information about network interface cards (NICs)
1369 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1375 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1376 Map "multicast" "if_multicast"
1383 =item B<Interface> I<Name>
1385 Collect statistical information about interface I<Name>.
1387 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1389 By default, the plugin will submit values as type C<derive> and I<type
1390 instance> set to I<Name>, the name of the metric as reported by the driver. If
1391 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1392 I<TypeInstance> will be used.
1394 =item B<MappedOnly> B<true>|B<false>
1396 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1397 collected, all other metrics will be ignored. Defaults to B<false>.
1401 =head2 Plugin C<exec>
1403 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1404 contains valuable information on when the executable is executed and the
1405 output that is expected from it.
1409 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1411 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1413 Execute the executable I<Executable> as user I<User>. If the user name is
1414 followed by a colon and a group name, the effective group is set to that group.
1415 The real group and saved-set group will be set to the default group of that
1416 user. If no group is given the effective group ID will be the same as the real
1419 Please note that in order to change the user and/or group the daemon needs
1420 superuser privileges. If the daemon is run as an unprivileged user you must
1421 specify the same user/group here. If the daemon is run with superuser
1422 privileges, you must supply a non-root user here.
1424 The executable may be followed by optional arguments that are passed to the
1425 program. Please note that due to the configuration parsing numbers and boolean
1426 values may be changed. If you want to be absolutely sure that something is
1427 passed as-is please enclose it in quotes.
1429 The B<Exec> and B<NotificationExec> statements change the semantics of the
1430 programs executed, i.E<nbsp>e. the data passed to them and the response
1431 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1435 =head2 Plugin C<filecount>
1437 The C<filecount> plugin counts the number of files in a certain directory (and
1438 its subdirectories) and their combined size. The configuration is very straight
1441 <Plugin "filecount">
1442 <Directory "/var/qmail/queue/mess">
1443 Instance "qmail-message"
1445 <Directory "/var/qmail/queue/todo">
1446 Instance "qmail-todo"
1448 <Directory "/var/lib/php5">
1449 Instance "php5-sessions"
1454 The example above counts the number of files in QMail's queue directories and
1455 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1456 QMail has not yet looked at, the "message" queue holds the messages that were
1457 classified into "local" and "remote".
1459 As you can see, the configuration consists of one or more C<Directory> blocks,
1460 each of which specifies a directory in which to count the files. Within those
1461 blocks, the following options are recognized:
1465 =item B<Instance> I<Instance>
1467 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1468 it's your responsibility, the plugin doesn't check for that. If not given, the
1469 instance is set to the directory name with all slashes replaced by underscores
1470 and all leading underscores removed.
1472 =item B<Name> I<Pattern>
1474 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1475 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1476 against the pattern, not the entire path. In case this makes it easier for you:
1477 This option has been named after the B<-name> parameter to L<find(1)>.
1479 =item B<MTime> I<Age>
1481 Count only files of a specific age: If I<Age> is greater than zero, only files
1482 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1483 a negative number, this is inversed. For example, if B<-60> is specified, only
1484 files that have been modified in the last minute will be counted.
1486 The number can also be followed by a "multiplier" to easily specify a larger
1487 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1488 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1489 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1490 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1491 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1494 =item B<Size> I<Size>
1496 Count only files of a specific size. When I<Size> is a positive number, only
1497 files that are at least this big are counted. If I<Size> is a negative number,
1498 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1499 I<Size> are counted.
1501 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1502 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1503 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1504 note that there are 1000 bytes in a kilobyte, not 1024.
1506 =item B<Recursive> I<true>|I<false>
1508 Controls whether or not to recurse into subdirectories. Enabled by default.
1510 =item B<IncludeHidden> I<true>|I<false>
1512 Controls whether or not to include "hidden" files and directories in the count.
1513 "Hidden" files and directories are those, whose name begins with a dot.
1514 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1518 =head2 Plugin C<GenericJMX>
1520 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1521 L<collectd-java(5)>.
1523 =head2 Plugin C<gmond>
1525 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1526 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1527 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1532 MCReceiveFrom "239.2.11.71" "8649"
1533 <Metric "swap_total">
1535 TypeInstance "total"
1538 <Metric "swap_free">
1545 The following metrics are built-in:
1551 load_one, load_five, load_fifteen
1555 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1559 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1571 Available configuration options:
1575 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1577 Sets sets the multicast group and UDP port to which to subscribe.
1579 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1581 =item E<lt>B<Metric> I<Name>E<gt>
1583 These blocks add a new metric conversion to the internal table. I<Name>, the
1584 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1588 =item B<Type> I<Type>
1590 Type to map this metric to. Required.
1592 =item B<TypeInstance> I<Instance>
1594 Type-instance to use. Optional.
1596 =item B<DataSource> I<Name>
1598 Data source to map this metric to. If the configured type has exactly one data
1599 source, this is optional. Otherwise the option is required.
1605 =head2 Plugin C<hddtemp>
1607 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1608 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1609 default values, see below. C<hddtemp> has to be running to work correctly. If
1610 C<hddtemp> is not running timeouts may appear which may interfere with other
1613 The B<hddtemp> homepage can be found at
1614 L<http://www.guzu.net/linux/hddtemp.php>.
1618 =item B<Host> I<Hostname>
1620 Hostname to connect to. Defaults to B<127.0.0.1>.
1622 =item B<Port> I<Port>
1624 TCP-Port to connect to. Defaults to B<7634>.
1628 =head2 Plugin C<interface>
1632 =item B<Interface> I<Interface>
1634 Select this interface. By default these interfaces will then be collected. For
1635 a more detailed description see B<IgnoreSelected> below.
1637 =item B<IgnoreSelected> I<true>|I<false>
1639 If no configuration if given, the B<traffic>-plugin will collect data from
1640 all interfaces. This may not be practical, especially for loopback- and
1641 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1642 interfaces you're interested in. Sometimes, however, it's easier/preferred
1643 to collect all interfaces I<except> a few ones. This option enables you to
1644 do that: By setting B<IgnoreSelected> to I<true> the effect of
1645 B<Interface> is inverted: All selected interfaces are ignored and all
1646 other interfaces are collected.
1650 =head2 Plugin C<ipmi>
1654 =item B<Sensor> I<Sensor>
1656 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1658 =item B<IgnoreSelected> I<true>|I<false>
1660 If no configuration if given, the B<ipmi> plugin will collect data from all
1661 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1662 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1663 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1664 all other sensors are collected.
1666 =item B<NotifySensorAdd> I<true>|I<false>
1668 If a sensor appears after initialization time of a minute a notification
1671 =item B<NotifySensorRemove> I<true>|I<false>
1673 If a sensor disappears a notification is sent.
1675 =item B<NotifySensorNotPresent> I<true>|I<false>
1677 If you have for example dual power supply and one of them is (un)plugged then
1678 a notification is sent.
1682 =head2 Plugin C<iptables>
1686 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1688 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1689 will collect the counters of all rules which have a comment-match. The comment
1690 is then used as type-instance.
1692 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1693 the I<n>th rule will be collected. Again, the comment (or the number) will be
1694 used as the type-instance.
1696 If I<Name> is supplied, it will be used as the type-instance instead of the
1697 comment or the number.
1701 =head2 Plugin C<irq>
1707 Select this irq. By default these irqs will then be collected. For a more
1708 detailed description see B<IgnoreSelected> below.
1710 =item B<IgnoreSelected> I<true>|I<false>
1712 If no configuration if given, the B<irq>-plugin will collect data from all
1713 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1714 can use the B<Irq>-option to pick the interrupt you're interested in.
1715 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1716 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1717 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1718 and all other interrupts are collected.
1722 =head2 Plugin C<java>
1724 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1725 This section only discusses the syntax and semantic of the configuration
1726 options. For more in-depth information on the I<Java> plugin, please read
1727 L<collectd-java(5)>.
1732 JVMArg "-verbose:jni"
1733 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1734 LoadPlugin "org.collectd.java.Foobar"
1735 <Plugin "org.collectd.java.Foobar">
1736 # To be parsed by the plugin
1740 Available configuration options:
1744 =item B<JVMArg> I<Argument>
1746 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1747 exactly the way the arguments to the I<java> binary on the command line work.
1748 Execute C<javaE<nbsp>--help> for details.
1750 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1751 any other options! When another option is found, the JVM will be started and
1752 later options will have to be ignored!
1754 =item B<LoadPlugin> I<JavaClass>
1756 Instantiates a new I<JavaClass> object. The constructor of this object very
1757 likely then registers one or more callback methods with the server.
1759 See L<collectd-java(5)> for details.
1761 When the first such option is found, the virtual machine (JVM) is created. This
1762 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1763 B<LoadPlugin> options!
1765 =item B<Plugin> I<Name>
1767 The entire block is passed to the Java plugin as an
1768 I<org.collectd.api.OConfigItem> object.
1770 For this to work, the plugin has to register a configuration callback first,
1771 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1772 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1773 depends on the (Java) plugin registering the callback and is completely
1774 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1778 =head2 Plugin C<libvirt>
1780 This plugin allows CPU, disk and network load to be collected for virtualized
1781 guests on the machine. This means that these characteristics can be collected
1782 for guest systems without installing any software on them - collectd only runs
1783 on the hosting system. The statistics are collected through libvirt
1784 (L<http://libvirt.org/>).
1786 Only I<Connection> is required.
1790 =item B<Connection> I<uri>
1792 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1794 Connection "xen:///"
1796 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1798 =item B<RefreshInterval> I<seconds>
1800 Refresh the list of domains and devices every I<seconds>. The default is 60
1801 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1802 the list of domains and devices to be refreshed on every iteration.
1804 Refreshing the devices in particular is quite a costly operation, so if your
1805 virtualization setup is static you might consider increasing this. If this
1806 option is set to 0, refreshing is disabled completely.
1808 =item B<Domain> I<name>
1810 =item B<BlockDevice> I<name:dev>
1812 =item B<InterfaceDevice> I<name:dev>
1814 =item B<IgnoreSelected> I<true>|I<false>
1816 Select which domains and devices are collected.
1818 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1819 disk/network devices are collected.
1821 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1822 domains and disk/network devices are ignored, while the rest are collected.
1824 The domain name and device names may use a regular expression, if the name is
1825 surrounded by I</.../> and collectd was compiled with support for regexps.
1827 The default is to collect statistics for all domains and all their devices.
1831 BlockDevice "/:hdb/"
1832 IgnoreSelected "true"
1834 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1837 =item B<HostnameFormat> B<name|uuid|hostname|...>
1839 When the libvirt plugin logs data, it sets the hostname of the collected data
1840 according to this setting. The default is to use the guest name as provided by
1841 the hypervisor, which is equal to setting B<name>.
1843 B<uuid> means use the guest's UUID. This is useful if you want to track the
1844 same guest across migrations.
1846 B<hostname> means to use the global B<Hostname> setting, which is probably not
1847 useful on its own because all guests will appear to have the same name.
1849 You can also specify combinations of these fields. For example B<name uuid>
1850 means to concatenate the guest name and UUID (with a literal colon character
1851 between, thus I<"foo:1234-1234-1234-1234">).
1853 =item B<InterfaceFormat> B<name>|B<address>
1855 When the libvirt plugin logs interface data, it sets the name of the collected
1856 data according to this setting. The default is to use the path as provided by
1857 the hypervisor (the "dev" property of the target node), which is equal to
1860 B<address> means use the interface's mac address. This is useful since the
1861 interface path might change between reboots of a guest or across migrations.
1865 =head2 Plugin C<logfile>
1869 =item B<LogLevel> B<debug|info|notice|warning|err>
1871 Sets the log-level. If, for example, set to B<notice>, then all events with
1872 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1874 Please note that B<debug> is only available if collectd has been compiled with
1877 =item B<File> I<File>
1879 Sets the file to write log messages to. The special strings B<stdout> and
1880 B<stderr> can be used to write to the standard output and standard error
1881 channels, respectively. This, of course, only makes much sense when I<collectd>
1882 is running in foreground- or non-daemon-mode.
1884 =item B<Timestamp> B<true>|B<false>
1886 Prefix all lines printed by the current time. Defaults to B<true>.
1888 =item B<PrintSeverity> B<true>|B<false>
1890 When enabled, all lines are prefixed by the severity of the log message, for
1891 example "warning". Defaults to B<false>.
1895 B<Note>: There is no need to notify the daemon after moving or removing the
1896 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1897 for each line it writes.
1899 =head2 Plugin C<lpar>
1901 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
1902 virtualization technique for IBM POWER processors. It takes into account CPU
1903 time stolen from or donated to a partition, in addition to the usual user,
1904 system, I/O statistics.
1906 The following configuration options are available:
1910 =item B<CpuPoolStats> B<false>|B<true>
1912 When enabled, statistics about the processor pool are read, too. The partition
1913 needs to have pool authority in order to be able to acquire this information.
1916 =item B<ReportBySerial> B<false>|B<true>
1918 If enabled, the serial of the physical machine the partition is currently
1919 running on is reported as I<hostname> and the logical hostname of the machine
1920 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
1921 used (just like other plugins) and the I<plugin instance> will be empty.
1926 =head2 Plugin C<mbmon>
1928 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
1930 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
1931 B<Host> and B<Port> options can be used to change these values, see below.
1932 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
1933 timeouts may appear which may interfere with other statistics..
1935 C<mbmon> must be run with the -r option ("print TAG and Value format");
1936 Debian's F</etc/init.d/mbmon> script already does this, other people
1937 will need to ensure that this is the case.
1941 =item B<Host> I<Hostname>
1943 Hostname to connect to. Defaults to B<127.0.0.1>.
1945 =item B<Port> I<Port>
1947 TCP-Port to connect to. Defaults to B<411>.
1953 The C<md plugin> collects information from Linux Software-RAID devices (md).
1955 All reported values are of the type C<md_disks>. Reported type instances are
1956 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
1957 I<missing> (physically absent) disks.
1961 =item B<Device> I<Device>
1963 Select md devices based on device name. The I<device name> is the basename of
1964 the device, i.e. the name of the block device without the leading C</dev/>.
1965 See B<IgnoreSelected> for more details.
1967 =item B<IgnoreSelected> B<true>|B<false>
1969 Invert device selection: If set to B<true>, all md devices B<except> those
1970 listed using B<Device> are collected. If B<false> (the default), only those
1971 listed are collected. If no configuration is given, the B<md> plugin will
1972 collect data from all md devices.
1976 =head2 Plugin C<memcachec>
1978 The C<memcachec plugin> connects to a memcached server, queries one or more
1979 given I<pages> and parses the returned data according to user specification.
1980 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
1983 In order to talk to the memcached server, this plugin uses the I<libmemcached>
1984 library. Please note that there is another library with a very similar name,
1985 libmemcache (notice the missing `d'), which is not applicable.
1987 Synopsis of the configuration:
1989 <Plugin "memcachec">
1990 <Page "plugin_instance">
1994 Regex "(\\d+) bytes sent"
1997 Instance "type_instance"
2002 The configuration options are:
2006 =item E<lt>B<Page> I<Name>E<gt>
2008 Each B<Page> block defines one I<page> to be queried from the memcached server.
2009 The block requires one string argument which is used as I<plugin instance>.
2011 =item B<Server> I<Address>
2013 Sets the server address to connect to when querying the page. Must be inside a
2018 When connected to the memcached server, asks for the page I<Key>.
2020 =item E<lt>B<Match>E<gt>
2022 Match blocks define which strings to look for and how matches substrings are
2023 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2027 =head2 Plugin C<memcached>
2029 The C<memcached plugin> connects to a memcached server and queries statistics
2030 about cache utilization, memory and bandwidth used.
2031 L<http://www.danga.com/memcached/>
2035 =item B<Host> I<Hostname>
2037 Hostname to connect to. Defaults to B<127.0.0.1>.
2039 =item B<Port> I<Port>
2041 TCP-Port to connect to. Defaults to B<11211>.
2045 =head2 Plugin C<modbus>
2047 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2048 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2049 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2050 values (two registers interpreted as IEEE floats in big endian notation).
2054 <Data "voltage-input-1">
2061 <Data "voltage-input-2">
2068 <Host "modbus.example.com">
2069 Address "192.168.0.42"
2074 Instance "power-supply"
2075 Collect "voltage-input-1"
2076 Collect "voltage-input-2"
2082 =item E<lt>B<Data> I<Name>E<gt> blocks
2084 Data blocks define a mapping between register numbers and the "types" used by
2087 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2091 =item B<RegisterBase> I<Number>
2093 Configures the base register to read from the device. If the option
2094 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2095 register will be read (the register number is increased by one).
2097 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2099 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2100 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2101 combined into one value. Defaults to B<Uint16>.
2103 =item B<Type> I<Type>
2105 Specifies the "type" (data set) to use when dispatching the value to
2106 I<collectd>. Currently, only data sets with exactly one data source are
2109 =item B<Instance> I<Instance>
2111 Sets the type instance to use when dispatching the value to I<collectd>. If
2112 unset, an empty string (no type instance) is used.
2116 =item E<lt>B<Host> I<Name>E<gt> blocks
2118 Host blocks are used to specify to which hosts to connect and what data to read
2119 from their "slaves". The string argument I<Name> is used as hostname when
2120 dispatching the values to I<collectd>.
2122 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2126 =item B<Address> I<Hostname>
2128 Specifies the node name (the actual network address) used to connect to the
2129 host. This may be an IP address or a hostname. Please note that the used
2130 I<libmodbus> library only supports IPv4 at the moment.
2132 =item B<Port> I<Service>
2134 Specifies the port used to connect to the host. The port can either be given as
2135 a number or as a service name. Please note that the I<Service> argument must be
2136 a string, even if ports are given in their numerical form. Defaults to "502".
2138 =item B<Interval> I<Interval>
2140 Sets the interval (in seconds) in which the values will be collected from this
2141 host. By default the global B<Interval> setting will be used.
2143 =item E<lt>B<Slave> I<ID>E<gt>
2145 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2146 is used to specify which device should be addressed. For each device you want
2147 to query, one B<Slave> block must be given.
2149 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2153 =item B<Instance> I<Instance>
2155 Specify the plugin instance to use when dispatching the values to I<collectd>.
2156 By default "slave_I<ID>" is used.
2158 =item B<Collect> I<DataName>
2160 Specifies which data to retrieve from the device. I<DataName> must be the same
2161 string as the I<Name> argument passed to a B<Data> block. You can specify this
2162 option multiple times to collect more than one value from a slave. At least one
2163 B<Collect> option is mandatory.
2171 =head2 Plugin C<mysql>
2173 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2174 one or more databases when started and keeps the connection up as long as
2175 possible. When the connection is interrupted for whatever reason it will try
2176 to re-connect. The plugin will complain loudly in case anything goes wrong.
2178 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2179 and collects information about MySQL network traffic, executed statements,
2180 requests, the query cache and threads by evaluating the
2181 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2182 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2183 Status Variables> for an explanation of these values.
2185 Optionally, master and slave statistics may be collected in a MySQL
2186 replication setup. In that case, information about the synchronization state
2187 of the nodes are collected by evaluating the C<Position> return value of the
2188 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2189 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2190 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2191 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2192 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2207 Socket "/var/run/mysql/mysqld.sock"
2209 SlaveNotifications true
2213 A B<Database> block defines one connection to a MySQL database. It accepts a
2214 single argument which specifies the name of the database. None of the other
2215 options are required. MySQL will use default values as documented in the
2216 section "mysql_real_connect()" in the B<MySQL reference manual>.
2220 =item B<Host> I<Hostname>
2222 Hostname of the database server. Defaults to B<localhost>.
2224 =item B<User> I<Username>
2226 Username to use when connecting to the database. The user does not have to be
2227 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2228 unless you want to collectd replication statistics (see B<MasterStats> and
2229 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2230 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2232 =item B<Password> I<Password>
2234 Password needed to log into the database.
2236 =item B<Database> I<Database>
2238 Select this database. Defaults to I<no database> which is a perfectly reasonable
2239 option for what this plugin does.
2241 =item B<Port> I<Port>
2243 TCP-port to connect to. The port must be specified in its numeric form, but it
2244 must be passed as a string nonetheless. For example:
2248 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2249 See the documentation for the C<mysql_real_connect> function for details.
2251 =item B<Socket> I<Socket>
2253 Specifies the path to the UNIX domain socket of the MySQL server. This option
2254 only has any effect, if B<Host> is set to B<localhost> (the default).
2255 Otherwise, use the B<Port> option above. See the documentation for the
2256 C<mysql_real_connect> function for details.
2258 =item B<MasterStats> I<true|false>
2260 =item B<SlaveStats> I<true|false>
2262 Enable the collection of master / slave statistics in a replication setup. In
2263 order to be able to get access to these statistics, the user needs special
2264 privileges. See the B<User> documentation above.
2266 =item B<SlaveNotifications> I<true|false>
2268 If enabled, the plugin sends a notification if the replication slave I/O and /
2269 or SQL threads are not running.
2273 =head2 Plugin C<netapp>
2275 The netapp plugin can collect various performance and capacity information
2276 from a NetApp filer using the NetApp API.
2278 Please note that NetApp has a wide line of products and a lot of different
2279 software versions for each of these products. This plugin was developed for a
2280 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2281 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2282 model and software version but it is very hard to test this.
2283 If you have used this plugin with other models and/or software version, feel
2284 free to send us a mail to tell us about the results, even if it's just a short
2287 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2288 basic authentication.
2290 B<Do not use a regular user for this!> Create a special collectd user with just
2291 the minimum of capabilities needed. The user only needs the "login-http-admin"
2292 capability as well as a few more depending on which data will be collected.
2293 Required capabilities are documented below.
2298 <Host "netapp1.example.com">
2322 IgnoreSelectedIO false
2324 IgnoreSelectedOps false
2325 GetLatency "volume0"
2326 IgnoreSelectedLatency false
2333 IgnoreSelectedCapacity false
2336 IgnoreSelectedSnapshot false
2349 The netapp plugin accepts the following configuration options:
2353 =item B<Host> I<Name>
2355 A host block defines one NetApp filer. It will appear in collectd with the name
2356 you specify here which does not have to be its real name nor its hostname.
2358 =item B<Protocol> B<httpd>|B<http>
2360 The protocol collectd will use to query this host.
2368 Valid options: http, https
2370 =item B<Address> I<Address>
2372 The hostname or IP address of the host.
2378 Default: The "host" block's name.
2380 =item B<Port> I<Port>
2382 The TCP port to connect to on the host.
2388 Default: 80 for protocol "http", 443 for protocol "https"
2390 =item B<User> I<User>
2392 =item B<Password> I<Password>
2394 The username and password to use to login to the NetApp.
2400 =item B<Interval> I<Interval>
2406 The following options decide what kind of data will be collected. You can
2407 either use them as a block and fine tune various parameters inside this block,
2408 use them as a single statement to just accept all default values, or omit it to
2409 not collect any data.
2411 The following options are valid inside all blocks:
2415 =item B<Interval> I<Seconds>
2417 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2418 host specific setting.
2422 =head3 The System block
2424 This will collect various performance data about the whole system.
2426 B<Note:> To get this data the collectd user needs the
2427 "api-perf-object-get-instances" capability.
2431 =item B<Interval> I<Seconds>
2433 Collect disk statistics every I<Seconds> seconds.
2435 =item B<GetCPULoad> B<true>|B<false>
2437 If you set this option to true the current CPU usage will be read. This will be
2438 the average usage between all CPUs in your NetApp without any information about
2441 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2442 returns in the "CPU" field.
2450 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2452 =item B<GetInterfaces> B<true>|B<false>
2454 If you set this option to true the current traffic of the network interfaces
2455 will be read. This will be the total traffic over all interfaces of your NetApp
2456 without any information about individual interfaces.
2458 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2459 in the "Net kB/s" field.
2469 Result: One value list of type "if_octects".
2471 =item B<GetDiskIO> B<true>|B<false>
2473 If you set this option to true the current IO throughput will be read. This
2474 will be the total IO of your NetApp without any information about individual
2475 disks, volumes or aggregates.
2477 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2478 in the "DiskE<nbsp>kB/s" field.
2486 Result: One value list of type "disk_octets".
2488 =item B<GetDiskOps> B<true>|B<false>
2490 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2491 iSCSI, etc. operations will be read. This will be the total number of
2492 operations on your NetApp without any information about individual volumes or
2495 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2496 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2504 Result: A variable number of value lists of type "disk_ops_complex". Each type
2505 of operation will result in one value list with the name of the operation as
2510 =head3 The WAFL block
2512 This will collect various performance data about the WAFL file system. At the
2513 moment this just means cache performance.
2515 B<Note:> To get this data the collectd user needs the
2516 "api-perf-object-get-instances" capability.
2518 B<Note:> The interface to get these values is classified as "Diagnostics" by
2519 NetApp. This means that it is not guaranteed to be stable even between minor
2524 =item B<Interval> I<Seconds>
2526 Collect disk statistics every I<Seconds> seconds.
2528 =item B<GetNameCache> B<true>|B<false>
2536 Result: One value list of type "cache_ratio" and type instance
2539 =item B<GetDirCache> B<true>|B<false>
2547 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2549 =item B<GetInodeCache> B<true>|B<false>
2557 Result: One value list of type "cache_ratio" and type instance
2560 =item B<GetBufferCache> B<true>|B<false>
2562 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2563 in the "Cache hit" field.
2571 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2575 =head3 The Disks block
2577 This will collect performance data about the individual disks in the NetApp.
2579 B<Note:> To get this data the collectd user needs the
2580 "api-perf-object-get-instances" capability.
2584 =item B<Interval> I<Seconds>
2586 Collect disk statistics every I<Seconds> seconds.
2588 =item B<GetBusy> B<true>|B<false>
2590 If you set this option to true the busy time of all disks will be calculated
2591 and the value of the busiest disk in the system will be written.
2593 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2594 in the "Disk util" field. Probably.
2602 Result: One value list of type "percent" and type instance "disk_busy".
2606 =head3 The VolumePerf block
2608 This will collect various performance data about the individual volumes.
2610 You can select which data to collect about which volume using the following
2611 options. They follow the standard ignorelist semantic.
2613 B<Note:> To get this data the collectd user needs the
2614 I<api-perf-object-get-instances> capability.
2618 =item B<Interval> I<Seconds>
2620 Collect volume performance data every I<Seconds> seconds.
2622 =item B<GetIO> I<Volume>
2624 =item B<GetOps> I<Volume>
2626 =item B<GetLatency> I<Volume>
2628 Select the given volume for IO, operations or latency statistics collection.
2629 The argument is the name of the volume without the C</vol/> prefix.
2631 Since the standard ignorelist functionality is used here, you can use a string
2632 starting and ending with a slash to specify regular expression matching: To
2633 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2636 GetIO "/^vol[027]$/"
2638 If no regular expression is specified, an exact match is required. Both,
2639 regular and exact matching are case sensitive.
2641 If no volume was specified at all for either of the three options, that data
2642 will be collected for all available volumes.
2644 =item B<IgnoreSelectedIO> B<true>|B<false>
2646 =item B<IgnoreSelectedOps> B<true>|B<false>
2648 =item B<IgnoreSelectedLatency> B<true>|B<false>
2650 When set to B<true>, the volumes selected for IO, operations or latency
2651 statistics collection will be ignored and the data will be collected for all
2654 When set to B<false>, data will only be collected for the specified volumes and
2655 all other volumes will be ignored.
2657 If no volumes have been specified with the above B<Get*> options, all volumes
2658 will be collected regardless of the B<IgnoreSelected*> option.
2660 Defaults to B<false>
2664 =head3 The VolumeUsage block
2666 This will collect capacity data about the individual volumes.
2668 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2673 =item B<Interval> I<Seconds>
2675 Collect volume usage statistics every I<Seconds> seconds.
2677 =item B<GetCapacity> I<VolumeName>
2679 The current capacity of the volume will be collected. This will result in two
2680 to four value lists, depending on the configuration of the volume. All data
2681 sources are of type "df_complex" with the name of the volume as
2684 There will be type_instances "used" and "free" for the number of used and
2685 available bytes on the volume. If the volume has some space reserved for
2686 snapshots, a type_instance "snap_reserved" will be available. If the volume
2687 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2688 number of bytes saved by the SIS feature.
2690 B<Note:> The current NetApp API has a bug that results in this value being
2691 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2692 number which works most of the time. If you see strange values here, bug
2693 NetApp support to fix this.
2695 Repeat this option to specify multiple volumes.
2697 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2699 Specify whether to collect only the volumes selected by the B<GetCapacity>
2700 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2701 B<false>. However, if no B<GetCapacity> option is specified at all, all
2702 capacities will be selected anyway.
2704 =item B<GetSnapshot> I<VolumeName>
2706 Select volumes from which to collect snapshot information.
2708 Usually, the space used for snapshots is included in the space reported as
2709 "used". If snapshot information is collected as well, the space used for
2710 snapshots is subtracted from the used space.
2712 To make things even more interesting, it is possible to reserve space to be
2713 used for snapshots. If the space required for snapshots is less than that
2714 reserved space, there is "reserved free" and "reserved used" space in addition
2715 to "free" and "used". If the space required for snapshots exceeds the reserved
2716 space, that part allocated in the normal space is subtracted from the "used"
2719 Repeat this option to specify multiple volumes.
2721 =item B<IgnoreSelectedSnapshot>
2723 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2724 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2725 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2726 capacities will be selected anyway.
2730 =head2 Plugin C<netlink>
2732 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2733 statistics of various interface and routing aspects.
2737 =item B<Interface> I<Interface>
2739 =item B<VerboseInterface> I<Interface>
2741 Instruct the plugin to collect interface statistics. This is basically the same
2742 as the statistics provided by the C<interface> plugin (see above) but
2743 potentially much more detailed.
2745 When configuring with B<Interface> only the basic statistics will be collected,
2746 namely octets, packets, and errors. These statistics are collected by
2747 the C<interface> plugin, too, so using both at the same time is no benefit.
2749 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2750 so that no data needs to be collected twice if you use the C<interface> plugin.
2751 This includes dropped packets, received multicast packets, collisions and a
2752 whole zoo of differentiated RX and TX errors. You can try the following command
2753 to get an idea of what awaits you:
2757 If I<Interface> is B<All>, all interfaces will be selected.
2759 =item B<QDisc> I<Interface> [I<QDisc>]
2761 =item B<Class> I<Interface> [I<Class>]
2763 =item B<Filter> I<Interface> [I<Filter>]
2765 Collect the octets and packets that pass a certain qdisc, class or filter.
2767 QDiscs and classes are identified by their type and handle (or classid).
2768 Filters don't necessarily have a handle, therefore the parent's handle is used.
2769 The notation used in collectd differs from that used in tc(1) in that it
2770 doesn't skip the major or minor number if it's zero and doesn't print special
2771 ids by their name. So, for example, a qdisc may be identified by
2772 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2773 thus not displayed by tc(1).
2775 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2776 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2777 associated with that interface will be collected.
2779 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2780 used. This may lead to problems when more than one filter is attached to a
2781 qdisc or class. This isn't nice, but we don't know how this could be done any
2782 better. If you have a idea, please don't hesitate to tell us.
2784 As with the B<Interface> option you can specify B<All> as the interface,
2785 meaning all interfaces.
2787 Here are some examples to help you understand the above text more easily:
2790 VerboseInterface "All"
2791 QDisc "eth0" "pfifo_fast-1:0"
2793 Class "ppp0" "htb-1:10"
2794 Filter "ppp0" "u32-1:0"
2797 =item B<IgnoreSelected>
2799 The behavior is the same as with all other similar plugins: If nothing is
2800 selected at all, everything is collected. If some things are selected using the
2801 options described above, only these statistics are collected. If you set
2802 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2803 specified statistics will not be collected.
2807 =head2 Plugin C<network>
2809 The Network plugin sends data to a remote instance of collectd, receives data
2810 from a remote instance, or both at the same time. Data which has been received
2811 from the network is usually not transmitted again, but this can be activated, see
2812 the B<Forward> option below.
2814 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2815 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2817 Both, B<Server> and B<Listen> can be used as single option or as block. When
2818 used as block, given options are valid for this socket only. The following
2819 example will export the metrics twice: Once to an "internal" server (without
2820 encryption and signing) and one to an external server (with cryptographic
2824 # Export to an internal server
2825 # (demonstrates usage without additional options)
2826 Server "collectd.internal.tld"
2828 # Export to an external server
2829 # (demonstrates usage with signature options)
2830 <Server "collectd.external.tld">
2831 SecurityLevel "sign"
2832 Username "myhostname"
2839 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2841 The B<Server> statement/block sets the server to send datagrams to. The
2842 statement may occur multiple times to send each datagram to multiple
2845 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2846 optional second argument specifies a port number or a service name. If not
2847 given, the default, B<25826>, is used.
2849 The following options are recognized within B<Server> blocks:
2853 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2855 Set the security you require for network communication. When the security level
2856 has been set to B<Encrypt>, data sent over the network will be encrypted using
2857 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2858 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2859 authentication code. When set to B<None>, data is sent without any security.
2861 This feature is only available if the I<network> plugin was linked with
2864 =item B<Username> I<Username>
2866 Sets the username to transmit. This is used by the server to lookup the
2867 password. See B<AuthFile> below. All security levels except B<None> require
2870 This feature is only available if the I<network> plugin was linked with
2873 =item B<Password> I<Password>
2875 Sets a password (shared secret) for this socket. All security levels except
2876 B<None> require this setting.
2878 This feature is only available if the I<network> plugin was linked with
2881 =item B<Interface> I<Interface name>
2883 Set the outgoing interface for IP packets. This applies at least
2884 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2885 undefined or a non-existent interface name is specified, the default
2886 behavior is to let the kernel choose the appropriate interface. Be warned
2887 that the manual selection of an interface for unicast traffic is only
2888 necessary in rare cases.
2892 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2894 The B<Listen> statement sets the interfaces to bind to. When multiple
2895 statements are found the daemon will bind to multiple interfaces.
2897 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2898 the argument is a multicast address the daemon will join that multicast group.
2899 The optional second argument specifies a port number or a service name. If not
2900 given, the default, B<25826>, is used.
2902 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
2906 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2908 Set the security you require for network communication. When the security level
2909 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
2910 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
2911 signed and encrypted data is accepted. When set to B<None>, all data will be
2912 accepted. If an B<AuthFile> option was given (see below), encrypted data is
2913 decrypted if possible.
2915 This feature is only available if the I<network> plugin was linked with
2918 =item B<AuthFile> I<Filename>
2920 Sets a file in which usernames are mapped to passwords. These passwords are
2921 used to verify signatures and to decrypt encrypted network packets. If
2922 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
2923 verified and encrypted packets are decrypted. Otherwise, signed data is
2924 accepted without checking the signature and encrypted data cannot be decrypted.
2925 For the other security levels this option is mandatory.
2927 The file format is very simple: Each line consists of a username followed by a
2928 colon and any number of spaces followed by the password. To demonstrate, an
2929 example file could look like this:
2934 Each time a packet is received, the modification time of the file is checked
2935 using L<stat(2)>. If the file has been changed, the contents is re-read. While
2936 the file is being read, it is locked using L<fcntl(2)>.
2938 =item B<Interface> I<Interface name>
2940 Set the incoming interface for IP packets explicitly. This applies at least
2941 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2942 undefined or a non-existent interface name is specified, the default
2943 behavior is, to let the kernel choose the appropriate interface. Thus incoming
2944 traffic gets only accepted, if it arrives on the given interface.
2948 =item B<TimeToLive> I<1-255>
2950 Set the time-to-live of sent packets. This applies to all, unicast and
2951 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
2952 That means that multicast packets will be sent with a TTL of C<1> (one) on most
2955 =item B<MaxPacketSize> I<1024-65535>
2957 Set the maximum size for datagrams received over the network. Packets larger
2958 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
2959 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
2962 On the server side, this limit should be set to the largest value used on
2963 I<any> client. Likewise, the value on the client must not be larger than the
2964 value on the server, or data will be lost.
2966 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
2967 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
2968 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
2971 =item B<Forward> I<true|false>
2973 If set to I<true>, write packets that were received via the network plugin to
2974 the sending sockets. This should only be activated when the B<Listen>- and
2975 B<Server>-statements differ. Otherwise packets may be send multiple times to
2976 the same multicast group. While this results in more network traffic than
2977 necessary it's not a huge problem since the plugin has a duplicate detection,
2978 so the values will not loop.
2980 =item B<ReportStats> B<true>|B<false>
2982 The network plugin cannot only receive and send statistics, it can also create
2983 statistics about itself. Collected data included the number of received and
2984 sent octets and packets, the length of the receive queue and the number of
2985 values handled. When set to B<true>, the I<Network plugin> will make these
2986 statistics available. Defaults to B<false>.
2990 =head2 Plugin C<nginx>
2992 This plugin collects the number of connections and requests handled by the
2993 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
2994 queries the page provided by the C<ngx_http_stub_status_module> module, which
2995 isn't compiled by default. Please refer to
2996 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
2997 how to compile and configure nginx and this module.
2999 The following options are accepted by the C<nginx plugin>:
3003 =item B<URL> I<http://host/nginx_status>
3005 Sets the URL of the C<ngx_http_stub_status_module> output.
3007 =item B<User> I<Username>
3009 Optional user name needed for authentication.
3011 =item B<Password> I<Password>
3013 Optional password needed for authentication.
3015 =item B<VerifyPeer> B<true|false>
3017 Enable or disable peer SSL certificate verification. See
3018 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3020 =item B<VerifyHost> B<true|false>
3022 Enable or disable peer host name verification. If enabled, the plugin checks
3023 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3024 certificate matches the host name provided by the B<URL> option. If this
3025 identity check fails, the connection is aborted. Obviously, only works when
3026 connecting to a SSL enabled server. Enabled by default.
3028 =item B<CACert> I<File>
3030 File that holds one or more SSL certificates. If you want to use HTTPS you will
3031 possibly need this option. What CA certificates come bundled with C<libcurl>
3032 and are checked by default depends on the distribution you use.
3036 =head2 Plugin C<notify_desktop>
3038 This plugin sends a desktop notification to a notification daemon, as defined
3039 in the Desktop Notification Specification. To actually display the
3040 notifications, B<notification-daemon> is required and B<collectd> has to be
3041 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3042 environment variables have to be set correctly) and the D-Bus message bus.
3044 The Desktop Notification Specification can be found at
3045 L<http://www.galago-project.org/specs/notification/>.
3049 =item B<OkayTimeout> I<timeout>
3051 =item B<WarningTimeout> I<timeout>
3053 =item B<FailureTimeout> I<timeout>
3055 Set the I<timeout>, in milliseconds, after which to expire the notification
3056 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3057 been specified, the displayed notification will not be closed at all - the
3058 user has to do so herself. These options default to 5000. If a negative number
3059 has been specified, the default is used as well.
3063 =head2 Plugin C<notify_email>
3065 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3066 configured email address.
3068 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3070 Available configuration options:
3074 =item B<From> I<Address>
3076 Email address from which the emails should appear to come from.
3078 Default: C<root@localhost>
3080 =item B<Recipient> I<Address>
3082 Configures the email address(es) to which the notifications should be mailed.
3083 May be repeated to send notifications to multiple addresses.
3085 At least one B<Recipient> must be present for the plugin to work correctly.
3087 =item B<SMTPServer> I<Hostname>
3089 Hostname of the SMTP server to connect to.
3091 Default: C<localhost>
3093 =item B<SMTPPort> I<Port>
3095 TCP port to connect to.
3099 =item B<SMTPUser> I<Username>
3101 Username for ASMTP authentication. Optional.
3103 =item B<SMTPPassword> I<Password>
3105 Password for ASMTP authentication. Optional.
3107 =item B<Subject> I<Subject>
3109 Subject-template to use when sending emails. There must be exactly two
3110 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3111 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3114 Default: C<Collectd notify: %s@%s>
3118 =head2 Plugin C<ntpd>
3122 =item B<Host> I<Hostname>
3124 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3126 =item B<Port> I<Port>
3128 UDP-Port to connect to. Defaults to B<123>.
3130 =item B<ReverseLookups> B<true>|B<false>
3132 Sets whether or not to perform reverse lookups on peers. Since the name or
3133 IP-address may be used in a filename it is recommended to disable reverse
3134 lookups. The default is to do reverse lookups to preserve backwards
3135 compatibility, though.
3139 =head2 Plugin C<nut>
3143 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3145 Add a UPS to collect data from. The format is identical to the one accepted by
3150 =head2 Plugin C<olsrd>
3152 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3153 the Optimized Link State Routing daemon and reads information about the current
3154 state of the meshed network.
3156 The following configuration options are understood:
3160 =item B<Host> I<Host>
3162 Connect to I<Host>. Defaults to B<"localhost">.
3164 =item B<Port> I<Port>
3166 Specifies the port to connect to. This must be a string, even if you give the
3167 port as a number rather than a service name. Defaults to B<"2006">.
3169 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3171 Specifies what information to collect about links, i.E<nbsp>e. direct
3172 connections of the daemon queried. If set to B<No>, no information is
3173 collected. If set to B<Summary>, the number of links and the average of all
3174 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3175 If set to B<Detail> LQ and NLQ are collected per link.
3177 Defaults to B<Detail>.
3179 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3181 Specifies what information to collect about routes of the daemon queried. If
3182 set to B<No>, no information is collected. If set to B<Summary>, the number of
3183 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3184 metric and ETX are collected per route.
3186 Defaults to B<Summary>.
3188 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3190 Specifies what information to collect about the global topology. If set to
3191 B<No>, no information is collected. If set to B<Summary>, the number of links
3192 in the entire topology and the average I<link quality> (LQ) is calculated.
3193 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3195 Defaults to B<Summary>.
3199 =head2 Plugin C<onewire>
3201 B<EXPERIMENTAL!> See notes below.
3203 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3204 L<http://owfs.org/> to read sensors connected via the onewire bus.
3206 Currently only temperature sensors (sensors with the family code C<10>,
3207 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3208 would like to have included, please send a sort request to the mailing list.
3210 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3211 experimental, below.
3215 =item B<Device> I<Device>
3217 Sets the device to read the values from. This can either be a "real" hardware
3218 device, such as a serial port or an USB port, or the address of the
3219 L<owserver(1)> socket, usually B<localhost:4304>.
3221 Though the documentation claims to automatically recognize the given address
3222 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3223 with that version, the following configuration worked for us:
3226 Device "-s localhost:4304"
3229 This directive is B<required> and does not have a default value.
3231 =item B<Sensor> I<Sensor>
3233 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3234 below. Sensors are specified without the family byte at the beginning, to you'd
3235 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3238 =item B<IgnoreSelected> I<true>|I<false>
3240 If no configuration if given, the B<onewire> plugin will collect data from all
3241 sensors found. This may not be practical, especially if sensors are added and
3242 removed regularly. Sometimes, however, it's easier/preferred to collect only
3243 specific sensors or all sensors I<except> a few specified ones. This option
3244 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3245 B<Sensor> is inverted: All selected interfaces are ignored and all other
3246 interfaces are collected.
3248 =item B<Interval> I<Seconds>
3250 Sets the interval in which all sensors should be read. If not specified, the
3251 global B<Interval> setting is used.
3255 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3256 work with big setups. It works with one sensor being attached to one
3257 controller, but as soon as you throw in a couple more senors and maybe a hub
3258 or two, reading all values will take more than ten seconds (the default
3259 interval). We will probably add some separate thread for reading the sensors
3260 and some cache or something like that, but it's not done yet. We will try to
3261 maintain backwards compatibility in the future, but we can't promise. So in
3262 short: If it works for you: Great! But keep in mind that the config I<might>
3263 change, though this is unlikely. Oh, and if you want to help improving this
3264 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3266 =head2 Plugin C<openvpn>
3268 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3269 traffic statistics about connected clients.
3271 To set up OpenVPN to write to the status file periodically, use the
3272 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3273 you need to set the required format, too. This is done by setting
3274 B<--status-version> to B<2>.
3276 So, in a nutshell you need:
3278 openvpn $OTHER_OPTIONS \
3279 --status "/var/run/openvpn-status" 10 \
3286 =item B<StatusFile> I<File>
3288 Specifies the location of the status file.
3290 =item B<ImprovedNamingSchema> B<true>|B<false>
3292 When enabled, the filename of the status file will be used as plugin instance
3293 and the client's "common name" will be used as type instance. This is required
3294 when reading multiple status files. Enabling this option is recommended, but to
3295 maintain backwards compatibility this option is disabled by default.
3297 =item B<CollectCompression> B<true>|B<false>
3299 Sets whether or not statistics about the compression used by OpenVPN should be
3300 collected. This information is only available in I<single> mode. Enabled by
3303 =item B<CollectIndividualUsers> B<true>|B<false>
3305 Sets whether or not traffic information is collected for each connected client
3306 individually. If set to false, currently no traffic data is collected at all
3307 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3309 =item B<CollectUserCount> B<true>|B<false>
3311 When enabled, the number of currently connected clients or users is collected.
3312 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3313 can be configured independently from that option. Defaults to B<false>.
3317 =head2 Plugin C<oracle>
3319 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3320 Oracle® Database and lets you execute SQL statements there. It is very similar
3321 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3322 plugin's documentation above for details.
3325 <Query "out_of_stock">
3326 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3329 # InstancePrefix "foo"
3330 InstancesFrom "category"
3334 <Database "product_information">
3338 Query "out_of_stock"
3342 =head3 B<Query> blocks
3344 The Query blocks are handled identically to the Query blocks of the "dbi"
3345 plugin. Please see its documentation above for details on how to specify
3348 =head3 B<Database> blocks
3350 Database blocks define a connection to a database and which queries should be
3351 sent to that database. Each database needs a "name" as string argument in the
3352 starting tag of the block. This name will be used as "PluginInstance" in the
3353 values submitted to the daemon. Other than that, that name is not used.
3357 =item B<ConnectID> I<ID>
3359 Defines the "database alias" or "service name" to connect to. Usually, these
3360 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3362 =item B<Host> I<Host>
3364 Hostname to use when dispatching values for this database. Defaults to using
3365 the global hostname of the I<collectd> instance.
3367 =item B<Username> I<Username>
3369 Username used for authentication.
3371 =item B<Password> I<Password>
3373 Password used for authentication.
3375 =item B<Query> I<QueryName>
3377 Associates the query named I<QueryName> with this database connection. The
3378 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3379 blocks you want to refer to must be placed above the database block you want to
3384 =head2 Plugin C<perl>
3386 This plugin embeds a Perl-interpreter into collectd and provides an interface
3387 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3389 =head2 Plugin C<pinba>
3391 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3392 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3393 PHP-based webpage has been delivered, the extension will send a UDP packet
3394 containing timing information, peak memory usage and so on. The plugin will
3395 wait for such packets, parse them and account the provided information, which
3396 is then dispatched to the daemon once per interval.
3403 # Overall statistics for the website.
3405 Server "www.example.com"
3407 # Statistics for www-a only
3409 Host "www-a.example.com"
3410 Server "www.example.com"
3412 # Statistics for www-b only
3414 Host "www-b.example.com"
3415 Server "www.example.com"
3419 The plugin provides the following configuration options:
3423 =item B<Address> I<Node>
3425 Configures the address used to open a listening socket. By default, plugin will
3426 bind to the I<any> address C<::0>.
3428 =item B<Port> I<Service>
3430 Configures the port (service) to bind to. By default the default Pinba port
3431 "30002" will be used. The option accepts service names in addition to port
3432 numbers and thus requires a I<string> argument.
3434 =item E<lt>B<View> I<Name>E<gt> block
3436 The packets sent by the Pinba extension include the hostname of the server, the
3437 server name (the name of the virtual host) and the script that was executed.
3438 Using B<View> blocks it is possible to separate the data into multiple groups
3439 to get more meaningful statistics. Each packet is added to all matching groups,
3440 so that a packet may be accounted for more than once.
3444 =item B<Host> I<Host>
3446 Matches the hostname of the system the webserver / script is running on. This
3447 will contain the result of the L<gethostname(2)> system call. If not
3448 configured, all hostnames will be accepted.
3450 =item B<Server> I<Server>
3452 Matches the name of the I<virtual host>, i.e. the contents of the
3453 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3454 server names will be accepted.
3456 =item B<Script> I<Script>
3458 Matches the name of the I<script name>, i.e. the contents of the
3459 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3460 script names will be accepted.
3466 =head2 Plugin C<ping>
3468 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3469 configured hosts periodically and measures the network latency. Whenever the
3470 C<read> function of the plugin is called, it submits the average latency, the
3471 standard deviation and the drop rate for each host.
3473 Available configuration options:
3477 =item B<Host> I<IP-address>
3479 Host to ping periodically. This option may be repeated several times to ping
3482 =item B<Interval> I<Seconds>
3484 Sets the interval in which to send ICMP echo packets to the configured hosts.
3485 This is B<not> the interval in which statistics are queries from the plugin but
3486 the interval in which the hosts are "pinged". Therefore, the setting here
3487 should be smaller than or equal to the global B<Interval> setting. Fractional
3488 times, such as "1.24" are allowed.
3492 =item B<Timeout> I<Seconds>
3494 Time to wait for a response from the host to which an ICMP packet had been
3495 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3496 to be down or the packet to be dropped. This setting must be smaller than the
3497 B<Interval> setting above for the plugin to work correctly. Fractional
3498 arguments are accepted.
3502 =item B<TTL> I<0-255>
3504 Sets the Time-To-Live of generated ICMP packets.
3506 =item B<SourceAddress> I<host>
3508 Sets the source address to use. I<host> may either be a numerical network
3509 address or a network hostname.
3511 =item B<Device> I<name>
3513 Sets the outgoing network device to be used. I<name> has to specify an
3514 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3517 =item B<MaxMissed> I<Packets>
3519 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3520 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3522 Default: B<-1> (disabled)
3526 =head2 Plugin C<postgresql>
3528 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3529 keeps a persistent connection to all configured databases and tries to
3530 reconnect if the connection has been interrupted. A database is configured by
3531 specifying a B<Database> block as described below. The default statistics are
3532 collected from PostgreSQL's B<statistics collector> which thus has to be
3533 enabled for this plugin to work correctly. This should usually be the case by
3534 default. See the section "The Statistics Collector" of the B<PostgreSQL
3535 Documentation> for details.
3537 By specifying custom database queries using a B<Query> block as described
3538 below, you may collect any data that is available from some PostgreSQL
3539 database. This way, you are able to access statistics of external daemons
3540 which are available in a PostgreSQL database or use future or special
3541 statistics provided by PostgreSQL without the need to upgrade your collectd
3544 The B<PostgreSQL Documentation> manual can be found at
3545 L<http://www.postgresql.org/docs/manuals/>.
3549 Statement "SELECT magic FROM wizard WHERE host = $1;"
3553 InstancePrefix "magic"
3558 <Query rt36_tickets>
3559 Statement "SELECT COUNT(type) AS count, type \
3561 WHEN resolved = 'epoch' THEN 'open' \
3562 ELSE 'resolved' END AS type \
3563 FROM tickets) type \
3567 InstancePrefix "rt36_tickets"
3568 InstancesFrom "type"
3579 KRBSrvName "kerberos_service_name"
3585 Service "service_name"
3586 Query backend # predefined
3591 The B<Query> block defines one database query which may later be used by a
3592 database definition. It accepts a single mandatory argument which specifies
3593 the name of the query. The names of all queries have to be unique (see the
3594 B<MinVersion> and B<MaxVersion> options below for an exception to this
3595 rule). The following configuration options are available to define the query:
3597 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3598 blocks define how to handle the values returned from the query. They define
3599 which column holds which value and how to dispatch that value to the daemon.
3600 Multiple B<Result> blocks may be used to extract multiple values from a single
3605 =item B<Statement> I<sql query statement>
3607 Specify the I<sql query statement> which the plugin should execute. The string
3608 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3609 first, second, etc. parameter. The value of the parameters is specified by the
3610 B<Param> configuration option - see below for details. To include a literal
3611 B<$> character followed by a number, surround it with single quotes (B<'>).
3613 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3614 allowed. Note, however, that only a single command may be used. Semicolons are
3615 allowed as long as a single non-empty command has been specified only.
3617 The returned lines will be handled separately one after another.
3619 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3621 Specify the parameters which should be passed to the SQL query. The parameters
3622 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3623 they appear in the configuration file. The value of the parameter is
3624 determined depending on the value of the B<Param> option as follows:
3630 The configured hostname of the database connection. If a UNIX domain socket is
3631 used, the parameter expands to "localhost".
3635 The name of the database of the current connection.
3639 The username used to connect to the database.
3643 The interval with which this database is queried (as specified by the database
3644 specific or global B<Interval> options).
3648 Please note that parameters are only supported by PostgreSQL's protocol
3649 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3651 =item B<Type> I<type>
3653 The I<type> name to be used when dispatching the values. The type describes
3654 how to handle the data and where to store it. See L<types.db(5)> for more
3655 details on types and their configuration. The number and type of values (as
3656 selected by the B<ValuesFrom> option) has to match the type of the given name.
3658 This option is required inside a B<Result> block.
3660 =item B<InstancePrefix> I<prefix>
3662 =item B<InstancesFrom> I<column0> [I<column1> ...]
3664 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3665 B<InstancePrefix> defines a static prefix that will be prepended to all type
3666 instances. B<InstancesFrom> defines the column names whose values will be used
3667 to create the type instance. Multiple values will be joined together using the
3668 hyphen (C<->) as separation character.
3670 The plugin itself does not check whether or not all built instances are
3671 different. It is your responsibility to assure that each is unique.
3673 Both options are optional. If none is specified, the type instance will be
3676 =item B<ValuesFrom> I<column0> [I<column1> ...]
3678 Names the columns whose content is used as the actual data for the data sets
3679 that are dispatched to the daemon. How many such columns you need is
3680 determined by the B<Type> setting as explained above. If you specify too many
3681 or not enough columns, the plugin will complain about that and no data will be
3682 submitted to the daemon.
3684 The actual data type, as seen by PostgreSQL, is not that important as long as
3685 it represents numbers. The plugin will automatically cast the values to the
3686 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3687 L<strtod(3)> functions, so anything supported by those functions is supported
3688 by the plugin as well.
3690 This option is required inside a B<Result> block and may be specified multiple
3691 times. If multiple B<ValuesFrom> options are specified, the columns are read
3694 =item B<MinVersion> I<version>
3696 =item B<MaxVersion> I<version>
3698 Specify the minimum or maximum version of PostgreSQL that this query should be
3699 used with. Some statistics might only be available with certain versions of
3700 PostgreSQL. This allows you to specify multiple queries with the same name but
3701 which apply to different versions, thus allowing you to use the same
3702 configuration in a heterogeneous environment.
3704 The I<version> has to be specified as the concatenation of the major, minor
3705 and patch-level versions, each represented as two-decimal-digit numbers. For
3706 example, version 8.2.3 will become 80203.
3710 The following predefined queries are available (the definitions can be found
3711 in the F<postgresql_default.conf> file which, by default, is available at
3712 C<I<prefix>/share/collectd/>):
3718 This query collects the number of backends, i.E<nbsp>e. the number of
3721 =item B<transactions>
3723 This query collects the numbers of committed and rolled-back transactions of
3728 This query collects the numbers of various table modifications (i.E<nbsp>e.
3729 insertions, updates, deletions) of the user tables.
3731 =item B<query_plans>
3733 This query collects the numbers of various table scans and returned tuples of
3736 =item B<table_states>
3738 This query collects the numbers of live and dead rows in the user tables.
3742 This query collects disk block access counts for user tables.
3746 This query collects the on-disk size of the database in bytes.
3750 The B<Database> block defines one PostgreSQL database for which to collect
3751 statistics. It accepts a single mandatory argument which specifies the
3752 database name. None of the other options are required. PostgreSQL will use
3753 default values as documented in the section "CONNECTING TO A DATABASE" in the
3754 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
3755 the user collectd is run as and special environment variables. See the manpage
3760 =item B<Interval> I<seconds>
3762 Specify the interval with which the database should be queried. The default is
3763 to use the global B<Interval> setting.
3765 =item B<Host> I<hostname>
3767 Specify the hostname or IP of the PostgreSQL server to connect to. If the
3768 value begins with a slash, it is interpreted as the directory name in which to
3769 look for the UNIX domain socket.
3771 This option is also used to determine the hostname that is associated with a
3772 collected data set. If it has been omitted or either begins with with a slash
3773 or equals B<localhost> it will be replaced with the global hostname definition
3774 of collectd. Any other value will be passed literally to collectd when
3775 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
3777 =item B<Port> I<port>
3779 Specify the TCP port or the local UNIX domain socket file extension of the
3782 =item B<User> I<username>
3784 Specify the username to be used when connecting to the server.
3786 =item B<Password> I<password>
3788 Specify the password to be used when connecting to the server.
3790 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
3792 Specify whether to use an SSL connection when contacting the server. The
3793 following modes are supported:
3799 Do not use SSL at all.
3803 First, try to connect without using SSL. If that fails, try using SSL.
3805 =item I<prefer> (default)
3807 First, try to connect using SSL. If that fails, try without using SSL.
3815 =item B<KRBSrvName> I<kerberos_service_name>
3817 Specify the Kerberos service name to use when authenticating with Kerberos 5
3818 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
3819 B<PostgreSQL Documentation> for details.
3821 =item B<Service> I<service_name>
3823 Specify the PostgreSQL service name to use for additional parameters. That
3824 service has to be defined in F<pg_service.conf> and holds additional
3825 connection parameters. See the section "The Connection Service File" in the
3826 B<PostgreSQL Documentation> for details.
3828 =item B<Query> I<query>
3830 Specify a I<query> which should be executed for the database connection. This
3831 may be any of the predefined or user-defined queries. If no such option is
3832 given, it defaults to "backends", "transactions", "queries", "query_plans",
3833 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
3838 =head2 Plugin C<powerdns>
3840 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
3841 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
3842 values, many of which are probably meaningless to most users, but may be useful
3843 for some. So you may chose which values to collect, but if you don't, some
3844 reasonable defaults will be collected.
3847 <Server "server_name">
3849 Collect "udp-answers" "udp-queries"
3850 Socket "/var/run/pdns.controlsocket"
3852 <Recursor "recursor_name">
3854 Collect "cache-hits" "cache-misses"
3855 Socket "/var/run/pdns_recursor.controlsocket"
3857 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
3862 =item B<Server> and B<Recursor> block
3864 The B<Server> block defines one authoritative server to query, the B<Recursor>
3865 does the same for an recursing server. The possible options in both blocks are
3866 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
3871 =item B<Collect> I<Field>
3873 Using the B<Collect> statement you can select which values to collect. Here,
3874 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
3875 C<dlg-only-drops>, C<answers10-100>.
3877 The method of getting the values differs for B<Server> and B<Recursor> blocks:
3878 When querying the server a C<SHOW *> command is issued in any case, because
3879 that's the only way of getting multiple values out of the server at once.
3880 collectd then picks out the values you have selected. When querying the
3881 recursor, a command is generated to query exactly these values. So if you
3882 specify invalid fields when querying the recursor, a syntax error may be
3883 returned by the daemon and collectd may not collect any values at all.
3885 If no B<Collect> statement is given, the following B<Server> values will be
3892 =item packetcache-hit
3894 =item packetcache-miss
3896 =item packetcache-size
3898 =item query-cache-hit
3900 =item query-cache-miss
3902 =item recursing-answers
3904 =item recursing-questions
3916 The following B<Recursor> values will be collected by default:
3920 =item noerror-answers
3922 =item nxdomain-answers
3924 =item servfail-answers
3942 Please note that up to that point collectd doesn't know what values are
3943 available on the server and values that are added do not need a change of the
3944 mechanism so far. However, the values must be mapped to collectd's naming
3945 scheme, which is done using a lookup table that lists all known values. If
3946 values are added in the future and collectd does not know about them, you will
3947 get an error much like this:
3949 powerdns plugin: submit: Not found in lookup table: foobar = 42
3951 In this case please file a bug report with the collectd team.
3953 =item B<Socket> I<Path>
3955 Configures the path to the UNIX domain socket to be used when connecting to the
3956 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
3957 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
3958 will be used for the recursor.
3962 =item B<LocalSocket> I<Path>
3964 Querying the recursor is done using UDP. When using UDP over UNIX domain
3965 sockets, the client socket needs a name in the file system, too. You can set
3966 this local name to I<Path> using the B<LocalSocket> option. The default is
3967 C<I<prefix>/var/run/collectd-powerdns>.
3971 =head2 Plugin C<processes>
3975 =item B<Process> I<Name>
3977 Select more detailed statistics of processes matching this name. The statistics
3978 collected for these selected processes are size of the resident segment size
3979 (RSS), user- and system-time used, number of processes and number of threads,
3980 io data (where available) and minor and major pagefaults.
3982 =item B<ProcessMatch> I<name> I<regex>
3984 Similar to the B<Process> option this allows to select more detailed
3985 statistics of processes matching the specified I<regex> (see L<regex(7)> for
3986 details). The statistics of all matching processes are summed up and
3987 dispatched to the daemon using the specified I<name> as an identifier. This
3988 allows to "group" several processes together. I<name> must not contain
3993 =head2 Plugin C<protocols>
3995 Collects a lot of information about various network protocols, such as I<IP>,
3996 I<TCP>, I<UDP>, etc.
3998 Available configuration options:
4002 =item B<Value> I<Selector>
4004 Selects whether or not to select a specific value. The string being matched is
4005 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4006 plugin instance and I<ValueName> will be used as type instance. An example of
4007 the string being used would be C<Tcp:RetransSegs>.
4009 You can use regular expressions to match a large number of values with just one
4010 configuration option. To select all "extended" I<TCP> values, you could use the
4011 following statement:
4015 Whether only matched values are selected or all matched values are ignored
4016 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4017 If no value is configured at all, all values will be selected.
4019 =item B<IgnoreSelected> B<true>|B<false>
4021 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4022 matching values will be ignored.
4026 =head2 Plugin C<python>
4028 This plugin embeds a Python-interpreter into collectd and provides an interface
4029 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4031 =head2 Plugin C<routeros>
4033 The C<routeros> plugin connects to a device running I<RouterOS>, the
4034 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4035 I<librouteros> to connect and reads information about the interfaces and
4036 wireless connections of the device. The configuration supports querying
4041 Host "router0.example.com"
4044 CollectInterface true
4049 Host "router1.example.com"
4052 CollectInterface true
4053 CollectRegistrationTable true
4059 As you can see above, the configuration of the I<routeros> plugin consists of
4060 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4061 options are understood:
4065 =item B<Host> I<Host>
4067 Hostname or IP-address of the router to connect to.
4069 =item B<Port> I<Port>
4071 Port name or port number used when connecting. If left unspecified, the default
4072 will be chosen by I<librouteros>, currently "8728". This option expects a
4073 string argument, even when a numeric port number is given.
4075 =item B<User> I<User>
4077 Use the user name I<User> to authenticate. Defaults to "admin".
4079 =item B<Password> I<Password>
4081 Set the password used to authenticate.
4083 =item B<CollectInterface> B<true>|B<false>
4085 When set to B<true>, interface statistics will be collected for all interfaces
4086 present on the device. Defaults to B<false>.
4088 =item B<CollectRegistrationTable> B<true>|B<false>
4090 When set to B<true>, information about wireless LAN connections will be
4091 collected. Defaults to B<false>.
4093 =item B<CollectCPULoad> B<true>|B<false>
4095 When set to B<true>, information about the CPU usage will be collected. The
4096 number is a dimensionless value where zero indicates no CPU usage at all.
4097 Defaults to B<false>.
4099 =item B<CollectMemory> B<true>|B<false>
4101 When enabled, the amount of used and free memory will be collected. How used
4102 memory is calculated is unknown, for example whether or not caches are counted
4104 Defaults to B<false>.
4106 =item B<CollectDF> B<true>|B<false>
4108 When enabled, the amount of used and free disk space will be collected.
4109 Defaults to B<false>.
4111 =item B<CollectDisk> B<true>|B<false>
4113 When enabled, the number of sectors written and bad blocks will be collected.
4114 Defaults to B<false>.
4118 =head2 Plugin C<redis>
4120 The I<Redis plugin> connects to one or more Redis servers and gathers
4121 information about each server's state. For each server there is a I<Node> block
4122 which configures the connection parameters for this node.
4132 The information shown in the synopsis above is the I<default configuration>
4133 which is used by the plugin if no configuration is present.
4137 =item B<Node> I<Nodename>
4139 The B<Node> block identifies a new Redis node, that is a new Redis instance
4140 running in an specified host and port. The name for node is a canonical
4141 identifier which is used as I<plugin instance>. It is limited to
4142 64E<nbsp>characters in length.
4144 =item B<Host> I<Hostname>
4146 The B<Host> option is the hostname or IP-address where the Redis instance is
4149 =item B<Port> I<Port>
4151 The B<Port> option is the TCP port on which the Redis instance accepts
4152 connections. Either a service name of a port number may be given. Please note
4153 that numerical port numbers must be given as a string, too.
4155 =item B<Timeout> I<Timeout in miliseconds>
4157 The B<Timeout> option set the socket timeout for node response. Since the Redis
4158 read function is blocking, you should keep this value as low as possible. Keep
4159 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4160 than B<Interval> defined globally.
4164 =head2 Plugin C<rrdcached>
4166 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4167 to store values to RRD files in an efficient manner. The combination of the
4168 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4169 way the C<rrdtool> plugin works (see below). The added abstraction layer
4170 provides a number of benefits, though: Because the cache is not within
4171 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4172 restarted. This results in much shorter (if any) gaps in graphs, especially
4173 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4174 daemon so that it can flush values to disk automatically when needed. This
4175 allows to integrate automated flushing of values into graphing solutions much
4178 There are disadvantages, though: The daemon may reside on a different host, so
4179 it may not be possible for C<collectd> to create the appropriate RRD files
4180 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4181 different base directory, so relative paths may do weird stuff if you're not
4184 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4185 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4186 setting should be set to an absolute path, so that a changed base directory
4187 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4191 =item B<DaemonAddress> I<Address>
4193 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4194 library. See L<rrdcached(1)> for details. Example:
4196 <Plugin "rrdcached">
4197 DaemonAddress "unix:/var/run/rrdcached.sock"
4200 =item B<DataDir> I<Directory>
4202 Set the base directory in which the RRD files reside. If this is a relative
4203 path, it is relative to the working base directory of the C<rrdcached> daemon!
4204 Use of an absolute path is recommended.
4206 =item B<CreateFiles> B<true>|B<false>
4208 Enables or disables the creation of RRD files. If the daemon is not running
4209 locally, or B<DataDir> is set to a relative path, this will not work as
4210 expected. Default is B<true>.
4214 =head2 Plugin C<rrdtool>
4216 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4217 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4218 using these settings. If you don't want to dive into the depths of RRDtool, you
4219 can safely ignore these settings.
4223 =item B<DataDir> I<Directory>
4225 Set the directory to store RRD-files under. Per default RRD-files are generated
4226 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
4228 =item B<StepSize> I<Seconds>
4230 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4231 this setting is unset and the stepsize is set to the interval in which the data
4232 is collected. Do not use this option unless you absolutely have to for some
4233 reason. Setting this option may cause problems with the C<snmp plugin>, the
4234 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4236 =item B<HeartBeat> I<Seconds>
4238 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4239 in which case the heartbeat is set to twice the B<StepSize> which should equal
4240 the interval in which data is collected. Do not set this option unless you have
4241 a very good reason to do so.
4243 =item B<RRARows> I<NumRows>
4245 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4246 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4247 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4248 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4249 week, one month, and one year.
4251 So for each timespan, it calculates how many PDPs need to be consolidated into
4252 one CDP by calculating:
4253 number of PDPs = timespan / (stepsize * rrarows)
4255 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4258 =item B<RRATimespan> I<Seconds>
4260 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4261 more then one RRA. If this option is never used, the built-in default of (3600,
4262 86400, 604800, 2678400, 31622400) is used.
4264 For more information on how RRA-sizes are calculated see B<RRARows> above.
4266 =item B<XFF> I<Factor>
4268 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4270 =item B<CacheFlush> I<Seconds>
4272 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4273 it writes all values for a certain RRD-file if the oldest value is older than
4274 (or equal to) the number of seconds specified. If some RRD-file is not updated
4275 anymore for some reason (the computer was shut down, the network is broken,
4276 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4277 entire cache is searched for entries older than B<CacheTimeout> seconds and
4278 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4279 does nothing under normal circumstances, this value should not be too small.
4280 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4281 normally do much harm either.
4283 =item B<CacheTimeout> I<Seconds>
4285 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4286 save values in a cache, as described above. Writing multiple values at once
4287 reduces IO-operations and thus lessens the load produced by updating the files.
4288 The trade off is that the graphs kind of "drag behind" and that more memory is
4291 =item B<WritesPerSecond> I<Updates>
4293 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4294 will run serious performance problems. The B<CacheFlush> setting and the
4295 internal update queue assert that collectd continues to work just fine even
4296 under heavy load, but the system may become very unresponsive and slow. This is
4297 a problem especially if you create graphs from the RRD files on the same
4298 machine, for example using the C<graph.cgi> script included in the
4299 C<contrib/collection3/> directory.
4301 This setting is designed for very large setups. Setting this option to a value
4302 between 25 and 80 updates per second, depending on your hardware, will leave
4303 the server responsive enough to draw graphs even while all the cached values
4304 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4305 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4306 written as fast as possible, so that web frontends have up to date data when
4309 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4310 updates per second, writing all values to disk will take approximately
4311 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4312 "collection3" you'll end up with a responsive and fast system, up to date
4313 graphs and basically a "backup" of your values every hour.
4315 =item B<RandomTimeout> I<Seconds>
4317 When set, the actual timeout for each value is chosen randomly between
4318 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4319 intention is to avoid high load situations that appear when many values timeout
4320 at the same time. This is especially a problem shortly after the daemon starts,
4321 because all values were added to the internal cache at roughly the same time.
4325 =head2 Plugin C<sensors>
4327 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4328 that all the needed modules have to be loaded and lm_sensors has to be
4329 configured (most likely by editing F</etc/sensors.conf>. Read
4330 L<sensors.conf(5)> for details.
4332 The B<lm_sensors> homepage can be found at
4333 L<http://secure.netroedge.com/~lm78/>.
4337 =item B<SensorConfigFile> I<File>
4339 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
4340 the library's default will be used.
4342 =item B<Sensor> I<chip-bus-address/type-feature>
4344 Selects the name of the sensor which you want to collect or ignore, depending
4345 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4346 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4347 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4349 =item B<IgnoreSelected> I<true>|I<false>
4351 If no configuration if given, the B<sensors>-plugin will collect data from all
4352 sensors. This may not be practical, especially for uninteresting sensors.
4353 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4354 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4355 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4356 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4357 and all other sensors are collected.
4361 =head2 Plugin C<snmp>
4363 Since the configuration of the C<snmp plugin> is a little more complicated than
4364 other plugins, its documentation has been moved to an own manpage,
4365 L<collectd-snmp(5)>. Please see there for details.
4367 =head2 Plugin C<swap>
4369 The I<Swap plugin> collects information about used and available swap space. On
4370 I<Linux> and I<Solaris>, the following options are available:
4374 =item B<ReportByDevice> B<false>|B<true>
4376 Configures how to report physical swap devices. If set to B<false> (the
4377 default), the summary over all swap devices is reported only, i.e. the globally
4378 used and available space over all devices. If B<true> is configured, the used
4379 and available space of each device will be reported separately.
4381 This option is only available if the I<Swap plugin> can read C</proc/swaps>
4382 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
4386 =head2 Plugin C<syslog>
4390 =item B<LogLevel> B<debug|info|notice|warning|err>
4392 Sets the log-level. If, for example, set to B<notice>, then all events with
4393 severity B<notice>, B<warning>, or B<err> will be submitted to the
4396 Please note that B<debug> is only available if collectd has been compiled with
4399 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
4401 Controls which notifications should be sent to syslog. The default behaviour is
4402 not to send any. Less severe notifications always imply logging more severe
4403 notifications: Setting this to B<OKAY> means all notifications will be sent to
4404 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
4405 notifications but will dismiss B<OKAY> notifications. Setting this option to
4406 B<FAILURE> will only send failures to syslog.
4410 =head2 Plugin C<table>
4412 The C<table plugin> provides generic means to parse tabular data and dispatch
4413 user specified values. Values are selected based on column numbers. For
4414 example, this plugin may be used to get values from the Linux L<proc(5)>
4415 filesystem or CSV (comma separated values) files.
4418 <Table "/proc/slabinfo">
4423 InstancePrefix "active_objs"
4429 InstancePrefix "objperslab"
4436 The configuration consists of one or more B<Table> blocks, each of which
4437 configures one file to parse. Within each B<Table> block, there are one or
4438 more B<Result> blocks, which configure which data to select and how to
4441 The following options are available inside a B<Table> block:
4445 =item B<Instance> I<instance>
4447 If specified, I<instance> is used as the plugin instance. So, in the above
4448 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4449 filename of the table is used instead, with all special characters replaced
4450 with an underscore (C<_>).
4452 =item B<Separator> I<string>
4454 Any character of I<string> is interpreted as a delimiter between the different
4455 columns of the table. A sequence of two or more contiguous delimiters in the
4456 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4457 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4458 of a table - see its documentation for more details. This option is mandatory.
4460 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4461 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4462 required because of collectd's config parsing.
4466 The following options are available inside a B<Result> block:
4470 =item B<Type> I<type>
4472 Sets the type used to dispatch the values to the daemon. Detailed information
4473 about types and their configuration can be found in L<types.db(5)>. This
4474 option is mandatory.
4476 =item B<InstancePrefix> I<prefix>
4478 If specified, prepend I<prefix> to the type instance. If omitted, only the
4479 B<InstancesFrom> option is considered for the type instance.
4481 =item B<InstancesFrom> I<column0> [I<column1> ...]
4483 If specified, the content of the given columns (identified by the column
4484 number starting at zero) will be used to create the type instance for each
4485 row. Multiple values (and the instance prefix) will be joined together with
4486 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
4487 option is considered for the type instance.
4489 The plugin itself does not check whether or not all built instances are
4490 different. It’s your responsibility to assure that each is unique. This is
4491 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4492 sure that the table only contains one row.
4494 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4497 =item B<ValuesFrom> I<column0> [I<column1> ...]
4499 Specifies the columns (identified by the column numbers starting at zero)
4500 whose content is used as the actual data for the data sets that are dispatched
4501 to the daemon. How many such columns you need is determined by the B<Type>
4502 setting above. If you specify too many or not enough columns, the plugin will
4503 complain about that and no data will be submitted to the daemon. The plugin
4504 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4505 respectively, so anything supported by those functions is supported by the
4506 plugin as well. This option is mandatory.
4510 =head2 Plugin C<tail>
4512 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4513 each line and dispatches found values. What is matched can be configured by the
4514 user using (extended) regular expressions, as described in L<regex(7)>.
4517 <File "/var/log/exim4/mainlog">
4520 Regex "S=([1-9][0-9]*)"
4526 Regex "\\<R=local_user\\>"
4527 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4530 Instance "local_user"
4535 The config consists of one or more B<File> blocks, each of which configures one
4536 logfile to parse. Within each B<File> block, there are one or more B<Match>
4537 blocks, which configure a regular expression to search for.
4539 The B<Instance> option in the B<File> block may be used to set the plugin
4540 instance. So in the above example the plugin name C<tail-foo> would be used.
4541 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4542 next B<Instance> option. This way you can extract several plugin instances from
4543 one logfile, handy when parsing syslog and the like.
4545 Each B<Match> block has the following options to describe how the match should
4550 =item B<Regex> I<regex>
4552 Sets the regular expression to use for matching against a line. The first
4553 subexpression has to match something that can be turned into a number by
4554 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4555 below. Because B<extended> regular expressions are used, you do not need to use
4556 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4557 collectd's config parsing you need to escape backslashes, though. So if you
4558 want to match literal parentheses you need to do the following:
4560 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4562 =item B<ExcludeRegex> I<regex>
4564 Sets an optional regular expression to use for excluding lines from the match.
4565 An example which excludes all connections from localhost from the match:
4567 ExcludeRegex "127\\.0\\.0\\.1"
4569 =item B<DSType> I<Type>
4571 Sets how the values are cumulated. I<Type> is one of:
4575 =item B<GaugeAverage>
4577 Calculate the average.
4581 Use the smallest number only.
4585 Use the greatest number only.
4589 Use the last number found.
4595 =item B<AbsoluteSet>
4597 The matched number is a counter. Simply I<sets> the internal counter to this
4598 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
4604 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
4605 matched number may be negative, which will effectively subtract from the
4612 Increase the internal counter by one. These B<DSType> are the only ones that do
4613 not use the matched subexpression, but simply count the number of matched
4614 lines. Thus, you may use a regular expression without submatch in this case.
4618 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
4619 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
4620 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
4621 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
4622 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
4625 =item B<Type> I<Type>
4627 Sets the type used to dispatch this value. Detailed information about types and
4628 their configuration can be found in L<types.db(5)>.
4630 =item B<Instance> I<TypeInstance>
4632 This optional setting sets the type instance to use.
4636 =head2 Plugin C<teamspeak2>
4638 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
4639 polls interesting global and virtual server data. The plugin can query only one
4640 physical server but unlimited virtual servers. You can use the following
4641 options to configure it:
4645 =item B<Host> I<hostname/ip>
4647 The hostname or ip which identifies the physical server.
4650 =item B<Port> I<port>
4652 The query port of the physical server. This needs to be a string.
4655 =item B<Server> I<port>
4657 This option has to be added once for every virtual server the plugin should
4658 query. If you want to query the virtual server on port 8767 this is what the
4659 option would look like:
4663 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
4664 use quotes around it! If no such statement is given only global information
4669 =head2 Plugin C<ted>
4671 The I<TED> plugin connects to a device of "The Energy Detective", a device to
4672 measure power consumption. These devices are usually connected to a serial
4673 (RS232) or USB port. The plugin opens a configured device and tries to read the
4674 current energy readings. For more information on TED, visit
4675 L<http://www.theenergydetective.com/>.
4677 Available configuration options:
4681 =item B<Device> I<Path>
4683 Path to the device on which TED is connected. collectd will need read and write
4684 permissions on that file.
4686 Default: B</dev/ttyUSB0>
4688 =item B<Retries> I<Num>
4690 Apparently reading from TED is not that reliable. You can therefore configure a
4691 number of retries here. You only configure the I<retries> here, to if you
4692 specify zero, one reading will be performed (but no retries if that fails); if
4693 you specify three, a maximum of four readings are performed. Negative values
4700 =head2 Plugin C<tcpconns>
4702 The C<tcpconns plugin> counts the number of currently established TCP
4703 connections based on the local port and/or the remote port. Since there may be
4704 a lot of connections the default if to count all connections with a local port,
4705 for which a listening socket is opened. You can use the following options to
4706 fine-tune the ports you are interested in:
4710 =item B<ListeningPorts> I<true>|I<false>
4712 If this option is set to I<true>, statistics for all local ports for which a
4713 listening socket exists are collected. The default depends on B<LocalPort> and
4714 B<RemotePort> (see below): If no port at all is specifically selected, the
4715 default is to collect listening ports. If specific ports (no matter if local or
4716 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
4717 the selected ports will be collected unless this option is set to I<true>
4720 =item B<LocalPort> I<Port>
4722 Count the connections to a specific local port. This can be used to see how
4723 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
4724 You have to specify the port in numeric form, so for the mailserver example
4725 you'd need to set B<25>.
4727 =item B<RemotePort> I<Port>
4729 Count the connections to a specific remote port. This is useful to see how
4730 much a remote service is used. This is most useful if you want to know how many
4731 connections a local service has opened to remote services, e.E<nbsp>g. how many
4732 connections a mail server or news server has to other mail or news servers, or
4733 how many connections a web proxy holds to web servers. You have to give the
4734 port in numeric form.
4738 =head2 Plugin C<thermal>
4742 =item B<ForceUseProcfs> I<true>|I<false>
4744 By default, the I<Thermal plugin> tries to read the statistics from the Linux
4745 C<sysfs> interface. If that is not available, the plugin falls back to the
4746 C<procfs> interface. By setting this option to I<true>, you can force the
4747 plugin to use the latter. This option defaults to I<false>.
4749 =item B<Device> I<Device>
4751 Selects the name of the thermal device that you want to collect or ignore,
4752 depending on the value of the B<IgnoreSelected> option. This option may be
4753 used multiple times to specify a list of devices.
4755 =item B<IgnoreSelected> I<true>|I<false>
4757 Invert the selection: If set to true, all devices B<except> the ones that
4758 match the device names specified by the B<Device> option are collected. By
4759 default only selected devices are collected if a selection is made. If no
4760 selection is configured at all, B<all> devices are selected.
4764 =head2 Plugin C<threshold>
4766 The I<Threshold plugin> checks values collected or received by I<collectd>
4767 against a configurable I<threshold> and issues I<notifications> if values are
4770 Documentation for this plugin is available in the L<collectd-threshold(5)>
4773 =head2 Plugin C<tokyotyrant>
4775 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
4776 couple metrics: number of records, and database size on disk.
4780 =item B<Host> I<Hostname/IP>
4782 The hostname or ip which identifies the server.
4783 Default: B<127.0.0.1>
4785 =item B<Port> I<Service/Port>
4787 The query port of the server. This needs to be a string, even if the port is
4788 given in its numeric form.
4793 =head2 Plugin C<unixsock>
4797 =item B<SocketFile> I<Path>
4799 Sets the socket-file which is to be created.
4801 =item B<SocketGroup> I<Group>
4803 If running as root change the group of the UNIX-socket after it has been
4804 created. Defaults to B<collectd>.
4806 =item B<SocketPerms> I<Permissions>
4808 Change the file permissions of the UNIX-socket after it has been created. The
4809 permissions must be given as a numeric, octal value as you would pass to
4810 L<chmod(1)>. Defaults to B<0770>.
4812 =item B<DeleteSocket> B<false>|B<true>
4814 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
4815 with the given name already exists. If I<collectd> crashes a socket file may be
4816 left over, preventing the daemon from opening a new socket when restarted.
4817 Since this is potentially dangerous, this defaults to B<false>.
4821 =head2 Plugin C<uuid>
4823 This plugin, if loaded, causes the Hostname to be taken from the machine's
4824 UUID. The UUID is a universally unique designation for the machine, usually
4825 taken from the machine's BIOS. This is most useful if the machine is running in
4826 a virtual environment such as Xen, in which case the UUID is preserved across
4827 shutdowns and migration.
4829 The following methods are used to find the machine's UUID, in order:
4835 Check I</etc/uuid> (or I<UUIDFile>).
4839 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
4844 Check for UUID from C<dmidecode> / SMBIOS.
4848 Check for UUID from Xen hypervisor.
4852 If no UUID can be found then the hostname is not modified.
4856 =item B<UUIDFile> I<Path>
4858 Take the UUID from the given file (default I</etc/uuid>).
4862 =head2 Plugin C<varnish>
4864 The Varnish plugin collects information about Varnish, an HTTP accelerator.
4868 =item B<CollectCache> B<true>|B<false>
4870 Cache hits and misses. True by default.
4872 =item B<CollectConnections> B<true>|B<false>
4874 Number of client connections received, accepted and dropped. True by default.
4876 =item B<CollectBackend> B<true>|B<false>
4878 Back-end connection statistics, such as successful, reused,
4879 and closed connections. True by default.
4881 =item B<CollectSHM> B<true>|B<false>
4883 Statistics about the shared memory log, a memory region to store
4884 log messages which is flushed to disk when full. True by default.
4886 =item B<CollectESI> B<true>|B<false>
4888 Edge Side Includes (ESI) parse statistics. False by default.
4890 =item B<CollectFetch> B<true>|B<false>
4892 Statistics about fetches (HTTP requests sent to the backend). False by default.
4894 =item B<CollectHCB> B<true>|B<false>
4896 Inserts and look-ups in the crit bit tree based hash. Look-ups are
4897 divided into locked and unlocked look-ups. False by default.
4899 =item B<CollectSMA> B<true>|B<false>
4901 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
4902 The umem storage component is Solaris specific. False by default.
4904 =item B<CollectSMS> B<true>|B<false>
4906 synth (synthetic content) storage statistics. This storage
4907 component is used internally only. False by default.
4909 =item B<CollectSM> B<true>|B<false>
4911 file (memory mapped file) storage statistics. False by default.
4913 =item B<CollectTotals> B<true>|B<false>
4915 Collects overview counters, such as the number of sessions created,
4916 the number of requests and bytes transferred. False by default.
4918 =item B<CollectWorkers> B<true>|B<false>
4920 Collect statistics about worker threads. False by default.
4924 =head2 Plugin C<vmem>
4926 The C<vmem> plugin collects information about the usage of virtual memory.
4927 Since the statistics provided by the Linux kernel are very detailed, they are
4928 collected very detailed. However, to get all the details, you have to switch
4929 them on manually. Most people just want an overview over, such as the number of
4930 pages read from swap space.
4934 =item B<Verbose> B<true>|B<false>
4936 Enables verbose collection of information. This will start collecting page
4937 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
4938 Part of these statistics are collected on a "per zone" basis.
4942 =head2 Plugin C<vserver>
4944 This plugin doesn't have any options. B<VServer> support is only available for
4945 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
4946 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
4947 need to apply the patches and compile your own kernel, which will then provide
4948 the F</proc/virtual> filesystem that is required by this plugin.
4950 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
4952 B<Note>: The traffic collected by this plugin accounts for the amount of
4953 traffic passing a socket which might be a lot less than the actual on-wire
4954 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
4955 collect on-wire traffic you could, for example, use the logging facilities of
4956 iptables to feed data for the guest IPs into the iptables plugin.
4958 =head2 Plugin C<write_graphite>
4960 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
4961 storage and graphing project. The plugin connects to I<Carbon>, the data layer
4962 of I<Graphite>, and sends data via the "line based" protocol (per default using
4963 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
4964 minimize the number of network packets.
4968 <Plugin write_graphite>
4978 =item B<Host> I<Address>
4980 Hostname or address to connect to. Defaults to C<localhost>.
4982 =item B<Port> I<Service>
4984 Service name or port number to connect to. Defaults to C<2003>.
4986 =item B<Prefix> I<String>
4988 When set, I<String> is added in front of the host name. Dots and whitespace are
4989 I<not> escaped in this string (see B<EscapeCharacter> below).
4991 =item B<Postfix> I<String>
4993 When set, I<String> is appended to the host name. Dots and whitespace are
4994 I<not> escaped in this string (see B<EscapeCharacter> below).
4996 =item B<EscapeCharacter> I<Char>
4998 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
4999 in the identifier. The B<EscapeCharacter> option determines which character
5000 dots, whitespace and control characters are replaced with. Defaults to
5003 =item B<StoreRates> B<false>|B<true>
5005 If set to B<true> (the default), convert counter values to rates. If set to
5006 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5009 =item B<SeparateInstances> B<false>|B<true>
5011 If set to B<true>, the plugin instance and type instance will be in their own
5012 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
5013 default), the plugin and plugin instance (and likewise the type and type
5014 instance) are put into once component, for example C<host.cpu-0.cpu-idle>.
5016 =item B<AlwaysAppendDS> B<false>|B<true>
5018 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
5019 identifier. If set to B<false> (the default), this is only done when there is
5024 =head2 Plugin C<write_mongodb>
5026 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
5031 <Plugin "write_mongodb">
5040 The plugin can send values to multiple instances of I<MongoDB> by specifying
5041 one B<Node> block for each instance. Within the B<Node> blocks, the following
5042 options are available:
5046 =item B<Host> I<Address>
5048 Hostname or address to connect to. Defaults to C<localhost>.
5050 =item B<Port> I<Service>
5052 Service name or port number to connect to. Defaults to C<27017>.
5054 =item B<Timeout> I<Timeout>
5056 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
5057 Setting this option to zero means no timeout, which is the default.
5059 =item B<StoreRates> B<false>|B<true>
5061 If set to B<true> (the default), convert counter values to rates. If set to
5062 B<false> counter values are stored as is, i.e. as an increasing integer
5067 =head2 Plugin C<write_http>
5069 This output plugin submits values to an http server by POST them using the
5070 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5071 have one B<URL> block, within which the destination can be configured further,
5072 for example by specifying authentication data.
5076 <Plugin "write_http">
5077 <URL "http://example.com/post-collectd">
5083 B<URL> blocks need one string argument which is used as the URL to which data
5084 is posted. The following options are understood within B<URL> blocks.
5088 =item B<User> I<Username>
5090 Optional user name needed for authentication.
5092 =item B<Password> I<Password>
5094 Optional password needed for authentication.
5096 =item B<VerifyPeer> B<true>|B<false>
5098 Enable or disable peer SSL certificate verification. See
5099 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5101 =item B<VerifyHost> B<true|false>
5103 Enable or disable peer host name verification. If enabled, the plugin checks if
5104 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5105 matches the host name provided by the B<URL> option. If this identity check
5106 fails, the connection is aborted. Obviously, only works when connecting to a
5107 SSL enabled server. Enabled by default.
5109 =item B<CACert> I<File>
5111 File that holds one or more SSL certificates. If you want to use HTTPS you will
5112 possibly need this option. What CA certificates come bundled with C<libcurl>
5113 and are checked by default depends on the distribution you use.
5115 =item B<Format> B<Command>|B<JSON>
5117 Format of the output to generate. If set to B<Command>, will create output that
5118 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5119 create output in the I<JavaScript Object Notation> (JSON).
5121 Defaults to B<Command>.
5123 =item B<StoreRates> B<true|false>
5125 If set to B<true>, convert counter values to rates. If set to B<false> (the
5126 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5131 =head1 THRESHOLD CONFIGURATION
5133 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
5134 we mean that the values are not only stored or sent somewhere, but that they
5135 are judged and, if a problem is recognized, acted upon. The only action
5136 collectd takes itself is to generate and dispatch a "notification". Plugins can
5137 register to receive notifications and perform appropriate further actions.
5139 Since systems and what you expect them to do differ a lot, you can configure
5140 B<thresholds> for your values freely. This gives you a lot of flexibility but
5141 also a lot of responsibility.
5143 Every time a value is out of range a notification is dispatched. This means
5144 that the idle percentage of your CPU needs to be less then the configured
5145 threshold only once for a notification to be generated. There's no such thing
5146 as a moving average or similar - at least not now.
5148 Also, all values that match a threshold are considered to be relevant or
5149 "interesting". As a consequence collectd will issue a notification if they are
5150 not received for B<Timeout> iterations. The B<Timeout> configuration option is
5151 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
5152 "2" (the default) and some hosts sends it's CPU statistics to the server every
5153 60 seconds, a notification will be dispatched after about 120 seconds. It may
5154 take a little longer because the timeout is checked only once each B<Interval>
5157 When a value comes within range again or is received after it was missing, an
5158 "OKAY-notification" is dispatched.
5160 Here is a configuration example to get you started. Read below for more
5173 <Plugin "interface">
5190 WarningMin 100000000
5196 There are basically two types of configuration statements: The C<Host>,
5197 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
5198 configured. The C<Plugin> and C<Type> blocks may be specified further using the
5199 C<Instance> option. You can combine the block by nesting the blocks, though
5200 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
5201 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
5202 C<Type> may not contain other blocks. If multiple blocks apply to the same
5203 value the most specific block is used.
5205 The other statements specify the threshold to configure. They B<must> be
5206 included in a C<Type> block. Currently the following statements are recognized:
5210 =item B<FailureMax> I<Value>
5212 =item B<WarningMax> I<Value>
5214 Sets the upper bound of acceptable values. If unset defaults to positive
5215 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
5216 will be created. If the value is greater than B<WarningMax> but less than (or
5217 equal to) B<FailureMax> a B<WARNING> notification will be created.
5219 =item B<FailureMin> I<Value>
5221 =item B<WarningMin> I<Value>
5223 Sets the lower bound of acceptable values. If unset defaults to negative
5224 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
5225 be created. If the value is less than B<WarningMin> but greater than (or equal
5226 to) B<FailureMin> a B<WARNING> notification will be created.
5228 =item B<DataSource> I<DSName>
5230 Some data sets have more than one "data source". Interesting examples are the
5231 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
5232 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
5233 system load data set, C<load>, even has three data sources: C<shortterm>,
5234 C<midterm>, and C<longterm>.
5236 Normally, all data sources are checked against a configured threshold. If this
5237 is undesirable, or if you want to specify different limits for each data
5238 source, you can use the B<DataSource> option to have a threshold apply only to
5241 =item B<Invert> B<true>|B<false>
5243 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
5244 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
5245 B<WarningMax>) are not okay. Defaults to B<false>.
5247 =item B<Persist> B<true>|B<false>
5249 Sets how often notifications are generated. If set to B<true> one notification
5250 will be generated for each value that is out of the acceptable range. If set to
5251 B<false> (the default) then a notification is only generated if a value is out
5252 of range but the previous value was okay.
5254 This applies to missing values, too: If set to B<true> a notification about a
5255 missing value is generated once every B<Interval> seconds. If set to B<false>
5256 only one such notification is generated until the value appears again.
5258 =item B<Percentage> B<true>|B<false>
5260 If set to B<true>, the minimum and maximum values given are interpreted as
5261 percentage value, relative to the other data sources. This is helpful for
5262 example for the "df" type, where you may want to issue a warning when less than
5263 5E<nbsp>% of the total space is available. Defaults to B<false>.
5265 =item B<Hits> I<Number>
5267 Delay creating the notification until the threshold has been passed I<Number>
5268 times. When a notification has been generated, or when a subsequent value is
5269 inside the threshold, the counter is reset. If, for example, a value is
5270 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
5271 will be dispatched at most once every 30E<nbsp>seconds.
5273 This is useful when short bursts are not a problem. If, for example, 100% CPU
5274 usage for up to a minute is normal (and data is collected every
5275 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
5277 =item B<Hysteresis> I<Number>
5279 When set to non-zero, a hysteresis value is applied when checking minimum and
5280 maximum bounds. This is useful for values that increase slowly and fluctuate a
5281 bit while doing so. When these values come close to the threshold, they may
5282 "flap", i.e. switch between failure / warning case and okay case repeatedly.
5284 If, for example, the threshold is configures as
5289 then a I<Warning> notification is created when the value exceeds I<101> and the
5290 corresponding I<Okay> notification is only created once the value falls below
5291 I<99>, thus avoiding the "flapping".
5295 =head1 FILTER CONFIGURATION
5297 Starting with collectd 4.6 there is a powerful filtering infrastructure
5298 implemented in the daemon. The concept has mostly been copied from
5299 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
5300 terminology, so that users that are familiar with iptables feel right at home.
5304 The following are the terms used in the remainder of the filter configuration
5305 documentation. For an ASCII-art schema of the mechanism, see
5306 L<"General structure"> below.
5312 A I<match> is a criteria to select specific values. Examples are, of course, the
5313 name of the value or it's current value.
5315 Matches are implemented in plugins which you have to load prior to using the
5316 match. The name of such plugins starts with the "match_" prefix.
5320 A I<target> is some action that is to be performed with data. Such actions
5321 could, for example, be to change part of the value's identifier or to ignore
5322 the value completely.
5324 Some of these targets are built into the daemon, see L<"Built-in targets">
5325 below. Other targets are implemented in plugins which you have to load prior to
5326 using the target. The name of such plugins starts with the "target_" prefix.
5330 The combination of any number of matches and at least one target is called a
5331 I<rule>. The target actions will be performed for all values for which B<all>
5332 matches apply. If the rule does not have any matches associated with it, the
5333 target action will be performed for all values.
5337 A I<chain> is a list of rules and possibly default targets. The rules are tried
5338 in order and if one matches, the associated target will be called. If a value
5339 is handled by a rule, it depends on the target whether or not any subsequent
5340 rules are considered or if traversal of the chain is aborted, see
5341 L<"Flow control"> below. After all rules have been checked, the default targets
5346 =head2 General structure
5348 The following shows the resulting structure:
5355 +---------+ +---------+ +---------+ +---------+
5356 ! Rule !->! Match !->! Match !->! Target !
5357 +---------+ +---------+ +---------+ +---------+
5360 +---------+ +---------+ +---------+
5361 ! Rule !->! Target !->! Target !
5362 +---------+ +---------+ +---------+
5369 +---------+ +---------+ +---------+
5370 ! Rule !->! Match !->! Target !
5371 +---------+ +---------+ +---------+
5381 There are four ways to control which way a value takes through the filter
5388 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
5389 process the value with another chain. When the called chain finishes, usually
5390 the next target or rule after the jump is executed.
5394 The stop condition, signaled for example by the built-in target B<stop>, causes
5395 all processing of the value to be stopped immediately.
5399 Causes processing in the current chain to be aborted, but processing of the
5400 value generally will continue. This means that if the chain was called via
5401 B<Jump>, the next target or rule after the jump will be executed. If the chain
5402 was not called by another chain, control will be returned to the daemon and it
5403 may pass the value to another chain.
5407 Most targets will signal the B<continue> condition, meaning that processing
5408 should continue normally. There is no special built-in target for this
5415 The configuration reflects this structure directly:
5417 PostCacheChain "PostCache"
5419 <Rule "ignore_mysql_show">
5422 Type "^mysql_command$"
5423 TypeInstance "^show_"
5433 The above configuration example will ignore all values where the plugin field
5434 is "mysql", the type is "mysql_command" and the type instance begins with
5435 "show_". All other values will be sent to the C<rrdtool> write plugin via the
5436 default target of the chain. Since this chain is run after the value has been
5437 added to the cache, the MySQL C<show_*> command statistics will be available
5438 via the C<unixsock> plugin.
5440 =head2 List of configuration options
5444 =item B<PreCacheChain> I<ChainName>
5446 =item B<PostCacheChain> I<ChainName>
5448 Configure the name of the "pre-cache chain" and the "post-cache chain". The
5449 argument is the name of a I<chain> that should be executed before and/or after
5450 the values have been added to the cache.
5452 To understand the implications, it's important you know what is going on inside
5453 I<collectd>. The following diagram shows how values are passed from the
5454 read-plugins to the write-plugins:
5460 + - - - - V - - - - +
5461 : +---------------+ :
5464 : +-------+-------+ :
5467 : +-------+-------+ : +---------------+
5468 : ! Cache !--->! Value Cache !
5469 : ! insert ! : +---+---+-------+
5470 : +-------+-------+ : ! !
5471 : ! ,------------' !
5473 : +-------+---+---+ : +-------+-------+
5474 : ! Post-Cache +--->! Write-Plugins !
5475 : ! Chain ! : +---------------+
5476 : +---------------+ :
5479 + - - - - - - - - - +
5481 After the values are passed from the "read" plugins to the dispatch functions,
5482 the pre-cache chain is run first. The values are added to the internal cache
5483 afterwards. The post-cache chain is run after the values have been added to the
5484 cache. So why is it such a huge deal if chains are run before or after the
5485 values have been added to this cache?
5487 Targets that change the identifier of a value list should be executed before
5488 the values are added to the cache, so that the name in the cache matches the
5489 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
5490 this cache to receive a list of all available values. If you change the
5491 identifier after the value list has been added to the cache, this may easily
5492 lead to confusion, but it's not forbidden of course.
5494 The cache is also used to convert counter values to rates. These rates are, for
5495 example, used by the C<value> match (see below). If you use the rate stored in
5496 the cache B<before> the new value is added, you will use the old, B<previous>
5497 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
5498 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
5501 Last but not last, the B<stop> target makes a difference: If the pre-cache
5502 chain returns the stop condition, the value will not be added to the cache and
5503 the post-cache chain will not be run.
5505 =item B<Chain> I<Name>
5507 Adds a new chain with a certain name. This name can be used to refer to a
5508 specific chain, for example to jump to it.
5510 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
5512 =item B<Rule> [I<Name>]
5514 Adds a new rule to the current chain. The name of the rule is optional and
5515 currently has no meaning for the daemon.
5517 Within the B<Rule> block, there may be any number of B<Match> blocks and there
5518 must be at least one B<Target> block.
5520 =item B<Match> I<Name>
5522 Adds a match to a B<Rule> block. The name specifies what kind of match should
5523 be performed. Available matches depend on the plugins that have been loaded.
5525 The arguments inside the B<Match> block are passed to the plugin implementing
5526 the match, so which arguments are valid here depends on the plugin being used.
5527 If you do not need any to pass any arguments to a match, you can use the
5532 Which is equivalent to:
5537 =item B<Target> I<Name>
5539 Add a target to a rule or a default target to a chain. The name specifies what
5540 kind of target is to be added. Which targets are available depends on the
5541 plugins being loaded.
5543 The arguments inside the B<Target> block are passed to the plugin implementing
5544 the target, so which arguments are valid here depends on the plugin being used.
5545 If you do not need any to pass any arguments to a target, you can use the
5550 This is the same as writing:
5557 =head2 Built-in targets
5559 The following targets are built into the core daemon and therefore need no
5560 plugins to be loaded:
5566 Signals the "return" condition, see the L<"Flow control"> section above. This
5567 causes the current chain to stop processing the value and returns control to
5568 the calling chain. The calling chain will continue processing targets and rules
5569 just after the B<jump> target (see below). This is very similar to the
5570 B<RETURN> target of iptables, see L<iptables(8)>.
5572 This target does not have any options.
5580 Signals the "stop" condition, see the L<"Flow control"> section above. This
5581 causes processing of the value to be aborted immediately. This is similar to
5582 the B<DROP> target of iptables, see L<iptables(8)>.
5584 This target does not have any options.
5592 Sends the value to "write" plugins.
5598 =item B<Plugin> I<Name>
5600 Name of the write plugin to which the data should be sent. This option may be
5601 given multiple times to send the data to more than one write plugin.
5605 If no plugin is explicitly specified, the values will be sent to all available
5616 Starts processing the rules of another chain, see L<"Flow control"> above. If
5617 the end of that chain is reached, or a stop condition is encountered,
5618 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
5619 next target or the next rule. This is similar to the B<-j> command line option
5620 of iptables, see L<iptables(8)>.
5626 =item B<Chain> I<Name>
5628 Jumps to the chain I<Name>. This argument is required and may appear only once.
5640 =head2 Available matches
5646 Matches a value using regular expressions.
5652 =item B<Host> I<Regex>
5654 =item B<Plugin> I<Regex>
5656 =item B<PluginInstance> I<Regex>
5658 =item B<Type> I<Regex>
5660 =item B<TypeInstance> I<Regex>
5662 Match values where the given regular expressions match the various fields of
5663 the identifier of a value. If multiple regular expressions are given, B<all>
5664 regexen must match for a value to match.
5666 =item B<Invert> B<false>|B<true>
5668 When set to B<true>, the result of the match is inverted, i.e. all value lists
5669 where all regular expressions apply are not matched, all other value lists are
5670 matched. Defaults to B<false>.
5677 Host "customer[0-9]+"
5683 Matches values that have a time which differs from the time on the server.
5685 This match is mainly intended for servers that receive values over the
5686 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
5687 is very sensitive to the timestamp used when updating the RRD files. In
5688 particular, the time must be ever increasing. If a misbehaving client sends one
5689 packet with a timestamp far in the future, all further packets with a correct
5690 time will be ignored because of that one packet. What's worse, such corrupted
5691 RRD files are hard to fix.
5693 This match lets one match all values B<outside> a specified time range
5694 (relative to the server's time), so you can use the B<stop> target (see below)
5695 to ignore the value, for example.
5701 =item B<Future> I<Seconds>
5703 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
5704 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5707 =item B<Past> I<Seconds>
5709 Matches all values that are I<behind> of the server's time by I<Seconds> or
5710 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5722 This example matches all values that are five minutes or more ahead of the
5723 server or one hour (or more) lagging behind.
5727 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
5728 values. If a data-set consists of more than one data-source, all data-sources
5729 must match the specified ranges for a positive match.
5735 =item B<Min> I<Value>
5737 Sets the smallest value which still results in a match. If unset, behaves like
5740 =item B<Max> I<Value>
5742 Sets the largest value which still results in a match. If unset, behaves like
5745 =item B<Invert> B<true>|B<false>
5747 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
5748 no-match is returned and vice versa. Please note that the B<Invert> setting
5749 only effects how B<Min> and B<Max> are applied to a specific value. Especially
5750 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
5752 =item B<DataSource> I<DSName> [I<DSName> ...]
5754 Select one or more of the data sources. If no data source is configured, all
5755 data sources will be checked. If the type handled by the match does not have a
5756 data source of the specified name(s), this will always result in no match
5757 (independent of the B<Invert> setting).
5759 =item B<Satisfy> B<Any>|B<All>
5761 Specifies how checking with several data sources is performed. If set to
5762 B<Any>, the match succeeds if one of the data sources is in the configured
5763 range. If set to B<All> the match only succeeds if all data sources are within
5764 the configured range. Default is B<All>.
5766 Usually B<All> is used for positive matches, B<Any> is used for negative
5767 matches. This means that with B<All> you usually check that all values are in a
5768 "good" range, while with B<Any> you check if any value is within a "bad" range
5769 (or outside the "good" range).
5773 Either B<Min> or B<Max>, but not both, may be unset.
5777 # Match all values smaller than or equal to 100. Matches only if all data
5778 # sources are below 100.
5784 # Match if the value of any data source is outside the range of 0 - 100.
5792 =item B<empty_counter>
5794 Matches all values with one or more data sources of type B<COUNTER> and where
5795 all counter values are zero. These counters usually I<never> increased since
5796 they started existing (and are therefore uninteresting), or got reset recently
5797 or overflowed and you had really, I<really> bad luck.
5799 Please keep in mind that ignoring such counters can result in confusing
5800 behavior: Counters which hardly ever increase will be zero for long periods of
5801 time. If the counter is reset for some reason (machine or service restarted,
5802 usually), the graph will be empty (NAN) for a long time. People may not
5807 Calculates a hash value of the host name and matches values according to that
5808 hash value. This makes it possible to divide all hosts into groups and match
5809 only values that are in a specific group. The intended use is in load
5810 balancing, where you want to handle only part of all data and leave the rest
5813 The hashing function used tries to distribute the hosts evenly. First, it
5814 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
5817 for (i = 0; host[i] != 0; i++)
5818 hash_value = (hash_value * 251) + host[i];
5820 The constant 251 is a prime number which is supposed to make this hash value
5821 more random. The code then checks the group for this host according to the
5822 I<Total> and I<Match> arguments:
5824 if ((hash_value % Total) == Match)
5829 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
5830 groups), then the least significant bit of the hash value will be the XOR of
5831 all least significant bits in the host name. One consequence is that when you
5832 have two hosts, "server0.example.com" and "server1.example.com", where the host
5833 name differs in one digit only and the digits differ by one, those hosts will
5834 never end up in the same group.
5840 =item B<Match> I<Match> I<Total>
5842 Divide the data into I<Total> groups and match all hosts in group I<Match> as
5843 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
5844 be smaller than I<Total>. I<Total> must be at least one, although only values
5845 greater than one really do make any sense.
5847 You can repeat this option to match multiple groups, for example:
5852 The above config will divide the data into seven groups and match groups three
5853 and five. One use would be to keep every value on two hosts so that if one
5854 fails the missing data can later be reconstructed from the second host.
5860 # Operate on the pre-cache chain, so that ignored values are not even in the
5865 # Divide all received hosts in seven groups and accept all hosts in
5869 # If matched: Return and continue.
5872 # If not matched: Return and stop.
5878 =head2 Available targets
5882 =item B<notification>
5884 Creates and dispatches a notification.
5890 =item B<Message> I<String>
5892 This required option sets the message of the notification. The following
5893 placeholders will be replaced by an appropriate value:
5901 =item B<%{plugin_instance}>
5905 =item B<%{type_instance}>
5907 These placeholders are replaced by the identifier field of the same name.
5909 =item B<%{ds:>I<name>B<}>
5911 These placeholders are replaced by a (hopefully) human readable representation
5912 of the current rate of this data source. If you changed the instance name
5913 (using the B<set> or B<replace> targets, see below), it may not be possible to
5914 convert counter values to rates.
5918 Please note that these placeholders are B<case sensitive>!
5920 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
5922 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
5929 <Target "notification">
5930 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
5936 Replaces parts of the identifier using regular expressions.
5942 =item B<Host> I<Regex> I<Replacement>
5944 =item B<Plugin> I<Regex> I<Replacement>
5946 =item B<PluginInstance> I<Regex> I<Replacement>
5948 =item B<TypeInstance> I<Regex> I<Replacement>
5950 Match the appropriate field with the given regular expression I<Regex>. If the
5951 regular expression matches, that part that matches is replaced with
5952 I<Replacement>. If multiple places of the input buffer match a given regular
5953 expression, only the first occurrence will be replaced.
5955 You can specify each option multiple times to use multiple regular expressions
5963 # Replace "example.net" with "example.com"
5964 Host "\\<example.net\\>" "example.com"
5966 # Strip "www." from hostnames
5972 Sets part of the identifier of a value to a given string.
5978 =item B<Host> I<String>
5980 =item B<Plugin> I<String>
5982 =item B<PluginInstance> I<String>
5984 =item B<TypeInstance> I<String>
5986 Set the appropriate field to the given string. The strings for plugin instance
5987 and type instance may be empty, the strings for host and plugin may not be
5988 empty. It's currently not possible to set the type of a value this way.
5995 PluginInstance "coretemp"
5996 TypeInstance "core3"
6001 =head2 Backwards compatibility
6003 If you use collectd with an old configuration, i.E<nbsp>e. one without a
6004 B<Chain> block, it will behave as it used to. This is equivalent to the
6005 following configuration:
6011 If you specify a B<PostCacheChain>, the B<write> target will not be added
6012 anywhere and you will have to make sure that it is called where appropriate. We
6013 suggest to add the above snippet as default target to your "PostCache" chain.
6017 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
6033 L<collectd-exec(5)>,
6034 L<collectd-perl(5)>,
6035 L<collectd-unixsock(5)>,
6048 Florian Forster E<lt>octo@verplant.orgE<gt>