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 =item B<Include> I<Path>
62 If I<Path> points to a file, includes that file. If I<Path> points to a
63 directory, recursively includes all files within that directory and its
64 subdirectories. If the C<wordexp> function is available on your system,
65 shell-like wildcards are expanded before files are included. This means you can
66 use statements like the following:
68 Include "/etc/collectd.d/*.conf"
70 If more than one files are included by a single B<Include> option, the files
71 will be included in lexicographical order (as defined by the C<strcmp>
72 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
73 order in which the files are loaded.
75 To prevent loops and shooting yourself in the foot in interesting ways the
76 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
77 most uses. Since symlinks are followed it is still possible to crash the daemon
78 by looping symlinks. In our opinion significant stupidity should result in an
79 appropriate amount of pain.
81 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
82 file, but you cannot include files from within blocks.
84 =item B<PIDFile> I<File>
86 Sets where to write the PID file to. This file is overwritten when it exists
87 and deleted when the program is stopped. Some init-scripts might override this
88 setting using the B<-P> command-line option.
90 =item B<PluginDir> I<Directory>
92 Path to the plugins (shared objects) of collectd.
94 =item B<TypesDB> I<File> [I<File> ...]
96 Set one or more files that contain the data-set descriptions. See
97 L<types.db(5)> for a description of the format of this file.
99 =item B<Interval> I<Seconds>
101 Configures the interval in which to query the read plugins. Obviously smaller
102 values lead to a higher system load produced by collectd, while higher values
103 lead to more coarse statistics.
105 =item B<Timeout> I<Iterations>
107 Consider a value list "missing" when no update has been read or received for
108 I<Iterations> iterations. By default, I<collectd> considers a value list
109 missing when no update has been received for twice the update interval. Since
110 this setting uses iterations, the maximum allowed time without update depends
111 on the I<Interval> information contained in each value list. This is used in
112 the I<Threshold> configuration to dispatch notifications about missing values,
113 see L<"THRESHOLD CONFIGURATION"> below.
115 =item B<ReadThreads> I<Num>
117 Number of threads to start for reading plugins. The default value is B<5>, but
118 you may want to increase this if you have more than five plugins that take a
119 long time to read. Mostly those are plugin that do network-IO. Setting this to
120 a value higher than the number of plugins you've loaded is totally useless.
122 =item B<Hostname> I<Name>
124 Sets the hostname that identifies a host. If you omit this setting, the
125 hostname will be determined using the L<gethostname(2)> system call.
127 =item B<FQDNLookup> B<true|false>
129 If B<Hostname> is determined automatically this setting controls whether or not
130 the daemon should try to figure out the "fully qualified domain name", FQDN.
131 This is done using a lookup of the name returned by C<gethostname>. This option
132 is enabled by default.
134 =item B<PreCacheChain> I<ChainName>
136 =item B<PostCacheChain> I<ChainName>
138 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
139 see L<FILTER CONFIGURATION> below on information on chains and how these
140 setting change the daemon's behavior.
144 =head1 PLUGIN OPTIONS
146 Some plugins may register own options. These options must be enclosed in a
147 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
148 require external configuration, too. The C<apache plugin>, for example,
149 required C<mod_status> to be configured in the webserver you're going to
150 collect data from. These plugins are listed below as well, even if they don't
151 require any configuration within collectd's configfile.
153 A list of all plugins and a short summary for each plugin can be found in the
154 F<README> file shipped with the sourcecode and hopefully binary packets as
157 =head2 Plugin C<apache>
159 To configure the C<apache>-plugin you first need to configure the Apache
160 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
161 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
162 the following snipped to base your Apache config upon:
165 <IfModule mod_status.c>
166 <Location /mod_status>
167 SetHandler server-status
171 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
172 also supported. It introduces a new field, called C<BusyServers>, to count the
173 number of currently connected clients. This field is also supported.
175 The following options are accepted by the C<apache>-plugin:
179 =item B<URL> I<http://host/mod_status?auto>
181 Sets the URL of the C<mod_status> output. This needs to be the output generated
182 by C<ExtendedStatus on> and it needs to be the machine readable output
183 generated by appending the C<?auto> argument.
185 =item B<User> I<Username>
187 Optional user name needed for authentication.
189 =item B<Password> I<Password>
191 Optional password needed for authentication.
193 =item B<VerifyPeer> B<true|false>
195 Enable or disable peer SSL certificate verification. See
196 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
198 =item B<VerifyHost> B<true|false>
200 Enable or disable peer host name verification. If enabled, the plugin checks
201 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
202 certificate matches the host name provided by the B<URL> option. If this
203 identity check fails, the connection is aborted. Obviously, only works when
204 connecting to a SSL enabled server. Enabled by default.
206 =item B<CACert> I<File>
208 File that holds one or more SSL certificates. If you want to use HTTPS you will
209 possibly need this option. What CA certificates come bundled with C<libcurl>
210 and are checked by default depends on the distribution you use.
214 =head2 Plugin C<apcups>
218 =item B<Host> I<Hostname>
220 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
221 that IPv6 support has been disabled unless someone can confirm or decline that
222 B<apcupsd> can handle it.
224 =item B<Port> I<Port>
226 TCP-Port to connect to. Defaults to B<3551>.
230 =head2 Plugin C<ascent>
232 This plugin collects information about an Ascent server, a free server for the
233 "World of Warcraft" game. This plugin gathers the information by fetching the
234 XML status page using C<libcurl> and parses it using C<libxml2>.
236 The configuration options are the same as for the C<apache> plugin above:
240 =item B<URL> I<http://localhost/ascent/status/>
242 Sets the URL of the XML status output.
244 =item B<User> I<Username>
246 Optional user name needed for authentication.
248 =item B<Password> I<Password>
250 Optional password needed for authentication.
252 =item B<VerifyPeer> B<true|false>
254 Enable or disable peer SSL certificate verification. See
255 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
257 =item B<VerifyHost> B<true|false>
259 Enable or disable peer host name verification. If enabled, the plugin checks
260 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
261 certificate matches the host name provided by the B<URL> option. If this
262 identity check fails, the connection is aborted. Obviously, only works when
263 connecting to a SSL enabled server. Enabled by default.
265 =item B<CACert> I<File>
267 File that holds one or more SSL certificates. If you want to use HTTPS you will
268 possibly need this option. What CA certificates come bundled with C<libcurl>
269 and are checked by default depends on the distribution you use.
273 =head2 Plugin C<bind>
275 Starting with BIND 9.5.0, the most widely used DNS server software provides
276 extensive statistics about queries, responses and lots of other information.
277 The bind plugin retrieves this information that's encoded in XML and provided
278 via HTTP and submits the values to collectd.
280 To use this plugin, you first need to tell BIND to make this information
281 available. This is done with the C<statistics-channels> configuration option:
283 statistics-channels {
284 inet localhost port 8053;
287 The configuration follows the grouping that can be seen when looking at the
288 data with an XSLT compatible viewer, such as a modern web browser. It's
289 probably a good idea to make yourself familiar with the provided values, so you
290 can understand what the collected statistics actually mean.
295 URL "http://localhost:8053/"
309 Zone "127.in-addr.arpa/IN"
313 The bind plugin accepts the following configuration options:
319 URL from which to retrieve the XML data. If not specified,
320 C<http://localhost:8053/> will be used.
322 =item B<OpCodes> I<true>|I<false>
324 When enabled, statistics about the I<"OpCodes">, for example the number of
325 C<QUERY> packets, are collected.
329 =item B<QTypes> I<true>|I<false>
331 When enabled, the number of I<incoming> queries by query types (for example
332 C<A>, C<MX>, C<AAAA>) is collected.
336 =item B<ServerStats> I<true>|I<false>
338 Collect global server statistics, such as requests received over IPv4 and IPv6,
339 successful queries, and failed updates.
343 =item B<ZoneMaintStats> I<true>|I<false>
345 Collect zone maintenance statistics, mostly information about notifications
346 (zone updates) and zone transfers.
350 =item B<ResolverStats> I<true>|I<false>
352 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
353 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
354 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
355 default. Use the B<ResolverStats> option within a B<View "_default"> block
356 instead for the same functionality.
362 Collect global memory statistics.
366 =item B<View> I<Name>
368 Collect statistics about a specific I<"view">. BIND can behave different,
369 mostly depending on the source IP-address of the request. These different
370 configurations are called "views". If you don't use this feature, you most
371 likely are only interested in the C<_default> view.
373 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
374 information you want to collect about a view. If no B<View> block is
375 configured, no detailed view statistics will be collected.
379 =item B<QTypes> I<true>|I<false>
381 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
386 =item B<ResolverStats> I<true>|I<false>
388 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
389 (e.E<nbsp>g. queries over IPv4, lame servers).
393 =item B<CacheRRSets> I<true>|I<false>
395 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
396 type is collected. Negative entries (queries which resulted in an error, for
397 example names that do not exist) are reported with a leading exclamation mark,
402 =item B<Zone> I<Name>
404 When given, collect detailed information about the given zone in the view. The
405 information collected if very similar to the global B<ServerStats> information
408 You can repeat this option to collect detailed information about multiple
411 By default no detailed zone information is collected.
417 =head2 Plugin C<cpufreq>
419 This plugin doesn't have any options. It reads
420 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
421 installed) to get the current CPU frequency. If this file does not exist make
422 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
423 installed and an "cpu governor" (that's a kernel module) is loaded.
429 =item B<DataDir> I<Directory>
431 Set the directory to store CSV-files under. Per default CSV-files are generated
432 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
433 The special strings B<stdout> and B<stderr> can be used to write to the standard
434 output and standard error channels, respectively. This, of course, only makes
435 much sense when collectd is running in foreground- or non-daemon-mode.
437 =item B<StoreRates> B<true|false>
439 If set to B<true>, convert counter values to rates. If set to B<false> (the
440 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
445 =head2 Plugin C<curl>
447 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
448 and the match infrastructure (the same code used by the tail plugin) to use
449 regular expressions with the received data.
451 The following example will read the current value of AMD stock from Google's
452 finance page and dispatch the value to collectd.
455 <Page "stock_quotes">
456 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
460 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
461 DSType "GaugeAverage"
462 # Note: `stock_value' is not a standard type.
469 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
470 a web page and one or more "matches" to be performed on the returned data. The
471 string argument to the B<Page> block is used as plugin instance.
473 The following options are valid within B<Page> blocks:
479 URL of the web site to retrieve. Since a regular expression will be used to
480 extract information from this data, non-binary data is a big plus here ;)
482 =item B<User> I<Name>
484 Username to use if authorization is required to read the page.
486 =item B<Password> I<Password>
488 Password to use if authorization is required to read the page.
490 =item B<VerifyPeer> B<true>|B<false>
492 Enable or disable peer SSL certificate verification. See
493 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
495 =item B<VerifyHost> B<true>|B<false>
497 Enable or disable peer host name verification. If enabled, the plugin checks if
498 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
499 matches the host name provided by the B<URL> option. If this identity check
500 fails, the connection is aborted. Obviously, only works when connecting to a
501 SSL enabled server. Enabled by default.
503 =item B<CACert> I<file>
505 File that holds one or more SSL certificates. If you want to use HTTPS you will
506 possibly need this option. What CA certificates come bundled with C<libcurl>
507 and are checked by default depends on the distribution you use.
509 =item B<MeasureResponseTime> B<true>|B<false>
511 Measure response time for the request. If this setting is enabled, B<Match>
512 blocks (see below) are optional. Disabled by default.
514 =item B<E<lt>MatchE<gt>>
516 One or more B<Match> blocks that define how to match information in the data
517 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
518 used by the C<tail> plugin, so please see the documentation of the C<tail>
519 plugin below on how matches are defined. If the B<MeasureResponseTime> option
520 is set to B<true>, B<Match> blocks are optional.
524 =head2 Plugin C<curl_json>
526 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
527 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
528 via cURL. This can be used to collect values from CouchDB documents (which are
529 stored JSON notation), for example.
531 The following example will collect several values from the built-in `_stats'
532 runtime statistics module of CouchDB
533 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
536 <URL "http://localhost:5984/_stats">
538 <Key "httpd/requests/count">
542 <Key "httpd_request_methods/*/count">
543 Type "http_request_methods"
546 <Key "httpd_status_codes/*/count">
547 Type "http_response_codes"
552 Another CouchDB example:
553 The following example will collect the status values from each database:
555 <URL "http://localhost:5984/_all_dbs">
560 <Key "*/doc_del_count">
568 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
569 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
570 The B<Key> string argument must be in a path format, which is used to collect a
571 value from a JSON map object. If a path element of B<Key> is the
572 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
574 The following options are valid within B<URL> blocks:
578 =item B<Instance> I<Instance>
580 Sets the plugin instance to I<Instance>.
582 =item B<User> I<Name>
584 Username to use if authorization is required to read the page.
586 =item B<Password> I<Password>
588 Password to use if authorization is required to read the page.
590 =item B<VerifyPeer> B<true>|B<false>
592 Enable or disable peer SSL certificate verification. See
593 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
595 =item B<VerifyHost> B<true>|B<false>
597 Enable or disable peer host name verification. If enabled, the plugin checks if
598 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
599 matches the host name provided by the B<URL> option. If this identity check
600 fails, the connection is aborted. Obviously, only works when connecting to a
601 SSL enabled server. Enabled by default.
603 =item B<CACert> I<file>
605 File that holds one or more SSL certificates. If you want to use HTTPS you will
606 possibly need this option. What CA certificates come bundled with C<libcurl>
607 and are checked by default depends on the distribution you use.
611 The following options are valid within B<Key> blocks:
615 =item B<Type> I<Type>
617 Sets the type used to dispatch the values to the daemon. Detailed information
618 about types and their configuration can be found in L<types.db(5)>. This
621 =item B<Instance> I<Instance>
623 Type-instance to use. Defaults to the current map key or current string array element value.
627 =head2 Plugin C<curl_xml>
629 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
630 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
633 <URL "http://localhost/stats.xml">
635 Instance "some_instance"
640 CACert "/path/to/ca.crt"
642 <XPath "table[@id=\"magic_level\"]/tr">
644 #InstancePrefix "prefix-"
646 ValuesFrom "td[2]/span[@class=\"level\"]"
651 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
652 URL to be fetched via HTTP (using libcurl). Within each B<URL> block there are
653 options which specify the connection parameters, for example authentication
654 information, and one or more B<XPath> blocks.
656 Each B<XPath> block specifies how to get one type of information. The
657 string argument must be a valid XPath expression which returns a list
658 of "base elements". One value is dispatched for each "base element". The
659 I<type instance> and values are looked up using further I<XPath> expressions
660 that should be relative to the base element.
662 Within the B<URL> block the following options are accepted:
666 =item B<Host> I<Name>
668 Use I<Name> as the host name when submitting values. Defaults to the global
671 =item B<Instance> I<Instance>
673 Use I<Instance> as the plugin instance when submitting values. Defaults to an
674 empty string (no plugin instance).
676 =item B<User> I<User>
677 =item B<Password> I<Password>
678 =item B<VerifyPeer> B<true>|B<false>
679 =item B<VerifyHost> B<true>|B<false>
680 =item B<CACert> I<CA Cert File>
682 These options behave exactly equivalent to the appropriate options of the
683 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
685 =item E<lt>B<XPath> I<XPath-expression>E<gt>
687 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
688 B<XPath> block specifies how to get one type of information. The string
689 argument must be a valid XPath expression which returns a list of "base
690 elements". One value is dispatched for each "base element".
692 Within the B<XPath> block the following options are accepted:
696 =item B<Type> I<Type>
698 Specifies the I<Type> used for submitting patches. This determines the number
699 of values that are required / expected and whether the strings are parsed as
700 signed or unsigned integer or as double values. See L<types.db(5)> for details.
701 This option is required.
703 =item B<InstancePrefix> I<InstancePrefix>
705 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
706 concatenated together without any separator.
707 This option is optional.
709 =item B<InstanceFrom> I<InstanceFrom>
711 Specifies a XPath expression to use for determining the I<type instance>. The
712 XPath expression must return exactly one element. The element's value is then
713 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
715 This value is required. As a special exception, if the "base XPath expression"
716 (the argument to the B<XPath> block) returns exactly one argument, then this
717 option may be omitted.
719 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
721 Specifies one or more XPath expression to use for reading the values. The
722 number of XPath expressions must match the number of data sources in the
723 I<type> specified with B<Type> (see above). Each XPath expression must return
724 exactly one element. The element's value is then parsed as a number and used as
725 value for the appropriate value in the value list dispatched to the daemon.
733 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
734 connect to various databases, execute I<SQL> statements and read back the
735 results. I<dbi> is an acronym for "database interface" in case you were
736 wondering about the name. You can configure how each column is to be
737 interpreted and the plugin will generate one or more data sets from each row
738 returned according to these rules.
740 Because the plugin is very generic, the configuration is a little more complex
741 than those of other plugins. It usually looks something like this:
744 <Query "out_of_stock">
745 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
746 # Use with MySQL 5.0.0 or later
750 InstancePrefix "out_of_stock"
751 InstancesFrom "category"
755 <Database "product_information">
757 DriverOption "host" "localhost"
758 DriverOption "username" "collectd"
759 DriverOption "password" "aZo6daiw"
760 DriverOption "dbname" "prod_info"
766 The configuration above defines one query with one result and one database. The
767 query is then linked to the database with the B<Query> option I<within> the
768 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
769 and you can also use the B<Include> statement to split up the configuration
770 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
771 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
774 The following is a complete list of options:
776 =head3 B<Query> blocks
778 Query blocks define I<SQL> statements and how the returned data should be
779 interpreted. They are identified by the name that is given in the opening line
780 of the block. Thus the name needs to be unique. Other than that, the name is
781 not used in collectd.
783 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
784 define which column holds which value or instance information. You can use
785 multiple B<Result> blocks to create multiple values from one returned row. This
786 is especially useful, when queries take a long time and sending almost the same
787 query again and again is not desirable.
791 <Query "environment">
792 Statement "select station, temperature, humidity from environment"
795 # InstancePrefix "foo"
796 InstancesFrom "station"
797 ValuesFrom "temperature"
801 InstancesFrom "station"
802 ValuesFrom "humidity"
806 The following options are accepted:
810 =item B<Statement> I<SQL>
812 Sets the statement that should be executed on the server. This is B<not>
813 interpreted by collectd, but simply passed to the database server. Therefore,
814 the SQL dialect that's used depends on the server collectd is connected to.
816 The query has to return at least two columns, one for the instance and one
817 value. You cannot omit the instance, even if the statement is guaranteed to
818 always return exactly one line. In that case, you can usually specify something
821 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
823 (That works with MySQL but may not be valid SQL according to the spec. If you
824 use a more strict database server, you may have to select from a dummy table or
827 Please note that some databases, for example B<Oracle>, will fail if you
828 include a semicolon at the end of the statement.
830 =item B<MinVersion> I<Version>
832 =item B<MaxVersion> I<Value>
834 Only use this query for the specified database version. You can use these
835 options to provide multiple queries with the same name but with a slightly
836 different syntax. The plugin will use only those queries, where the specified
837 minimum and maximum versions fit the version of the database in use.
839 The database version is determined by C<dbi_conn_get_engine_version>, see the
840 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
841 for details. Basically, each part of the version is assumed to be in the range
842 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
843 "40102", version "5.0.42" becomes "50042".
845 B<Warning:> The plugin will use B<all> matching queries, so if you specify
846 multiple queries with the same name and B<overlapping> ranges, weird stuff will
847 happen. Don't to it! A valid example would be something along these lines:
858 In the above example, there are three ranges that don't overlap. The last one
859 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
860 before "4.0.0" are not specified.
862 =item B<Type> I<Type>
864 The B<type> that's used for each line returned. See L<types.db(5)> for more
865 details on how types are defined. In short: A type is a predefined layout of
866 data and the number of values and type of values has to match the type
869 If you specify "temperature" here, you need exactly one gauge column. If you
870 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
873 There must be exactly one B<Type> option inside each B<Result> block.
875 =item B<InstancePrefix> I<prefix>
877 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
878 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
879 all strings returned in the appropriate columns are concatenated together,
880 separated by dashes I<("-")>.
882 =item B<InstancesFrom> I<column0> [I<column1> ...]
884 Specifies the columns whose values will be used to create the "type-instance"
885 for each row. If you specify more than one column, the value of all columns
886 will be joined together with dashes I<("-")> as separation characters.
888 The plugin itself does not check whether or not all built instances are
889 different. It's your responsibility to assure that each is unique. This is
890 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
891 sure that only one row is returned in this case.
893 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
896 =item B<ValuesFrom> I<column0> [I<column1> ...]
898 Names the columns whose content is used as the actual data for the data sets
899 that are dispatched to the daemon. How many such columns you need is determined
900 by the B<Type> setting above. If you specify too many or not enough columns,
901 the plugin will complain about that and no data will be submitted to the
904 The actual data type in the columns is not that important. The plugin will
905 automatically cast the values to the right type if it know how to do that. So
906 it should be able to handle integer an floating point types, as well as strings
907 (if they include a number at the beginning).
909 There must be at least one B<ValuesFrom> option inside each B<Result> block.
913 =head3 B<Database> blocks
915 Database blocks define a connection to a database and which queries should be
916 sent to that database. Since the used "dbi" library can handle a wide variety
917 of databases, the configuration is very generic. If in doubt, refer to libdbi's
918 documentationE<nbsp>- we stick as close to the terminology used there.
920 Each database needs a "name" as string argument in the starting tag of the
921 block. This name will be used as "PluginInstance" in the values submitted to
922 the daemon. Other than that, that name is not used.
926 =item B<Driver> I<Driver>
928 Specifies the driver to use to connect to the database. In many cases those
929 drivers are named after the database they can connect to, but this is not a
930 technical necessity. These drivers are sometimes referred to as "DBD",
931 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
932 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
933 project at L<http://libdbi-drivers.sourceforge.net/>.
935 You need to give the driver name as expected by the "dbi" library here. You
936 should be able to find that in the documentation for each driver. If you
937 mistype the driver name, the plugin will dump a list of all known driver names
940 =item B<DriverOption> I<Key> I<Value>
942 Sets driver-specific options. What option a driver supports can be found in the
943 documentation for each driver, somewhere at
944 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
945 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
947 Unfortunately, drivers are not too keen to report errors when an unknown option
948 is passed to them, so invalid settings here may go unnoticed. This is not the
949 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
950 the driver. If a driver complains about an option, the plugin will dump a
951 complete list of all options understood by that driver to the log.
953 =item B<SelectDB> I<Database>
955 In some cases, the database name you connect with is not the database name you
956 want to use for querying data. If this option is set, the plugin will "select"
957 (switch to) that database after the connection is established.
959 =item B<Query> I<QueryName>
961 Associates the query named I<QueryName> with this database connection. The
962 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
963 blocks you want to refer to must be placed above the database block you want to
972 =item B<Device> I<Device>
974 Select partitions based on the devicename.
976 =item B<MountPoint> I<Directory>
978 Select partitions based on the mountpoint.
980 =item B<FSType> I<FSType>
982 Select partitions based on the filesystem type.
984 =item B<IgnoreSelected> B<true>|B<false>
986 Invert the selection: If set to true, all partitions B<except> the ones that
987 match any one of the criteria are collected. By default only selected
988 partitions are collected if a selection is made. If no selection is configured
989 at all, B<all> partitions are selected.
991 =item B<ReportByDevice> B<true>|B<false>
993 Report using the device name rather than the mountpoint. i.e. with this I<false>,
994 (the default), it will report a disk as "root", but with it I<true>, it will be
995 "sda1" (or whichever).
997 =item B<ReportReserved> B<true>|B<false>
999 When enabled, the blocks reserved for root are reported separately. When
1000 disabled (the default for backwards compatibility reasons) the reserved space
1001 will be included in the "free" space.
1003 When disabled, the "df" type will be used to store "free" and "used" space. The
1004 mount point or disk name (see option B<ReportByDevice>) is used as type
1005 instance in this case (again: backwards compatibility).
1007 When enabled, the type "df_complex" is used and three files are created. The
1008 mount point or disk name is used as plugin instance and the type instance is
1009 set to "free", "reserved" and "used" as appropriate.
1011 Enabling this option is recommended.
1013 =item B<ReportInodes> B<true>|B<false>
1015 Enables or disables reporting of free, reserved and used inodes. Defaults to
1016 inode collection being disabled.
1018 Enable this option if inodes are a scarce resource for you, usually because
1019 many small files are stored on the disk. This is a usual scenario for mail
1020 transfer agents and web caches.
1024 =head2 Plugin C<disk>
1026 The C<disk> plugin collects information about the usage of physical disks and
1027 logical disks (partitions). Values collected are the number of octets written
1028 to and read from a disk or partition, the number of read/write operations
1029 issued to the disk and a rather complex "time" it took for these commands to be
1032 Using the following two options you can ignore some disks or configure the
1033 collection only of specific disks.
1037 =item B<Disk> I<Name>
1039 Select the disk I<Name>. Whether it is collected or ignored depends on the
1040 B<IgnoreSelected> setting, see below. As with other plugins that use the
1041 daemon's ignorelist functionality, a string that starts and ends with a slash
1042 is interpreted as a regular expression. Examples:
1047 =item B<IgnoreSelected> B<true>|B<false>
1049 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1050 statements, are ignored or if all other disks are ignored. The behavior
1051 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1052 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1053 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1054 is set to B<true>, all disks are collected B<except> the ones matched.
1058 =head2 Plugin C<dns>
1062 =item B<Interface> I<Interface>
1064 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1065 option sets the interface that should be used. If this option is not set, or
1066 set to "any", the plugin will try to get packets from B<all> interfaces. This
1067 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1069 =item B<IgnoreSource> I<IP-address>
1071 Ignore packets that originate from this address.
1073 =item B<SelectNumericQueryTypes> B<true>|B<false>
1075 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1079 =head2 Plugin C<email>
1083 =item B<SocketFile> I<Path>
1085 Sets the socket-file which is to be created.
1087 =item B<SocketGroup> I<Group>
1089 If running as root change the group of the UNIX-socket after it has been
1090 created. Defaults to B<collectd>.
1092 =item B<SocketPerms> I<Permissions>
1094 Change the file permissions of the UNIX-socket after it has been created. The
1095 permissions must be given as a numeric, octal value as you would pass to
1096 L<chmod(1)>. Defaults to B<0770>.
1098 =item B<MaxConns> I<Number>
1100 Sets the maximum number of connections that can be handled in parallel. Since
1101 this many threads will be started immediately setting this to a very high
1102 value will waste valuable resources. Defaults to B<5> and will be forced to be
1103 at most B<16384> to prevent typos and dumb mistakes.
1107 =head2 Plugin C<exec>
1109 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1110 contains valuable information on when the executable is executed and the
1111 output that is expected from it.
1115 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1117 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1119 Execute the executable I<Executable> as user I<User>. If the user name is
1120 followed by a colon and a group name, the effective group is set to that group.
1121 The real group and saved-set group will be set to the default group of that
1122 user. If no group is given the effective group ID will be the same as the real
1125 Please note that in order to change the user and/or group the daemon needs
1126 superuser privileges. If the daemon is run as an unprivileged user you must
1127 specify the same user/group here. If the daemon is run with superuser
1128 privileges, you must supply a non-root user here.
1130 The executable may be followed by optional arguments that are passed to the
1131 program. Please note that due to the configuration parsing numbers and boolean
1132 values may be changed. If you want to be absolutely sure that something is
1133 passed as-is please enclose it in quotes.
1135 The B<Exec> and B<NotificationExec> statements change the semantics of the
1136 programs executed, i.E<nbsp>e. the data passed to them and the response
1137 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1141 =head2 Plugin C<filecount>
1143 The C<filecount> plugin counts the number of files in a certain directory (and
1144 its subdirectories) and their combined size. The configuration is very straight
1147 <Plugin "filecount">
1148 <Directory "/var/qmail/queue/mess">
1149 Instance "qmail-message"
1151 <Directory "/var/qmail/queue/todo">
1152 Instance "qmail-todo"
1154 <Directory "/var/lib/php5">
1155 Instance "php5-sessions"
1160 The example above counts the number of files in QMail's queue directories and
1161 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1162 QMail has not yet looked at, the "message" queue holds the messages that were
1163 classified into "local" and "remote".
1165 As you can see, the configuration consists of one or more C<Directory> blocks,
1166 each of which specifies a directory in which to count the files. Within those
1167 blocks, the following options are recognized:
1171 =item B<Instance> I<Instance>
1173 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1174 it's your responsibility, the plugin doesn't check for that. If not given, the
1175 instance is set to the directory name with all slashes replaced by underscores
1176 and all leading underscores removed.
1178 =item B<Name> I<Pattern>
1180 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1181 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1182 against the pattern, not the entire path. In case this makes it easier for you:
1183 This option has been named after the B<-name> parameter to L<find(1)>.
1185 =item B<MTime> I<Age>
1187 Count only files of a specific age: If I<Age> is greater than zero, only files
1188 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1189 a negative number, this is inversed. For example, if B<-60> is specified, only
1190 files that have been modified in the last minute will be counted.
1192 The number can also be followed by a "multiplier" to easily specify a larger
1193 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1194 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1195 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1196 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1197 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1200 =item B<Size> I<Size>
1202 Count only files of a specific size. When I<Size> is a positive number, only
1203 files that are at least this big are counted. If I<Size> is a negative number,
1204 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1205 I<Size> are counted.
1207 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1208 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1209 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1210 note that there are 1000 bytes in a kilobyte, not 1024.
1212 =item B<Recursive> I<true>|I<false>
1214 Controls whether or not to recurse into subdirectories. Enabled by default.
1216 =item B<IncludeHidden> I<true>|I<false>
1218 Controls whether or not to include "hidden" files and directories in the count.
1219 "Hidden" files and directories are those, whose name begins with a dot.
1220 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1224 =head2 Plugin C<GenericJMX>
1226 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1227 L<collectd-java(5)>.
1229 =head2 Plugin C<gmond>
1231 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1232 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1233 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1238 MCReceiveFrom "239.2.11.71" "8649"
1239 <Metric "swap_total">
1241 TypeInstance "total"
1244 <Metric "swap_free">
1251 The following metrics are built-in:
1257 load_one, load_five, load_fifteen
1261 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1265 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1277 Available configuration options:
1281 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1283 Sets sets the multicast group and UDP port to which to subscribe.
1285 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1287 =item E<lt>B<Metric> I<Name>E<gt>
1289 These blocks add a new metric conversion to the internal table. I<Name>, the
1290 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1294 =item B<Type> I<Type>
1296 Type to map this metric to. Required.
1298 =item B<TypeInstance> I<Instance>
1300 Type-instance to use. Optional.
1302 =item B<DataSource> I<Name>
1304 Data source to map this metric to. If the configured type has exactly one data
1305 source, this is optional. Otherwise the option is required.
1311 =head2 Plugin C<hddtemp>
1313 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1314 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1315 default values, see below. C<hddtemp> has to be running to work correctly. If
1316 C<hddtemp> is not running timeouts may appear which may interfere with other
1319 The B<hddtemp> homepage can be found at
1320 L<http://www.guzu.net/linux/hddtemp.php>.
1324 =item B<Host> I<Hostname>
1326 Hostname to connect to. Defaults to B<127.0.0.1>.
1328 =item B<Port> I<Port>
1330 TCP-Port to connect to. Defaults to B<7634>.
1332 =item B<TranslateDevicename> I<true>|I<false>
1334 If enabled, translate the disk names to major/minor device numbers
1335 (e.E<nbsp>g. "8-0" for /dev/sda). For backwards compatibility this defaults to
1336 I<true> but it's recommended to disable it as it will probably be removed in
1337 the next major version.
1341 =head2 Plugin C<interface>
1345 =item B<Interface> I<Interface>
1347 Select this interface. By default these interfaces will then be collected. For
1348 a more detailed description see B<IgnoreSelected> below.
1350 =item B<IgnoreSelected> I<true>|I<false>
1352 If no configuration if given, the B<traffic>-plugin will collect data from
1353 all interfaces. This may not be practical, especially for loopback- and
1354 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1355 interfaces you're interested in. Sometimes, however, it's easier/preferred
1356 to collect all interfaces I<except> a few ones. This option enables you to
1357 do that: By setting B<IgnoreSelected> to I<true> the effect of
1358 B<Interface> is inverted: All selected interfaces are ignored and all
1359 other interfaces are collected.
1363 =head2 Plugin C<ipmi>
1367 =item B<Sensor> I<Sensor>
1369 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1371 =item B<IgnoreSelected> I<true>|I<false>
1373 If no configuration if given, the B<ipmi> plugin will collect data from all
1374 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1375 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1376 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1377 all other sensors are collected.
1379 =item B<NotifySensorAdd> I<true>|I<false>
1381 If a sensor appears after initialization time of a minute a notification
1384 =item B<NotifySensorRemove> I<true>|I<false>
1386 If a sensor disappears a notification is sent.
1388 =item B<NotifySensorNotPresent> I<true>|I<false>
1390 If you have for example dual power supply and one of them is (un)plugged then
1391 a notification is sent.
1395 =head2 Plugin C<iptables>
1399 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1401 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1402 will collect the counters of all rules which have a comment-match. The comment
1403 is then used as type-instance.
1405 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1406 the I<n>th rule will be collected. Again, the comment (or the number) will be
1407 used as the type-instance.
1409 If I<Name> is supplied, it will be used as the type-instance instead of the
1410 comment or the number.
1414 =head2 Plugin C<irq>
1420 Select this irq. By default these irqs will then be collected. For a more
1421 detailed description see B<IgnoreSelected> below.
1423 =item B<IgnoreSelected> I<true>|I<false>
1425 If no configuration if given, the B<irq>-plugin will collect data from all
1426 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1427 can use the B<Irq>-option to pick the interrupt you're interested in.
1428 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1429 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1430 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1431 and all other interrupts are collected.
1435 =head2 Plugin C<java>
1437 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1438 This section only discusses the syntax and semantic of the configuration
1439 options. For more in-depth information on the I<Java> plugin, please read
1440 L<collectd-java(5)>.
1445 JVMArg "-verbose:jni"
1446 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1447 LoadPlugin "org.collectd.java.Foobar"
1448 <Plugin "org.collectd.java.Foobar">
1449 # To be parsed by the plugin
1453 Available configuration options:
1457 =item B<JVMArg> I<Argument>
1459 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1460 exactly the way the arguments to the I<java> binary on the command line work.
1461 Execute C<javaE<nbsp>--help> for details.
1463 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1464 any other options! When another option is found, the JVM will be started and
1465 later options will have to be ignored!
1467 =item B<LoadPlugin> I<JavaClass>
1469 Instantiates a new I<JavaClass> object. The constructor of this object very
1470 likely then registers one or more callback methods with the server.
1472 See L<collectd-java(5)> for details.
1474 When the first such option is found, the virtual machine (JVM) is created. This
1475 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1476 B<LoadPlugin> options!
1478 =item B<Plugin> I<Name>
1480 The entire block is passed to the Java plugin as an
1481 I<org.collectd.api.OConfigItem> object.
1483 For this to work, the plugin has to register a configuration callback first,
1484 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1485 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1486 depends on the (Java) plugin registering the callback and is completely
1487 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1491 =head2 Plugin C<libvirt>
1493 This plugin allows CPU, disk and network load to be collected for virtualized
1494 guests on the machine. This means that these characteristics can be collected
1495 for guest systems without installing any software on them - collectd only runs
1496 on the hosting system. The statistics are collected through libvirt
1497 (L<http://libvirt.org/>).
1499 Only I<Connection> is required.
1503 =item B<Connection> I<uri>
1505 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1507 Connection "xen:///"
1509 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1511 =item B<RefreshInterval> I<seconds>
1513 Refresh the list of domains and devices every I<seconds>. The default is 60
1514 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1515 the list of domains and devices to be refreshed on every iteration.
1517 Refreshing the devices in particular is quite a costly operation, so if your
1518 virtualization setup is static you might consider increasing this. If this
1519 option is set to 0, refreshing is disabled completely.
1521 =item B<Domain> I<name>
1523 =item B<BlockDevice> I<name:dev>
1525 =item B<InterfaceDevice> I<name:dev>
1527 =item B<IgnoreSelected> I<true>|I<false>
1529 Select which domains and devices are collected.
1531 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1532 disk/network devices are collected.
1534 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1535 domains and disk/network devices are ignored, while the rest are collected.
1537 The domain name and device names may use a regular expression, if the name is
1538 surrounded by I</.../> and collectd was compiled with support for regexps.
1540 The default is to collect statistics for all domains and all their devices.
1544 BlockDevice "/:hdb/"
1545 IgnoreSelected "true"
1547 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1550 =item B<HostnameFormat> B<name|uuid|hostname|...>
1552 When the libvirt plugin logs data, it sets the hostname of the collected data
1553 according to this setting. The default is to use the guest name as provided by
1554 the hypervisor, which is equal to setting B<name>.
1556 B<uuid> means use the guest's UUID. This is useful if you want to track the
1557 same guest across migrations.
1559 B<hostname> means to use the global B<Hostname> setting, which is probably not
1560 useful on its own because all guests will appear to have the same name.
1562 You can also specify combinations of these fields. For example B<name uuid>
1563 means to concatenate the guest name and UUID (with a literal colon character
1564 between, thus I<"foo:1234-1234-1234-1234">).
1566 =item B<InterfaceFormat> B<name|address|...>
1568 When the libvirt plugin logs interface data, it sets the name of the collected data according to this setting.
1569 The default is to use the path as provided by the hypervisor (the ’dev’ property of the target node), which is equal to setting B<name>.
1571 B<address> means use the interface's mac address.
1572 This is useful since the interface path might change between reboots of a guest or across migrations.
1576 =head2 Plugin C<logfile>
1580 =item B<LogLevel> B<debug|info|notice|warning|err>
1582 Sets the log-level. If, for example, set to B<notice>, then all events with
1583 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1585 Please note that B<debug> is only available if collectd has been compiled with
1588 =item B<File> I<File>
1590 Sets the file to write log messages to. The special strings B<stdout> and
1591 B<stderr> can be used to write to the standard output and standard error
1592 channels, respectively. This, of course, only makes much sense when collectd is
1593 running in foreground- or non-daemon-mode.
1595 =item B<Timestamp> B<true>|B<false>
1597 Prefix all lines printed by the current time. Defaults to B<true>.
1599 =item B<PrintSeverity> B<true>|B<false>
1601 When enabled, all lines are prefixed by the severity of the log message, for
1602 example "warning". Defaults to B<false>.
1606 B<Note>: There is no need to notify the daemon after moving or removing the
1607 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1608 for each line it writes.
1610 =head2 Plugin C<mbmon>
1612 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
1614 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
1615 B<Host> and B<Port> options can be used to change these values, see below.
1616 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
1617 timeouts may appear which may interfere with other statistics..
1619 C<mbmon> must be run with the -r option ("print TAG and Value format");
1620 Debian's F</etc/init.d/mbmon> script already does this, other people
1621 will need to ensure that this is the case.
1625 =item B<Host> I<Hostname>
1627 Hostname to connect to. Defaults to B<127.0.0.1>.
1629 =item B<Port> I<Port>
1631 TCP-Port to connect to. Defaults to B<411>.
1635 =head2 Plugin C<memcachec>
1637 The C<memcachec plugin> connects to a memcached server, queries one or more
1638 given I<pages> and parses the returned data according to user specification.
1639 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
1642 In order to talk to the memcached server, this plugin uses the I<libmemcached>
1643 library. Please note that there is another library with a very similar name,
1644 libmemcache (notice the missing `d'), which is not applicable.
1646 Synopsis of the configuration:
1648 <Plugin "memcachec">
1649 <Page "plugin_instance">
1653 Regex "(\\d+) bytes sent"
1656 Instance "type_instance"
1661 The configuration options are:
1665 =item E<lt>B<Page> I<Name>E<gt>
1667 Each B<Page> block defines one I<page> to be queried from the memcached server.
1668 The block requires one string argument which is used as I<plugin instance>.
1670 =item B<Server> I<Address>
1672 Sets the server address to connect to when querying the page. Must be inside a
1677 When connected to the memcached server, asks for the page I<Key>.
1679 =item E<lt>B<Match>E<gt>
1681 Match blocks define which strings to look for and how matches substrings are
1682 interpreted. For a description of match blocks, please see L<"Plugin tail">.
1686 =head2 Plugin C<memcached>
1688 The C<memcached plugin> connects to a memcached server and queries statistics
1689 about cache utilization, memory and bandwidth used.
1690 L<http://www.danga.com/memcached/>
1694 =item B<Host> I<Hostname>
1696 Hostname to connect to. Defaults to B<127.0.0.1>.
1698 =item B<Port> I<Port>
1700 TCP-Port to connect to. Defaults to B<11211>.
1704 =head2 Plugin C<modbus>
1706 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
1707 register values. It supports reading single registers (unsigned 16E<nbsp>bit
1708 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
1709 values (two registers interpreted as IEEE floats in big endian notation).
1713 <Data "voltage-input-1">
1720 <Data "voltage-input-2">
1727 <Host "modbus.example.com">
1728 Address "192.168.0.42"
1733 Instance "power-supply"
1734 Collect "voltage-input-1"
1735 Collect "voltage-input-2"
1741 =item E<lt>B<Data> I<Name>E<gt> blocks
1743 Data blocks define a mapping between register numbers and the "types" used by
1746 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
1750 =item B<RegisterBase> I<Number>
1752 Configures the base register to read from the device. If the option
1753 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
1754 register will be read (the register number is increased by one).
1756 =item B<RegisterType> B<Uint16>|B<Uint32>|B<Float>
1758 Specifies what kind of data is returned by the device. If the type is B<Uint32>
1759 or B<Float>, two 16E<nbsp>bit registers will be read and the data is combined
1760 into one value. Defaults to B<Uint16>.
1762 =item B<Type> I<Type>
1764 Specifies the "type" (data set) to use when dispatching the value to
1765 I<collectd>. Currently, only data sets with exactly one data source are
1768 =item B<Instance> I<Instance>
1770 Sets the type instance to use when dispatching the value to I<collectd>. If
1771 unset, an empty string (no type instance) is used.
1775 =item E<lt>B<Host> I<Name>E<gt> blocks
1777 Host blocks are used to specify to which hosts to connect and what data to read
1778 from their "slaves". The string argument I<Name> is used as hostname when
1779 dispatching the values to I<collectd>.
1781 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
1785 =item B<Address> I<Hostname>
1787 Specifies the node name (the actual network address) used to connect to the
1788 host. This may be an IP address or a hostname. Please note that the used
1789 I<libmodbus> library only supports IPv4 at the moment.
1791 =item B<Port> I<Service>
1793 Specifies the port used to connect to the host. The port can either be given as
1794 a number or as a service name. Please note that the I<Service> argument must be
1795 a string, even if ports are given in their numerical form. Defaults to "502".
1797 =item B<Interval> I<Interval>
1799 Sets the interval (in seconds) in which the values will be collected from this
1800 host. By default the global B<Interval> setting will be used.
1802 =item E<lt>B<Slave> I<ID>E<gt>
1804 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
1805 is used to specify which device should be addressed. For each device you want
1806 to query, one B<Slave> block must be given.
1808 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
1812 =item B<Instance> I<Instance>
1814 Specify the plugin instance to use when dispatching the values to I<collectd>.
1815 By default "slave_I<ID>" is used.
1817 =item B<Collect> I<DataName>
1819 Specifies which data to retrieve from the device. I<DataName> must be the same
1820 string as the I<Name> argument passed to a B<Data> block. You can specify this
1821 option multiple times to collect more than one value from a slave. At least one
1822 B<Collect> option is mandatory.
1830 =head2 Plugin C<mysql>
1832 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
1833 one or more databases when started and keeps the connection up as long as
1834 possible. When the connection is interrupted for whatever reason it will try
1835 to re-connect. The plugin will complaint loudly in case anything goes wrong.
1837 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
1838 and collects information about MySQL network traffic, executed statements,
1839 requests, the query cache and threads by evaluating the
1840 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
1841 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
1842 Status Variables> for an explanation of these values.
1844 Optionally, master and slave statistics may be collected in a MySQL
1845 replication setup. In that case, information about the synchronization state
1846 of the nodes are collected by evaluating the C<Position> return value of the
1847 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
1848 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
1849 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
1850 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
1851 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
1866 Socket "/var/run/mysql/mysqld.sock"
1868 SlaveNotifications true
1872 A B<Database> block defines one connection to a MySQL database. It accepts a
1873 single argument which specifies the name of the database. None of the other
1874 options are required. MySQL will use default values as documented in the
1875 section "mysql_real_connect()" in the B<MySQL reference manual>.
1879 =item B<Host> I<Hostname>
1881 Hostname of the database server. Defaults to B<localhost>.
1883 =item B<User> I<Username>
1885 Username to use when connecting to the database. The user does not have to be
1886 granted any privileges (which is synonym to granting the C<USAGE> privilege).
1887 Any existing MySQL user will do.
1889 =item B<Password> I<Password>
1891 Password needed to log into the database.
1893 =item B<Database> I<Database>
1895 Select this database. Defaults to I<no database> which is a perfectly reasonable
1896 option for what this plugin does.
1898 =item B<Port> I<Port>
1900 TCP-port to connect to. The port must be specified in its numeric form, but it
1901 must be passed as a string nonetheless. For example:
1905 If B<Host> is set to B<localhost> (the default), this setting has no effect.
1906 See the documentation for the C<mysql_real_connect> function for details.
1908 =item B<Socket> I<Socket>
1910 Specifies the path to the UNIX domain socket of the MySQL server. This option
1911 only has any effect, if B<Host> is set to B<localhost> (the default).
1912 Otherwise, use the B<Port> option above. See the documentation for the
1913 C<mysql_real_connect> function for details.
1915 =item B<MasterStats> I<true|false>
1917 =item B<SlaveStats> I<true|false>
1919 Enable the collection of master / slave statistics in a replication setup.
1921 =item B<SlaveNotifications> I<true|false>
1923 If enabled, the plugin sends a notification if the replication slave I/O and /
1924 or SQL threads are not running.
1928 =head2 Plugin C<netapp>
1930 The netapp plugin can collect various performance and capacity information
1931 from a NetApp filer using the NetApp API.
1933 Please note that NetApp has a wide line of products and a lot of different
1934 software versions for each of these products. This plugin was developed for a
1935 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
1936 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
1937 model and software version but it is very hard to test this.
1938 If you have used this plugin with other models and/or software version, feel
1939 free to send us a mail to tell us about the results, even if it's just a short
1942 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
1943 basic authentication.
1945 B<Do not use a regular user for this!> Create a special collectd user with just
1946 the minimum of capabilities needed. The user only needs the "login-http-admin"
1947 capability as well as a few more depending on which data will be collected.
1948 Required capabilities are documented below.
1953 <Host "netapp1.example.com">
1977 IgnoreSelectedIO false
1979 IgnoreSelectedOps false
1980 GetLatency "volume0"
1981 IgnoreSelectedLatency false
1988 IgnoreSelectedCapacity false
1991 IgnoreSelectedSnapshot false
2004 The netapp plugin accepts the following configuration options:
2008 =item B<Host> I<Name>
2010 A host block defines one NetApp filer. It will appear in collectd with the name
2011 you specify here which does not have to be its real name nor its hostname.
2013 =item B<Protocol> B<httpd>|B<http>
2015 The protocol collectd will use to query this host.
2023 Valid options: http, https
2025 =item B<Address> I<Address>
2027 The hostname or IP address of the host.
2033 Default: The "host" block's name.
2035 =item B<Port> I<Port>
2037 The TCP port to connect to on the host.
2043 Default: 80 for protocol "http", 443 for protocol "https"
2045 =item B<User> I<User>
2047 =item B<Password> I<Password>
2049 The username and password to use to login to the NetApp.
2055 =item B<Interval> I<Interval>
2061 The following options decide what kind of data will be collected. You can
2062 either use them as a block and fine tune various parameters inside this block,
2063 use them as a single statement to just accept all default values, or omit it to
2064 not collect any data.
2066 The following options are valid inside all blocks:
2070 =item B<Interval> I<Seconds>
2072 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2073 host specific setting.
2077 =head3 The System block
2079 This will collect various performance data about the whole system.
2081 B<Note:> To get this data the collectd user needs the
2082 "api-perf-object-get-instances" capability.
2086 =item B<Interval> I<Seconds>
2088 Collect disk statistics every I<Seconds> seconds.
2090 =item B<GetCPULoad> B<true>|B<false>
2092 If you set this option to true the current CPU usage will be read. This will be
2093 the average usage between all CPUs in your NetApp without any information about
2096 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2097 returns in the "CPU" field.
2105 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2107 =item B<GetInterfaces> B<true>|B<false>
2109 If you set this option to true the current traffic of the network interfaces
2110 will be read. This will be the total traffic over all interfaces of your NetApp
2111 without any information about individual interfaces.
2113 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2114 in the "Net kB/s" field.
2124 Result: One value list of type "if_octects".
2126 =item B<GetDiskIO> B<true>|B<false>
2128 If you set this option to true the current IO throughput will be read. This
2129 will be the total IO of your NetApp without any information about individual
2130 disks, volumes or aggregates.
2132 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2133 in the "DiskE<nbsp>kB/s" field.
2141 Result: One value list of type "disk_octets".
2143 =item B<GetDiskOps> B<true>|B<false>
2145 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2146 iSCSI, etc. operations will be read. This will be the total number of
2147 operations on your NetApp without any information about individual volumes or
2150 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2151 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2159 Result: A variable number of value lists of type "disk_ops_complex". Each type
2160 of operation will result in one value list with the name of the operation as
2165 =head3 The WAFL block
2167 This will collect various performance data about the WAFL file system. At the
2168 moment this just means cache performance.
2170 B<Note:> To get this data the collectd user needs the
2171 "api-perf-object-get-instances" capability.
2173 B<Note:> The interface to get these values is classified as "Diagnostics" by
2174 NetApp. This means that it is not guaranteed to be stable even between minor
2179 =item B<Interval> I<Seconds>
2181 Collect disk statistics every I<Seconds> seconds.
2183 =item B<GetNameCache> B<true>|B<false>
2191 Result: One value list of type "cache_ratio" and type instance
2194 =item B<GetDirCache> B<true>|B<false>
2202 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2204 =item B<GetInodeCache> B<true>|B<false>
2212 Result: One value list of type "cache_ratio" and type instance
2215 =item B<GetBufferCache> B<true>|B<false>
2217 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2218 in the "Cache hit" field.
2226 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2230 =head3 The Disks block
2232 This will collect performance data about the individual disks in the NetApp.
2234 B<Note:> To get this data the collectd user needs the
2235 "api-perf-object-get-instances" capability.
2239 =item B<Interval> I<Seconds>
2241 Collect disk statistics every I<Seconds> seconds.
2243 =item B<GetBusy> B<true>|B<false>
2245 If you set this option to true the busy time of all disks will be calculated
2246 and the value of the busiest disk in the system will be written.
2248 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2249 in the "Disk util" field. Probably.
2257 Result: One value list of type "percent" and type instance "disk_busy".
2261 =head3 The VolumePerf block
2263 This will collect various performance data about the individual volumes.
2265 You can select which data to collect about which volume using the following
2266 options. They follow the standard ignorelist semantic.
2268 B<Note:> To get this data the collectd user needs the
2269 I<api-perf-object-get-instances> capability.
2273 =item B<Interval> I<Seconds>
2275 Collect volume performance data every I<Seconds> seconds.
2277 =item B<GetIO> I<Volume>
2279 =item B<GetOps> I<Volume>
2281 =item B<GetLatency> I<Volume>
2283 Select the given volume for IO, operations or latency statistics collection.
2284 The argument is the name of the volume without the C</vol/> prefix.
2286 Since the standard ignorelist functionality is used here, you can use a string
2287 starting and ending with a slash to specify regular expression matching: To
2288 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2291 GetIO "/^vol[027]$/"
2293 If no regular expression is specified, an exact match is required. Both,
2294 regular and exact matching are case sensitive.
2296 If no volume was specified at all for either of the three options, that data
2297 will be collected for all available volumes.
2299 =item B<IgnoreSelectedIO> B<true>|B<false>
2301 =item B<IgnoreSelectedOps> B<true>|B<false>
2303 =item B<IgnoreSelectedLatency> B<true>|B<false>
2305 When set to B<true>, the volumes selected for IO, operations or latency
2306 statistics collection will be ignored and the data will be collected for all
2309 When set to B<false>, data will only be collected for the specified volumes and
2310 all other volumes will be ignored.
2312 If no volumes have been specified with the above B<Get*> options, all volumes
2313 will be collected regardless of the B<IgnoreSelected*> option.
2315 Defaults to B<false>
2319 =head3 The VolumeUsage block
2321 This will collect capacity data about the individual volumes.
2323 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2328 =item B<Interval> I<Seconds>
2330 Collect volume usage statistics every I<Seconds> seconds.
2332 =item B<GetCapacity> I<VolumeName>
2334 The current capacity of the volume will be collected. This will result in two
2335 to four value lists, depending on the configuration of the volume. All data
2336 sources are of type "df_complex" with the name of the volume as
2339 There will be type_instances "used" and "free" for the number of used and
2340 available bytes on the volume. If the volume has some space reserved for
2341 snapshots, a type_instance "snap_reserved" will be available. If the volume
2342 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2343 number of bytes saved by the SIS feature.
2345 B<Note:> The current NetApp API has a bug that results in this value being
2346 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2347 number which works most of the time. If you see strange values here, bug
2348 NetApp support to fix this.
2350 Repeat this option to specify multiple volumes.
2352 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2354 Specify whether to collect only the volumes selected by the B<GetCapacity>
2355 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2356 B<false>. However, if no B<GetCapacity> option is specified at all, all
2357 capacities will be selected anyway.
2359 =item B<GetSnapshot> I<VolumeName>
2361 Select volumes from which to collect snapshot information.
2363 Usually, the space used for snapshots is included in the space reported as
2364 "used". If snapshot information is collected as well, the space used for
2365 snapshots is subtracted from the used space.
2367 To make things even more interesting, it is possible to reserve space to be
2368 used for snapshots. If the space required for snapshots is less than that
2369 reserved space, there is "reserved free" and "reserved used" space in addition
2370 to "free" and "used". If the space required for snapshots exceeds the reserved
2371 space, that part allocated in the normal space is subtracted from the "used"
2374 Repeat this option to specify multiple volumes.
2376 =item B<IgnoreSelectedSnapshot>
2378 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2379 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2380 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2381 capacities will be selected anyway.
2385 =head2 Plugin C<netlink>
2387 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2388 statistics of various interface and routing aspects.
2392 =item B<Interface> I<Interface>
2394 =item B<VerboseInterface> I<Interface>
2396 Instruct the plugin to collect interface statistics. This is basically the same
2397 as the statistics provided by the C<interface> plugin (see above) but
2398 potentially much more detailed.
2400 When configuring with B<Interface> only the basic statistics will be collected,
2401 namely octets, packets, and errors. These statistics are collected by
2402 the C<interface> plugin, too, so using both at the same time is no benefit.
2404 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2405 so that no data needs to be collected twice if you use the C<interface> plugin.
2406 This includes dropped packets, received multicast packets, collisions and a
2407 whole zoo of differentiated RX and TX errors. You can try the following command
2408 to get an idea of what awaits you:
2412 If I<Interface> is B<All>, all interfaces will be selected.
2414 =item B<QDisc> I<Interface> [I<QDisc>]
2416 =item B<Class> I<Interface> [I<Class>]
2418 =item B<Filter> I<Interface> [I<Filter>]
2420 Collect the octets and packets that pass a certain qdisc, class or filter.
2422 QDiscs and classes are identified by their type and handle (or classid).
2423 Filters don't necessarily have a handle, therefore the parent's handle is used.
2424 The notation used in collectd differs from that used in tc(1) in that it
2425 doesn't skip the major or minor number if it's zero and doesn't print special
2426 ids by their name. So, for example, a qdisc may be identified by
2427 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2428 thus not displayed by tc(1).
2430 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2431 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2432 associated with that interface will be collected.
2434 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2435 used. This may lead to problems when more than one filter is attached to a
2436 qdisc or class. This isn't nice, but we don't know how this could be done any
2437 better. If you have a idea, please don't hesitate to tell us.
2439 As with the B<Interface> option you can specify B<All> as the interface,
2440 meaning all interfaces.
2442 Here are some examples to help you understand the above text more easily:
2445 VerboseInterface "All"
2446 QDisc "eth0" "pfifo_fast-1:0"
2448 Class "ppp0" "htb-1:10"
2449 Filter "ppp0" "u32-1:0"
2452 =item B<IgnoreSelected>
2454 The behavior is the same as with all other similar plugins: If nothing is
2455 selected at all, everything is collected. If some things are selected using the
2456 options described above, only these statistics are collected. If you set
2457 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2458 specified statistics will not be collected.
2462 =head2 Plugin C<network>
2464 The Network plugin sends data to a remote instance of collectd, receives data
2465 from a remote instance, or both at the same time. Data which has been received
2466 from the network is usually not transmitted again, but this can be activated, see
2467 the B<Forward> option below.
2469 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2470 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2472 Both, B<Server> and B<Listen> can be used as single option or as block. When
2473 used as block, given options are valid for this socket only. For example:
2476 Server "collectd.internal.tld"
2477 <Server "collectd.external.tld">
2478 SecurityLevel "sign"
2479 Username "myhostname"
2486 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2488 The B<Server> statement/block sets the server to send datagrams to. The
2489 statement may occur multiple times to send each datagram to multiple
2492 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2493 optional second argument specifies a port number or a service name. If not
2494 given, the default, B<25826>, is used.
2496 The following options are recognized within B<Server> blocks:
2500 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2502 Set the security you require for network communication. When the security level
2503 has been set to B<Encrypt>, data sent over the network will be encrypted using
2504 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2505 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2506 authentication code. When set to B<None>, data is sent without any security.
2508 This feature is only available if the I<network> plugin was linked with
2511 =item B<Username> I<Username>
2513 Sets the username to transmit. This is used by the server to lookup the
2514 password. See B<AuthFile> below. All security levels except B<None> require
2517 This feature is only available if the I<network> plugin was linked with
2520 =item B<Password> I<Password>
2522 Sets a password (shared secret) for this socket. All security levels except
2523 B<None> require this setting.
2525 This feature is only available if the I<network> plugin was linked with
2528 =item B<Interface> I<Interface name>
2530 Set the outgoing interface for IP packets. This applies at least
2531 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2532 undefined or a non-existent interface name is specified, the default
2533 behaviour is to let the kernel choose the appropriate interface. Be warned
2534 that the manual selection of an interface for unicast traffic is only
2535 necessary in rare cases.
2539 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2541 The B<Listen> statement sets the interfaces to bind to. When multiple
2542 statements are found the daemon will bind to multiple interfaces.
2544 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2545 the argument is a multicast address the daemon will join that multicast group.
2546 The optional second argument specifies a port number or a service name. If not
2547 given, the default, B<25826>, is used.
2549 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
2553 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2555 Set the security you require for network communication. When the security level
2556 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
2557 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
2558 signed and encrypted data is accepted. When set to B<None>, all data will be
2559 accepted. If an B<AuthFile> option was given (see below), encrypted data is
2560 decrypted if possible.
2562 This feature is only available if the I<network> plugin was linked with
2565 =item B<AuthFile> I<Filename>
2567 Sets a file in which usernames are mapped to passwords. These passwords are
2568 used to verify signatures and to decrypt encrypted network packets. If
2569 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
2570 verified and encrypted packets are decrypted. Otherwise, signed data is
2571 accepted without checking the signature and encrypted data cannot be decrypted.
2572 For the other security levels this option is mandatory.
2574 The file format is very simple: Each line consists of a username followed by a
2575 colon and any number of spaces followed by the password. To demonstrate, an
2576 example file could look like this:
2581 Each time a packet is received, the modification time of the file is checked
2582 using L<stat(2)>. If the file has been changed, the contents is re-read. While
2583 the file is being read, it is locked using L<fcntl(2)>.
2585 =item B<Interface> I<Interface name>
2587 Set the incoming interface for IP packets explicitly. This applies at least
2588 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2589 undefined or a non-existent interface name is specified, the default
2590 behaviour is, to let the kernel choose the appropriate interface. Thus incoming
2591 traffic gets only accepted, if it arrives on the given interface.
2595 =item B<TimeToLive> I<1-255>
2597 Set the time-to-live of sent packets. This applies to all, unicast and
2598 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
2599 That means that multicast packets will be sent with a TTL of C<1> (one) on most
2602 =item B<MaxPacketSize> I<1024-65535>
2604 Set the maximum size for datagrams received over the network. Packets larger
2605 than this will be truncated.
2607 =item B<Forward> I<true|false>
2609 If set to I<true>, write packets that were received via the network plugin to
2610 the sending sockets. This should only be activated when the B<Listen>- and
2611 B<Server>-statements differ. Otherwise packets may be send multiple times to
2612 the same multicast group. While this results in more network traffic than
2613 necessary it's not a huge problem since the plugin has a duplicate detection,
2614 so the values will not loop.
2616 =item B<CacheFlush> I<Seconds>
2618 For each host/plugin/type combination the C<network plugin> caches the time of
2619 the last value being sent or received. Every I<Seconds> seconds the plugin
2620 searches and removes all entries that are older than I<Seconds> seconds, thus
2621 freeing the unused memory again. Since this process is somewhat expensive and
2622 normally doesn't do much, this value should not be too small. The default is
2623 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
2626 =item B<ReportStats> B<true>|B<false>
2628 The network plugin cannot only receive and send statistics, it can also create
2629 statistics about itself. Collected data included the number of received and
2630 sent octets and packets, the length of the receive queue and the number of
2631 values handled. When set to B<true>, the I<Network plugin> will make these
2632 statistics available. Defaults to B<false>.
2636 =head2 Plugin C<nginx>
2638 This plugin collects the number of connections and requests handled by the
2639 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
2640 queries the page provided by the C<ngx_http_stub_status_module> module, which
2641 isn't compiled by default. Please refer to
2642 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
2643 how to compile and configure nginx and this module.
2645 The following options are accepted by the C<nginx plugin>:
2649 =item B<URL> I<http://host/nginx_status>
2651 Sets the URL of the C<ngx_http_stub_status_module> output.
2653 =item B<User> I<Username>
2655 Optional user name needed for authentication.
2657 =item B<Password> I<Password>
2659 Optional password needed for authentication.
2661 =item B<VerifyPeer> B<true|false>
2663 Enable or disable peer SSL certificate verification. See
2664 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
2666 =item B<VerifyHost> B<true|false>
2668 Enable or disable peer host name verification. If enabled, the plugin checks
2669 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
2670 certificate matches the host name provided by the B<URL> option. If this
2671 identity check fails, the connection is aborted. Obviously, only works when
2672 connecting to a SSL enabled server. Enabled by default.
2674 =item B<CACert> I<File>
2676 File that holds one or more SSL certificates. If you want to use HTTPS you will
2677 possibly need this option. What CA certificates come bundled with C<libcurl>
2678 and are checked by default depends on the distribution you use.
2682 =head2 Plugin C<notify_desktop>
2684 This plugin sends a desktop notification to a notification daemon, as defined
2685 in the Desktop Notification Specification. To actually display the
2686 notifications, B<notification-daemon> is required and B<collectd> has to be
2687 able to access the X server.
2689 The Desktop Notification Specification can be found at
2690 L<http://www.galago-project.org/specs/notification/>.
2694 =item B<OkayTimeout> I<timeout>
2696 =item B<WarningTimeout> I<timeout>
2698 =item B<FailureTimeout> I<timeout>
2700 Set the I<timeout>, in milliseconds, after which to expire the notification
2701 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
2702 been specified, the displayed notification will not be closed at all - the
2703 user has to do so herself. These options default to 5000. If a negative number
2704 has been specified, the default is used as well.
2708 =head2 Plugin C<notify_email>
2710 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
2711 configured email address.
2713 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
2715 Available configuration options:
2719 =item B<From> I<Address>
2721 Email address from which the emails should appear to come from.
2723 Default: C<root@localhost>
2725 =item B<Recipient> I<Address>
2727 Configures the email address(es) to which the notifications should be mailed.
2728 May be repeated to send notifications to multiple addresses.
2730 At least one B<Recipient> must be present for the plugin to work correctly.
2732 =item B<SMTPServer> I<Hostname>
2734 Hostname of the SMTP server to connect to.
2736 Default: C<localhost>
2738 =item B<SMTPPort> I<Port>
2740 TCP port to connect to.
2744 =item B<SMTPUser> I<Username>
2746 Username for ASMTP authentication. Optional.
2748 =item B<SMTPPassword> I<Password>
2750 Password for ASMTP authentication. Optional.
2752 =item B<Subject> I<Subject>
2754 Subject-template to use when sending emails. There must be exactly two
2755 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
2756 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
2759 Default: C<Collectd notify: %s@%s>
2763 =head2 Plugin C<ntpd>
2767 =item B<Host> I<Hostname>
2769 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
2771 =item B<Port> I<Port>
2773 UDP-Port to connect to. Defaults to B<123>.
2775 =item B<ReverseLookups> B<true>|B<false>
2777 Sets whether or not to perform reverse lookups on peers. Since the name or
2778 IP-address may be used in a filename it is recommended to disable reverse
2779 lookups. The default is to do reverse lookups to preserve backwards
2780 compatibility, though.
2784 =head2 Plugin C<nut>
2788 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
2790 Add a UPS to collect data from. The format is identical to the one accepted by
2795 =head2 Plugin C<olsrd>
2797 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
2798 the Optimized Link State Routing daemon and reads information about the current
2799 state of the meshed network.
2801 The following configuration options are understood:
2805 =item B<Host> I<Host>
2807 Connect to I<Host>. Defaults to B<"localhost">.
2809 =item B<Port> I<Port>
2811 Specifies the port to connect to. This must be a string, even if you give the
2812 port as a number rather than a service name. Defaults to B<"2006">.
2814 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
2816 Specifies what information to collect about links, i.E<nbsp>e. direct
2817 connections of the daemon queried. If set to B<No>, no information is
2818 collected. If set to B<Summary>, the number of links and the average of all
2819 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
2820 If set to B<Detail> LQ and NLQ are collected per link.
2822 Defaults to B<Detail>.
2824 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
2826 Specifies what information to collect about routes of the daemon queried. If
2827 set to B<No>, no information is collected. If set to B<Summary>, the number of
2828 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
2829 metric and ETX are collected per route.
2831 Defaults to B<Summary>.
2833 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
2835 Specifies what information to collect about the global topology. If set to
2836 B<No>, no information is collected. If set to B<Summary>, the number of links
2837 in the entire topology and the average I<link quality> (LQ) is calculated.
2838 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
2840 Defaults to B<Summary>.
2844 =head2 Plugin C<onewire>
2846 B<EXPERIMENTAL!> See notes below.
2848 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
2849 L<http://owfs.org/> to read sensors connected via the onewire bus.
2851 Currently only temperature sensors (sensors with the family code C<10>,
2852 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
2853 would like to have included, please send a sort request to the mailing list.
2855 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
2856 experimental, below.
2860 =item B<Device> I<Device>
2862 Sets the device to read the values from. This can either be a "real" hardware
2863 device, such as a serial port or an USB port, or the address of the
2864 L<owserver(1)> socket, usually B<localhost:4304>.
2866 Though the documentation claims to automatically recognize the given address
2867 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
2868 with that version, the following configuration worked for us:
2871 Device "-s localhost:4304"
2874 This directive is B<required> and does not have a default value.
2876 =item B<Sensor> I<Sensor>
2878 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
2879 below. Sensors are specified without the family byte at the beginning, to you'd
2880 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
2883 =item B<IgnoreSelected> I<true>|I<false>
2885 If no configuration if given, the B<onewire> plugin will collect data from all
2886 sensors found. This may not be practical, especially if sensors are added and
2887 removed regularly. Sometimes, however, it's easier/preferred to collect only
2888 specific sensors or all sensors I<except> a few specified ones. This option
2889 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
2890 B<Sensor> is inverted: All selected interfaces are ignored and all other
2891 interfaces are collected.
2893 =item B<Interval> I<Seconds>
2895 Sets the interval in which all sensors should be read. If not specified, the
2896 global B<Interval> setting is used.
2900 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
2901 work with big setups. It works with one sensor being attached to one
2902 controller, but as soon as you throw in a couple more senors and maybe a hub
2903 or two, reading all values will take more than ten seconds (the default
2904 interval). We will probably add some separate thread for reading the sensors
2905 and some cache or something like that, but it's not done yet. We will try to
2906 maintain backwards compatibility in the future, but we can't promise. So in
2907 short: If it works for you: Great! But keep in mind that the config I<might>
2908 change, though this is unlikely. Oh, and if you want to help improving this
2909 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
2911 =head2 Plugin C<openvpn>
2913 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
2914 traffic statistics about connected clients.
2916 To set up OpenVPN to write to the status file periodically, use the
2917 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
2918 you need to set the required format, too. This is done by setting
2919 B<--status-version> to B<2>.
2921 So, in a nutshell you need:
2923 openvpn $OTHER_OPTIONS \
2924 --status "/var/run/openvpn-status" 10 \
2931 =item B<StatusFile> I<File>
2933 Specifies the location of the status file.
2935 =item B<ImprovedNamingSchema> B<true>|B<false>
2937 When enabled, the filename of the status file will be used as plugin instance
2938 and the client's "common name" will be used as type instance. This is required
2939 when reading multiple status files. Enabling this option is recommended, but to
2940 maintain backwards compatibility this option is disabled by default.
2942 =item B<CollectCompression> B<true>|B<false>
2944 Sets whether or not statistics about the compression used by OpenVPN should be
2945 collected. This information is only available in I<single> mode. Enabled by
2948 =item B<CollectIndividualUsers> B<true>|B<false>
2950 Sets whether or not traffic information is collected for each connected client
2951 individually. If set to false, currently no traffic data is collected at all
2952 because aggregating this data in a save manner is tricky. Defaults to B<true>.
2954 =item B<CollectUserCount> B<true>|B<false>
2956 When enabled, the number of currently connected clients or users is collected.
2957 This is expecially interesting when B<CollectIndividualUsers> is disabled, but
2958 can be configured independently from that option. Defaults to B<false>.
2962 =head2 Plugin C<oracle>
2964 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
2965 Oracle® Database and lets you execute SQL statements there. It is very similar
2966 to the "dbi" plugin, because it was written around the same time. See the "dbi"
2967 plugin's documentation above for details.
2970 <Query "out_of_stock">
2971 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2974 # InstancePrefix "foo"
2975 InstancesFrom "category"
2979 <Database "product_information">
2983 Query "out_of_stock"
2987 =head3 B<Query> blocks
2989 The Query blocks are handled identically to the Query blocks of the "dbi"
2990 plugin. Please see its documentation above for details on how to specify
2993 =head3 B<Database> blocks
2995 Database blocks define a connection to a database and which queries should be
2996 sent to that database. Each database needs a "name" as string argument in the
2997 starting tag of the block. This name will be used as "PluginInstance" in the
2998 values submitted to the daemon. Other than that, that name is not used.
3002 =item B<ConnectID> I<ID>
3004 Defines the "database alias" or "service name" to connect to. Usually, these
3005 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3007 =item B<Username> I<Username>
3009 Username used for authentication.
3011 =item B<Password> I<Password>
3013 Password used for authentication.
3015 =item B<Query> I<QueryName>
3017 Associates the query named I<QueryName> with this database connection. The
3018 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3019 blocks you want to refer to must be placed above the database block you want to
3024 =head2 Plugin C<perl>
3026 This plugin embeds a Perl-interpreter into collectd and provides an interface
3027 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3029 =head2 Plugin C<ping>
3031 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3032 configured hosts periodically and measures the network latency. Whenever the
3033 C<read> function of the plugin is called, it submits the average latency, the
3034 standard deviation and the drop rate for each host.
3036 Available configuration options:
3040 =item B<Host> I<IP-address>
3042 Host to ping periodically. This option may be repeated several times to ping
3045 =item B<Interval> I<Seconds>
3047 Sets the interval in which to send ICMP echo packets to the configured hosts.
3048 This is B<not> the interval in which statistics are queries from the plugin but
3049 the interval in which the hosts are "pinged". Therefore, the setting here
3050 should be smaller than or equal to the global B<Interval> setting. Fractional
3051 times, such as "1.24" are allowed.
3055 =item B<Timeout> I<Seconds>
3057 Time to wait for a response from the host to which an ICMP packet had been
3058 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3059 to be down or the packet to be dropped. This setting must be smaller than the
3060 B<Interval> setting above for the plugin to work correctly. Fractional
3061 arguments are accepted.
3065 =item B<TTL> I<0-255>
3067 Sets the Time-To-Live of generated ICMP packets.
3069 =item B<SourceAddress> I<host>
3071 Sets the source address to use. I<host> may either be a numerical network
3072 address or a network hostname.
3074 =item B<Device> I<name>
3076 Sets the outgoing network device to be used. I<name> has to specify an
3077 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3080 =item B<MaxMissed> I<Packets>
3082 Trigger a DNS resolv after the host has not replied to I<Packets> packets. This
3083 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3085 Default: B<-1> (disabled)
3089 =head2 Plugin C<postgresql>
3091 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3092 keeps a persistent connection to all configured databases and tries to
3093 reconnect if the connection has been interrupted. A database is configured by
3094 specifying a B<Database> block as described below. The default statistics are
3095 collected from PostgreSQL's B<statistics collector> which thus has to be
3096 enabled for this plugin to work correctly. This should usually be the case by
3097 default. See the section "The Statistics Collector" of the B<PostgreSQL
3098 Documentation> for details.
3100 By specifying custom database queries using a B<Query> block as described
3101 below, you may collect any data that is available from some PostgreSQL
3102 database. This way, you are able to access statistics of external daemons
3103 which are available in a PostgreSQL database or use future or special
3104 statistics provided by PostgreSQL without the need to upgrade your collectd
3107 The B<PostgreSQL Documentation> manual can be found at
3108 L<http://www.postgresql.org/docs/manuals/>.
3112 Statement "SELECT magic FROM wizard WHERE host = $1;"
3116 InstancePrefix "magic"
3121 <Query rt36_tickets>
3122 Statement "SELECT COUNT(type) AS count, type \
3124 WHEN resolved = 'epoch' THEN 'open' \
3125 ELSE 'resolved' END AS type \
3126 FROM tickets) type \
3130 InstancePrefix "rt36_tickets"
3131 InstancesFrom "type"
3142 KRBSrvName "kerberos_service_name"
3148 Service "service_name"
3149 Query backend # predefined
3154 The B<Query> block defines one database query which may later be used by a
3155 database definition. It accepts a single mandatory argument which specifies
3156 the name of the query. The names of all queries have to be unique (see the
3157 B<MinVersion> and B<MaxVersion> options below for an exception to this
3158 rule). The following configuration options are available to define the query:
3160 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3161 blocks define how to handle the values returned from the query. They define
3162 which column holds which value and how to dispatch that value to the daemon.
3163 Multiple B<Result> blocks may be used to extract multiple values from a single
3168 =item B<Statement> I<sql query statement>
3170 Specify the I<sql query statement> which the plugin should execute. The string
3171 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3172 first, second, etc. parameter. The value of the parameters is specified by the
3173 B<Param> configuration option - see below for details. To include a literal
3174 B<$> character followed by a number, surround it with single quotes (B<'>).
3176 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3177 allowed. Note, however, that only a single command may be used. Semicolons are
3178 allowed as long as a single non-empty command has been specified only.
3180 The returned lines will be handled separately one after another.
3182 =item B<Query> I<sql query statement>
3184 This is a deprecated synonym for B<Statement>. It will be removed in version 5
3187 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3189 Specify the parameters which should be passed to the SQL query. The parameters
3190 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3191 they appear in the configuration file. The value of the parameter is
3192 determined depending on the value of the B<Param> option as follows:
3198 The configured hostname of the database connection. If a UNIX domain socket is
3199 used, the parameter expands to "localhost".
3203 The name of the database of the current connection.
3207 The username used to connect to the database.
3211 The interval with which this database is queried (as specified by the database
3212 specific or global B<Interval> options).
3216 Please note that parameters are only supported by PostgreSQL's protocol
3217 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3219 =item B<Type> I<type>
3221 The I<type> name to be used when dispatching the values. The type describes
3222 how to handle the data and where to store it. See L<types.db(5)> for more
3223 details on types and their configuration. The number and type of values (as
3224 selected by the B<ValuesFrom> option) has to match the type of the given name.
3226 This option is required inside a B<Result> block.
3228 =item B<InstancePrefix> I<prefix>
3230 =item B<InstancesFrom> I<column0> [I<column1> ...]
3232 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3233 B<InstancePrefix> defines a static prefix that will be prepended to all type
3234 instances. B<InstancesFrom> defines the column names whose values will be used
3235 to create the type instance. Multiple values will be joined together using the
3236 hyphen (C<->) as separation character.
3238 The plugin itself does not check whether or not all built instances are
3239 different. It is your responsibility to assure that each is unique.
3241 Both options are optional. If none is specified, the type instance will be
3244 =item B<ValuesFrom> I<column0> [I<column1> ...]
3246 Names the columns whose content is used as the actual data for the data sets
3247 that are dispatched to the daemon. How many such columns you need is
3248 determined by the B<Type> setting as explained above. If you specify too many
3249 or not enough columns, the plugin will complain about that and no data will be
3250 submitted to the daemon.
3252 The actual data type, as seen by PostgreSQL, is not that important as long as
3253 it represents numbers. The plugin will automatically cast the values to the
3254 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3255 L<strtod(3)> functions, so anything supported by those functions is supported
3256 by the plugin as well.
3258 This option is required inside a B<Result> block and may be specified multiple
3259 times. If multiple B<ValuesFrom> options are specified, the columns are read
3262 =item B<Column> I<type> [I<type instance>]
3264 This is a deprecated alternative to a B<Result> block. It will be removed in
3265 version 5 of collectd. It is equivalent to the following B<Result> block:
3269 InstancePrefix I<type instance>
3270 ValuesFrom I<name of the x. column>
3273 The order of the B<Column> options defines which columns of the query result
3274 should be used. The first option specifies the data found in the first column,
3275 the second option that of the second column, and so on.
3277 =item B<MinVersion> I<version>
3279 =item B<MaxVersion> I<version>
3281 Specify the minimum or maximum version of PostgreSQL that this query should be
3282 used with. Some statistics might only be available with certain versions of
3283 PostgreSQL. This allows you to specify multiple queries with the same name but
3284 which apply to different versions, thus allowing you to use the same
3285 configuration in a heterogeneous environment.
3287 The I<version> has to be specified as the concatenation of the major, minor
3288 and patch-level versions, each represented as two-decimal-digit numbers. For
3289 example, version 8.2.3 will become 80203.
3291 =item B<MinPGVersion> I<version>
3293 =item B<MaxPGVersion> I<version>
3295 These are deprecated synonyms for B<MinVersion> and B<MaxVersion>
3296 respectively. They will be removed in version 5 of collectd.
3300 The following predefined queries are available (the definitions can be found
3301 in the F<postgresql_default.conf> file which, by default, is available at
3302 C<I<prefix>/share/collectd/>):
3308 This query collects the number of backends, i.E<nbsp>e. the number of
3311 =item B<transactions>
3313 This query collects the numbers of committed and rolled-back transactions of
3318 This query collects the numbers of various table modifications (i.E<nbsp>e.
3319 insertions, updates, deletions) of the user tables.
3321 =item B<query_plans>
3323 This query collects the numbers of various table scans and returned tuples of
3326 =item B<table_states>
3328 This query collects the numbers of live and dead rows in the user tables.
3332 This query collects disk block access counts for user tables.
3336 This query collects the on-disk size of the database in bytes.
3340 The B<Database> block defines one PostgreSQL database for which to collect
3341 statistics. It accepts a single mandatory argument which specifies the
3342 database name. None of the other options are required. PostgreSQL will use
3343 default values as documented in the section "CONNECTING TO A DATABASE" in the
3344 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
3345 the user collectd is run as and special environment variables. See the manpage
3350 =item B<Interval> I<seconds>
3352 Specify the interval with which the database should be queried. The default is
3353 to use the global B<Interval> setting.
3355 =item B<Host> I<hostname>
3357 Specify the hostname or IP of the PostgreSQL server to connect to. If the
3358 value begins with a slash, it is interpreted as the directory name in which to
3359 look for the UNIX domain socket.
3361 This option is also used to determine the hostname that is associated with a
3362 collected data set. If it has been omitted or either begins with with a slash
3363 or equals B<localhost> it will be replaced with the global hostname definition
3364 of collectd. Any other value will be passed literally to collectd when
3365 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
3367 =item B<Port> I<port>
3369 Specify the TCP port or the local UNIX domain socket file extension of the
3372 =item B<User> I<username>
3374 Specify the username to be used when connecting to the server.
3376 =item B<Password> I<password>
3378 Specify the password to be used when connecting to the server.
3380 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
3382 Specify whether to use an SSL connection when contacting the server. The
3383 following modes are supported:
3389 Do not use SSL at all.
3393 First, try to connect without using SSL. If that fails, try using SSL.
3395 =item I<prefer> (default)
3397 First, try to connect using SSL. If that fails, try without using SSL.
3405 =item B<KRBSrvName> I<kerberos_service_name>
3407 Specify the Kerberos service name to use when authenticating with Kerberos 5
3408 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
3409 B<PostgreSQL Documentation> for details.
3411 =item B<Service> I<service_name>
3413 Specify the PostgreSQL service name to use for additional parameters. That
3414 service has to be defined in F<pg_service.conf> and holds additional
3415 connection parameters. See the section "The Connection Service File" in the
3416 B<PostgreSQL Documentation> for details.
3418 =item B<Query> I<query>
3420 Specify a I<query> which should be executed for the database connection. This
3421 may be any of the predefined or user-defined queries. If no such option is
3422 given, it defaults to "backends", "transactions", "queries", "query_plans",
3423 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
3428 =head2 Plugin C<powerdns>
3430 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
3431 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
3432 values, many of which are probably meaningless to most users, but may be useful
3433 for some. So you may chose which values to collect, but if you don't, some
3434 reasonable defaults will be collected.
3437 <Server "server_name">
3439 Collect "udp-answers" "udp-queries"
3440 Socket "/var/run/pdns.controlsocket"
3442 <Recursor "recursor_name">
3444 Collect "cache-hits" "cache-misses"
3445 Socket "/var/run/pdns_recursor.controlsocket"
3447 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
3452 =item B<Server> and B<Recursor> block
3454 The B<Server> block defines one authoritative server to query, the B<Recursor>
3455 does the same for an recursing server. The possible options in both blocks are
3456 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
3461 =item B<Collect> I<Field>
3463 Using the B<Collect> statement you can select which values to collect. Here,
3464 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
3465 C<dlg-only-drops>, C<answers10-100>.
3467 The method of getting the values differs for B<Server> and B<Recursor> blocks:
3468 When querying the server a C<SHOW *> command is issued in any case, because
3469 that's the only way of getting multiple values out of the server at once.
3470 collectd then picks out the values you have selected. When querying the
3471 recursor, a command is generated to query exactly these values. So if you
3472 specify invalid fields when querying the recursor, a syntax error may be
3473 returned by the daemon and collectd may not collect any values at all.
3475 If no B<Collect> statement is given, the following B<Server> values will be
3482 =item packetcache-hit
3484 =item packetcache-miss
3486 =item packetcache-size
3488 =item query-cache-hit
3490 =item query-cache-miss
3492 =item recursing-answers
3494 =item recursing-questions
3506 The following B<Recursor> values will be collected by default:
3510 =item noerror-answers
3512 =item nxdomain-answers
3514 =item servfail-answers
3532 Please note that up to that point collectd doesn't know what values are
3533 available on the server and values that are added do not need a change of the
3534 mechanism so far. However, the values must be mapped to collectd's naming
3535 scheme, which is done using a lookup table that lists all known values. If
3536 values are added in the future and collectd does not know about them, you will
3537 get an error much like this:
3539 powerdns plugin: submit: Not found in lookup table: foobar = 42
3541 In this case please file a bug report with the collectd team.
3543 =item B<Socket> I<Path>
3545 Configures the path to the UNIX domain socket to be used when connecting to the
3546 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
3547 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
3548 will be used for the recursor.
3552 =item B<LocalSocket> I<Path>
3554 Querying the recursor is done using UDP. When using UDP over UNIX domain
3555 sockets, the client socket needs a name in the file system, too. You can set
3556 this local name to I<Path> using the B<LocalSocket> option. The default is
3557 C<I<prefix>/var/run/collectd-powerdns>.
3561 =head2 Plugin C<processes>
3565 =item B<Process> I<Name>
3567 Select more detailed statistics of processes matching this name. The statistics
3568 collected for these selected processes are size of the resident segment size
3569 (RSS), user- and system-time used, number of processes and number of threads,
3570 io data (where available) and minor and major pagefaults.
3572 =item B<ProcessMatch> I<name> I<regex>
3574 Similar to the B<Process> option this allows to select more detailed
3575 statistics of processes matching the specified I<regex> (see L<regex(7)> for
3576 details). The statistics of all matching processes are summed up and
3577 dispatched to the daemon using the specified I<name> as an identifier. This
3578 allows to "group" several processes together. I<name> must not contain
3583 =head2 Plugin C<protocols>
3585 Collects a lot of information about various network protocols, such as I<IP>,
3586 I<TCP>, I<UDP>, etc.
3588 Available configuration options:
3592 =item B<Value> I<Selector>
3594 Selects whether or not to select a specific value. The string being matched is
3595 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
3596 plugin instance and I<ValueName> will be used as type instance. An example of
3597 the string being used would be C<Tcp:RetransSegs>.
3599 You can use regular expressions to match a large number of values with just one
3600 configuration option. To select all "extended" I<TCP> values, you could use the
3601 following statement:
3605 Whether only matched values are selected or all matched values are ignored
3606 depends on the B<IgnoreSelected>. By default, only matched values are selected.
3607 If no value is configured at all, all values will be selected.
3609 =item B<IgnoreSelected> B<true>|B<false>
3611 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
3612 matching values will be ignored.
3616 =head2 Plugin C<python>
3618 This plugin embeds a Python-interpreter into collectd and provides an interface
3619 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
3621 =head2 Plugin C<routeros>
3623 The C<routeros> plugin connects to a device running I<RouterOS>, the
3624 Linux-based operating system for routers by I<MikroTik>. The plugin uses
3625 I<librouteros> to connect and reads information about the interfaces and
3626 wireless connections of the device. The configuration supports querying
3631 Host "router0.example.com"
3634 CollectInterface true
3639 Host "router1.example.com"
3642 CollectInterface true
3643 CollectRegistrationTable true
3649 As you can see above, the configuration of the I<routeros> plugin consists of
3650 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
3651 options are understood:
3655 =item B<Host> I<Host>
3657 Hostname or IP-address of the router to connect to.
3659 =item B<Port> I<Port>
3661 Port name or port number used when connecting. If left unspecified, the default
3662 will be chosen by I<librouteros>, currently "8728". This option expects a
3663 string argument, even when a numeric port number is given.
3665 =item B<User> I<User>
3667 Use the user name I<User> to authenticate. Defaults to "admin".
3669 =item B<Password> I<Password>
3671 Set the password used to authenticate.
3673 =item B<CollectInterface> B<true>|B<false>
3675 When set to B<true>, interface statistics will be collected for all interfaces
3676 present on the device. Defaults to B<false>.
3678 =item B<CollectRegistrationTable> B<true>|B<false>
3680 When set to B<true>, information about wireless LAN connections will be
3681 collected. Defaults to B<false>.
3683 =item B<CollectCPULoad> B<true>|B<false>
3685 When set to B<true>, information about the CPU usage will be collected. The
3686 number is a dimensionless value where zero indicates no CPU usage at all.
3687 Defaults to B<false>.
3689 =item B<CollectMemory> B<true>|B<false>
3691 When enabled, the amount of used and free memory will be collected. How used
3692 memory is calculated is unknown, for example whether or not caches are counted
3694 Defaults to B<false>.
3696 =item B<CollectDF> B<true>|B<false>
3698 When enabled, the amount of used and free disk space will be collected.
3699 Defaults to B<false>.
3701 =item B<CollectDisk> B<true>|B<false>
3703 When enabled, the number of sectors written and bad blocks will be collected.
3704 Defaults to B<false>.
3708 =head2 Plugin C<rrdcached>
3710 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
3711 to store values to RRD files in an efficient manner. The combination of the
3712 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
3713 way the C<rrdtool> plugin works (see below). The added abstraction layer
3714 provides a number of benefits, though: Because the cache is not within
3715 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
3716 restarted. This results in much shorter (if any) gaps in graphs, especially
3717 under heavy load. Also, the C<rrdtool> command line utility is aware of the
3718 daemon so that it can flush values to disk automatically when needed. This
3719 allows to integrate automated flushing of values into graphing solutions much
3722 There are disadvantages, though: The daemon may reside on a different host, so
3723 it may not be possible for C<collectd> to create the appropriate RRD files
3724 anymore. And even if C<rrdcached> runs on the same host, it may run in a
3725 different base directory, so relative paths may do weird stuff if you're not
3728 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
3729 on the same host, communicating via a UNIX domain socket. The B<DataDir>
3730 setting should be set to an absolute path, so that a changed base directory
3731 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
3735 =item B<DaemonAddress> I<Address>
3737 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
3738 library. See L<rrdcached(1)> for details. Example:
3740 <Plugin "rrdcached">
3741 DaemonAddress "unix:/var/run/rrdcached.sock"
3744 =item B<DataDir> I<Directory>
3746 Set the base directory in which the RRD files reside. If this is a relative
3747 path, it is relative to the working base directory of the C<rrdcached> daemon!
3748 Use of an absolute path is recommended.
3750 =item B<CreateFiles> B<true>|B<false>
3752 Enables or disables the creation of RRD files. If the daemon is not running
3753 locally, or B<DataDir> is set to a relative path, this will not work as
3754 expected. Default is B<true>.
3758 =head2 Plugin C<rrdtool>
3760 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
3761 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
3762 using these settings. If you don't want to dive into the depths of RRDtool, you
3763 can safely ignore these settings.
3767 =item B<DataDir> I<Directory>
3769 Set the directory to store RRD-files under. Per default RRD-files are generated
3770 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
3772 =item B<StepSize> I<Seconds>
3774 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
3775 this setting is unset and the stepsize is set to the interval in which the data
3776 is collected. Do not use this option unless you absolutely have to for some
3777 reason. Setting this option may cause problems with the C<snmp plugin>, the
3778 C<exec plugin> or when the daemon is set up to receive data from other hosts.
3780 =item B<HeartBeat> I<Seconds>
3782 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
3783 in which case the heartbeat is set to twice the B<StepSize> which should equal
3784 the interval in which data is collected. Do not set this option unless you have
3785 a very good reason to do so.
3787 =item B<RRARows> I<NumRows>
3789 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
3790 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
3791 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
3792 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
3793 week, one month, and one year.
3795 So for each timespan, it calculates how many PDPs need to be consolidated into
3796 one CDP by calculating:
3797 number of PDPs = timespan / (stepsize * rrarows)
3799 Bottom line is, set this no smaller than the width of you graphs in pixels. The
3802 =item B<RRATimespan> I<Seconds>
3804 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
3805 more then one RRA. If this option is never used, the built-in default of (3600,
3806 86400, 604800, 2678400, 31622400) is used.
3808 For more information on how RRA-sizes are calculated see B<RRARows> above.
3810 =item B<XFF> I<Factor>
3812 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
3814 =item B<CacheFlush> I<Seconds>
3816 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
3817 it writes all values for a certain RRD-file if the oldest value is older than
3818 (or equal to) the number of seconds specified. If some RRD-file is not updated
3819 anymore for some reason (the computer was shut down, the network is broken,
3820 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
3821 entire cache is searched for entries older than B<CacheTimeout> seconds and
3822 written to disk every I<Seconds> seconds. Since this is kind of expensive and
3823 does nothing under normal circumstances, this value should not be too small.
3824 900 seconds might be a good value, though setting this to 7200 seconds doesn't
3825 normally do much harm either.
3827 =item B<CacheTimeout> I<Seconds>
3829 If this option is set to a value greater than zero, the C<rrdtool plugin> will
3830 save values in a cache, as described above. Writing multiple values at once
3831 reduces IO-operations and thus lessens the load produced by updating the files.
3832 The trade off is that the graphs kind of "drag behind" and that more memory is
3835 =item B<WritesPerSecond> I<Updates>
3837 When collecting many statistics with collectd and the C<rrdtool> plugin, you
3838 will run serious performance problems. The B<CacheFlush> setting and the
3839 internal update queue assert that collectd continues to work just fine even
3840 under heavy load, but the system may become very unresponsive and slow. This is
3841 a problem especially if you create graphs from the RRD files on the same
3842 machine, for example using the C<graph.cgi> script included in the
3843 C<contrib/collection3/> directory.
3845 This setting is designed for very large setups. Setting this option to a value
3846 between 25 and 80 updates per second, depending on your hardware, will leave
3847 the server responsive enough to draw graphs even while all the cached values
3848 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
3849 by the B<FLUSH> command, are B<not> effected by this limit. They are still
3850 written as fast as possible, so that web frontends have up to date data when
3853 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
3854 updates per second, writing all values to disk will take approximately
3855 56E<nbsp>minutes. Together with the flushing ability that's integrated into
3856 "collection3" you'll end up with a responsive and fast system, up to date
3857 graphs and basically a "backup" of your values every hour.
3859 =item B<RandomTimeout> I<Seconds>
3861 When set, the actual timeout for each value is chosen randomly between
3862 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
3863 intention is to avoid high load situations that appear when many values timeout
3864 at the same time. This is especially a problem shortly after the daemon starts,
3865 because all values were added to the internal cache at roughly the same time.
3869 =head2 Plugin C<sensors>
3871 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
3872 that all the needed modules have to be loaded and lm_sensors has to be
3873 configured (most likely by editing F</etc/sensors.conf>. Read
3874 L<sensors.conf(5)> for details.
3876 The B<lm_sensors> homepage can be found at
3877 L<http://secure.netroedge.com/~lm78/>.
3881 =item B<Sensor> I<chip-bus-address/type-feature>
3883 Selects the name of the sensor which you want to collect or ignore, depending
3884 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
3885 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
3886 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
3888 =item B<IgnoreSelected> I<true>|I<false>
3890 If no configuration if given, the B<sensors>-plugin will collect data from all
3891 sensors. This may not be practical, especially for uninteresting sensors.
3892 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
3893 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
3894 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3895 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
3896 and all other sensors are collected.
3900 =head2 Plugin C<snmp>
3902 Since the configuration of the C<snmp plugin> is a little more complicated than
3903 other plugins, its documentation has been moved to an own manpage,
3904 L<collectd-snmp(5)>. Please see there for details.
3906 =head2 Plugin C<syslog>
3910 =item B<LogLevel> B<debug|info|notice|warning|err>
3912 Sets the log-level. If, for example, set to B<notice>, then all events with
3913 severity B<notice>, B<warning>, or B<err> will be submitted to the
3916 Please note that B<debug> is only available if collectd has been compiled with
3921 =head2 Plugin C<table>
3923 The C<table plugin> provides generic means to parse tabular data and dispatch
3924 user specified values. Values are selected based on column numbers. For
3925 example, this plugin may be used to get values from the Linux L<proc(5)>
3926 filesystem or CSV (comma separated values) files.
3929 <Table "/proc/slabinfo">
3934 InstancePrefix "active_objs"
3940 InstancePrefix "objperslab"
3947 The configuration consists of one or more B<Table> blocks, each of which
3948 configures one file to parse. Within each B<Table> block, there are one or
3949 more B<Result> blocks, which configure which data to select and how to
3952 The following options are available inside a B<Table> block:
3956 =item B<Instance> I<instance>
3958 If specified, I<instance> is used as the plugin instance. So, in the above
3959 example, the plugin name C<table-slabinfo> would be used. If omitted, the
3960 filename of the table is used instead, with all special characters replaced
3961 with an underscore (C<_>).
3963 =item B<Separator> I<string>
3965 Any character of I<string> is interpreted as a delimiter between the different
3966 columns of the table. A sequence of two or more contiguous delimiters in the
3967 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
3968 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
3969 of a table - see its documentation for more details. This option is mandatory.
3971 A horizontal tab, newline and carriage return may be specified by C<\\t>,
3972 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
3973 required because of collectd's config parsing.
3977 The following options are available inside a B<Result> block:
3981 =item B<Type> I<type>
3983 Sets the type used to dispatch the values to the daemon. Detailed information
3984 about types and their configuration can be found in L<types.db(5)>. This
3985 option is mandatory.
3987 =item B<InstancePrefix> I<prefix>
3989 If specified, prepend I<prefix> to the type instance. If omitted, only the
3990 B<InstancesFrom> option is considered for the type instance.
3992 =item B<InstancesFrom> I<column0> [I<column1> ...]
3994 If specified, the content of the given columns (identified by the column
3995 number starting at zero) will be used to create the type instance for each
3996 row. Multiple values (and the instance prefix) will be joined together with
3997 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
3998 option is considered for the type instance.
4000 The plugin itself does not check whether or not all built instances are
4001 different. It’s your responsibility to assure that each is unique. This is
4002 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4003 sure that the table only contains one row.
4005 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4008 =item B<ValuesFrom> I<column0> [I<column1> ...]
4010 Specifies the columns (identified by the column numbers starting at zero)
4011 whose content is used as the actual data for the data sets that are dispatched
4012 to the daemon. How many such columns you need is determined by the B<Type>
4013 setting above. If you specify too many or not enough columns, the plugin will
4014 complain about that and no data will be submitted to the daemon. The plugin
4015 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4016 respectively, so anything supported by those functions is supported by the
4017 plugin as well. This option is mandatory.
4021 =head2 Plugin C<tail>
4023 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4024 each line and dispatches found values. What is matched can be configured by the
4025 user using (extended) regular expressions, as described in L<regex(7)>.
4028 <File "/var/log/exim4/mainlog">
4031 Regex "S=([1-9][0-9]*)"
4037 Regex "\\<R=local_user\\>"
4038 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4041 Instance "local_user"
4046 The config consists of one or more B<File> blocks, each of which configures one
4047 logfile to parse. Within each B<File> block, there are one or more B<Match>
4048 blocks, which configure a regular expression to search for.
4050 The B<Instance> option in the B<File> block may be used to set the plugin
4051 instance. So in the above example the plugin name C<tail-foo> would be used.
4052 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4053 next B<Instance> option. This way you can extract several plugin instances from
4054 one logfile, handy when parsing syslog and the like.
4056 Each B<Match> block has the following options to describe how the match should
4061 =item B<Regex> I<regex>
4063 Sets the regular expression to use for matching against a line. The first
4064 subexpression has to match something that can be turned into a number by
4065 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4066 below. Because B<extended> regular expressions are used, you do not need to use
4067 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4068 collectd's config parsing you need to escape backslashes, though. So if you
4069 want to match literal parentheses you need to do the following:
4071 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4073 =item B<ExcludeRegex> I<regex>
4075 Sets an optional regular expression to use for excluding lines from the match.
4076 An example which excludes all connections from localhost from the match:
4078 ExcludeRegex "127\\.0\\.0\\.1"
4080 =item B<DSType> I<Type>
4082 Sets how the values are cumulated. I<Type> is one of:
4086 =item B<GaugeAverage>
4088 Calculate the average.
4092 Use the smallest number only.
4096 Use the greatest number only.
4100 Use the last number found.
4104 The matched number is a counter. Simply sets the internal counter to this
4109 Add the matched value to the internal counter.
4113 Increase the internal counter by one. This B<DSType> is the only one that does
4114 not use the matched subexpression, but simply counts the number of matched
4115 lines. Thus, you may use a regular expression without submatch in this case.
4119 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
4120 number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
4121 submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
4122 submatch at all and it may be omitted in this case.
4124 =item B<Type> I<Type>
4126 Sets the type used to dispatch this value. Detailed information about types and
4127 their configuration can be found in L<types.db(5)>.
4129 =item B<Instance> I<TypeInstance>
4131 This optional setting sets the type instance to use.
4135 =head2 Plugin C<teamspeak2>
4137 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
4138 polls interesting global and virtual server data. The plugin can query only one
4139 physical server but unlimited virtual servers. You can use the following
4140 options to configure it:
4144 =item B<Host> I<hostname/ip>
4146 The hostname or ip which identifies the physical server.
4149 =item B<Port> I<port>
4151 The query port of the physical server. This needs to be a string.
4154 =item B<Server> I<port>
4156 This option has to be added once for every virtual server the plugin should
4157 query. If you want to query the virtual server on port 8767 this is what the
4158 option would look like:
4162 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
4163 use quotes around it! If no such statement is given only global information
4168 =head2 Plugin C<ted>
4170 The I<TED> plugin connects to a device of "The Energy Detective", a device to
4171 measure power consumption. These devices are usually connected to a serial
4172 (RS232) or USB port. The plugin opens a configured device and tries to read the
4173 current energy readings. For more information on TED, visit
4174 L<http://www.theenergydetective.com/>.
4176 Available configuration options:
4180 =item B<Device> I<Path>
4182 Path to the device on which TED is connected. collectd will need read and write
4183 permissions on that file.
4185 Default: B</dev/ttyUSB0>
4187 =item B<Retries> I<Num>
4189 Apparently reading from TED is not that reliable. You can therefore configure a
4190 number of retries here. You only configure the I<retries> here, to if you
4191 specify zero, one reading will be performed (but no retries if that fails); if
4192 you specify three, a maximum of four readings are performed. Negative values
4199 =head2 Plugin C<tcpconns>
4201 The C<tcpconns plugin> counts the number of currently established TCP
4202 connections based on the local port and/or the remote port. Since there may be
4203 a lot of connections the default if to count all connections with a local port,
4204 for which a listening socket is opened. You can use the following options to
4205 fine-tune the ports you are interested in:
4209 =item B<ListeningPorts> I<true>|I<false>
4211 If this option is set to I<true>, statistics for all local ports for which a
4212 listening socket exists are collected. The default depends on B<LocalPort> and
4213 B<RemotePort> (see below): If no port at all is specifically selected, the
4214 default is to collect listening ports. If specific ports (no matter if local or
4215 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
4216 the selected ports will be collected unless this option is set to I<true>
4219 =item B<LocalPort> I<Port>
4221 Count the connections to a specific local port. This can be used to see how
4222 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
4223 You have to specify the port in numeric form, so for the mailserver example
4224 you'd need to set B<25>.
4226 =item B<RemotePort> I<Port>
4228 Count the connections to a specific remote port. This is useful to see how
4229 much a remote service is used. This is most useful if you want to know how many
4230 connections a local service has opened to remote services, e.E<nbsp>g. how many
4231 connections a mail server or news server has to other mail or news servers, or
4232 how many connections a web proxy holds to web servers. You have to give the
4233 port in numeric form.
4237 =head2 Plugin C<thermal>
4241 =item B<ForceUseProcfs> I<true>|I<false>
4243 By default, the C<thermal> plugin tries to read the statistics from the Linux
4244 C<sysfs> interface. If that is not available, the plugin falls back to the
4245 C<procfs> interface. By setting this option to I<true>, you can force the
4246 plugin to use the latter. This option defaults to I<false>.
4248 =item B<Device> I<Device>
4250 Selects the name of the thermal device that you want to collect or ignore,
4251 depending on the value of the B<IgnoreSelected> option. This option may be
4252 used multiple times to specify a list of devices.
4254 =item B<IgnoreSelected> I<true>|I<false>
4256 Invert the selection: If set to true, all devices B<except> the ones that
4257 match the device names specified by the B<Device> option are collected. By
4258 default only selected devices are collected if a selection is made. If no
4259 selection is configured at all, B<all> devices are selected.
4263 =head2 Plugin C<tokyotyrant>
4265 The C<tokyotyrant plugin> connects to a TokyoTyrant server and collects a
4266 couple metrics: number of records, and database size on disk.
4270 =item B<Host> I<Hostname/IP>
4272 The hostname or ip which identifies the server.
4273 Default: B<127.0.0.1>
4275 =item B<Port> I<Service/Port>
4277 The query port of the server. This needs to be a string, even if the port is
4278 given in its numeric form.
4283 =head2 Plugin C<unixsock>
4287 =item B<SocketFile> I<Path>
4289 Sets the socket-file which is to be created.
4291 =item B<SocketGroup> I<Group>
4293 If running as root change the group of the UNIX-socket after it has been
4294 created. Defaults to B<collectd>.
4296 =item B<SocketPerms> I<Permissions>
4298 Change the file permissions of the UNIX-socket after it has been created. The
4299 permissions must be given as a numeric, octal value as you would pass to
4300 L<chmod(1)>. Defaults to B<0770>.
4304 =head2 Plugin C<uuid>
4306 This plugin, if loaded, causes the Hostname to be taken from the machine's
4307 UUID. The UUID is a universally unique designation for the machine, usually
4308 taken from the machine's BIOS. This is most useful if the machine is running in
4309 a virtual environment such as Xen, in which case the UUID is preserved across
4310 shutdowns and migration.
4312 The following methods are used to find the machine's UUID, in order:
4318 Check I</etc/uuid> (or I<UUIDFile>).
4322 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
4327 Check for UUID from C<dmidecode> / SMBIOS.
4331 Check for UUID from Xen hypervisor.
4335 If no UUID can be found then the hostname is not modified.
4339 =item B<UUIDFile> I<Path>
4341 Take the UUID from the given file (default I</etc/uuid>).
4345 =head2 Plugin C<vmem>
4347 The C<vmem> plugin collects information about the usage of virtual memory.
4348 Since the statistics provided by the Linux kernel are very detailed, they are
4349 collected very detailed. However, to get all the details, you have to switch
4350 them on manually. Most people just want an overview over, such as the number of
4351 pages read from swap space.
4355 =item B<Verbose> B<true>|B<false>
4357 Enables verbose collection of information. This will start collecting page
4358 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
4359 Part of these statistics are collected on a "per zone" basis.
4363 =head2 Plugin C<vserver>
4365 This plugin doesn't have any options. B<VServer> support is only available for
4366 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
4367 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
4368 need to apply the patches and compile your own kernel, which will then provide
4369 the F</proc/virtual> filesystem that is required by this plugin.
4371 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
4373 B<Note>: The traffic collected by this plugin accounts for the amount of
4374 traffic passing a socket which might be a lot less than the actual on-wire
4375 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
4376 collect on-wire traffic you could, for example, use the logging facilities of
4377 iptables to feed data for the guest IPs into the iptables plugin.
4379 =head2 Plugin C<write_http>
4381 This output plugin submits values to an http server by POST them using the
4382 PUTVAL plain-text protocol. Each destination you want to post data to needs to
4383 have one B<URL> block, within which the destination can be configured further,
4384 for example by specifying authentication data.
4388 <Plugin "write_http">
4389 <URL "http://example.com/post-collectd">
4395 B<URL> blocks need one string argument which is used as the URL to which data
4396 is posted. The following options are understood within B<URL> blocks.
4400 =item B<User> I<Username>
4402 Optional user name needed for authentication.
4404 =item B<Password> I<Password>
4406 Optional password needed for authentication.
4408 =item B<VerifyPeer> B<true>|B<false>
4410 Enable or disable peer SSL certificate verification. See
4411 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4413 =item B<VerifyHost> B<true|false>
4415 Enable or disable peer host name verification. If enabled, the plugin checks if
4416 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
4417 matches the host name provided by the B<URL> option. If this identity check
4418 fails, the connection is aborted. Obviously, only works when connecting to a
4419 SSL enabled server. Enabled by default.
4421 =item B<CACert> I<File>
4423 File that holds one or more SSL certificates. If you want to use HTTPS you will
4424 possibly need this option. What CA certificates come bundled with C<libcurl>
4425 and are checked by default depends on the distribution you use.
4427 =item B<Format> B<Command>|B<JSON>
4429 Format of the output to generate. If set to B<Command>, will create output that
4430 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
4431 create output in the I<JavaScript Object Notation> (JSON).
4433 Defaults to B<Command>.
4435 =item B<StoreRates> B<true|false>
4437 If set to B<true>, convert counter values to rates. If set to B<false> (the
4438 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
4443 =head1 THRESHOLD CONFIGURATION
4445 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
4446 we mean that the values are not only stored or sent somewhere, but that they
4447 are judged and, if a problem is recognized, acted upon. The only action
4448 collectd takes itself is to generate and dispatch a "notification". Plugins can
4449 register to receive notifications and perform appropriate further actions.
4451 Since systems and what you expect them to do differ a lot, you can configure
4452 B<thresholds> for your values freely. This gives you a lot of flexibility but
4453 also a lot of responsibility.
4455 Every time a value is out of range a notification is dispatched. This means
4456 that the idle percentage of your CPU needs to be less then the configured
4457 threshold only once for a notification to be generated. There's no such thing
4458 as a moving average or similar - at least not now.
4460 Also, all values that match a threshold are considered to be relevant or
4461 "interesting". As a consequence collectd will issue a notification if they are
4462 not received for B<Timeout> iterations. The B<Timeout> configuration option is
4463 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
4464 "2" (the default) and some hosts sends it's CPU statistics to the server every
4465 60 seconds, a notification will be dispatched after about 120 seconds. It may
4466 take a little longer because the timeout is checked only once each B<Interval>
4469 When a value comes within range again or is received after it was missing, an
4470 "OKAY-notification" is dispatched.
4472 Here is a configuration example to get you started. Read below for more
4485 <Plugin "interface">
4502 WarningMin 100000000
4508 There are basically two types of configuration statements: The C<Host>,
4509 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
4510 configured. The C<Plugin> and C<Type> blocks may be specified further using the
4511 C<Instance> option. You can combine the block by nesting the blocks, though
4512 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
4513 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
4514 C<Type> may not contain other blocks. If multiple blocks apply to the same
4515 value the most specific block is used.
4517 The other statements specify the threshold to configure. They B<must> be
4518 included in a C<Type> block. Currently the following statements are recognized:
4522 =item B<FailureMax> I<Value>
4524 =item B<WarningMax> I<Value>
4526 Sets the upper bound of acceptable values. If unset defaults to positive
4527 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
4528 will be created. If the value is greater than B<WarningMax> but less than (or
4529 equal to) B<FailureMax> a B<WARNING> notification will be created.
4531 =item B<FailureMin> I<Value>
4533 =item B<WarningMin> I<Value>
4535 Sets the lower bound of acceptable values. If unset defaults to negative
4536 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
4537 be created. If the value is less than B<WarningMin> but greater than (or equal
4538 to) B<FailureMin> a B<WARNING> notification will be created.
4540 =item B<DataSource> I<DSName>
4542 Some data sets have more than one "data source". Interesting examples are the
4543 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
4544 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
4545 system load data set, C<load>, even has three data sources: C<shortterm>,
4546 C<midterm>, and C<longterm>.
4548 Normally, all data sources are checked against a configured threshold. If this
4549 is undesirable, or if you want to specify different limits for each data
4550 source, you can use the B<DataSource> option to have a threshold apply only to
4553 =item B<Invert> B<true>|B<false>
4555 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
4556 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
4557 B<WarningMax>) are not okay. Defaults to B<false>.
4559 =item B<Persist> B<true>|B<false>
4561 Sets how often notifications are generated. If set to B<true> one notification
4562 will be generated for each value that is out of the acceptable range. If set to
4563 B<false> (the default) then a notification is only generated if a value is out
4564 of range but the previous value was okay.
4566 This applies to missing values, too: If set to B<true> a notification about a
4567 missing value is generated once every B<Interval> seconds. If set to B<false>
4568 only one such notification is generated until the value appears again.
4570 =item B<Percentage> B<true>|B<false>
4572 If set to B<true>, the minimum and maximum values given are interpreted as
4573 percentage value, relative to the other data sources. This is helpful for
4574 example for the "df" type, where you may want to issue a warning when less than
4575 5E<nbsp>% of the total space is available. Defaults to B<false>.
4579 =head1 FILTER CONFIGURATION
4581 Starting with collectd 4.6 there is a powerful filtering infrastructure
4582 implemented in the daemon. The concept has mostly been copied from
4583 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
4584 terminology, so that users that are familiar with iptables feel right at home.
4588 The following are the terms used in the remainder of the filter configuration
4589 documentation. For an ASCII-art schema of the mechanism, see
4590 L<"General structure"> below.
4596 A I<match> is a criteria to select specific values. Examples are, of course, the
4597 name of the value or it's current value.
4599 Matches are implemented in plugins which you have to load prior to using the
4600 match. The name of such plugins starts with the "match_" prefix.
4604 A I<target> is some action that is to be performed with data. Such actions
4605 could, for example, be to change part of the value's identifier or to ignore
4606 the value completely.
4608 Some of these targets are built into the daemon, see L<"Built-in targets">
4609 below. Other targets are implemented in plugins which you have to load prior to
4610 using the target. The name of such plugins starts with the "target_" prefix.
4614 The combination of any number of matches and at least one target is called a
4615 I<rule>. The target actions will be performed for all values for which B<all>
4616 matches apply. If the rule does not have any matches associated with it, the
4617 target action will be performed for all values.
4621 A I<chain> is a list of rules and possibly default targets. The rules are tried
4622 in order and if one matches, the associated target will be called. If a value
4623 is handled by a rule, it depends on the target whether or not any subsequent
4624 rules are considered or if traversal of the chain is aborted, see
4625 L<"Flow control"> below. After all rules have been checked, the default targets
4630 =head2 General structure
4632 The following shows the resulting structure:
4639 +---------+ +---------+ +---------+ +---------+
4640 ! Rule !->! Match !->! Match !->! Target !
4641 +---------+ +---------+ +---------+ +---------+
4644 +---------+ +---------+ +---------+
4645 ! Rule !->! Target !->! Target !
4646 +---------+ +---------+ +---------+
4653 +---------+ +---------+ +---------+
4654 ! Rule !->! Match !->! Target !
4655 +---------+ +---------+ +---------+
4665 There are four ways to control which way a value takes through the filter
4672 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
4673 process the value with another chain. When the called chain finishes, usually
4674 the next target or rule after the jump is executed.
4678 The stop condition, signaled for example by the built-in target B<stop>, causes
4679 all processing of the value to be stopped immediately.
4683 Causes processing in the current chain to be aborted, but processing of the
4684 value generally will continue. This means that if the chain was called via
4685 B<Jump>, the next target or rule after the jump will be executed. If the chain
4686 was not called by another chain, control will be returned to the daemon and it
4687 may pass the value to another chain.
4691 Most targets will signal the B<continue> condition, meaning that processing
4692 should continue normally. There is no special built-in target for this
4699 The configuration reflects this structure directly:
4701 PostCacheChain "PostCache"
4703 <Rule "ignore_mysql_show">
4706 Type "^mysql_command$"
4707 TypeInstance "^show_"
4717 The above configuration example will ignore all values where the plugin field
4718 is "mysql", the type is "mysql_command" and the type instance begins with
4719 "show_". All other values will be sent to the C<rrdtool> write plugin via the
4720 default target of the chain. Since this chain is run after the value has been
4721 added to the cache, the MySQL C<show_*> command statistics will be available
4722 via the C<unixsock> plugin.
4724 =head2 List of configuration options
4728 =item B<PreCacheChain> I<ChainName>
4730 =item B<PostCacheChain> I<ChainName>
4732 Configure the name of the "pre-cache chain" and the "post-cache chain". The
4733 argument is the name of a I<chain> that should be executed before and/or after
4734 the values have been added to the cache.
4736 To understand the implications, it's important you know what is going on inside
4737 I<collectd>. The following diagram shows how values are passed from the
4738 read-plugins to the write-plugins:
4744 + - - - - V - - - - +
4745 : +---------------+ :
4748 : +-------+-------+ :
4751 : +-------+-------+ : +---------------+
4752 : ! Cache !--->! Value Cache !
4753 : ! insert ! : +---+---+-------+
4754 : +-------+-------+ : ! !
4755 : ! ,------------' !
4757 : +-------+---+---+ : +-------+-------+
4758 : ! Post-Cache +--->! Write-Plugins !
4759 : ! Chain ! : +---------------+
4760 : +---------------+ :
4763 + - - - - - - - - - +
4765 After the values are passed from the "read" plugins to the dispatch functions,
4766 the pre-cache chain is run first. The values are added to the internal cache
4767 afterwards. The post-cache chain is run after the values have been added to the
4768 cache. So why is it such a huge deal if chains are run before or after the
4769 values have been added to this cache?
4771 Targets that change the identifier of a value list should be executed before
4772 the values are added to the cache, so that the name in the cache matches the
4773 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
4774 this cache to receive a list of all available values. If you change the
4775 identifier after the value list has been added to the cache, this may easily
4776 lead to confusion, but it's not forbidden of course.
4778 The cache is also used to convert counter values to rates. These rates are, for
4779 example, used by the C<value> match (see below). If you use the rate stored in
4780 the cache B<before> the new value is added, you will use the old, B<previous>
4781 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
4782 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
4785 Last but not last, the B<stop> target makes a difference: If the pre-cache
4786 chain returns the stop condition, the value will not be added to the cache and
4787 the post-cache chain will not be run.
4789 =item B<Chain> I<Name>
4791 Adds a new chain with a certain name. This name can be used to refer to a
4792 specific chain, for example to jump to it.
4794 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
4796 =item B<Rule> [I<Name>]
4798 Adds a new rule to the current chain. The name of the rule is optional and
4799 currently has no meaning for the daemon.
4801 Within the B<Rule> block, there may be any number of B<Match> blocks and there
4802 must be at least one B<Target> block.
4804 =item B<Match> I<Name>
4806 Adds a match to a B<Rule> block. The name specifies what kind of match should
4807 be performed. Available matches depend on the plugins that have been loaded.
4809 The arguments inside the B<Match> block are passed to the plugin implementing
4810 the match, so which arguments are valid here depends on the plugin being used.
4811 If you do not need any to pass any arguments to a match, you can use the
4816 Which is equivalent to:
4821 =item B<Target> I<Name>
4823 Add a target to a rule or a default target to a chain. The name specifies what
4824 kind of target is to be added. Which targets are available depends on the
4825 plugins being loaded.
4827 The arguments inside the B<Target> block are passed to the plugin implementing
4828 the target, so which arguments are valid here depends on the plugin being used.
4829 If you do not need any to pass any arguments to a target, you can use the
4834 This is the same as writing:
4841 =head2 Built-in targets
4843 The following targets are built into the core daemon and therefore need no
4844 plugins to be loaded:
4850 Signals the "return" condition, see the L<"Flow control"> section above. This
4851 causes the current chain to stop processing the value and returns control to
4852 the calling chain. The calling chain will continue processing targets and rules
4853 just after the B<jump> target (see below). This is very similar to the
4854 B<RETURN> target of iptables, see L<iptables(8)>.
4856 This target does not have any options.
4864 Signals the "stop" condition, see the L<"Flow control"> section above. This
4865 causes processing of the value to be aborted immediately. This is similar to
4866 the B<DROP> target of iptables, see L<iptables(8)>.
4868 This target does not have any options.
4876 Sends the value to "write" plugins.
4882 =item B<Plugin> I<Name>
4884 Name of the write plugin to which the data should be sent. This option may be
4885 given multiple times to send the data to more than one write plugin.
4889 If no plugin is explicitly specified, the values will be sent to all available
4900 Starts processing the rules of another chain, see L<"Flow control"> above. If
4901 the end of that chain is reached, or a stop condition is encountered,
4902 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
4903 next target or the next rule. This is similar to the B<-j> command line option
4904 of iptables, see L<iptables(8)>.
4910 =item B<Chain> I<Name>
4912 Jumps to the chain I<Name>. This argument is required and may appear only once.
4924 =head2 Available matches
4930 Matches a value using regular expressions.
4936 =item B<Host> I<Regex>
4938 =item B<Plugin> I<Regex>
4940 =item B<PluginInstance> I<Regex>
4942 =item B<Type> I<Regex>
4944 =item B<TypeInstance> I<Regex>
4946 Match values where the given regular expressions match the various fields of
4947 the identifier of a value. If multiple regular expressions are given, B<all>
4948 regexen must match for a value to match.
4950 =item B<Invert> B<false>|B<true>
4952 When set to B<true>, the result of the match is inverted, i.e. all value lists
4953 where all regular expressions apply are not matched, all other value lists are
4954 matched. Defaults to B<false>.
4961 Host "customer[0-9]+"
4967 Matches values that have a time which differs from the time on the server.
4969 This match is mainly intended for servers that receive values over the
4970 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
4971 is very sensitive to the timestamp used when updating the RRD files. In
4972 particular, the time must be ever increasing. If a misbehaving client sends one
4973 packet with a timestamp far in the future, all further packets with a correct
4974 time will be ignored because of that one packet. What's worse, such corrupted
4975 RRD files are hard to fix.
4977 This match lets one match all values B<outside> a specified time range
4978 (relative to the server's time), so you can use the B<stop> target (see below)
4979 to ignore the value, for example.
4985 =item B<Future> I<Seconds>
4987 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
4988 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
4991 =item B<Past> I<Seconds>
4993 Matches all values that are I<behind> of the server's time by I<Seconds> or
4994 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5006 This example matches all values that are five minutes or more ahead of the
5007 server or one hour (or more) lagging behind.
5011 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
5012 values. If a data-set consists of more than one data-source, all data-sources
5013 must match the specified ranges for a positive match.
5019 =item B<Min> I<Value>
5021 Sets the smallest value which still results in a match. If unset, behaves like
5024 =item B<Max> I<Value>
5026 Sets the largest value which still results in a match. If unset, behaves like
5029 =item B<Invert> B<true>|B<false>
5031 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
5032 no-match is returned and vice versa. Please note that the B<Invert> setting
5033 only effects how B<Min> and B<Max> are applied to a specific value. Especially
5034 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
5036 =item B<DataSource> I<DSName> [I<DSName> ...]
5038 Select one or more of the data sources. If no data source is configured, all
5039 data sources will be checked. If the type handled by the match does not have a
5040 data source of the specified name(s), this will always result in no match
5041 (independent of the B<Invert> setting).
5043 =item B<Satisfy> B<Any>|B<All>
5045 Specifies how checking with several data sources is performed. If set to
5046 B<Any>, the match succeeds if one of the data sources is in the configured
5047 range. If set to B<All> the match only succeeds if all data sources are within
5048 the configured range. Default is B<All>.
5050 Usually B<All> is used for positive matches, B<Any> is used for negative
5051 matches. This means that with B<All> you usually check that all values are in a
5052 "good" range, while with B<Any> you check if any value is within a "bad" range
5053 (or outside the "good" range).
5057 Either B<Min> or B<Max>, but not both, may be unset.
5061 # Match all values smaller than or equal to 100. Matches only if all data
5062 # sources are below 100.
5068 # Match if the value of any data source is outside the range of 0 - 100.
5076 =item B<empty_counter>
5078 Matches all values with one or more data sources of type B<COUNTER> and where
5079 all counter values are zero. These counters usually I<never> increased since
5080 they started existing (and are therefore uninteresting), or got reset recently
5081 or overflowed and you had really, I<really> bad luck.
5083 Please keep in mind that ignoring such counters can result in confusing
5084 behavior: Counters which hardly ever increase will be zero for long periods of
5085 time. If the counter is reset for some reason (machine or service restarted,
5086 usually), the graph will be empty (NAN) for a long time. People may not
5091 Calculates a hash value of the host name and matches values according to that
5092 hash value. This makes it possible to divide all hosts into groups and match
5093 only values that are in a specific group. The intended use is in load
5094 balancing, where you want to handle only part of all data and leave the rest
5097 The hashing function used tries to distribute the hosts evenly. First, it
5098 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
5101 for (i = 0; host[i] != 0; i++)
5102 hash_value = (hash_value * 251) + host[i];
5104 The constant 251 is a prime number which is supposed to make this hash value
5105 more random. The code then checks the group for this host according to the
5106 I<Total> and I<Match> arguments:
5108 if ((hash_value % Total) == Match)
5113 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
5114 groups), then the least significant bit of the hash value will be the XOR of
5115 all least significant bits in the host name. One consequence is that when you
5116 have two hosts, "server0.example.com" and "server1.example.com", where the host
5117 name differs in one digit only and the digits differ by one, those hosts will
5118 never end up in the same group.
5124 =item B<Match> I<Match> I<Total>
5126 Divide the data into I<Total> groups and match all hosts in group I<Match> as
5127 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
5128 be smaller than I<Total>. I<Total> must be at least one, although only values
5129 greater than one really do make any sense.
5131 You can repeat this option to match multiple groups, for example:
5136 The above config will divide the data into seven groups and match groups three
5137 and five. One use would be to keep every value on two hosts so that if one
5138 fails the missing data can later be reconstructed from the second host.
5144 # Operate on the pre-cache chain, so that ignored values are not even in the
5149 # Divide all received hosts in seven groups and accept all hosts in
5153 # If matched: Return and continue.
5156 # If not matched: Return and stop.
5162 =head2 Available targets
5166 =item B<notification>
5168 Creates and dispatches a notification.
5174 =item B<Message> I<String>
5176 This required option sets the message of the notification. The following
5177 placeholders will be replaced by an appropriate value:
5185 =item B<%{plugin_instance}>
5189 =item B<%{type_instance}>
5191 These placeholders are replaced by the identifier field of the same name.
5193 =item B<%{ds:>I<name>B<}>
5195 These placeholders are replaced by a (hopefully) human readable representation
5196 of the current rate of this data source. If you changed the instance name
5197 (using the B<set> or B<replace> targets, see below), it may not be possible to
5198 convert counter values to rates.
5202 Please note that these placeholders are B<case sensitive>!
5204 =item B<Severity> B<"FATAL">|B<"WARNING">|B<"OKAY">
5206 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
5213 <Target "notification">
5214 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
5220 Replaces parts of the identifier using regular expressions.
5226 =item B<Host> I<Regex> I<Replacement>
5228 =item B<Plugin> I<Regex> I<Replacement>
5230 =item B<PluginInstance> I<Regex> I<Replacement>
5232 =item B<TypeInstance> I<Regex> I<Replacement>
5234 Match the appropriate field with the given regular expression I<Regex>. If the
5235 regular expression matches, that part that matches is replaced with
5236 I<Replacement>. If multiple places of the input buffer match a given regular
5237 expression, only the first occurrence will be replaced.
5239 You can specify each option multiple times to use multiple regular expressions
5247 # Replace "example.net" with "example.com"
5248 Host "\\<example.net\\>" "example.com"
5250 # Strip "www." from hostnames
5256 Sets part of the identifier of a value to a given string.
5262 =item B<Host> I<String>
5264 =item B<Plugin> I<String>
5266 =item B<PluginInstance> I<String>
5268 =item B<TypeInstance> I<String>
5270 Set the appropriate field to the given string. The strings for plugin instance
5271 and type instance may be empty, the strings for host and plugin may not be
5272 empty. It's currently not possible to set the type of a value this way.
5279 PluginInstance "coretemp"
5280 TypeInstance "core3"
5285 =head2 Backwards compatibility
5287 If you use collectd with an old configuration, i.E<nbsp>e. one without a
5288 B<Chain> block, it will behave as it used to. This is equivalent to the
5289 following configuration:
5295 If you specify a B<PostCacheChain>, the B<write> target will not be added
5296 anywhere and you will have to make sure that it is called where appropriate. We
5297 suggest to add the above snippet as default target to your "PostCache" chain.
5301 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
5317 L<collectd-exec(5)>,
5318 L<collectd-perl(5)>,
5319 L<collectd-unixsock(5)>,
5332 Florian Forster E<lt>octo@verplant.orgE<gt>