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<ReadThreads> I<Num>
107 Number of threads to start for reading plugins. The default value is B<5>, but
108 you may want to increase this if you have more than five plugins that take a
109 long time to read. Mostly those are plugin that do network-IO. Setting this to
110 a value higher than the number of plugins you've loaded is totally useless.
112 =item B<Hostname> I<Name>
114 Sets the hostname that identifies a host. If you omit this setting, the
115 hostname will be determined using the L<gethostname(2)> system call.
117 =item B<FQDNLookup> B<true|false>
119 If B<Hostname> is determined automatically this setting controls whether or not
120 the daemon should try to figure out the "fully qualified domain name", FQDN.
121 This is done using a lookup of the name returned by C<gethostname>.
123 Using this feature (i.E<nbsp>e. setting this option to B<true>) is recommended.
124 However, to preserve backwards compatibility the default is set to B<false>.
125 The sample config file that is installed with C<makeE<nbsp>install> includes a
126 line which sets this option, though, so that default installations will have
127 this setting enabled.
129 =item B<PreCacheChain> I<ChainName>
131 =item B<PostCacheChain> I<ChainName>
133 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
134 see L<FILTER CONFIGURATION> below on information on chains and how these
135 setting change the daemon's behavior.
139 =head1 PLUGIN OPTIONS
141 Some plugins may register own options. These options must be enclosed in a
142 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
143 require external configuration, too. The C<apache plugin>, for example,
144 required C<mod_status> to be configured in the webserver you're going to
145 collect data from. These plugins are listed below as well, even if they don't
146 require any configuration within collectd's configfile.
148 A list of all plugins and a short summary for each plugin can be found in the
149 F<README> file shipped with the sourcecode and hopefully binary packets as
152 =head2 Plugin C<apache>
154 To configure the C<apache>-plugin you first need to configure the Apache
155 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
156 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
157 the following snipped to base your Apache config upon:
160 <IfModule mod_status.c>
161 <Location /mod_status>
162 SetHandler server-status
166 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
167 also supported. It introduces a new field, called C<BusyServers>, to count the
168 number of currently connected clients. This field is also supported.
170 The following options are accepted by the C<apache>-plugin:
174 =item B<URL> I<http://host/mod_status?auto>
176 Sets the URL of the C<mod_status> output. This needs to be the output generated
177 by C<ExtendedStatus on> and it needs to be the machine readable output
178 generated by appending the C<?auto> argument.
180 =item B<User> I<Username>
182 Optional user name needed for authentication.
184 =item B<Password> I<Password>
186 Optional password needed for authentication.
188 =item B<VerifyPeer> B<true|false>
190 Enable or disable peer SSL certificate verification. See
191 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
193 =item B<VerifyHost> B<true|false>
195 Enable or disable peer host name verification. If enabled, the plugin checks
196 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
197 certificate matches the host name provided by the B<URL> option. If this
198 identity check fails, the connection is aborted. Obviously, only works when
199 connecting to a SSL enabled server. Enabled by default.
201 =item B<CACert> I<File>
203 File that holds one or more SSL certificates. If you want to use HTTPS you will
204 possibly need this option. What CA certificates come bundled with C<libcurl>
205 and are checked by default depends on the distribution you use.
209 =head2 Plugin C<apcups>
213 =item B<Host> I<Hostname>
215 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
216 that IPv6 support has been disabled unless someone can confirm or decline that
217 B<apcupsd> can handle it.
219 =item B<Port> I<Port>
221 TCP-Port to connect to. Defaults to B<3551>.
225 =head2 Plugin C<ascent>
227 This plugin collects information about an Ascent server, a free server for the
228 "World of Warcraft" game. This plugin gathers the information by fetching the
229 XML status page using C<libcurl> and parses it using C<libxml2>.
231 The configuration options are the same as for the C<apache> plugin above:
235 =item B<URL> I<http://localhost/ascent/status/>
237 Sets the URL of the XML status output.
239 =item B<User> I<Username>
241 Optional user name needed for authentication.
243 =item B<Password> I<Password>
245 Optional password needed for authentication.
247 =item B<VerifyPeer> B<true|false>
249 Enable or disable peer SSL certificate verification. See
250 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
252 =item B<VerifyHost> B<true|false>
254 Enable or disable peer host name verification. If enabled, the plugin checks
255 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
256 certificate matches the host name provided by the B<URL> option. If this
257 identity check fails, the connection is aborted. Obviously, only works when
258 connecting to a SSL enabled server. Enabled by default.
260 =item B<CACert> I<File>
262 File that holds one or more SSL certificates. If you want to use HTTPS you will
263 possibly need this option. What CA certificates come bundled with C<libcurl>
264 and are checked by default depends on the distribution you use.
268 =head2 Plugin C<bind>
270 Starting with BIND 9.5.0, the most widely used DNS server software provides
271 extensive statistics about queries, responses and lots of other information.
272 The bind plugin retrieves this information that's encoded in XML and provided
273 via HTTP and submits the values to collectd.
275 To use this plugin, you first need to tell BIND to make this information
276 available. This is done with the C<statistics-channels> configuration option:
278 statistics-channels {
279 inet localhost port 8053;
282 The configuration follows the grouping that can be seen when looking at the
283 data with an XSLT compatible viewer, such as a modern web browser. It's
284 probably a good idea to make yourself familiar with the provided values, so you
285 can understand what the collected statistics actually mean.
290 URL "http://localhost:8053/"
304 Zone "127.in-addr.arpa/IN"
308 The bind plugin accepts the following configuration options:
314 URL from which to retrieve the XML data. If not specified,
315 C<http://localhost:8053/> will be used.
317 =item B<OpCodes> I<true>|I<false>
319 When enabled, statistics about the I<"OpCodes">, for example the number of
320 C<QUERY> packets, are collected.
324 =item B<QTypes> I<true>|I<false>
326 When enabled, the number of I<incoming> queries by query types (for example
327 C<A>, C<MX>, C<AAAA>) is collected.
331 =item B<ServerStats> I<true>|I<false>
333 Collect global server statistics, such as requests received over IPv4 and IPv6,
334 successful queries, and failed updates.
338 =item B<ZoneMaintStats> I<true>|I<false>
340 Collect zone maintenance statistics, mostly information about notifications
341 (zone updates) and zone transfers.
345 =item B<ResolverStats> I<true>|I<false>
347 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
348 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
349 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
350 default. Use the B<ResolverStats> option within a B<View "_default"> block
351 instead for the same functionality.
357 Collect global memory statistics.
361 =item B<View> I<Name>
363 Collect statistics about a specific I<"view">. BIND can behave different,
364 mostly depending on the source IP-address of the request. These different
365 configurations are called "views". If you don't use this feature, you most
366 likely are only interested in the C<_default> view.
368 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
369 information you want to collect about a view. If no B<View> block is
370 configured, no detailed view statistics will be collected.
374 =item B<QTypes> I<true>|I<false>
376 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
381 =item B<ResolverStats> I<true>|I<false>
383 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
384 (e.E<nbsp>g. queries over IPv4, lame servers).
388 =item B<CacheRRSets> I<true>|I<false>
390 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
391 type is collected. Negative entries (queries which resulted in an error, for
392 example names that do not exist) are reported with a leading exclamation mark,
397 =item B<Zone> I<Name>
399 When given, collect detailed information about the given zone in the view. The
400 information collected if very similar to the global B<ServerStats> information
403 You can repeat this option to collect detailed information about multiple
406 By default no detailed zone information is collected.
412 =head2 Plugin C<cpufreq>
414 This plugin doesn't have any options. It reads
415 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
416 installed) to get the current CPU frequency. If this file does not exist make
417 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
418 installed and an "cpu governor" (that's a kernel module) is loaded.
424 =item B<DataDir> I<Directory>
426 Set the directory to store CSV-files under. Per default CSV-files are generated
427 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
428 The special strings B<stdout> and B<stderr> can be used to write to the standard
429 output and standard error channels, respectively. This, of course, only makes
430 much sense when collectd is running in foreground- or non-daemon-mode.
432 =item B<StoreRates> B<true|false>
434 If set to B<true>, convert counter values to rates. If set to B<false> (the
435 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
440 =head2 Plugin C<curl>
442 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
443 and the match infrastructure (the same code used by the tail plugin) to use
444 regular expressions with the received data.
446 The following example will read the current value of AMD stock from Google's
447 finance page and dispatch the value to collectd.
450 <Page "stock_quotes">
451 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
455 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
456 DSType "GaugeAverage"
457 # Note: `stock_value' is not a standard type.
464 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
465 a web page and one or more "matches" to be performed on the returned data. The
466 string argument to the B<Page> block is used as plugin instance.
468 The following options are valid within B<Page> blocks:
474 URL of the web site to retrieve. Since a regular expression will be used to
475 extract information from this data, non-binary data is a big plus here ;)
477 =item B<User> I<Name>
479 Username to use if authorization is required to read the page.
481 =item B<Password> I<Password>
483 Password to use if authorization is required to read the page.
485 =item B<VerifyPeer> B<true>|B<false>
487 Enable or disable peer SSL certificate verification. See
488 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
490 =item B<VerifyHost> B<true>|B<false>
492 Enable or disable peer host name verification. If enabled, the plugin checks if
493 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
494 matches the host name provided by the B<URL> option. If this identity check
495 fails, the connection is aborted. Obviously, only works when connecting to a
496 SSL enabled server. Enabled by default.
498 =item B<CACert> I<file>
500 File that holds one or more SSL certificates. If you want to use HTTPS you will
501 possibly need this option. What CA certificates come bundled with C<libcurl>
502 and are checked by default depends on the distribution you use.
504 =item B<MeasureResponseTime> B<true>|B<false>
506 Measure response time for the request. If this setting is enabled, B<Match>
507 blocks (see below) are optional. Disabled by default.
509 =item B<E<lt>MatchE<gt>>
511 One or more B<Match> blocks that define how to match information in the data
512 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
513 used by the C<tail> plugin, so please see the documentation of the C<tail>
514 plugin below on how matches are defined. If the B<MeasureResponseTime> option
515 is set to B<true>, B<Match> blocks are optional.
519 =head2 Plugin C<curl_json>
521 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
522 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
523 via cURL. This can be used to collect values from CouchDB documents (which are
524 stored JSON notation), for example.
526 The following example will collect several values from the built-in `_stats'
527 runtime statistics module of CouchDB
528 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
531 <URL "http://localhost:5984/_stats">
533 <Key "httpd/requests/count">
537 <Key "httpd_request_methods/*/count">
538 Type "http_request_methods"
541 <Key "httpd_status_codes/*/count">
542 Type "http_response_codes"
547 Another CouchDB example:
548 The following example will collect the status values from each database:
550 <URL "http://localhost:5984/_all_dbs">
555 <Key "*/doc_del_count">
563 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
564 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
565 The B<Key> string argument must be in a path format, which is used to collect a
566 value from a JSON map object. If a path element of B<Key> is the
567 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
569 The following options are valid within B<URL> blocks:
573 =item B<Instance> I<Instance>
575 Sets the plugin instance to I<Instance>.
577 =item B<User> I<Name>
579 Username to use if authorization is required to read the page.
581 =item B<Password> I<Password>
583 Password to use if authorization is required to read the page.
585 =item B<VerifyPeer> B<true>|B<false>
587 Enable or disable peer SSL certificate verification. See
588 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
590 =item B<VerifyHost> B<true>|B<false>
592 Enable or disable peer host name verification. If enabled, the plugin checks if
593 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
594 matches the host name provided by the B<URL> option. If this identity check
595 fails, the connection is aborted. Obviously, only works when connecting to a
596 SSL enabled server. Enabled by default.
598 =item B<CACert> I<file>
600 File that holds one or more SSL certificates. If you want to use HTTPS you will
601 possibly need this option. What CA certificates come bundled with C<libcurl>
602 and are checked by default depends on the distribution you use.
606 The following options are valid within B<Key> blocks:
610 =item B<Type> I<Type>
612 Sets the type used to dispatch the values to the daemon. Detailed information
613 about types and their configuration can be found in L<types.db(5)>. This
616 =item B<Instance> I<Instance>
618 Type-instance to use. Defaults to the current map key or current string array element value.
622 =head2 Plugin C<curl_xml>
624 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
625 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
628 <URL "http://localhost/stats.xml">
630 Instance "some_instance"
635 CACert "/path/to/ca.crt"
637 <XPath "table[@id=\"magic_level\"]/tr">
639 #InstancePrefix "prefix-"
641 ValuesFrom "td[2]/span[@class=\"level\"]"
646 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
647 URL to be fetched via HTTP (using libcurl). Within each B<URL> block there are
648 options which specify the connection parameters, for example authentication
649 information, and one or more B<XPath> blocks.
651 Each B<XPath> block specifies how to get one type of information. The
652 string argument must be a valid XPath expression which returns a list
653 of "base elements". One value is dispatched for each "base element". The
654 I<type instance> and values are looked up using further I<XPath> expressions
655 that should be relative to the base element.
657 Within the B<URL> block the following options are accepted:
661 =item B<Host> I<Name>
663 Use I<Name> as the host name when submitting values. Defaults to the global
666 =item B<Instance> I<Instance>
668 Use I<Instance> as the plugin instance when submitting values. Defaults to an
669 empty string (no plugin instance).
671 =item B<User> I<User>
672 =item B<Password> I<Password>
673 =item B<VerifyPeer> B<true>|B<false>
674 =item B<VerifyHost> B<true>|B<false>
675 =item B<CACert> I<CA Cert File>
677 These options behave exactly equivalent to the appropriate options of the
678 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
680 =item E<lt>B<XPath> I<XPath-expression>E<gt>
682 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
683 B<XPath> block specifies how to get one type of information. The string
684 argument must be a valid XPath expression which returns a list of "base
685 elements". One value is dispatched for each "base element".
687 Within the B<XPath> block the following options are accepted:
691 =item B<Type> I<Type>
693 Specifies the I<Type> used for submitting patches. This determines the number
694 of values that are required / expected and whether the strings are parsed as
695 signed or unsigned integer or as double values. See L<types.db(5)> for details.
696 This option is required.
698 =item B<InstancePrefix> I<InstancePrefix>
700 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
701 concatenated together without any separator.
702 This option is optional.
704 =item B<InstanceFrom> I<InstanceFrom>
706 Specifies a XPath expression to use for determining the I<type instance>. The
707 XPath expression must return exactly one element. The element's value is then
708 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
710 This value is required. As a special exception, if the "base XPath expression"
711 (the argument to the B<XPath> block) returns exactly one argument, then this
712 option may be omitted.
714 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
716 Specifies one or more XPath expression to use for reading the values. The
717 number of XPath expressions must match the number of data sources in the
718 I<type> specified with B<Type> (see above). Each XPath expression must return
719 exactly one element. The element's value is then parsed as a number and used as
720 value for the appropriate value in the value list dispatched to the daemon.
728 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
729 connect to various databases, execute I<SQL> statements and read back the
730 results. I<dbi> is an acronym for "database interface" in case you were
731 wondering about the name. You can configure how each column is to be
732 interpreted and the plugin will generate one or more data sets from each row
733 returned according to these rules.
735 Because the plugin is very generic, the configuration is a little more complex
736 than those of other plugins. It usually looks something like this:
739 <Query "out_of_stock">
740 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
741 # Use with MySQL 5.0.0 or later
745 InstancePrefix "out_of_stock"
746 InstancesFrom "category"
750 <Database "product_information">
752 DriverOption "host" "localhost"
753 DriverOption "username" "collectd"
754 DriverOption "password" "aZo6daiw"
755 DriverOption "dbname" "prod_info"
761 The configuration above defines one query with one result and one database. The
762 query is then linked to the database with the B<Query> option I<within> the
763 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
764 and you can also use the B<Include> statement to split up the configuration
765 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
766 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
769 The following is a complete list of options:
771 =head3 B<Query> blocks
773 Query blocks define I<SQL> statements and how the returned data should be
774 interpreted. They are identified by the name that is given in the opening line
775 of the block. Thus the name needs to be unique. Other than that, the name is
776 not used in collectd.
778 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
779 define which column holds which value or instance information. You can use
780 multiple B<Result> blocks to create multiple values from one returned row. This
781 is especially useful, when queries take a long time and sending almost the same
782 query again and again is not desirable.
786 <Query "environment">
787 Statement "select station, temperature, humidity from environment"
790 # InstancePrefix "foo"
791 InstancesFrom "station"
792 ValuesFrom "temperature"
796 InstancesFrom "station"
797 ValuesFrom "humidity"
801 The following options are accepted:
805 =item B<Statement> I<SQL>
807 Sets the statement that should be executed on the server. This is B<not>
808 interpreted by collectd, but simply passed to the database server. Therefore,
809 the SQL dialect that's used depends on the server collectd is connected to.
811 The query has to return at least two columns, one for the instance and one
812 value. You cannot omit the instance, even if the statement is guaranteed to
813 always return exactly one line. In that case, you can usually specify something
816 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
818 (That works with MySQL but may not be valid SQL according to the spec. If you
819 use a more strict database server, you may have to select from a dummy table or
822 Please note that some databases, for example B<Oracle>, will fail if you
823 include a semicolon at the end of the statement.
825 =item B<MinVersion> I<Version>
827 =item B<MaxVersion> I<Value>
829 Only use this query for the specified database version. You can use these
830 options to provide multiple queries with the same name but with a slightly
831 different syntax. The plugin will use only those queries, where the specified
832 minimum and maximum versions fit the version of the database in use.
834 The database version is determined by C<dbi_conn_get_engine_version>, see the
835 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
836 for details. Basically, each part of the version is assumed to be in the range
837 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
838 "40102", version "5.0.42" becomes "50042".
840 B<Warning:> The plugin will use B<all> matching queries, so if you specify
841 multiple queries with the same name and B<overlapping> ranges, weird stuff will
842 happen. Don't to it! A valid example would be something along these lines:
853 In the above example, there are three ranges that don't overlap. The last one
854 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
855 before "4.0.0" are not specified.
857 =item B<Type> I<Type>
859 The B<type> that's used for each line returned. See L<types.db(5)> for more
860 details on how types are defined. In short: A type is a predefined layout of
861 data and the number of values and type of values has to match the type
864 If you specify "temperature" here, you need exactly one gauge column. If you
865 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
868 There must be exactly one B<Type> option inside each B<Result> block.
870 =item B<InstancePrefix> I<prefix>
872 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
873 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
874 all strings returned in the appropriate columns are concatenated together,
875 separated by dashes I<("-")>.
877 =item B<InstancesFrom> I<column0> [I<column1> ...]
879 Specifies the columns whose values will be used to create the "type-instance"
880 for each row. If you specify more than one column, the value of all columns
881 will be joined together with dashes I<("-")> as separation characters.
883 The plugin itself does not check whether or not all built instances are
884 different. It's your responsibility to assure that each is unique. This is
885 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
886 sure that only one row is returned in this case.
888 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
891 =item B<ValuesFrom> I<column0> [I<column1> ...]
893 Names the columns whose content is used as the actual data for the data sets
894 that are dispatched to the daemon. How many such columns you need is determined
895 by the B<Type> setting above. If you specify too many or not enough columns,
896 the plugin will complain about that and no data will be submitted to the
899 The actual data type in the columns is not that important. The plugin will
900 automatically cast the values to the right type if it know how to do that. So
901 it should be able to handle integer an floating point types, as well as strings
902 (if they include a number at the beginning).
904 There must be at least one B<ValuesFrom> option inside each B<Result> block.
908 =head3 B<Database> blocks
910 Database blocks define a connection to a database and which queries should be
911 sent to that database. Since the used "dbi" library can handle a wide variety
912 of databases, the configuration is very generic. If in doubt, refer to libdbi's
913 documentationE<nbsp>- we stick as close to the terminology used there.
915 Each database needs a "name" as string argument in the starting tag of the
916 block. This name will be used as "PluginInstance" in the values submitted to
917 the daemon. Other than that, that name is not used.
921 =item B<Driver> I<Driver>
923 Specifies the driver to use to connect to the database. In many cases those
924 drivers are named after the database they can connect to, but this is not a
925 technical necessity. These drivers are sometimes referred to as "DBD",
926 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
927 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
928 project at L<http://libdbi-drivers.sourceforge.net/>.
930 You need to give the driver name as expected by the "dbi" library here. You
931 should be able to find that in the documentation for each driver. If you
932 mistype the driver name, the plugin will dump a list of all known driver names
935 =item B<DriverOption> I<Key> I<Value>
937 Sets driver-specific options. What option a driver supports can be found in the
938 documentation for each driver, somewhere at
939 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
940 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
942 Unfortunately, drivers are not too keen to report errors when an unknown option
943 is passed to them, so invalid settings here may go unnoticed. This is not the
944 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
945 the driver. If a driver complains about an option, the plugin will dump a
946 complete list of all options understood by that driver to the log.
948 =item B<SelectDB> I<Database>
950 In some cases, the database name you connect with is not the database name you
951 want to use for querying data. If this option is set, the plugin will "select"
952 (switch to) that database after the connection is established.
954 =item B<Query> I<QueryName>
956 Associates the query named I<QueryName> with this database connection. The
957 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
958 blocks you want to refer to must be placed above the database block you want to
967 =item B<Device> I<Device>
969 Select partitions based on the devicename.
971 =item B<MountPoint> I<Directory>
973 Select partitions based on the mountpoint.
975 =item B<FSType> I<FSType>
977 Select partitions based on the filesystem type.
979 =item B<IgnoreSelected> B<true>|B<false>
981 Invert the selection: If set to true, all partitions B<except> the ones that
982 match any one of the criteria are collected. By default only selected
983 partitions are collected if a selection is made. If no selection is configured
984 at all, B<all> partitions are selected.
986 =item B<ReportByDevice> B<true>|B<false>
988 Report using the device name rather than the mountpoint. i.e. with this I<false>,
989 (the default), it will report a disk as "root", but with it I<true>, it will be
990 "sda1" (or whichever).
992 =item B<ReportReserved> B<true>|B<false>
994 When enabled, the blocks reserved for root are reported separately. When
995 disabled (the default for backwards compatibility reasons) the reserved space
996 will be included in the "free" space.
998 When disabled, the "df" type will be used to store "free" and "used" space. The
999 mount point or disk name (see option B<ReportByDevice>) is used as type
1000 instance in this case (again: backwards compatibility).
1002 When enabled, the type "df_complex" is used and three files are created. The
1003 mount point or disk name is used as plugin instance and the type instance is
1004 set to "free", "reserved" and "used" as appropriate.
1006 Enabling this option is recommended.
1008 =item B<ReportInodes> B<true>|B<false>
1010 Enables or disables reporting of free, reserved and used inodes. Defaults to
1011 inode collection being disabled.
1013 Enable this option if inodes are a scarce resource for you, usually because
1014 many small files are stored on the disk. This is a usual scenario for mail
1015 transfer agents and web caches.
1019 =head2 Plugin C<disk>
1021 The C<disk> plugin collects information about the usage of physical disks and
1022 logical disks (partitions). Values collected are the number of octets written
1023 to and read from a disk or partition, the number of read/write operations
1024 issued to the disk and a rather complex "time" it took for these commands to be
1027 Using the following two options you can ignore some disks or configure the
1028 collection only of specific disks.
1032 =item B<Disk> I<Name>
1034 Select the disk I<Name>. Whether it is collected or ignored depends on the
1035 B<IgnoreSelected> setting, see below. As with other plugins that use the
1036 daemon's ignorelist functionality, a string that starts and ends with a slash
1037 is interpreted as a regular expression. Examples:
1042 =item B<IgnoreSelected> B<true>|B<false>
1044 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1045 statements, are ignored or if all other disks are ignored. The behavior
1046 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1047 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1048 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1049 is set to B<true>, all disks are collected B<except> the ones matched.
1053 =head2 Plugin C<dns>
1057 =item B<Interface> I<Interface>
1059 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1060 option sets the interface that should be used. If this option is not set, or
1061 set to "any", the plugin will try to get packets from B<all> interfaces. This
1062 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1064 =item B<IgnoreSource> I<IP-address>
1066 Ignore packets that originate from this address.
1068 =item B<SelectNumericQueryTypes> B<true>|B<false>
1070 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1074 =head2 Plugin C<email>
1078 =item B<SocketFile> I<Path>
1080 Sets the socket-file which is to be created.
1082 =item B<SocketGroup> I<Group>
1084 If running as root change the group of the UNIX-socket after it has been
1085 created. Defaults to B<collectd>.
1087 =item B<SocketPerms> I<Permissions>
1089 Change the file permissions of the UNIX-socket after it has been created. The
1090 permissions must be given as a numeric, octal value as you would pass to
1091 L<chmod(1)>. Defaults to B<0770>.
1093 =item B<MaxConns> I<Number>
1095 Sets the maximum number of connections that can be handled in parallel. Since
1096 this many threads will be started immediately setting this to a very high
1097 value will waste valuable resources. Defaults to B<5> and will be forced to be
1098 at most B<16384> to prevent typos and dumb mistakes.
1102 =head2 Plugin C<exec>
1104 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1105 contains valuable information on when the executable is executed and the
1106 output that is expected from it.
1110 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1112 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1114 Execute the executable I<Executable> as user I<User>. If the user name is
1115 followed by a colon and a group name, the effective group is set to that group.
1116 The real group and saved-set group will be set to the default group of that
1117 user. If no group is given the effective group ID will be the same as the real
1120 Please note that in order to change the user and/or group the daemon needs
1121 superuser privileges. If the daemon is run as an unprivileged user you must
1122 specify the same user/group here. If the daemon is run with superuser
1123 privileges, you must supply a non-root user here.
1125 The executable may be followed by optional arguments that are passed to the
1126 program. Please note that due to the configuration parsing numbers and boolean
1127 values may be changed. If you want to be absolutely sure that something is
1128 passed as-is please enclose it in quotes.
1130 The B<Exec> and B<NotificationExec> statements change the semantics of the
1131 programs executed, i.E<nbsp>e. the data passed to them and the response
1132 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1136 =head2 Plugin C<filecount>
1138 The C<filecount> plugin counts the number of files in a certain directory (and
1139 its subdirectories) and their combined size. The configuration is very straight
1142 <Plugin "filecount">
1143 <Directory "/var/qmail/queue/mess">
1144 Instance "qmail-message"
1146 <Directory "/var/qmail/queue/todo">
1147 Instance "qmail-todo"
1149 <Directory "/var/lib/php5">
1150 Instance "php5-sessions"
1155 The example above counts the number of files in QMail's queue directories and
1156 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1157 QMail has not yet looked at, the "message" queue holds the messages that were
1158 classified into "local" and "remote".
1160 As you can see, the configuration consists of one or more C<Directory> blocks,
1161 each of which specifies a directory in which to count the files. Within those
1162 blocks, the following options are recognized:
1166 =item B<Instance> I<Instance>
1168 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1169 it's your responsibility, the plugin doesn't check for that. If not given, the
1170 instance is set to the directory name with all slashes replaced by underscores
1171 and all leading underscores removed.
1173 =item B<Name> I<Pattern>
1175 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1176 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1177 against the pattern, not the entire path. In case this makes it easier for you:
1178 This option has been named after the B<-name> parameter to L<find(1)>.
1180 =item B<MTime> I<Age>
1182 Count only files of a specific age: If I<Age> is greater than zero, only files
1183 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1184 a negative number, this is inversed. For example, if B<-60> is specified, only
1185 files that have been modified in the last minute will be counted.
1187 The number can also be followed by a "multiplier" to easily specify a larger
1188 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1189 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1190 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1191 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1192 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1195 =item B<Size> I<Size>
1197 Count only files of a specific size. When I<Size> is a positive number, only
1198 files that are at least this big are counted. If I<Size> is a negative number,
1199 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1200 I<Size> are counted.
1202 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1203 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1204 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1205 note that there are 1000 bytes in a kilobyte, not 1024.
1207 =item B<Recursive> I<true>|I<false>
1209 Controls whether or not to recurse into subdirectories. Enabled by default.
1211 =item B<IncludeHidden> I<true>|I<false>
1213 Controls whether or not to include "hidden" files and directories in the count.
1214 "Hidden" files and directories are those, whose name begins with a dot.
1215 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1219 =head2 Plugin C<GenericJMX>
1221 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1222 L<collectd-java(5)>.
1224 =head2 Plugin C<gmond>
1226 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1227 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1228 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1233 MCReceiveFrom "239.2.11.71" "8649"
1234 <Metric "swap_total">
1236 TypeInstance "total"
1239 <Metric "swap_free">
1246 The following metrics are built-in:
1252 load_one, load_five, load_fifteen
1256 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1260 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1272 Available configuration options:
1276 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1278 Sets sets the multicast group and UDP port to which to subscribe.
1280 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1282 =item E<lt>B<Metric> I<Name>E<gt>
1284 These blocks add a new metric conversion to the internal table. I<Name>, the
1285 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1289 =item B<Type> I<Type>
1291 Type to map this metric to. Required.
1293 =item B<TypeInstance> I<Instance>
1295 Type-instance to use. Optional.
1297 =item B<DataSource> I<Name>
1299 Data source to map this metric to. If the configured type has exactly one data
1300 source, this is optional. Otherwise the option is required.
1306 =head2 Plugin C<hddtemp>
1308 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1309 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1310 default values, see below. C<hddtemp> has to be running to work correctly. If
1311 C<hddtemp> is not running timeouts may appear which may interfere with other
1314 The B<hddtemp> homepage can be found at
1315 L<http://www.guzu.net/linux/hddtemp.php>.
1319 =item B<Host> I<Hostname>
1321 Hostname to connect to. Defaults to B<127.0.0.1>.
1323 =item B<Port> I<Port>
1325 TCP-Port to connect to. Defaults to B<7634>.
1327 =item B<TranslateDevicename> I<true>|I<false>
1329 If enabled, translate the disk names to major/minor device numbers
1330 (e.E<nbsp>g. "8-0" for /dev/sda). For backwards compatibility this defaults to
1331 I<true> but it's recommended to disable it as it will probably be removed in
1332 the next major version.
1336 =head2 Plugin C<interface>
1340 =item B<Interface> I<Interface>
1342 Select this interface. By default these interfaces will then be collected. For
1343 a more detailed description see B<IgnoreSelected> below.
1345 =item B<IgnoreSelected> I<true>|I<false>
1347 If no configuration if given, the B<traffic>-plugin will collect data from
1348 all interfaces. This may not be practical, especially for loopback- and
1349 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1350 interfaces you're interested in. Sometimes, however, it's easier/preferred
1351 to collect all interfaces I<except> a few ones. This option enables you to
1352 do that: By setting B<IgnoreSelected> to I<true> the effect of
1353 B<Interface> is inverted: All selected interfaces are ignored and all
1354 other interfaces are collected.
1358 =head2 Plugin C<ipmi>
1362 =item B<Sensor> I<Sensor>
1364 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1366 =item B<IgnoreSelected> I<true>|I<false>
1368 If no configuration if given, the B<ipmi> plugin will collect data from all
1369 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1370 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1371 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1372 all other sensors are collected.
1374 =item B<NotifySensorAdd> I<true>|I<false>
1376 If a sensor appears after initialization time of a minute a notification
1379 =item B<NotifySensorRemove> I<true>|I<false>
1381 If a sensor disappears a notification is sent.
1383 =item B<NotifySensorNotPresent> I<true>|I<false>
1385 If you have for example dual power supply and one of them is (un)plugged then
1386 a notification is sent.
1390 =head2 Plugin C<iptables>
1394 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1396 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1397 will collect the counters of all rules which have a comment-match. The comment
1398 is then used as type-instance.
1400 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1401 the I<n>th rule will be collected. Again, the comment (or the number) will be
1402 used as the type-instance.
1404 If I<Name> is supplied, it will be used as the type-instance instead of the
1405 comment or the number.
1409 =head2 Plugin C<irq>
1415 Select this irq. By default these irqs will then be collected. For a more
1416 detailed description see B<IgnoreSelected> below.
1418 =item B<IgnoreSelected> I<true>|I<false>
1420 If no configuration if given, the B<irq>-plugin will collect data from all
1421 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1422 can use the B<Irq>-option to pick the interrupt you're interested in.
1423 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1424 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1425 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1426 and all other interrupts are collected.
1430 =head2 Plugin C<java>
1432 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1433 This section only discusses the syntax and semantic of the configuration
1434 options. For more in-depth information on the I<Java> plugin, please read
1435 L<collectd-java(5)>.
1440 JVMArg "-verbose:jni"
1441 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1442 LoadPlugin "org.collectd.java.Foobar"
1443 <Plugin "org.collectd.java.Foobar">
1444 # To be parsed by the plugin
1448 Available configuration options:
1452 =item B<JVMArg> I<Argument>
1454 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1455 exactly the way the arguments to the I<java> binary on the command line work.
1456 Execute C<javaE<nbsp>--help> for details.
1458 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1459 any other options! When another option is found, the JVM will be started and
1460 later options will have to be ignored!
1462 =item B<LoadPlugin> I<JavaClass>
1464 Instantiates a new I<JavaClass> object. The constructor of this object very
1465 likely then registers one or more callback methods with the server.
1467 See L<collectd-java(5)> for details.
1469 When the first such option is found, the virtual machine (JVM) is created. This
1470 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1471 B<LoadPlugin> options!
1473 =item B<Plugin> I<Name>
1475 The entire block is passed to the Java plugin as an
1476 I<org.collectd.api.OConfigItem> object.
1478 For this to work, the plugin has to register a configuration callback first,
1479 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1480 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1481 depends on the (Java) plugin registering the callback and is completely
1482 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1486 =head2 Plugin C<libvirt>
1488 This plugin allows CPU, disk and network load to be collected for virtualized
1489 guests on the machine. This means that these characteristics can be collected
1490 for guest systems without installing any software on them - collectd only runs
1491 on the hosting system. The statistics are collected through libvirt
1492 (L<http://libvirt.org/>).
1494 Only I<Connection> is required.
1498 =item B<Connection> I<uri>
1500 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1502 Connection "xen:///"
1504 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1506 =item B<RefreshInterval> I<seconds>
1508 Refresh the list of domains and devices every I<seconds>. The default is 60
1509 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1510 the list of domains and devices to be refreshed on every iteration.
1512 Refreshing the devices in particular is quite a costly operation, so if your
1513 virtualization setup is static you might consider increasing this. If this
1514 option is set to 0, refreshing is disabled completely.
1516 =item B<Domain> I<name>
1518 =item B<BlockDevice> I<name:dev>
1520 =item B<InterfaceDevice> I<name:dev>
1522 =item B<IgnoreSelected> I<true>|I<false>
1524 Select which domains and devices are collected.
1526 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1527 disk/network devices are collected.
1529 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1530 domains and disk/network devices are ignored, while the rest are collected.
1532 The domain name and device names may use a regular expression, if the name is
1533 surrounded by I</.../> and collectd was compiled with support for regexps.
1535 The default is to collect statistics for all domains and all their devices.
1539 BlockDevice "/:hdb/"
1540 IgnoreSelected "true"
1542 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1545 =item B<HostnameFormat> B<name|uuid|hostname|...>
1547 When the libvirt plugin logs data, it sets the hostname of the collected data
1548 according to this setting. The default is to use the guest name as provided by
1549 the hypervisor, which is equal to setting B<name>.
1551 B<uuid> means use the guest's UUID. This is useful if you want to track the
1552 same guest across migrations.
1554 B<hostname> means to use the global B<Hostname> setting, which is probably not
1555 useful on its own because all guests will appear to have the same name.
1557 You can also specify combinations of these fields. For example B<name uuid>
1558 means to concatenate the guest name and UUID (with a literal colon character
1559 between, thus I<"foo:1234-1234-1234-1234">).
1563 =head2 Plugin C<logfile>
1567 =item B<LogLevel> B<debug|info|notice|warning|err>
1569 Sets the log-level. If, for example, set to B<notice>, then all events with
1570 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1572 Please note that B<debug> is only available if collectd has been compiled with
1575 =item B<File> I<File>
1577 Sets the file to write log messages to. The special strings B<stdout> and
1578 B<stderr> can be used to write to the standard output and standard error
1579 channels, respectively. This, of course, only makes much sense when collectd is
1580 running in foreground- or non-daemon-mode.
1582 =item B<Timestamp> B<true>|B<false>
1584 Prefix all lines printed by the current time. Defaults to B<true>.
1586 =item B<PrintSeverity> B<true>|B<false>
1588 When enabled, all lines are prefixed by the severity of the log message, for
1589 example "warning". Defaults to B<false>.
1593 B<Note>: There is no need to notify the daemon after moving or removing the
1594 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1595 for each line it writes.
1597 =head2 Plugin C<mbmon>
1599 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
1601 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
1602 B<Host> and B<Port> options can be used to change these values, see below.
1603 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
1604 timeouts may appear which may interfere with other statistics..
1606 C<mbmon> must be run with the -r option ("print TAG and Value format");
1607 Debian's F</etc/init.d/mbmon> script already does this, other people
1608 will need to ensure that this is the case.
1612 =item B<Host> I<Hostname>
1614 Hostname to connect to. Defaults to B<127.0.0.1>.
1616 =item B<Port> I<Port>
1618 TCP-Port to connect to. Defaults to B<411>.
1622 =head2 Plugin C<memcachec>
1624 The C<memcachec plugin> connects to a memcached server, queries one or more
1625 given I<pages> and parses the returned data according to user specification.
1626 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
1629 In order to talk to the memcached server, this plugin uses the I<libmemcached>
1630 library. Please note that there is another library with a very similar name,
1631 libmemcache (notice the missing `d'), which is not applicable.
1633 Synopsis of the configuration:
1635 <Plugin "memcachec">
1636 <Page "plugin_instance">
1640 Regex "(\\d+) bytes sent"
1643 Instance "type_instance"
1648 The configuration options are:
1652 =item E<lt>B<Page> I<Name>E<gt>
1654 Each B<Page> block defines one I<page> to be queried from the memcached server.
1655 The block requires one string argument which is used as I<plugin instance>.
1657 =item B<Server> I<Address>
1659 Sets the server address to connect to when querying the page. Must be inside a
1664 When connected to the memcached server, asks for the page I<Key>.
1666 =item E<lt>B<Match>E<gt>
1668 Match blocks define which strings to look for and how matches substrings are
1669 interpreted. For a description of match blocks, please see L<"Plugin tail">.
1673 =head2 Plugin C<memcached>
1675 The C<memcached plugin> connects to a memcached server and queries statistics
1676 about cache utilization, memory and bandwidth used.
1677 L<http://www.danga.com/memcached/>
1681 =item B<Host> I<Hostname>
1683 Hostname to connect to. Defaults to B<127.0.0.1>.
1685 =item B<Port> I<Port>
1687 TCP-Port to connect to. Defaults to B<11211>.
1691 =head2 Plugin C<modbus>
1693 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
1694 register values. It supports reading single registers (unsigned 16E<nbsp>bit
1695 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
1696 values (two registers interpreted as IEEE floats in big endian notation).
1700 <Data "voltage-input-1">
1707 <Data "voltage-input-2">
1714 <Host "modbus.example.com">
1715 Address "192.168.0.42"
1720 Instance "power-supply"
1721 Collect "voltage-input-1"
1722 Collect "voltage-input-2"
1728 =item E<lt>B<Data> I<Name>E<gt> blocks
1730 Data blocks define a mapping between register numbers and the "types" used by
1733 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
1737 =item B<RegisterBase> I<Number>
1739 Configures the base register to read from the device. If the option
1740 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
1741 register will be read (the register number is increased by one).
1743 =item B<RegisterType> B<Uint16>|B<Uint32>|B<Float>
1745 Specifies what kind of data is returned by the device. If the type is B<Uint32>
1746 or B<Float>, two 16E<nbsp>bit registers will be read and the data is combined
1747 into one value. Defaults to B<Uint16>.
1749 =item B<Type> I<Type>
1751 Specifies the "type" (data set) to use when dispatching the value to
1752 I<collectd>. Currently, only data sets with exactly one data source are
1755 =item B<Instance> I<Instance>
1757 Sets the type instance to use when dispatching the value to I<collectd>. If
1758 unset, an empty string (no type instance) is used.
1762 =item E<lt>B<Host> I<Name>E<gt> blocks
1764 Host blocks are used to specify to which hosts to connect and what data to read
1765 from their "slaves". The string argument I<Name> is used as hostname when
1766 dispatching the values to I<collectd>.
1768 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
1772 =item B<Address> I<Hostname>
1774 Specifies the node name (the actual network address) used to connect to the
1775 host. This may be an IP address or a hostname. Please note that the used
1776 I<libmodbus> library only supports IPv4 at the moment.
1778 =item B<Port> I<Service>
1780 Specifies the port used to connect to the host. The port can either be given as
1781 a number or as a service name. Please note that the I<Service> argument must be
1782 a string, even if ports are given in their numerical form. Defaults to "502".
1784 =item B<Interval> I<Interval>
1786 Sets the interval (in seconds) in which the values will be collected from this
1787 host. By default the global B<Interval> setting will be used.
1789 =item E<lt>B<Slave> I<ID>E<gt>
1791 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
1792 is used to specify which device should be addressed. For each device you want
1793 to query, one B<Slave> block must be given.
1795 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
1799 =item B<Instance> I<Instance>
1801 Specify the plugin instance to use when dispatching the values to I<collectd>.
1802 By default "slave_I<ID>" is used.
1804 =item B<Collect> I<DataName>
1806 Specifies which data to retrieve from the device. I<DataName> must be the same
1807 string as the I<Name> argument passed to a B<Data> block. You can specify this
1808 option multiple times to collect more than one value from a slave. At least one
1809 B<Collect> option is mandatory.
1817 =head2 Plugin C<mysql>
1819 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
1820 one or more databases when started and keeps the connection up as long as
1821 possible. When the connection is interrupted for whatever reason it will try
1822 to re-connect. The plugin will complaint loudly in case anything goes wrong.
1824 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
1825 and collects information about MySQL network traffic, executed statements,
1826 requests, the query cache and threads by evaluating the
1827 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
1828 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
1829 Status Variables> for an explanation of these values.
1831 Optionally, master and slave statistics may be collected in a MySQL
1832 replication setup. In that case, information about the synchronization state
1833 of the nodes are collected by evaluating the C<Position> return value of the
1834 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
1835 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
1836 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
1837 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
1838 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
1853 Socket "/var/run/mysql/mysqld.sock"
1855 SlaveNotifications true
1859 A B<Database> block defines one connection to a MySQL database. It accepts a
1860 single argument which specifies the name of the database. None of the other
1861 options are required. MySQL will use default values as documented in the
1862 section "mysql_real_connect()" in the B<MySQL reference manual>.
1866 =item B<Host> I<Hostname>
1868 Hostname of the database server. Defaults to B<localhost>.
1870 =item B<User> I<Username>
1872 Username to use when connecting to the database. The user does not have to be
1873 granted any privileges (which is synonym to granting the C<USAGE> privilege).
1874 Any existing MySQL user will do.
1876 =item B<Password> I<Password>
1878 Password needed to log into the database.
1880 =item B<Database> I<Database>
1882 Select this database. Defaults to I<no database> which is a perfectly reasonable
1883 option for what this plugin does.
1885 =item B<Port> I<Port>
1887 TCP-port to connect to. The port must be specified in its numeric form, but it
1888 must be passed as a string nonetheless. For example:
1892 If B<Host> is set to B<localhost> (the default), this setting has no effect.
1893 See the documentation for the C<mysql_real_connect> function for details.
1895 =item B<Socket> I<Socket>
1897 Specifies the path to the UNIX domain socket of the MySQL server. This option
1898 only has any effect, if B<Host> is set to B<localhost> (the default).
1899 Otherwise, use the B<Port> option above. See the documentation for the
1900 C<mysql_real_connect> function for details.
1902 =item B<MasterStats> I<true|false>
1904 =item B<SlaveStats> I<true|false>
1906 Enable the collection of master / slave statistics in a replication setup.
1908 =item B<SlaveNotifications> I<true|false>
1910 If enabled, the plugin sends a notification if the replication slave I/O and /
1911 or SQL threads are not running.
1915 =head2 Plugin C<netapp>
1917 The netapp plugin can collect various performance and capacity information
1918 from a NetApp filer using the NetApp API.
1920 Please note that NetApp has a wide line of products and a lot of different
1921 software versions for each of these products. This plugin was developed for a
1922 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
1923 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
1924 model and software version but it is very hard to test this.
1925 If you have used this plugin with other models and/or software version, feel
1926 free to send us a mail to tell us about the results, even if it's just a short
1929 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
1930 basic authentication.
1932 B<Do not use a regular user for this!> Create a special collectd user with just
1933 the minimum of capabilities needed. The user only needs the "login-http-admin"
1934 capability as well as a few more depending on which data will be collected.
1935 Required capabilities are documented below.
1940 <Host "netapp1.example.com">
1964 IgnoreSelectedIO false
1966 IgnoreSelectedOps false
1967 GetLatency "volume0"
1968 IgnoreSelectedLatency false
1975 IgnoreSelectedCapacity false
1978 IgnoreSelectedSnapshot false
1991 The netapp plugin accepts the following configuration options:
1995 =item B<Host> I<Name>
1997 A host block defines one NetApp filer. It will appear in collectd with the name
1998 you specify here which does not have to be its real name nor its hostname.
2000 =item B<Protocol> B<httpd>|B<http>
2002 The protocol collectd will use to query this host.
2010 Valid options: http, https
2012 =item B<Address> I<Address>
2014 The hostname or IP address of the host.
2020 Default: The "host" block's name.
2022 =item B<Port> I<Port>
2024 The TCP port to connect to on the host.
2030 Default: 80 for protocol "http", 443 for protocol "https"
2032 =item B<User> I<User>
2034 =item B<Password> I<Password>
2036 The username and password to use to login to the NetApp.
2042 =item B<Interval> I<Interval>
2048 The following options decide what kind of data will be collected. You can
2049 either use them as a block and fine tune various parameters inside this block,
2050 use them as a single statement to just accept all default values, or omit it to
2051 not collect any data.
2053 The following options are valid inside all blocks:
2057 =item B<Interval> I<Seconds>
2059 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2060 host specific setting.
2064 =head3 The System block
2066 This will collect various performance data about the whole system.
2068 B<Note:> To get this data the collectd user needs the
2069 "api-perf-object-get-instances" capability.
2073 =item B<Interval> I<Seconds>
2075 Collect disk statistics every I<Seconds> seconds.
2077 =item B<GetCPULoad> B<true>|B<false>
2079 If you set this option to true the current CPU usage will be read. This will be
2080 the average usage between all CPUs in your NetApp without any information about
2083 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2084 returns in the "CPU" field.
2092 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2094 =item B<GetInterfaces> B<true>|B<false>
2096 If you set this option to true the current traffic of the network interfaces
2097 will be read. This will be the total traffic over all interfaces of your NetApp
2098 without any information about individual interfaces.
2100 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2101 in the "Net kB/s" field.
2111 Result: One value list of type "if_octects".
2113 =item B<GetDiskIO> B<true>|B<false>
2115 If you set this option to true the current IO throughput will be read. This
2116 will be the total IO of your NetApp without any information about individual
2117 disks, volumes or aggregates.
2119 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2120 in the "DiskE<nbsp>kB/s" field.
2128 Result: One value list of type "disk_octets".
2130 =item B<GetDiskOps> B<true>|B<false>
2132 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2133 iSCSI, etc. operations will be read. This will be the total number of
2134 operations on your NetApp without any information about individual volumes or
2137 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2138 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2146 Result: A variable number of value lists of type "disk_ops_complex". Each type
2147 of operation will result in one value list with the name of the operation as
2152 =head3 The WAFL block
2154 This will collect various performance data about the WAFL file system. At the
2155 moment this just means cache performance.
2157 B<Note:> To get this data the collectd user needs the
2158 "api-perf-object-get-instances" capability.
2160 B<Note:> The interface to get these values is classified as "Diagnostics" by
2161 NetApp. This means that it is not guaranteed to be stable even between minor
2166 =item B<Interval> I<Seconds>
2168 Collect disk statistics every I<Seconds> seconds.
2170 =item B<GetNameCache> B<true>|B<false>
2178 Result: One value list of type "cache_ratio" and type instance
2181 =item B<GetDirCache> B<true>|B<false>
2189 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2191 =item B<GetInodeCache> B<true>|B<false>
2199 Result: One value list of type "cache_ratio" and type instance
2202 =item B<GetBufferCache> B<true>|B<false>
2204 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2205 in the "Cache hit" field.
2213 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2217 =head3 The Disks block
2219 This will collect performance data about the individual disks in the NetApp.
2221 B<Note:> To get this data the collectd user needs the
2222 "api-perf-object-get-instances" capability.
2226 =item B<Interval> I<Seconds>
2228 Collect disk statistics every I<Seconds> seconds.
2230 =item B<GetBusy> B<true>|B<false>
2232 If you set this option to true the busy time of all disks will be calculated
2233 and the value of the busiest disk in the system will be written.
2235 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2236 in the "Disk util" field. Probably.
2244 Result: One value list of type "percent" and type instance "disk_busy".
2248 =head3 The VolumePerf block
2250 This will collect various performance data about the individual volumes.
2252 You can select which data to collect about which volume using the following
2253 options. They follow the standard ignorelist semantic.
2255 B<Note:> To get this data the collectd user needs the
2256 I<api-perf-object-get-instances> capability.
2260 =item B<Interval> I<Seconds>
2262 Collect volume performance data every I<Seconds> seconds.
2264 =item B<GetIO> I<Volume>
2266 =item B<GetOps> I<Volume>
2268 =item B<GetLatency> I<Volume>
2270 Select the given volume for IO, operations or latency statistics collection.
2271 The argument is the name of the volume without the C</vol/> prefix.
2273 Since the standard ignorelist functionality is used here, you can use a string
2274 starting and ending with a slash to specify regular expression matching: To
2275 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2278 GetIO "/^vol[027]$/"
2280 If no regular expression is specified, an exact match is required. Both,
2281 regular and exact matching are case sensitive.
2283 If no volume was specified at all for either of the three options, that data
2284 will be collected for all available volumes.
2286 =item B<IgnoreSelectedIO> B<true>|B<false>
2288 =item B<IgnoreSelectedOps> B<true>|B<false>
2290 =item B<IgnoreSelectedLatency> B<true>|B<false>
2292 When set to B<true>, the volumes selected for IO, operations or latency
2293 statistics collection will be ignored and the data will be collected for all
2296 When set to B<false>, data will only be collected for the specified volumes and
2297 all other volumes will be ignored.
2299 If no volumes have been specified with the above B<Get*> options, all volumes
2300 will be collected regardless of the B<IgnoreSelected*> option.
2302 Defaults to B<false>
2306 =head3 The VolumeUsage block
2308 This will collect capacity data about the individual volumes.
2310 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2315 =item B<Interval> I<Seconds>
2317 Collect volume usage statistics every I<Seconds> seconds.
2319 =item B<GetCapacity> I<VolumeName>
2321 The current capacity of the volume will be collected. This will result in two
2322 to four value lists, depending on the configuration of the volume. All data
2323 sources are of type "df_complex" with the name of the volume as
2326 There will be type_instances "used" and "free" for the number of used and
2327 available bytes on the volume. If the volume has some space reserved for
2328 snapshots, a type_instance "snap_reserved" will be available. If the volume
2329 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2330 number of bytes saved by the SIS feature.
2332 B<Note:> The current NetApp API has a bug that results in this value being
2333 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2334 number which works most of the time. If you see strange values here, bug
2335 NetApp support to fix this.
2337 Repeat this option to specify multiple volumes.
2339 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2341 Specify whether to collect only the volumes selected by the B<GetCapacity>
2342 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2343 B<false>. However, if no B<GetCapacity> option is specified at all, all
2344 capacities will be selected anyway.
2346 =item B<GetSnapshot> I<VolumeName>
2348 Select volumes from which to collect snapshot information.
2350 Usually, the space used for snapshots is included in the space reported as
2351 "used". If snapshot information is collected as well, the space used for
2352 snapshots is subtracted from the used space.
2354 To make things even more interesting, it is possible to reserve space to be
2355 used for snapshots. If the space required for snapshots is less than that
2356 reserved space, there is "reserved free" and "reserved used" space in addition
2357 to "free" and "used". If the space required for snapshots exceeds the reserved
2358 space, that part allocated in the normal space is subtracted from the "used"
2361 Repeat this option to specify multiple volumes.
2363 =item B<IgnoreSelectedSnapshot>
2365 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2366 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2367 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2368 capacities will be selected anyway.
2372 =head2 Plugin C<netlink>
2374 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2375 statistics of various interface and routing aspects.
2379 =item B<Interface> I<Interface>
2381 =item B<VerboseInterface> I<Interface>
2383 Instruct the plugin to collect interface statistics. This is basically the same
2384 as the statistics provided by the C<interface> plugin (see above) but
2385 potentially much more detailed.
2387 When configuring with B<Interface> only the basic statistics will be collected,
2388 namely octets, packets, and errors. These statistics are collected by
2389 the C<interface> plugin, too, so using both at the same time is no benefit.
2391 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2392 so that no data needs to be collected twice if you use the C<interface> plugin.
2393 This includes dropped packets, received multicast packets, collisions and a
2394 whole zoo of differentiated RX and TX errors. You can try the following command
2395 to get an idea of what awaits you:
2399 If I<Interface> is B<All>, all interfaces will be selected.
2401 =item B<QDisc> I<Interface> [I<QDisc>]
2403 =item B<Class> I<Interface> [I<Class>]
2405 =item B<Filter> I<Interface> [I<Filter>]
2407 Collect the octets and packets that pass a certain qdisc, class or filter.
2409 QDiscs and classes are identified by their type and handle (or classid).
2410 Filters don't necessarily have a handle, therefore the parent's handle is used.
2411 The notation used in collectd differs from that used in tc(1) in that it
2412 doesn't skip the major or minor number if it's zero and doesn't print special
2413 ids by their name. So, for example, a qdisc may be identified by
2414 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2415 thus not displayed by tc(1).
2417 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2418 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2419 associated with that interface will be collected.
2421 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2422 used. This may lead to problems when more than one filter is attached to a
2423 qdisc or class. This isn't nice, but we don't know how this could be done any
2424 better. If you have a idea, please don't hesitate to tell us.
2426 As with the B<Interface> option you can specify B<All> as the interface,
2427 meaning all interfaces.
2429 Here are some examples to help you understand the above text more easily:
2432 VerboseInterface "All"
2433 QDisc "eth0" "pfifo_fast-1:0"
2435 Class "ppp0" "htb-1:10"
2436 Filter "ppp0" "u32-1:0"
2439 =item B<IgnoreSelected>
2441 The behavior is the same as with all other similar plugins: If nothing is
2442 selected at all, everything is collected. If some things are selected using the
2443 options described above, only these statistics are collected. If you set
2444 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2445 specified statistics will not be collected.
2449 =head2 Plugin C<network>
2451 The Network plugin sends data to a remote instance of collectd, receives data
2452 from a remote instance, or both at the same time. Data which has been received
2453 from the network is usually not transmitted again, but this can be activated, see
2454 the B<Forward> option below.
2456 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2457 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2459 Both, B<Server> and B<Listen> can be used as single option or as block. When
2460 used as block, given options are valid for this socket only. For example:
2463 Server "collectd.internal.tld"
2464 <Server "collectd.external.tld">
2465 SecurityLevel "sign"
2466 Username "myhostname"
2473 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2475 The B<Server> statement/block sets the server to send datagrams to. The
2476 statement may occur multiple times to send each datagram to multiple
2479 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2480 optional second argument specifies a port number or a service name. If not
2481 given, the default, B<25826>, is used.
2483 The following options are recognized within B<Server> blocks:
2487 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2489 Set the security you require for network communication. When the security level
2490 has been set to B<Encrypt>, data sent over the network will be encrypted using
2491 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2492 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2493 authentication code. When set to B<None>, data is sent without any security.
2495 This feature is only available if the I<network> plugin was linked with
2498 =item B<Username> I<Username>
2500 Sets the username to transmit. This is used by the server to lookup the
2501 password. See B<AuthFile> below. All security levels except B<None> require
2504 This feature is only available if the I<network> plugin was linked with
2507 =item B<Password> I<Password>
2509 Sets a password (shared secret) for this socket. All security levels except
2510 B<None> require this setting.
2512 This feature is only available if the I<network> plugin was linked with
2517 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2519 The B<Listen> statement sets the interfaces to bind to. When multiple
2520 statements are found the daemon will bind to multiple interfaces.
2522 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2523 the argument is a multicast address the daemon will join that multicast group.
2524 The optional second argument specifies a port number or a service name. If not
2525 given, the default, B<25826>, is used.
2527 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
2531 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2533 Set the security you require for network communication. When the security level
2534 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
2535 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
2536 signed and encrypted data is accepted. When set to B<None>, all data will be
2537 accepted. If an B<AuthFile> option was given (see below), encrypted data is
2538 decrypted if possible.
2540 This feature is only available if the I<network> plugin was linked with
2543 =item B<AuthFile> I<Filename>
2545 Sets a file in which usernames are mapped to passwords. These passwords are
2546 used to verify signatures and to decrypt encrypted network packets. If
2547 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
2548 verified and encrypted packets are decrypted. Otherwise, signed data is
2549 accepted without checking the signature and encrypted data cannot be decrypted.
2550 For the other security levels this option is mandatory.
2552 The file format is very simple: Each line consists of a username followed by a
2553 colon and any number of spaces followed by the password. To demonstrate, an
2554 example file could look like this:
2559 Each time a packet is received, the modification time of the file is checked
2560 using L<stat(2)>. If the file has been changed, the contents is re-read. While
2561 the file is being read, it is locked using L<fcntl(2)>.
2565 =item B<TimeToLive> I<1-255>
2567 Set the time-to-live of sent packets. This applies to all, unicast and
2568 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
2569 That means that multicast packets will be sent with a TTL of C<1> (one) on most
2572 =item B<MaxPacketSize> I<1024-65535>
2574 Set the maximum size for datagrams received over the network. Packets larger
2575 than this will be truncated.
2577 =item B<Forward> I<true|false>
2579 If set to I<true>, write packets that were received via the network plugin to
2580 the sending sockets. This should only be activated when the B<Listen>- and
2581 B<Server>-statements differ. Otherwise packets may be send multiple times to
2582 the same multicast group. While this results in more network traffic than
2583 necessary it's not a huge problem since the plugin has a duplicate detection,
2584 so the values will not loop.
2586 =item B<CacheFlush> I<Seconds>
2588 For each host/plugin/type combination the C<network plugin> caches the time of
2589 the last value being sent or received. Every I<Seconds> seconds the plugin
2590 searches and removes all entries that are older than I<Seconds> seconds, thus
2591 freeing the unused memory again. Since this process is somewhat expensive and
2592 normally doesn't do much, this value should not be too small. The default is
2593 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
2596 =item B<ReportStats> B<true>|B<false>
2598 The network plugin cannot only receive and send statistics, it can also create
2599 statistics about itself. Collected data included the number of received and
2600 sent octets and packets, the length of the receive queue and the number of
2601 values handled. When set to B<true>, the I<Network plugin> will make these
2602 statistics available. Defaults to B<false>.
2606 =head2 Plugin C<nginx>
2608 This plugin collects the number of connections and requests handled by the
2609 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
2610 queries the page provided by the C<ngx_http_stub_status_module> module, which
2611 isn't compiled by default. Please refer to
2612 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
2613 how to compile and configure nginx and this module.
2615 The following options are accepted by the C<nginx plugin>:
2619 =item B<URL> I<http://host/nginx_status>
2621 Sets the URL of the C<ngx_http_stub_status_module> output.
2623 =item B<User> I<Username>
2625 Optional user name needed for authentication.
2627 =item B<Password> I<Password>
2629 Optional password needed for authentication.
2631 =item B<VerifyPeer> B<true|false>
2633 Enable or disable peer SSL certificate verification. See
2634 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
2636 =item B<VerifyHost> B<true|false>
2638 Enable or disable peer host name verification. If enabled, the plugin checks
2639 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
2640 certificate matches the host name provided by the B<URL> option. If this
2641 identity check fails, the connection is aborted. Obviously, only works when
2642 connecting to a SSL enabled server. Enabled by default.
2644 =item B<CACert> I<File>
2646 File that holds one or more SSL certificates. If you want to use HTTPS you will
2647 possibly need this option. What CA certificates come bundled with C<libcurl>
2648 and are checked by default depends on the distribution you use.
2652 =head2 Plugin C<notify_desktop>
2654 This plugin sends a desktop notification to a notification daemon, as defined
2655 in the Desktop Notification Specification. To actually display the
2656 notifications, B<notification-daemon> is required and B<collectd> has to be
2657 able to access the X server.
2659 The Desktop Notification Specification can be found at
2660 L<http://www.galago-project.org/specs/notification/>.
2664 =item B<OkayTimeout> I<timeout>
2666 =item B<WarningTimeout> I<timeout>
2668 =item B<FailureTimeout> I<timeout>
2670 Set the I<timeout>, in milliseconds, after which to expire the notification
2671 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
2672 been specified, the displayed notification will not be closed at all - the
2673 user has to do so herself. These options default to 5000. If a negative number
2674 has been specified, the default is used as well.
2678 =head2 Plugin C<notify_email>
2680 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
2681 configured email address.
2683 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
2685 Available configuration options:
2689 =item B<From> I<Address>
2691 Email address from which the emails should appear to come from.
2693 Default: C<root@localhost>
2695 =item B<Recipient> I<Address>
2697 Configures the email address(es) to which the notifications should be mailed.
2698 May be repeated to send notifications to multiple addresses.
2700 At least one B<Recipient> must be present for the plugin to work correctly.
2702 =item B<SMTPServer> I<Hostname>
2704 Hostname of the SMTP server to connect to.
2706 Default: C<localhost>
2708 =item B<SMTPPort> I<Port>
2710 TCP port to connect to.
2714 =item B<SMTPUser> I<Username>
2716 Username for ASMTP authentication. Optional.
2718 =item B<SMTPPassword> I<Password>
2720 Password for ASMTP authentication. Optional.
2722 =item B<Subject> I<Subject>
2724 Subject-template to use when sending emails. There must be exactly two
2725 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
2726 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
2729 Default: C<Collectd notify: %s@%s>
2733 =head2 Plugin C<ntpd>
2737 =item B<Host> I<Hostname>
2739 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
2741 =item B<Port> I<Port>
2743 UDP-Port to connect to. Defaults to B<123>.
2745 =item B<ReverseLookups> B<true>|B<false>
2747 Sets whether or not to perform reverse lookups on peers. Since the name or
2748 IP-address may be used in a filename it is recommended to disable reverse
2749 lookups. The default is to do reverse lookups to preserve backwards
2750 compatibility, though.
2754 =head2 Plugin C<nut>
2758 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
2760 Add a UPS to collect data from. The format is identical to the one accepted by
2765 =head2 Plugin C<olsrd>
2767 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
2768 the Optimized Link State Routing daemon and reads information about the current
2769 state of the meshed network.
2771 The following configuration options are understood:
2775 =item B<Host> I<Host>
2777 Connect to I<Host>. Defaults to B<"localhost">.
2779 =item B<Port> I<Port>
2781 Specifies the port to connect to. This must be a string, even if you give the
2782 port as a number rather than a service name. Defaults to B<"2006">.
2784 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
2786 Specifies what information to collect about links, i.E<nbsp>e. direct
2787 connections of the daemon queried. If set to B<No>, no information is
2788 collected. If set to B<Summary>, the number of links and the average of all
2789 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
2790 If set to B<Detail> LQ and NLQ are collected per link.
2792 Defaults to B<Detail>.
2794 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
2796 Specifies what information to collect about routes of the daemon queried. If
2797 set to B<No>, no information is collected. If set to B<Summary>, the number of
2798 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
2799 metric and ETX are collected per route.
2801 Defaults to B<Summary>.
2803 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
2805 Specifies what information to collect about the global topology. If set to
2806 B<No>, no information is collected. If set to B<Summary>, the number of links
2807 in the entire topology and the average I<link quality> (LQ) is calculated.
2808 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
2810 Defaults to B<Summary>.
2814 =head2 Plugin C<onewire>
2816 B<EXPERIMENTAL!> See notes below.
2818 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
2819 L<http://owfs.org/> to read sensors connected via the onewire bus.
2821 Currently only temperature sensors (sensors with the family code C<10>,
2822 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
2823 would like to have included, please send a sort request to the mailing list.
2825 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
2826 experimental, below.
2830 =item B<Device> I<Device>
2832 Sets the device to read the values from. This can either be a "real" hardware
2833 device, such as a serial port or an USB port, or the address of the
2834 L<owserver(1)> socket, usually B<localhost:4304>.
2836 Though the documentation claims to automatically recognize the given address
2837 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
2838 with that version, the following configuration worked for us:
2841 Device "-s localhost:4304"
2844 This directive is B<required> and does not have a default value.
2846 =item B<Sensor> I<Sensor>
2848 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
2849 below. Sensors are specified without the family byte at the beginning, to you'd
2850 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
2853 =item B<IgnoreSelected> I<true>|I<false>
2855 If no configuration if given, the B<onewire> plugin will collect data from all
2856 sensors found. This may not be practical, especially if sensors are added and
2857 removed regularly. Sometimes, however, it's easier/preferred to collect only
2858 specific sensors or all sensors I<except> a few specified ones. This option
2859 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
2860 B<Sensor> is inverted: All selected interfaces are ignored and all other
2861 interfaces are collected.
2863 =item B<Interval> I<Seconds>
2865 Sets the interval in which all sensors should be read. If not specified, the
2866 global B<Interval> setting is used.
2870 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
2871 work with big setups. It works with one sensor being attached to one
2872 controller, but as soon as you throw in a couple more senors and maybe a hub
2873 or two, reading all values will take more than ten seconds (the default
2874 interval). We will probably add some separate thread for reading the sensors
2875 and some cache or something like that, but it's not done yet. We will try to
2876 maintain backwards compatibility in the future, but we can't promise. So in
2877 short: If it works for you: Great! But keep in mind that the config I<might>
2878 change, though this is unlikely. Oh, and if you want to help improving this
2879 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
2881 =head2 Plugin C<openvpn>
2883 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
2884 traffic statistics about connected clients.
2886 To set up OpenVPN to write to the status file periodically, use the
2887 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
2888 you need to set the required format, too. This is done by setting
2889 B<--status-version> to B<2>.
2891 So, in a nutshell you need:
2893 openvpn $OTHER_OPTIONS \
2894 --status "/var/run/openvpn-status" 10 \
2901 =item B<StatusFile> I<File>
2903 Specifies the location of the status file.
2905 =item B<ImprovedNamingSchema> B<true>|B<false>
2907 When enabled, the filename of the status file will be used as plugin instance
2908 and the client's "common name" will be used as type instance. This is required
2909 when reading multiple status files. Enabling this option is recommended, but to
2910 maintain backwards compatibility this option is disabled by default.
2912 =item B<CollectCompression> B<true>|B<false>
2914 Sets whether or not statistics about the compression used by OpenVPN should be
2915 collected. This information is only available in I<single> mode. Enabled by
2918 =item B<CollectIndividualUsers> B<true>|B<false>
2920 Sets whether or not traffic information is collected for each connected client
2921 individually. If set to false, currently no traffic data is collected at all
2922 because aggregating this data in a save manner is tricky. Defaults to B<true>.
2924 =item B<CollectUserCount> B<true>|B<false>
2926 When enabled, the number of currently connected clients or users is collected.
2927 This is expecially interesting when B<CollectIndividualUsers> is disabled, but
2928 can be configured independently from that option. Defaults to B<false>.
2932 =head2 Plugin C<oracle>
2934 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
2935 Oracle® Database and lets you execute SQL statements there. It is very similar
2936 to the "dbi" plugin, because it was written around the same time. See the "dbi"
2937 plugin's documentation above for details.
2940 <Query "out_of_stock">
2941 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2944 # InstancePrefix "foo"
2945 InstancesFrom "category"
2949 <Database "product_information">
2953 Query "out_of_stock"
2957 =head3 B<Query> blocks
2959 The Query blocks are handled identically to the Query blocks of the "dbi"
2960 plugin. Please see its documentation above for details on how to specify
2963 =head3 B<Database> blocks
2965 Database blocks define a connection to a database and which queries should be
2966 sent to that database. Each database needs a "name" as string argument in the
2967 starting tag of the block. This name will be used as "PluginInstance" in the
2968 values submitted to the daemon. Other than that, that name is not used.
2972 =item B<ConnectID> I<ID>
2974 Defines the "database alias" or "service name" to connect to. Usually, these
2975 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
2977 =item B<Username> I<Username>
2979 Username used for authentication.
2981 =item B<Password> I<Password>
2983 Password used for authentication.
2985 =item B<Query> I<QueryName>
2987 Associates the query named I<QueryName> with this database connection. The
2988 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2989 blocks you want to refer to must be placed above the database block you want to
2994 =head2 Plugin C<perl>
2996 This plugin embeds a Perl-interpreter into collectd and provides an interface
2997 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
2999 =head2 Plugin C<ping>
3001 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3002 configured hosts periodically and measures the network latency. Whenever the
3003 C<read> function of the plugin is called, it submits the average latency, the
3004 standard deviation and the drop rate for each host.
3006 Available configuration options:
3010 =item B<Host> I<IP-address>
3012 Host to ping periodically. This option may be repeated several times to ping
3015 =item B<Interval> I<Seconds>
3017 Sets the interval in which to send ICMP echo packets to the configured hosts.
3018 This is B<not> the interval in which statistics are queries from the plugin but
3019 the interval in which the hosts are "pinged". Therefore, the setting here
3020 should be smaller than or equal to the global B<Interval> setting. Fractional
3021 times, such as "1.24" are allowed.
3025 =item B<Timeout> I<Seconds>
3027 Time to wait for a response from the host to which an ICMP packet had been
3028 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3029 to be down or the packet to be dropped. This setting must be smaller than the
3030 B<Interval> setting above for the plugin to work correctly. Fractional
3031 arguments are accepted.
3035 =item B<TTL> I<0-255>
3037 Sets the Time-To-Live of generated ICMP packets.
3039 =item B<SourceAddress> I<host>
3041 Sets the source address to use. I<host> may either be a numerical network
3042 address or a network hostname.
3044 =item B<Device> I<name>
3046 Sets the outgoing network device to be used. I<name> has to specify an
3047 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3050 =item B<MaxMissed> I<Packets>
3052 Trigger a DNS resolv after the host has not replied to I<Packets> packets. This
3053 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3055 Default: B<-1> (disabled)
3059 =head2 Plugin C<postgresql>
3061 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3062 keeps a persistent connection to all configured databases and tries to
3063 reconnect if the connection has been interrupted. A database is configured by
3064 specifying a B<Database> block as described below. The default statistics are
3065 collected from PostgreSQL's B<statistics collector> which thus has to be
3066 enabled for this plugin to work correctly. This should usually be the case by
3067 default. See the section "The Statistics Collector" of the B<PostgreSQL
3068 Documentation> for details.
3070 By specifying custom database queries using a B<Query> block as described
3071 below, you may collect any data that is available from some PostgreSQL
3072 database. This way, you are able to access statistics of external daemons
3073 which are available in a PostgreSQL database or use future or special
3074 statistics provided by PostgreSQL without the need to upgrade your collectd
3077 The B<PostgreSQL Documentation> manual can be found at
3078 L<http://www.postgresql.org/docs/manuals/>.
3082 Statement "SELECT magic FROM wizard WHERE host = $1;"
3086 InstancePrefix "magic"
3091 <Query rt36_tickets>
3092 Statement "SELECT COUNT(type) AS count, type \
3094 WHEN resolved = 'epoch' THEN 'open' \
3095 ELSE 'resolved' END AS type \
3096 FROM tickets) type \
3100 InstancePrefix "rt36_tickets"
3101 InstancesFrom "type"
3112 KRBSrvName "kerberos_service_name"
3117 Service "service_name"
3118 Query backend # predefined
3123 The B<Query> block defines one database query which may later be used by a
3124 database definition. It accepts a single mandatory argument which specifies
3125 the name of the query. The names of all queries have to be unique (see the
3126 B<MinVersion> and B<MaxVersion> options below for an exception to this
3127 rule). The following configuration options are available to define the query:
3129 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3130 blocks define how to handle the values returned from the query. They define
3131 which column holds which value and how to dispatch that value to the daemon.
3132 Multiple B<Result> blocks may be used to extract multiple values from a single
3137 =item B<Statement> I<sql query statement>
3139 Specify the I<sql query statement> which the plugin should execute. The string
3140 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3141 first, second, etc. parameter. The value of the parameters is specified by the
3142 B<Param> configuration option - see below for details. To include a literal
3143 B<$> character followed by a number, surround it with single quotes (B<'>).
3145 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3146 allowed. Note, however, that only a single command may be used. Semicolons are
3147 allowed as long as a single non-empty command has been specified only.
3149 The returned lines will be handled separately one after another.
3151 =item B<Query> I<sql query statement>
3153 This is a deprecated synonym for B<Statement>. It will be removed in version 5
3156 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3158 Specify the parameters which should be passed to the SQL query. The parameters
3159 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3160 they appear in the configuration file. The value of the parameter is
3161 determined depending on the value of the B<Param> option as follows:
3167 The configured hostname of the database connection. If a UNIX domain socket is
3168 used, the parameter expands to "localhost".
3172 The name of the database of the current connection.
3176 The username used to connect to the database.
3180 The interval collectd is using (as specified by the B<Interval> option).
3184 Please note that parameters are only supported by PostgreSQL's protocol
3185 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3187 =item B<Type> I<type>
3189 The I<type> name to be used when dispatching the values. The type describes
3190 how to handle the data and where to store it. See L<types.db(5)> for more
3191 details on types and their configuration. The number and type of values (as
3192 selected by the B<ValuesFrom> option) has to match the type of the given name.
3194 This option is required inside a B<Result> block.
3196 =item B<InstancePrefix> I<prefix>
3198 =item B<InstancesFrom> I<column0> [I<column1> ...]
3200 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3201 B<InstancePrefix> defines a static prefix that will be prepended to all type
3202 instances. B<InstancesFrom> defines the column names whose values will be used
3203 to create the type instance. Multiple values will be joined together using the
3204 hyphen (C<->) as separation character.
3206 The plugin itself does not check whether or not all built instances are
3207 different. It is your responsibility to assure that each is unique.
3209 Both options are optional. If none is specified, the type instance will be
3212 =item B<ValuesFrom> I<column0> [I<column1> ...]
3214 Names the columns whose content is used as the actual data for the data sets
3215 that are dispatched to the daemon. How many such columns you need is
3216 determined by the B<Type> setting as explained above. If you specify too many
3217 or not enough columns, the plugin will complain about that and no data will be
3218 submitted to the daemon.
3220 The actual data type, as seen by PostgreSQL, is not that important as long as
3221 it represents numbers. The plugin will automatically cast the values to the
3222 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3223 L<strtod(3)> functions, so anything supported by those functions is supported
3224 by the plugin as well.
3226 This option is required inside a B<Result> block and may be specified multiple
3227 times. If multiple B<ValuesFrom> options are specified, the columns are read
3230 =item B<Column> I<type> [I<type instance>]
3232 This is a deprecated alternative to a B<Result> block. It will be removed in
3233 version 5 of collectd. It is equivalent to the following B<Result> block:
3237 InstancePrefix I<type instance>
3238 ValuesFrom I<name of the x. column>
3241 The order of the B<Column> options defines which columns of the query result
3242 should be used. The first option specifies the data found in the first column,
3243 the second option that of the second column, and so on.
3245 =item B<MinVersion> I<version>
3247 =item B<MaxVersion> I<version>
3249 Specify the minimum or maximum version of PostgreSQL that this query should be
3250 used with. Some statistics might only be available with certain versions of
3251 PostgreSQL. This allows you to specify multiple queries with the same name but
3252 which apply to different versions, thus allowing you to use the same
3253 configuration in a heterogeneous environment.
3255 The I<version> has to be specified as the concatenation of the major, minor
3256 and patch-level versions, each represented as two-decimal-digit numbers. For
3257 example, version 8.2.3 will become 80203.
3259 =item B<MinPGVersion> I<version>
3261 =item B<MaxPGVersion> I<version>
3263 These are deprecated synonyms for B<MinVersion> and B<MaxVersion>
3264 respectively. They will be removed in version 5 of collectd.
3268 The following predefined queries are available (the definitions can be found
3269 in the F<postgresql_default.conf> file which, by default, is available at
3270 C<I<prefix>/share/collectd/>):
3276 This query collects the number of backends, i.E<nbsp>e. the number of
3279 =item B<transactions>
3281 This query collects the numbers of committed and rolled-back transactions of
3286 This query collects the numbers of various table modifications (i.E<nbsp>e.
3287 insertions, updates, deletions) of the user tables.
3289 =item B<query_plans>
3291 This query collects the numbers of various table scans and returned tuples of
3294 =item B<table_states>
3296 This query collects the numbers of live and dead rows in the user tables.
3300 This query collects disk block access counts for user tables.
3304 This query collects the on-disk size of the database in bytes.
3308 The B<Database> block defines one PostgreSQL database for which to collect
3309 statistics. It accepts a single mandatory argument which specifies the
3310 database name. None of the other options are required. PostgreSQL will use
3311 default values as documented in the section "CONNECTING TO A DATABASE" in the
3312 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
3313 the user collectd is run as and special environment variables. See the manpage
3318 =item B<Host> I<hostname>
3320 Specify the hostname or IP of the PostgreSQL server to connect to. If the
3321 value begins with a slash, it is interpreted as the directory name in which to
3322 look for the UNIX domain socket.
3324 This option is also used to determine the hostname that is associated with a
3325 collected data set. If it has been omitted or either begins with with a slash
3326 or equals B<localhost> it will be replaced with the global hostname definition
3327 of collectd. Any other value will be passed literally to collectd when
3328 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
3330 =item B<Port> I<port>
3332 Specify the TCP port or the local UNIX domain socket file extension of the
3335 =item B<User> I<username>
3337 Specify the username to be used when connecting to the server.
3339 =item B<Password> I<password>
3341 Specify the password to be used when connecting to the server.
3343 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
3345 Specify whether to use an SSL connection when contacting the server. The
3346 following modes are supported:
3352 Do not use SSL at all.
3356 First, try to connect without using SSL. If that fails, try using SSL.
3358 =item I<prefer> (default)
3360 First, try to connect using SSL. If that fails, try without using SSL.
3368 =item B<KRBSrvName> I<kerberos_service_name>
3370 Specify the Kerberos service name to use when authenticating with Kerberos 5
3371 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
3372 B<PostgreSQL Documentation> for details.
3374 =item B<Service> I<service_name>
3376 Specify the PostgreSQL service name to use for additional parameters. That
3377 service has to be defined in F<pg_service.conf> and holds additional
3378 connection parameters. See the section "The Connection Service File" in the
3379 B<PostgreSQL Documentation> for details.
3381 =item B<Query> I<query>
3383 Specify a I<query> which should be executed for the database connection. This
3384 may be any of the predefined or user-defined queries. If no such option is
3385 given, it defaults to "backends", "transactions", "queries", "query_plans",
3386 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
3391 =head2 Plugin C<powerdns>
3393 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
3394 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
3395 values, many of which are probably meaningless to most users, but may be useful
3396 for some. So you may chose which values to collect, but if you don't, some
3397 reasonable defaults will be collected.
3400 <Server "server_name">
3402 Collect "udp-answers" "udp-queries"
3403 Socket "/var/run/pdns.controlsocket"
3405 <Recursor "recursor_name">
3407 Collect "cache-hits" "cache-misses"
3408 Socket "/var/run/pdns_recursor.controlsocket"
3410 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
3415 =item B<Server> and B<Recursor> block
3417 The B<Server> block defines one authoritative server to query, the B<Recursor>
3418 does the same for an recursing server. The possible options in both blocks are
3419 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
3424 =item B<Collect> I<Field>
3426 Using the B<Collect> statement you can select which values to collect. Here,
3427 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
3428 C<dlg-only-drops>, C<answers10-100>.
3430 The method of getting the values differs for B<Server> and B<Recursor> blocks:
3431 When querying the server a C<SHOW *> command is issued in any case, because
3432 that's the only way of getting multiple values out of the server at once.
3433 collectd then picks out the values you have selected. When querying the
3434 recursor, a command is generated to query exactly these values. So if you
3435 specify invalid fields when querying the recursor, a syntax error may be
3436 returned by the daemon and collectd may not collect any values at all.
3438 If no B<Collect> statement is given, the following B<Server> values will be
3445 =item packetcache-hit
3447 =item packetcache-miss
3449 =item packetcache-size
3451 =item query-cache-hit
3453 =item query-cache-miss
3455 =item recursing-answers
3457 =item recursing-questions
3469 The following B<Recursor> values will be collected by default:
3473 =item noerror-answers
3475 =item nxdomain-answers
3477 =item servfail-answers
3495 Please note that up to that point collectd doesn't know what values are
3496 available on the server and values that are added do not need a change of the
3497 mechanism so far. However, the values must be mapped to collectd's naming
3498 scheme, which is done using a lookup table that lists all known values. If
3499 values are added in the future and collectd does not know about them, you will
3500 get an error much like this:
3502 powerdns plugin: submit: Not found in lookup table: foobar = 42
3504 In this case please file a bug report with the collectd team.
3506 =item B<Socket> I<Path>
3508 Configures the path to the UNIX domain socket to be used when connecting to the
3509 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
3510 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
3511 will be used for the recursor.
3515 =item B<LocalSocket> I<Path>
3517 Querying the recursor is done using UDP. When using UDP over UNIX domain
3518 sockets, the client socket needs a name in the file system, too. You can set
3519 this local name to I<Path> using the B<LocalSocket> option. The default is
3520 C<I<prefix>/var/run/collectd-powerdns>.
3524 =head2 Plugin C<processes>
3528 =item B<Process> I<Name>
3530 Select more detailed statistics of processes matching this name. The statistics
3531 collected for these selected processes are size of the resident segment size
3532 (RSS), user- and system-time used, number of processes and number of threads,
3533 io data (where available) and minor and major pagefaults.
3535 =item B<ProcessMatch> I<name> I<regex>
3537 Similar to the B<Process> option this allows to select more detailed
3538 statistics of processes matching the specified I<regex> (see L<regex(7)> for
3539 details). The statistics of all matching processes are summed up and
3540 dispatched to the daemon using the specified I<name> as an identifier. This
3541 allows to "group" several processes together. I<name> must not contain
3546 =head2 Plugin C<protocols>
3548 Collects a lot of information about various network protocols, such as I<IP>,
3549 I<TCP>, I<UDP>, etc.
3551 Available configuration options:
3555 =item B<Value> I<Selector>
3557 Selects whether or not to select a specific value. The string being matched is
3558 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
3559 plugin instance and I<ValueName> will be used as type instance. An example of
3560 the string being used would be C<Tcp:RetransSegs>.
3562 You can use regular expressions to match a large number of values with just one
3563 configuration option. To select all "extended" I<TCP> values, you could use the
3564 following statement:
3568 Whether only matched values are selected or all matched values are ignored
3569 depends on the B<IgnoreSelected>. By default, only matched values are selected.
3570 If no value is configured at all, all values will be selected.
3572 =item B<IgnoreSelected> B<true>|B<false>
3574 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
3575 matching values will be ignored.
3579 =head2 Plugin C<python>
3581 This plugin embeds a Python-interpreter into collectd and provides an interface
3582 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
3584 =head2 Plugin C<routeros>
3586 The C<routeros> plugin connects to a device running I<RouterOS>, the
3587 Linux-based operating system for routers by I<MikroTik>. The plugin uses
3588 I<librouteros> to connect and reads information about the interfaces and
3589 wireless connections of the device. The configuration supports querying
3594 Host "router0.example.com"
3597 CollectInterface true
3602 Host "router1.example.com"
3605 CollectInterface true
3606 CollectRegistrationTable true
3612 As you can see above, the configuration of the I<routeros> plugin consists of
3613 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
3614 options are understood:
3618 =item B<Host> I<Host>
3620 Hostname or IP-address of the router to connect to.
3622 =item B<Port> I<Port>
3624 Port name or port number used when connecting. If left unspecified, the default
3625 will be chosen by I<librouteros>, currently "8728". This option expects a
3626 string argument, even when a numeric port number is given.
3628 =item B<User> I<User>
3630 Use the user name I<User> to authenticate. Defaults to "admin".
3632 =item B<Password> I<Password>
3634 Set the password used to authenticate.
3636 =item B<CollectInterface> B<true>|B<false>
3638 When set to B<true>, interface statistics will be collected for all interfaces
3639 present on the device. Defaults to B<false>.
3641 =item B<CollectRegistrationTable> B<true>|B<false>
3643 When set to B<true>, information about wireless LAN connections will be
3644 collected. Defaults to B<false>.
3646 =item B<CollectCPULoad> B<true>|B<false>
3648 When set to B<true>, information about the CPU usage will be collected. The
3649 number is a dimensionless value where zero indicates no CPU usage at all.
3650 Defaults to B<false>.
3652 =item B<CollectMemory> B<true>|B<false>
3654 When enabled, the amount of used and free memory will be collected. How used
3655 memory is calculated is unknown, for example whether or not caches are counted
3657 Defaults to B<false>.
3659 =item B<CollectDF> B<true>|B<false>
3661 When enabled, the amount of used and free disk space will be collected.
3662 Defaults to B<false>.
3664 =item B<CollectDisk> B<true>|B<false>
3666 When enabled, the number of sectors written and bad blocks will be collected.
3667 Defaults to B<false>.
3671 =head2 Plugin C<rrdcached>
3673 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
3674 to store values to RRD files in an efficient manner. The combination of the
3675 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
3676 way the C<rrdtool> plugin works (see below). The added abstraction layer
3677 provides a number of benefits, though: Because the cache is not within
3678 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
3679 restarted. This results in much shorter (if any) gaps in graphs, especially
3680 under heavy load. Also, the C<rrdtool> command line utility is aware of the
3681 daemon so that it can flush values to disk automatically when needed. This
3682 allows to integrate automated flushing of values into graphing solutions much
3685 There are disadvantages, though: The daemon may reside on a different host, so
3686 it may not be possible for C<collectd> to create the appropriate RRD files
3687 anymore. And even if C<rrdcached> runs on the same host, it may run in a
3688 different base directory, so relative paths may do weird stuff if you're not
3691 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
3692 on the same host, communicating via a UNIX domain socket. The B<DataDir>
3693 setting should be set to an absolute path, so that a changed base directory
3694 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
3698 =item B<DaemonAddress> I<Address>
3700 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
3701 library. See L<rrdcached(1)> for details. Example:
3703 <Plugin "rrdcached">
3704 DaemonAddress "unix:/var/run/rrdcached.sock"
3707 =item B<DataDir> I<Directory>
3709 Set the base directory in which the RRD files reside. If this is a relative
3710 path, it is relative to the working base directory of the C<rrdcached> daemon!
3711 Use of an absolute path is recommended.
3713 =item B<CreateFiles> B<true>|B<false>
3715 Enables or disables the creation of RRD files. If the daemon is not running
3716 locally, or B<DataDir> is set to a relative path, this will not work as
3717 expected. Default is B<true>.
3721 =head2 Plugin C<rrdtool>
3723 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
3724 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
3725 using these settings. If you don't want to dive into the depths of RRDtool, you
3726 can safely ignore these settings.
3730 =item B<DataDir> I<Directory>
3732 Set the directory to store RRD-files under. Per default RRD-files are generated
3733 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
3735 =item B<StepSize> I<Seconds>
3737 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
3738 this setting is unset and the stepsize is set to the interval in which the data
3739 is collected. Do not use this option unless you absolutely have to for some
3740 reason. Setting this option may cause problems with the C<snmp plugin>, the
3741 C<exec plugin> or when the daemon is set up to receive data from other hosts.
3743 =item B<HeartBeat> I<Seconds>
3745 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
3746 in which case the heartbeat is set to twice the B<StepSize> which should equal
3747 the interval in which data is collected. Do not set this option unless you have
3748 a very good reason to do so.
3750 =item B<RRARows> I<NumRows>
3752 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
3753 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
3754 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
3755 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
3756 week, one month, and one year.
3758 So for each timespan, it calculates how many PDPs need to be consolidated into
3759 one CDP by calculating:
3760 number of PDPs = timespan / (stepsize * rrarows)
3762 Bottom line is, set this no smaller than the width of you graphs in pixels. The
3765 =item B<RRATimespan> I<Seconds>
3767 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
3768 more then one RRA. If this option is never used, the built-in default of (3600,
3769 86400, 604800, 2678400, 31622400) is used.
3771 For more information on how RRA-sizes are calculated see B<RRARows> above.
3773 =item B<XFF> I<Factor>
3775 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
3777 =item B<CacheFlush> I<Seconds>
3779 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
3780 it writes all values for a certain RRD-file if the oldest value is older than
3781 (or equal to) the number of seconds specified. If some RRD-file is not updated
3782 anymore for some reason (the computer was shut down, the network is broken,
3783 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
3784 entire cache is searched for entries older than B<CacheTimeout> seconds and
3785 written to disk every I<Seconds> seconds. Since this is kind of expensive and
3786 does nothing under normal circumstances, this value should not be too small.
3787 900 seconds might be a good value, though setting this to 7200 seconds doesn't
3788 normally do much harm either.
3790 =item B<CacheTimeout> I<Seconds>
3792 If this option is set to a value greater than zero, the C<rrdtool plugin> will
3793 save values in a cache, as described above. Writing multiple values at once
3794 reduces IO-operations and thus lessens the load produced by updating the files.
3795 The trade off is that the graphs kind of "drag behind" and that more memory is
3798 =item B<WritesPerSecond> I<Updates>
3800 When collecting many statistics with collectd and the C<rrdtool> plugin, you
3801 will run serious performance problems. The B<CacheFlush> setting and the
3802 internal update queue assert that collectd continues to work just fine even
3803 under heavy load, but the system may become very unresponsive and slow. This is
3804 a problem especially if you create graphs from the RRD files on the same
3805 machine, for example using the C<graph.cgi> script included in the
3806 C<contrib/collection3/> directory.
3808 This setting is designed for very large setups. Setting this option to a value
3809 between 25 and 80 updates per second, depending on your hardware, will leave
3810 the server responsive enough to draw graphs even while all the cached values
3811 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
3812 by the B<FLUSH> command, are B<not> effected by this limit. They are still
3813 written as fast as possible, so that web frontends have up to date data when
3816 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
3817 updates per second, writing all values to disk will take approximately
3818 56E<nbsp>minutes. Together with the flushing ability that's integrated into
3819 "collection3" you'll end up with a responsive and fast system, up to date
3820 graphs and basically a "backup" of your values every hour.
3822 =item B<RandomTimeout> I<Seconds>
3824 When set, the actual timeout for each value is chosen randomly between
3825 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
3826 intention is to avoid high load situations that appear when many values timeout
3827 at the same time. This is especially a problem shortly after the daemon starts,
3828 because all values were added to the internal cache at roughly the same time.
3832 =head2 Plugin C<sensors>
3834 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
3835 that all the needed modules have to be loaded and lm_sensors has to be
3836 configured (most likely by editing F</etc/sensors.conf>. Read
3837 L<sensors.conf(5)> for details.
3839 The B<lm_sensors> homepage can be found at
3840 L<http://secure.netroedge.com/~lm78/>.
3844 =item B<Sensor> I<chip-bus-address/type-feature>
3846 Selects the name of the sensor which you want to collect or ignore, depending
3847 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
3848 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
3849 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
3851 =item B<IgnoreSelected> I<true>|I<false>
3853 If no configuration if given, the B<sensors>-plugin will collect data from all
3854 sensors. This may not be practical, especially for uninteresting sensors.
3855 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
3856 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
3857 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3858 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
3859 and all other sensors are collected.
3863 =head2 Plugin C<snmp>
3865 Since the configuration of the C<snmp plugin> is a little more complicated than
3866 other plugins, its documentation has been moved to an own manpage,
3867 L<collectd-snmp(5)>. Please see there for details.
3869 =head2 Plugin C<syslog>
3873 =item B<LogLevel> B<debug|info|notice|warning|err>
3875 Sets the log-level. If, for example, set to B<notice>, then all events with
3876 severity B<notice>, B<warning>, or B<err> will be submitted to the
3879 Please note that B<debug> is only available if collectd has been compiled with
3884 =head2 Plugin C<table>
3886 The C<table plugin> provides generic means to parse tabular data and dispatch
3887 user specified values. Values are selected based on column numbers. For
3888 example, this plugin may be used to get values from the Linux L<proc(5)>
3889 filesystem or CSV (comma separated values) files.
3892 <Table "/proc/slabinfo">
3897 InstancePrefix "active_objs"
3903 InstancePrefix "objperslab"
3910 The configuration consists of one or more B<Table> blocks, each of which
3911 configures one file to parse. Within each B<Table> block, there are one or
3912 more B<Result> blocks, which configure which data to select and how to
3915 The following options are available inside a B<Table> block:
3919 =item B<Instance> I<instance>
3921 If specified, I<instance> is used as the plugin instance. So, in the above
3922 example, the plugin name C<table-slabinfo> would be used. If omitted, the
3923 filename of the table is used instead, with all special characters replaced
3924 with an underscore (C<_>).
3926 =item B<Separator> I<string>
3928 Any character of I<string> is interpreted as a delimiter between the different
3929 columns of the table. A sequence of two or more contiguous delimiters in the
3930 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
3931 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
3932 of a table - see its documentation for more details. This option is mandatory.
3934 A horizontal tab, newline and carriage return may be specified by C<\\t>,
3935 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
3936 required because of collectd's config parsing.
3940 The following options are available inside a B<Result> block:
3944 =item B<Type> I<type>
3946 Sets the type used to dispatch the values to the daemon. Detailed information
3947 about types and their configuration can be found in L<types.db(5)>. This
3948 option is mandatory.
3950 =item B<InstancePrefix> I<prefix>
3952 If specified, prepend I<prefix> to the type instance. If omitted, only the
3953 B<InstancesFrom> option is considered for the type instance.
3955 =item B<InstancesFrom> I<column0> [I<column1> ...]
3957 If specified, the content of the given columns (identified by the column
3958 number starting at zero) will be used to create the type instance for each
3959 row. Multiple values (and the instance prefix) will be joined together with
3960 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
3961 option is considered for the type instance.
3963 The plugin itself does not check whether or not all built instances are
3964 different. It’s your responsibility to assure that each is unique. This is
3965 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
3966 sure that the table only contains one row.
3968 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
3971 =item B<ValuesFrom> I<column0> [I<column1> ...]
3973 Specifies the columns (identified by the column numbers starting at zero)
3974 whose content is used as the actual data for the data sets that are dispatched
3975 to the daemon. How many such columns you need is determined by the B<Type>
3976 setting above. If you specify too many or not enough columns, the plugin will
3977 complain about that and no data will be submitted to the daemon. The plugin
3978 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
3979 respectively, so anything supported by those functions is supported by the
3980 plugin as well. This option is mandatory.
3984 =head2 Plugin C<tail>
3986 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
3987 each line and dispatches found values. What is matched can be configured by the
3988 user using (extended) regular expressions, as described in L<regex(7)>.
3991 <File "/var/log/exim4/mainlog">
3994 Regex "S=([1-9][0-9]*)"
4000 Regex "\\<R=local_user\\>"
4003 Instance "local_user"
4008 The config consists of one or more B<File> blocks, each of which configures one
4009 logfile to parse. Within each B<File> block, there are one or more B<Match>
4010 blocks, which configure a regular expression to search for.
4012 The B<Instance> option in the B<File> block may be used to set the plugin
4013 instance. So in the above example the plugin name C<tail-foo> would be used.
4014 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4015 next B<Instance> option. This way you can extract several plugin instances from
4016 one logfile, handy when parsing syslog and the like.
4018 Each B<Match> block has the following options to describe how the match should
4023 =item B<Regex> I<regex>
4025 Sets the regular expression to use for matching against a line. The first
4026 subexpression has to match something that can be turned into a number by
4027 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4028 below. Because B<extended> regular expressions are used, you do not need to use
4029 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4030 collectd's config parsing you need to escape backslashes, though. So if you
4031 want to match literal parentheses you need to do the following:
4033 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4035 =item B<DSType> I<Type>
4037 Sets how the values are cumulated. I<Type> is one of:
4041 =item B<GaugeAverage>
4043 Calculate the average.
4047 Use the smallest number only.
4051 Use the greatest number only.
4055 Use the last number found.
4059 The matched number is a counter. Simply sets the internal counter to this
4064 Add the matched value to the internal counter.
4068 Increase the internal counter by one. This B<DSType> is the only one that does
4069 not use the matched subexpression, but simply counts the number of matched
4070 lines. Thus, you may use a regular expression without submatch in this case.
4074 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
4075 number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
4076 submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
4077 submatch at all and it may be omitted in this case.
4079 =item B<Type> I<Type>
4081 Sets the type used to dispatch this value. Detailed information about types and
4082 their configuration can be found in L<types.db(5)>.
4084 =item B<Instance> I<TypeInstance>
4086 This optional setting sets the type instance to use.
4090 =head2 Plugin C<teamspeak2>
4092 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
4093 polls interesting global and virtual server data. The plugin can query only one
4094 physical server but unlimited virtual servers. You can use the following
4095 options to configure it:
4099 =item B<Host> I<hostname/ip>
4101 The hostname or ip which identifies the physical server.
4104 =item B<Port> I<port>
4106 The query port of the physical server. This needs to be a string.
4109 =item B<Server> I<port>
4111 This option has to be added once for every virtual server the plugin should
4112 query. If you want to query the virtual server on port 8767 this is what the
4113 option would look like:
4117 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
4118 use quotes around it! If no such statement is given only global information
4123 =head2 Plugin C<ted>
4125 The I<TED> plugin connects to a device of "The Energy Detective", a device to
4126 measure power consumption. These devices are usually connected to a serial
4127 (RS232) or USB port. The plugin opens a configured device and tries to read the
4128 current energy readings. For more information on TED, visit
4129 L<http://www.theenergydetective.com/>.
4131 Available configuration options:
4135 =item B<Device> I<Path>
4137 Path to the device on which TED is connected. collectd will need read and write
4138 permissions on that file.
4140 Default: B</dev/ttyUSB0>
4142 =item B<Retries> I<Num>
4144 Apparently reading from TED is not that reliable. You can therefore configure a
4145 number of retries here. You only configure the I<retries> here, to if you
4146 specify zero, one reading will be performed (but no retries if that fails); if
4147 you specify three, a maximum of four readings are performed. Negative values
4154 =head2 Plugin C<tcpconns>
4156 The C<tcpconns plugin> counts the number of currently established TCP
4157 connections based on the local port and/or the remote port. Since there may be
4158 a lot of connections the default if to count all connections with a local port,
4159 for which a listening socket is opened. You can use the following options to
4160 fine-tune the ports you are interested in:
4164 =item B<ListeningPorts> I<true>|I<false>
4166 If this option is set to I<true>, statistics for all local ports for which a
4167 listening socket exists are collected. The default depends on B<LocalPort> and
4168 B<RemotePort> (see below): If no port at all is specifically selected, the
4169 default is to collect listening ports. If specific ports (no matter if local or
4170 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
4171 the selected ports will be collected unless this option is set to I<true>
4174 =item B<LocalPort> I<Port>
4176 Count the connections to a specific local port. This can be used to see how
4177 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
4178 You have to specify the port in numeric form, so for the mailserver example
4179 you'd need to set B<25>.
4181 =item B<RemotePort> I<Port>
4183 Count the connections to a specific remote port. This is useful to see how
4184 much a remote service is used. This is most useful if you want to know how many
4185 connections a local service has opened to remote services, e.E<nbsp>g. how many
4186 connections a mail server or news server has to other mail or news servers, or
4187 how many connections a web proxy holds to web servers. You have to give the
4188 port in numeric form.
4192 =head2 Plugin C<thermal>
4196 =item B<ForceUseProcfs> I<true>|I<false>
4198 By default, the C<thermal> plugin tries to read the statistics from the Linux
4199 C<sysfs> interface. If that is not available, the plugin falls back to the
4200 C<procfs> interface. By setting this option to I<true>, you can force the
4201 plugin to use the latter. This option defaults to I<false>.
4203 =item B<Device> I<Device>
4205 Selects the name of the thermal device that you want to collect or ignore,
4206 depending on the value of the B<IgnoreSelected> option. This option may be
4207 used multiple times to specify a list of devices.
4209 =item B<IgnoreSelected> I<true>|I<false>
4211 Invert the selection: If set to true, all devices B<except> the ones that
4212 match the device names specified by the B<Device> option are collected. By
4213 default only selected devices are collected if a selection is made. If no
4214 selection is configured at all, B<all> devices are selected.
4218 =head2 Plugin C<tokyotyrant>
4220 The C<tokyotyrant plugin> connects to a TokyoTyrant server and collects a
4221 couple metrics: number of records, and database size on disk.
4225 =item B<Host> I<Hostname/IP>
4227 The hostname or ip which identifies the server.
4228 Default: B<127.0.0.1>
4230 =item B<Port> I<Service/Port>
4232 The query port of the server. This needs to be a string, even if the port is
4233 given in its numeric form.
4238 =head2 Plugin C<unixsock>
4242 =item B<SocketFile> I<Path>
4244 Sets the socket-file which is to be created.
4246 =item B<SocketGroup> I<Group>
4248 If running as root change the group of the UNIX-socket after it has been
4249 created. Defaults to B<collectd>.
4251 =item B<SocketPerms> I<Permissions>
4253 Change the file permissions of the UNIX-socket after it has been created. The
4254 permissions must be given as a numeric, octal value as you would pass to
4255 L<chmod(1)>. Defaults to B<0770>.
4259 =head2 Plugin C<uuid>
4261 This plugin, if loaded, causes the Hostname to be taken from the machine's
4262 UUID. The UUID is a universally unique designation for the machine, usually
4263 taken from the machine's BIOS. This is most useful if the machine is running in
4264 a virtual environment such as Xen, in which case the UUID is preserved across
4265 shutdowns and migration.
4267 The following methods are used to find the machine's UUID, in order:
4273 Check I</etc/uuid> (or I<UUIDFile>).
4277 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
4282 Check for UUID from C<dmidecode> / SMBIOS.
4286 Check for UUID from Xen hypervisor.
4290 If no UUID can be found then the hostname is not modified.
4294 =item B<UUIDFile> I<Path>
4296 Take the UUID from the given file (default I</etc/uuid>).
4300 =head2 Plugin C<vmem>
4302 The C<vmem> plugin collects information about the usage of virtual memory.
4303 Since the statistics provided by the Linux kernel are very detailed, they are
4304 collected very detailed. However, to get all the details, you have to switch
4305 them on manually. Most people just want an overview over, such as the number of
4306 pages read from swap space.
4310 =item B<Verbose> B<true>|B<false>
4312 Enables verbose collection of information. This will start collecting page
4313 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
4314 Part of these statistics are collected on a "per zone" basis.
4318 =head2 Plugin C<vserver>
4320 This plugin doesn't have any options. B<VServer> support is only available for
4321 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
4322 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
4323 need to apply the patches and compile your own kernel, which will then provide
4324 the F</proc/virtual> filesystem that is required by this plugin.
4326 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
4328 B<Note>: The traffic collected by this plugin accounts for the amount of
4329 traffic passing a socket which might be a lot less than the actual on-wire
4330 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
4331 collect on-wire traffic you could, for example, use the logging facilities of
4332 iptables to feed data for the guest IPs into the iptables plugin.
4334 =head2 Plugin C<write_http>
4336 This output plugin submits values to an http server by POST them using the
4337 PUTVAL plain-text protocol. Each destination you want to post data to needs to
4338 have one B<URL> block, within which the destination can be configured further,
4339 for example by specifying authentication data.
4343 <Plugin "write_http">
4344 <URL "http://example.com/post-collectd">
4350 B<URL> blocks need one string argument which is used as the URL to which data
4351 is posted. The following options are understood within B<URL> blocks.
4355 =item B<User> I<Username>
4357 Optional user name needed for authentication.
4359 =item B<Password> I<Password>
4361 Optional password needed for authentication.
4363 =item B<VerifyPeer> B<true>|B<false>
4365 Enable or disable peer SSL certificate verification. See
4366 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4368 =item B<VerifyHost> B<true|false>
4370 Enable or disable peer host name verification. If enabled, the plugin checks if
4371 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
4372 matches the host name provided by the B<URL> option. If this identity check
4373 fails, the connection is aborted. Obviously, only works when connecting to a
4374 SSL enabled server. Enabled by default.
4376 =item B<CACert> I<File>
4378 File that holds one or more SSL certificates. If you want to use HTTPS you will
4379 possibly need this option. What CA certificates come bundled with C<libcurl>
4380 and are checked by default depends on the distribution you use.
4382 =item B<Format> B<Command>|B<JSON>
4384 Format of the output to generate. If set to B<Command>, will create output that
4385 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
4386 create output in the I<JavaScript Object Notation> (JSON).
4388 Defaults to B<Command>.
4390 =item B<StoreRates> B<true|false>
4392 If set to B<true>, convert counter values to rates. If set to B<false> (the
4393 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
4398 =head1 THRESHOLD CONFIGURATION
4400 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
4401 we mean that the values are not only stored or sent somewhere, but that they
4402 are judged and, if a problem is recognized, acted upon. The only action
4403 collectd takes itself is to generate and dispatch a "notification". Plugins can
4404 register to receive notifications and perform appropriate further actions.
4406 Since systems and what you expect them to do differ a lot, you can configure
4407 B<thresholds> for your values freely. This gives you a lot of flexibility but
4408 also a lot of responsibility.
4410 Every time a value is out of range a notification is dispatched. This means
4411 that the idle percentage of your CPU needs to be less then the configured
4412 threshold only once for a notification to be generated. There's no such thing
4413 as a moving average or similar - at least not now.
4415 Also, all values that match a threshold are considered to be relevant or
4416 "interesting". As a consequence collectd will issue a notification if they are
4417 not received for twice the last timeout of the values. If, for example, some
4418 hosts sends it's CPU statistics to the server every 60 seconds, a notification
4419 will be dispatched after about 120 seconds. It may take a little longer because
4420 the timeout is checked only once each B<Interval> on the server.
4422 When a value comes within range again or is received after it was missing, an
4423 "OKAY-notification" is dispatched.
4425 Here is a configuration example to get you started. Read below for more
4438 <Plugin "interface">
4455 WarningMin 100000000
4461 There are basically two types of configuration statements: The C<Host>,
4462 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
4463 configured. The C<Plugin> and C<Type> blocks may be specified further using the
4464 C<Instance> option. You can combine the block by nesting the blocks, though
4465 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
4466 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
4467 C<Type> may not contain other blocks. If multiple blocks apply to the same
4468 value the most specific block is used.
4470 The other statements specify the threshold to configure. They B<must> be
4471 included in a C<Type> block. Currently the following statements are recognized:
4475 =item B<FailureMax> I<Value>
4477 =item B<WarningMax> I<Value>
4479 Sets the upper bound of acceptable values. If unset defaults to positive
4480 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
4481 will be created. If the value is greater than B<WarningMax> but less than (or
4482 equal to) B<FailureMax> a B<WARNING> notification will be created.
4484 =item B<FailureMin> I<Value>
4486 =item B<WarningMin> I<Value>
4488 Sets the lower bound of acceptable values. If unset defaults to negative
4489 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
4490 be created. If the value is less than B<WarningMin> but greater than (or equal
4491 to) B<FailureMin> a B<WARNING> notification will be created.
4493 =item B<DataSource> I<DSName>
4495 Some data sets have more than one "data source". Interesting examples are the
4496 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
4497 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
4498 system load data set, C<load>, even has three data sources: C<shortterm>,
4499 C<midterm>, and C<longterm>.
4501 Normally, all data sources are checked against a configured threshold. If this
4502 is undesirable, or if you want to specify different limits for each data
4503 source, you can use the B<DataSource> option to have a threshold apply only to
4506 =item B<Invert> B<true>|B<false>
4508 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
4509 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
4510 B<WarningMax>) are not okay. Defaults to B<false>.
4512 =item B<Persist> B<true>|B<false>
4514 Sets how often notifications are generated. If set to B<true> one notification
4515 will be generated for each value that is out of the acceptable range. If set to
4516 B<false> (the default) then a notification is only generated if a value is out
4517 of range but the previous value was okay.
4519 This applies to missing values, too: If set to B<true> a notification about a
4520 missing value is generated once every B<Interval> seconds. If set to B<false>
4521 only one such notification is generated until the value appears again.
4523 =item B<Percentage> B<true>|B<false>
4525 If set to B<true>, the minimum and maximum values given are interpreted as
4526 percentage value, relative to the other data sources. This is helpful for
4527 example for the "df" type, where you may want to issue a warning when less than
4528 5E<nbsp>% of the total space is available. Defaults to B<false>.
4532 =head1 FILTER CONFIGURATION
4534 Starting with collectd 4.6 there is a powerful filtering infrastructure
4535 implemented in the daemon. The concept has mostly been copied from
4536 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
4537 terminology, so that users that are familiar with iptables feel right at home.
4541 The following are the terms used in the remainder of the filter configuration
4542 documentation. For an ASCII-art schema of the mechanism, see
4543 L<"General structure"> below.
4549 A I<match> is a criteria to select specific values. Examples are, of course, the
4550 name of the value or it's current value.
4552 Matches are implemented in plugins which you have to load prior to using the
4553 match. The name of such plugins starts with the "match_" prefix.
4557 A I<target> is some action that is to be performed with data. Such actions
4558 could, for example, be to change part of the value's identifier or to ignore
4559 the value completely.
4561 Some of these targets are built into the daemon, see L<"Built-in targets">
4562 below. Other targets are implemented in plugins which you have to load prior to
4563 using the target. The name of such plugins starts with the "target_" prefix.
4567 The combination of any number of matches and at least one target is called a
4568 I<rule>. The target actions will be performed for all values for which B<all>
4569 matches apply. If the rule does not have any matches associated with it, the
4570 target action will be performed for all values.
4574 A I<chain> is a list of rules and possibly default targets. The rules are tried
4575 in order and if one matches, the associated target will be called. If a value
4576 is handled by a rule, it depends on the target whether or not any subsequent
4577 rules are considered or if traversal of the chain is aborted, see
4578 L<"Flow control"> below. After all rules have been checked, the default targets
4583 =head2 General structure
4585 The following shows the resulting structure:
4592 +---------+ +---------+ +---------+ +---------+
4593 ! Rule !->! Match !->! Match !->! Target !
4594 +---------+ +---------+ +---------+ +---------+
4597 +---------+ +---------+ +---------+
4598 ! Rule !->! Target !->! Target !
4599 +---------+ +---------+ +---------+
4606 +---------+ +---------+ +---------+
4607 ! Rule !->! Match !->! Target !
4608 +---------+ +---------+ +---------+
4618 There are four ways to control which way a value takes through the filter
4625 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
4626 process the value with another chain. When the called chain finishes, usually
4627 the next target or rule after the jump is executed.
4631 The stop condition, signaled for example by the built-in target B<stop>, causes
4632 all processing of the value to be stopped immediately.
4636 Causes processing in the current chain to be aborted, but processing of the
4637 value generally will continue. This means that if the chain was called via
4638 B<Jump>, the next target or rule after the jump will be executed. If the chain
4639 was not called by another chain, control will be returned to the daemon and it
4640 may pass the value to another chain.
4644 Most targets will signal the B<continue> condition, meaning that processing
4645 should continue normally. There is no special built-in target for this
4652 The configuration reflects this structure directly:
4654 PostCacheChain "PostCache"
4656 <Rule "ignore_mysql_show">
4659 Type "^mysql_command$"
4660 TypeInstance "^show_"
4670 The above configuration example will ignore all values where the plugin field
4671 is "mysql", the type is "mysql_command" and the type instance begins with
4672 "show_". All other values will be sent to the C<rrdtool> write plugin via the
4673 default target of the chain. Since this chain is run after the value has been
4674 added to the cache, the MySQL C<show_*> command statistics will be available
4675 via the C<unixsock> plugin.
4677 =head2 List of configuration options
4681 =item B<PreCacheChain> I<ChainName>
4683 =item B<PostCacheChain> I<ChainName>
4685 Configure the name of the "pre-cache chain" and the "post-cache chain". The
4686 argument is the name of a I<chain> that should be executed before and/or after
4687 the values have been added to the cache.
4689 To understand the implications, it's important you know what is going on inside
4690 I<collectd>. The following diagram shows how values are passed from the
4691 read-plugins to the write-plugins:
4697 + - - - - V - - - - +
4698 : +---------------+ :
4701 : +-------+-------+ :
4704 : +-------+-------+ : +---------------+
4705 : ! Cache !--->! Value Cache !
4706 : ! insert ! : +---+---+-------+
4707 : +-------+-------+ : ! !
4708 : ! ,------------' !
4710 : +-------+---+---+ : +-------+-------+
4711 : ! Post-Cache +--->! Write-Plugins !
4712 : ! Chain ! : +---------------+
4713 : +---------------+ :
4716 + - - - - - - - - - +
4718 After the values are passed from the "read" plugins to the dispatch functions,
4719 the pre-cache chain is run first. The values are added to the internal cache
4720 afterwards. The post-cache chain is run after the values have been added to the
4721 cache. So why is it such a huge deal if chains are run before or after the
4722 values have been added to this cache?
4724 Targets that change the identifier of a value list should be executed before
4725 the values are added to the cache, so that the name in the cache matches the
4726 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
4727 this cache to receive a list of all available values. If you change the
4728 identifier after the value list has been added to the cache, this may easily
4729 lead to confusion, but it's not forbidden of course.
4731 The cache is also used to convert counter values to rates. These rates are, for
4732 example, used by the C<value> match (see below). If you use the rate stored in
4733 the cache B<before> the new value is added, you will use the old, B<previous>
4734 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
4735 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
4738 Last but not last, the B<stop> target makes a difference: If the pre-cache
4739 chain returns the stop condition, the value will not be added to the cache and
4740 the post-cache chain will not be run.
4742 =item B<Chain> I<Name>
4744 Adds a new chain with a certain name. This name can be used to refer to a
4745 specific chain, for example to jump to it.
4747 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
4749 =item B<Rule> [I<Name>]
4751 Adds a new rule to the current chain. The name of the rule is optional and
4752 currently has no meaning for the daemon.
4754 Within the B<Rule> block, there may be any number of B<Match> blocks and there
4755 must be at least one B<Target> block.
4757 =item B<Match> I<Name>
4759 Adds a match to a B<Rule> block. The name specifies what kind of match should
4760 be performed. Available matches depend on the plugins that have been loaded.
4762 The arguments inside the B<Match> block are passed to the plugin implementing
4763 the match, so which arguments are valid here depends on the plugin being used.
4764 If you do not need any to pass any arguments to a match, you can use the
4769 Which is equivalent to:
4774 =item B<Target> I<Name>
4776 Add a target to a rule or a default target to a chain. The name specifies what
4777 kind of target is to be added. Which targets are available depends on the
4778 plugins being loaded.
4780 The arguments inside the B<Target> block are passed to the plugin implementing
4781 the target, so which arguments are valid here depends on the plugin being used.
4782 If you do not need any to pass any arguments to a target, you can use the
4787 This is the same as writing:
4794 =head2 Built-in targets
4796 The following targets are built into the core daemon and therefore need no
4797 plugins to be loaded:
4803 Signals the "return" condition, see the L<"Flow control"> section above. This
4804 causes the current chain to stop processing the value and returns control to
4805 the calling chain. The calling chain will continue processing targets and rules
4806 just after the B<jump> target (see below). This is very similar to the
4807 B<RETURN> target of iptables, see L<iptables(8)>.
4809 This target does not have any options.
4817 Signals the "stop" condition, see the L<"Flow control"> section above. This
4818 causes processing of the value to be aborted immediately. This is similar to
4819 the B<DROP> target of iptables, see L<iptables(8)>.
4821 This target does not have any options.
4829 Sends the value to "write" plugins.
4835 =item B<Plugin> I<Name>
4837 Name of the write plugin to which the data should be sent. This option may be
4838 given multiple times to send the data to more than one write plugin.
4842 If no plugin is explicitly specified, the values will be sent to all available
4853 Starts processing the rules of another chain, see L<"Flow control"> above. If
4854 the end of that chain is reached, or a stop condition is encountered,
4855 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
4856 next target or the next rule. This is similar to the B<-j> command line option
4857 of iptables, see L<iptables(8)>.
4863 =item B<Chain> I<Name>
4865 Jumps to the chain I<Name>. This argument is required and may appear only once.
4877 =head2 Available matches
4883 Matches a value using regular expressions.
4889 =item B<Host> I<Regex>
4891 =item B<Plugin> I<Regex>
4893 =item B<PluginInstance> I<Regex>
4895 =item B<Type> I<Regex>
4897 =item B<TypeInstance> I<Regex>
4899 Match values where the given regular expressions match the various fields of
4900 the identifier of a value. If multiple regular expressions are given, B<all>
4901 regexen must match for a value to match.
4908 Host "customer[0-9]+"
4914 Matches values that have a time which differs from the time on the server.
4916 This match is mainly intended for servers that receive values over the
4917 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
4918 is very sensitive to the timestamp used when updating the RRD files. In
4919 particular, the time must be ever increasing. If a misbehaving client sends one
4920 packet with a timestamp far in the future, all further packets with a correct
4921 time will be ignored because of that one packet. What's worse, such corrupted
4922 RRD files are hard to fix.
4924 This match lets one match all values B<outside> a specified time range
4925 (relative to the server's time), so you can use the B<stop> target (see below)
4926 to ignore the value, for example.
4932 =item B<Future> I<Seconds>
4934 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
4935 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
4938 =item B<Past> I<Seconds>
4940 Matches all values that are I<behind> of the server's time by I<Seconds> or
4941 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
4953 This example matches all values that are five minutes or more ahead of the
4954 server or one hour (or more) lagging behind.
4958 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
4959 values. If a data-set consists of more than one data-source, all data-sources
4960 must match the specified ranges for a positive match.
4966 =item B<Min> I<Value>
4968 Sets the smallest value which still results in a match. If unset, behaves like
4971 =item B<Max> I<Value>
4973 Sets the largest value which still results in a match. If unset, behaves like
4976 =item B<Invert> B<true>|B<false>
4978 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
4979 no-match is returned and vice versa. Please note that the B<Invert> setting
4980 only effects how B<Min> and B<Max> are applied to a specific value. Especially
4981 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
4983 =item B<DataSource> I<DSName> [I<DSName> ...]
4985 Select one or more of the data sources. If no data source is configured, all
4986 data sources will be checked. If the type handled by the match does not have a
4987 data source of the specified name(s), this will always result in no match
4988 (independent of the B<Invert> setting).
4990 =item B<Satisfy> B<Any>|B<All>
4992 Specifies how checking with several data sources is performed. If set to
4993 B<Any>, the match succeeds if one of the data sources is in the configured
4994 range. If set to B<All> the match only succeeds if all data sources are within
4995 the configured range. Default is B<All>.
4997 Usually B<All> is used for positive matches, B<Any> is used for negative
4998 matches. This means that with B<All> you usually check that all values are in a
4999 "good" range, while with B<Any> you check if any value is within a "bad" range
5000 (or outside the "good" range).
5004 Either B<Min> or B<Max>, but not both, may be unset.
5008 # Match all values smaller than or equal to 100. Matches only if all data
5009 # sources are below 100.
5015 # Match if the value of any data source is outside the range of 0 - 100.
5023 =item B<empty_counter>
5025 Matches all values with one or more data sources of type B<COUNTER> and where
5026 all counter values are zero. These counters usually I<never> increased since
5027 they started existing (and are therefore uninteresting), or got reset recently
5028 or overflowed and you had really, I<really> bad luck.
5030 Please keep in mind that ignoring such counters can result in confusing
5031 behavior: Counters which hardly ever increase will be zero for long periods of
5032 time. If the counter is reset for some reason (machine or service restarted,
5033 usually), the graph will be empty (NAN) for a long time. People may not
5038 Calculates a hash value of the host name and matches values according to that
5039 hash value. This makes it possible to divide all hosts into groups and match
5040 only values that are in a specific group. The intended use is in load
5041 balancing, where you want to handle only part of all data and leave the rest
5044 The hashing function used tries to distribute the hosts evenly. First, it
5045 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
5048 for (i = 0; host[i] != 0; i++)
5049 hash_value = (hash_value * 251) + host[i];
5051 The constant 251 is a prime number which is supposed to make this hash value
5052 more random. The code then checks the group for this host according to the
5053 I<Total> and I<Match> arguments:
5055 if ((hash_value % Total) == Match)
5060 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
5061 groups), then the least significant bit of the hash value will be the XOR of
5062 all least significant bits in the host name. One consequence is that when you
5063 have two hosts, "server0.example.com" and "server1.example.com", where the host
5064 name differs in one digit only and the digits differ by one, those hosts will
5065 never end up in the same group.
5071 =item B<Match> I<Match> I<Total>
5073 Divide the data into I<Total> groups and match all hosts in group I<Match> as
5074 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
5075 be smaller than I<Total>. I<Total> must be at least one, although only values
5076 greater than one really do make any sense.
5078 You can repeat this option to match multiple groups, for example:
5083 The above config will divide the data into seven groups and match groups three
5084 and five. One use would be to keep every value on two hosts so that if one
5085 fails the missing data can later be reconstructed from the second host.
5091 # Operate on the pre-cache chain, so that ignored values are not even in the
5096 # Divide all received hosts in seven groups and accept all hosts in
5100 # If matched: Return and continue.
5103 # If not matched: Return and stop.
5109 =head2 Available targets
5113 =item B<notification>
5115 Creates and dispatches a notification.
5121 =item B<Message> I<String>
5123 This required option sets the message of the notification. The following
5124 placeholders will be replaced by an appropriate value:
5132 =item B<%{plugin_instance}>
5136 =item B<%{type_instance}>
5138 These placeholders are replaced by the identifier field of the same name.
5140 =item B<%{ds:>I<name>B<}>
5142 These placeholders are replaced by a (hopefully) human readable representation
5143 of the current rate of this data source. If you changed the instance name
5144 (using the B<set> or B<replace> targets, see below), it may not be possible to
5145 convert counter values to rates.
5149 Please note that these placeholders are B<case sensitive>!
5151 =item B<Severity> B<"FATAL">|B<"WARNING">|B<"OKAY">
5153 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
5160 <Target "notification">
5161 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
5167 Replaces parts of the identifier using regular expressions.
5173 =item B<Host> I<Regex> I<Replacement>
5175 =item B<Plugin> I<Regex> I<Replacement>
5177 =item B<PluginInstance> I<Regex> I<Replacement>
5179 =item B<TypeInstance> I<Regex> I<Replacement>
5181 Match the appropriate field with the given regular expression I<Regex>. If the
5182 regular expression matches, that part that matches is replaced with
5183 I<Replacement>. If multiple places of the input buffer match a given regular
5184 expression, only the first occurrence will be replaced.
5186 You can specify each option multiple times to use multiple regular expressions
5194 # Replace "example.net" with "example.com"
5195 Host "\\<example.net\\>" "example.com"
5197 # Strip "www." from hostnames
5203 Sets part of the identifier of a value to a given string.
5209 =item B<Host> I<String>
5211 =item B<Plugin> I<String>
5213 =item B<PluginInstance> I<String>
5215 =item B<TypeInstance> I<String>
5217 Set the appropriate field to the given string. The strings for plugin instance
5218 and type instance may be empty, the strings for host and plugin may not be
5219 empty. It's currently not possible to set the type of a value this way.
5226 PluginInstance "coretemp"
5227 TypeInstance "core3"
5232 =head2 Backwards compatibility
5234 If you use collectd with an old configuration, i.E<nbsp>e. one without a
5235 B<Chain> block, it will behave as it used to. This is equivalent to the
5236 following configuration:
5242 If you specify a B<PostCacheChain>, the B<write> target will not be added
5243 anywhere and you will have to make sure that it is called where appropriate. We
5244 suggest to add the above snippet as default target to your "PostCache" chain.
5248 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
5264 L<collectd-exec(5)>,
5265 L<collectd-perl(5)>,
5266 L<collectd-unixsock(5)>,
5279 Florian Forster E<lt>octo@verplant.orgE<gt>