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 determinded 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. Disabled by default.
508 =item B<E<lt>MatchE<gt>>
510 One or more B<Match> blocks that define how to match information in the data
511 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
512 used by the C<tail> plugin, so please see the documentation of the C<tail>
513 plugin below on how matches are defined.
517 =head2 Plugin C<curl_json>
519 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
520 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
521 via cURL. This can be used to collect values from CouchDB documents (which are
522 stored JSON notation), for example.
524 The following example will collect several values from the built-in `_stats'
525 runtime statistics module of CouchDB
526 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
529 <URL "http://localhost:5984/_stats">
531 <Key "httpd/requests/count">
535 <Key "httpd_request_methods/*/count">
536 Type "http_request_methods"
539 <Key "httpd_status_codes/*/count">
540 Type "http_response_codes"
545 Another CouchDB example:
546 The following example will collect the status values from each database:
548 <URL "http://localhost:5984/_all_dbs">
553 <Key "*/doc_del_count">
561 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
562 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
563 The B<Key> string argument must be in a path format, of which is used to collect
564 a value from a JSON map object. If a B<Key> path element is that of a I<*> wildcard,
565 the values for all keys will be collectd.
567 The following options are valid within B<URL> blocks:
571 =item B<Instance> I<Instance>
573 Sets the plugin instance to I<Instance>.
575 =item B<User> I<Name>
577 Username to use if authorization is required to read the page.
579 =item B<Password> I<Password>
581 Password to use if authorization is required to read the page.
583 =item B<VerifyPeer> B<true>|B<false>
585 Enable or disable peer SSL certificate verification. See
586 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
588 =item B<VerifyHost> B<true>|B<false>
590 Enable or disable peer host name verification. If enabled, the plugin checks if
591 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
592 matches the host name provided by the B<URL> option. If this identity check
593 fails, the connection is aborted. Obviously, only works when connecting to a
594 SSL enabled server. Enabled by default.
596 =item B<CACert> I<file>
598 File that holds one or more SSL certificates. If you want to use HTTPS you will
599 possibly need this option. What CA certificates come bundled with C<libcurl>
600 and are checked by default depends on the distribution you use.
604 The following options are valid within B<Key> blocks:
608 =item B<Type> I<Type>
610 Sets the type used to dispatch the values to the daemon. Detailed information
611 about types and their configuration can be found in L<types.db(5)>. This
614 =item B<Instance> I<Instance>
616 Type-instance to use. Defaults to the current map key or current string array element value.
622 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
623 connect to various databases, execute I<SQL> statements and read back the
624 results. I<dbi> is an acronym for "database interface" in case you were
625 wondering about the name. You can configure how each column is to be
626 interpreted and the plugin will generate one or more data sets from each row
627 returned according to these rules.
629 Because the plugin is very generic, the configuration is a little more complex
630 than those of other plugins. It usually looks something like this:
633 <Query "out_of_stock">
634 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
635 # Use with MySQL 5.0.0 or later
639 InstancePrefix "out_of_stock"
640 InstancesFrom "category"
644 <Database "product_information">
646 DriverOption "host" "localhost"
647 DriverOption "username" "collectd"
648 DriverOption "password" "aZo6daiw"
649 DriverOption "dbname" "prod_info"
655 The configuration above defines one query with one result and one database. The
656 query is then linked to the database with the B<Query> option I<within> the
657 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
658 and you can also use the B<Include> statement to split up the configuration
659 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
660 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
663 The following is a complete list of options:
665 =head3 B<Query> blocks
667 Query blocks define I<SQL> statements and how the returned data should be
668 interpreted. They are identified by the name that is given in the opening line
669 of the block. Thus the name needs to be unique. Other than that, the name is
670 not used in collectd.
672 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
673 define which column holds which value or instance information. You can use
674 multiple B<Result> blocks to create multiple values from one returned row. This
675 is especially useful, when queries take a long time and sending almost the same
676 query again and again is not desirable.
680 <Query "environment">
681 Statement "select station, temperature, humidity from environment"
684 # InstancePrefix "foo"
685 InstancesFrom "station"
686 ValuesFrom "temperature"
690 InstancesFrom "station"
691 ValuesFrom "humidity"
695 The following options are accepted:
699 =item B<Statement> I<SQL>
701 Sets the statement that should be executed on the server. This is B<not>
702 interpreted by collectd, but simply passed to the database server. Therefore,
703 the SQL dialect that's used depends on the server collectd is connected to.
705 The query has to return at least two columns, one for the instance and one
706 value. You cannot omit the instance, even if the statement is guaranteed to
707 always return exactly one line. In that case, you can usually specify something
710 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
712 (That works with MySQL but may not be valid SQL according to the spec. If you
713 use a more strict database server, you may have to select from a dummy table or
716 Please note that some databases, for example B<Oracle>, will fail if you
717 include a semicolon at the end of the statement.
719 =item B<MinVersion> I<Version>
721 =item B<MaxVersion> I<Value>
723 Only use this query for the specified database version. You can use these
724 options to provide multiple queries with the same name but with a slightly
725 different syntax. The plugin will use only those queries, where the specified
726 minimum and maximum versions fit the version of the database in use.
728 The database version is determined by C<dbi_conn_get_engine_version>, see the
729 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
730 for details. Basically, each part of the version is assumed to be in the range
731 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
732 "40102", version "5.0.42" becomes "50042".
734 B<Warning:> The plugin will use B<all> matching queries, so if you specify
735 multiple queries with the same name and B<overlapping> ranges, weird stuff will
736 happen. Don't to it! A valid example would be something along these lines:
747 In the above example, there are three ranges that don't overlap. The last one
748 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
749 before "4.0.0" are not specified.
751 =item B<Type> I<Type>
753 The B<type> that's used for each line returned. See L<types.db(5)> for more
754 details on how types are defined. In short: A type is a predefined layout of
755 data and the number of values and type of values has to match the type
758 If you specify "temperature" here, you need exactly one gauge column. If you
759 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
762 There must be exactly one B<Type> option inside each B<Result> block.
764 =item B<InstancePrefix> I<prefix>
766 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
767 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
768 all strings returned in the appropriate columns are concatenated together,
769 separated by dashes I<("-")>.
771 =item B<InstancesFrom> I<column0> [I<column1> ...]
773 Specifies the columns whose values will be used to create the "type-instance"
774 for each row. If you specify more than one column, the value of all columns
775 will be joined together with dashes I<("-")> as separation characters.
777 The plugin itself does not check whether or not all built instances are
778 different. It's your responsibility to assure that each is unique. This is
779 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
780 sure that only one row is returned in this case.
782 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
785 =item B<ValuesFrom> I<column0> [I<column1> ...]
787 Names the columns whose content is used as the actual data for the data sets
788 that are dispatched to the daemon. How many such columns you need is determined
789 by the B<Type> setting above. If you specify too many or not enough columns,
790 the plugin will complain about that and no data will be submitted to the
793 The actual data type in the columns is not that important. The plugin will
794 automatically cast the values to the right type if it know how to do that. So
795 it should be able to handle integer an floating point types, as well as strings
796 (if they include a number at the beginning).
798 There must be at least one B<ValuesFrom> option inside each B<Result> block.
802 =head3 B<Database> blocks
804 Database blocks define a connection to a database and which queries should be
805 sent to that database. Since the used "dbi" library can handle a wide variety
806 of databases, the configuration is very generic. If in doubt, refer to libdbi's
807 documentationE<nbsp>- we stick as close to the terminology used there.
809 Each database needs a "name" as string argument in the starting tag of the
810 block. This name will be used as "PluginInstance" in the values submitted to
811 the daemon. Other than that, that name is not used.
815 =item B<Driver> I<Driver>
817 Specifies the driver to use to connect to the database. In many cases those
818 drivers are named after the database they can connect to, but this is not a
819 technical necessity. These drivers are sometimes referred to as "DBD",
820 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
821 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
822 project at L<http://libdbi-drivers.sourceforge.net/>.
824 You need to give the driver name as expected by the "dbi" library here. You
825 should be able to find that in the documentation for each driver. If you
826 mistype the driver name, the plugin will dump a list of all known driver names
829 =item B<DriverOption> I<Key> I<Value>
831 Sets driver-specific options. What option a driver supports can be found in the
832 documentation for each driver, somewhere at
833 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
834 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
836 Unfortunately, drivers are not too keen to report errors when an unknown option
837 is passed to them, so invalid settings here may go unnoticed. This is not the
838 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
839 the driver. If a driver complains about an option, the plugin will dump a
840 complete list of all options understood by that driver to the log.
842 =item B<SelectDB> I<Database>
844 In some cases, the database name you connect with is not the database name you
845 want to use for querying data. If this option is set, the plugin will "select"
846 (switch to) that database after the connection is established.
848 =item B<Query> I<QueryName>
850 Associates the query named I<QueryName> with this database connection. The
851 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
852 blocks you want to refer to must be placed above the database block you want to
861 =item B<Device> I<Device>
863 Select partitions based on the devicename.
865 =item B<MountPoint> I<Directory>
867 Select partitions based on the mountpoint.
869 =item B<FSType> I<FSType>
871 Select partitions based on the filesystem type.
873 =item B<IgnoreSelected> I<true>|I<false>
875 Invert the selection: If set to true, all partitions B<except> the ones that
876 match any one of the criteria are collected. By default only selected
877 partitions are collected if a selection is made. If no selection is configured
878 at all, B<all> partitions are selected.
880 =item B<ReportByDevice> I<true>|I<false>
882 Report using the device name rather than the mountpoint. i.e. with this I<false>,
883 (the default), it will report a disk as "root", but with it I<true>, it will be
884 "sda1" (or whichever).
888 =head2 Plugin C<disk>
890 The C<disk> plugin collects information about the usage of physical disks and
891 logical disks (partitions). Values collected are the number of octets written
892 to and read from a disk or partition, the number of read/write operations
893 issued to the disk and a rather complex "time" it took for these commands to be
896 Using the following two options you can ignore some disks or configure the
897 collection only of specific disks.
901 =item B<Disk> I<Name>
903 Select the disk I<Name>. Whether it is collected or ignored depends on the
904 B<IgnoreSelected> setting, see below. As with other plugins that use the
905 daemon's ignorelist functionality, a string that starts and ends with a slash
906 is interpreted as a regular expression. Examples:
911 =item B<IgnoreSelected> B<true>|B<false>
913 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
914 statements, are ignored or if all other disks are ignored. The behavior
915 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
916 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
917 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
918 is set to B<true>, all disks are collected B<except> the ones matched.
926 =item B<Interface> I<Interface>
928 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
929 option sets the interface that should be used. If this option is not set, or
930 set to "any", the plugin will try to get packets from B<all> interfaces. This
931 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
933 =item B<IgnoreSource> I<IP-address>
935 Ignore packets that originate from this address.
937 =item B<SelectNumericQueryTypes> B<true>|B<false>
939 Enabled by default, collects unknown (and thus presented as numeric only) query types.
943 =head2 Plugin C<email>
947 =item B<SocketFile> I<Path>
949 Sets the socket-file which is to be created.
951 =item B<SocketGroup> I<Group>
953 If running as root change the group of the UNIX-socket after it has been
954 created. Defaults to B<collectd>.
956 =item B<SocketPerms> I<Permissions>
958 Change the file permissions of the UNIX-socket after it has been created. The
959 permissions must be given as a numeric, octal value as you would pass to
960 L<chmod(1)>. Defaults to B<0770>.
962 =item B<MaxConns> I<Number>
964 Sets the maximum number of connections that can be handled in parallel. Since
965 this many threads will be started immediately setting this to a very high
966 value will waste valuable resources. Defaults to B<5> and will be forced to be
967 at most B<16384> to prevent typos and dumb mistakes.
971 =head2 Plugin C<exec>
973 Please make sure to read L<collectd-exec(5)> before using this plugin. It
974 contains valuable information on when the executable is executed and the
975 output that is expected from it.
979 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
981 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
983 Execute the executable I<Executable> as user I<User>. If the user name is
984 followed by a colon and a group name, the effective group is set to that group.
985 The real group and saved-set group will be set to the default group of that
986 user. If no group is given the effective group ID will be the same as the real
989 Please note that in order to change the user and/or group the daemon needs
990 superuser privileges. If the daemon is run as an unprivileged user you must
991 specify the same user/group here. If the daemon is run with superuser
992 privileges, you must supply a non-root user here.
994 The executable may be followed by optional arguments that are passed to the
995 program. Please note that due to the configuration parsing numbers and boolean
996 values may be changed. If you want to be absolutely sure that something is
997 passed as-is please enclose it in quotes.
999 The B<Exec> and B<NotificationExec> statements change the semantics of the
1000 programs executed, i.E<nbsp>e. the data passed to them and the response
1001 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1005 =head2 Plugin C<filecount>
1007 The C<filecount> plugin counts the number of files in a certain directory (and
1008 its subdirectories) and their combined size. The configuration is very straight
1011 <Plugin "filecount">
1012 <Directory "/var/qmail/queue/mess">
1013 Instance "qmail-message"
1015 <Directory "/var/qmail/queue/todo">
1016 Instance "qmail-todo"
1018 <Directory "/var/lib/php5">
1019 Instance "php5-sessions"
1024 The example above counts the number of files in QMail's queue directories and
1025 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1026 QMail has not yet looked at, the "message" queue holds the messages that were
1027 classified into "local" and "remote".
1029 As you can see, the configuration consists of one or more C<Directory> blocks,
1030 each of which specifies a directory in which to count the files. Within those
1031 blocks, the following options are recognized:
1035 =item B<Instance> I<Instance>
1037 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1038 it's your responsibility, the plugin doesn't check for that. If not given, the
1039 instance is set to the directory name with all slashes replaced by underscores
1040 and all leading underscores removed.
1042 =item B<Name> I<Pattern>
1044 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1045 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1046 against the pattern, not the entire path. In case this makes it easier for you:
1047 This option has been named after the B<-name> parameter to L<find(1)>.
1049 =item B<MTime> I<Age>
1051 Count only files of a specific age: If I<Age> is greater than zero, only files
1052 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1053 a negative number, this is inversed. For example, if B<-60> is specified, only
1054 files that have been modified in the last minute will be counted.
1056 The number can also be followed by a "multiplier" to easily specify a larger
1057 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1058 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1059 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1060 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1061 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1064 =item B<Size> I<Size>
1066 Count only files of a specific size. When I<Size> is a positive number, only
1067 files that are at least this big are counted. If I<Size> is a negative number,
1068 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1069 I<Size> are counted.
1071 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1072 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1073 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1074 note that there are 1000 bytes in a kilobyte, not 1024.
1076 =item B<Recursive> I<true>|I<false>
1078 Controls whether or not to recurse into subdirectories. Enabled by default.
1082 =head2 Plugin C<gmond>
1084 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1085 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1086 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1091 MCReceiveFrom "239.2.11.71" "8649"
1092 <Metric "swap_total">
1094 TypeInstance "total"
1097 <Metric "swap_free">
1104 The following metrics are built-in:
1110 load_one, load_five, load_fifteen
1114 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1118 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1130 Available configuration options:
1134 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1136 Sets sets the multicast group and UDP port to which to subscribe.
1138 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1140 =item E<lt>B<Metric> I<Name>E<gt>
1142 These blocks add a new metric conversion to the internal table. I<Name>, the
1143 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1147 =item B<Type> I<Type>
1149 Type to map this metric to. Required.
1151 =item B<TypeInstance> I<Instance>
1153 Type-instance to use. Optional.
1155 =item B<DataSource> I<Name>
1157 Data source to map this metric to. If the configured type has exactly one data
1158 source, this is optional. Otherwise the option is required.
1164 =head2 Plugin C<hddtemp>
1166 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1167 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1168 default values, see below. C<hddtemp> has to be running to work correctly. If
1169 C<hddtemp> is not running timeouts may appear which may interfere with other
1172 The B<hddtemp> homepage can be found at
1173 L<http://www.guzu.net/linux/hddtemp.php>.
1177 =item B<Host> I<Hostname>
1179 Hostname to connect to. Defaults to B<127.0.0.1>.
1181 =item B<Port> I<Port>
1183 TCP-Port to connect to. Defaults to B<7634>.
1185 =item B<TranslateDevicename> I<true>|I<false>
1187 If enabled, translate the disk names to major/minor device numbers
1188 (e.E<nbsp>g. "8-0" for /dev/sda). For backwards compatibility this defaults to
1189 I<true> but it's recommended to disable it as it will probably be removed in
1190 the next major version.
1194 =head2 Plugin C<interface>
1198 =item B<Interface> I<Interface>
1200 Select this interface. By default these interfaces will then be collected. For
1201 a more detailed description see B<IgnoreSelected> below.
1203 =item B<IgnoreSelected> I<true>|I<false>
1205 If no configuration if given, the B<traffic>-plugin will collect data from
1206 all interfaces. This may not be practical, especially for loopback- and
1207 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1208 interfaces you're interested in. Sometimes, however, it's easier/preferred
1209 to collect all interfaces I<except> a few ones. This option enables you to
1210 do that: By setting B<IgnoreSelected> to I<true> the effect of
1211 B<Interface> is inverted: All selected interfaces are ignored and all
1212 other interfaces are collected.
1216 =head2 Plugin C<ipmi>
1220 =item B<Sensor> I<Sensor>
1222 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1224 =item B<IgnoreSelected> I<true>|I<false>
1226 If no configuration if given, the B<ipmi> plugin will collect data from all
1227 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1228 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1229 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1230 all other sensors are collected.
1232 =item B<NotifySensorAdd> I<true>|I<false>
1234 If a sensor appears after initialization time of a minute a notification
1237 =item B<NotifySensorRemove> I<true>|I<false>
1239 If a sensor disappears a notification is sent.
1241 =item B<NotifySensorNotPresent> I<true>|I<false>
1243 If you have for example dual power supply and one of them is (un)plugged then
1244 a notification is sent.
1248 =head2 Plugin C<iptables>
1252 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1254 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1255 will collect the counters of all rules which have a comment-match. The comment
1256 is then used as type-instance.
1258 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1259 the I<n>th rule will be collected. Again, the comment (or the number) will be
1260 used as the type-instance.
1262 If I<Name> is supplied, it will be used as the type-instance instead of the
1263 comment or the number.
1267 =head2 Plugin C<irq>
1273 Select this irq. By default these irqs will then be collected. For a more
1274 detailed description see B<IgnoreSelected> below.
1276 =item B<IgnoreSelected> I<true>|I<false>
1278 If no configuration if given, the B<irq>-plugin will collect data from all
1279 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1280 can use the B<Irq>-option to pick the interrupt you're interested in.
1281 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1282 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1283 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1284 and all other interrupts are collected.
1288 =head2 Plugin C<java>
1290 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1291 This section only discusses the syntax and semantic of the configuration
1292 options. For more in-depth information on the I<Java> plugin, please read
1293 L<collectd-java(5)>.
1298 JVMArg "-verbose:jni"
1299 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1300 LoadPlugin "org.collectd.java.Foobar"
1301 <Plugin "org.collectd.java.Foobar">
1302 # To be parsed by the plugin
1306 Available configuration options:
1310 =item B<JVMArg> I<Argument>
1312 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1313 exactly the way the arguments to the I<java> binary on the command line work.
1314 Execute C<javaE<nbsp>--help> for details.
1316 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1317 any other options! When another option is found, the JVM will be started and
1318 later options will have to be ignored!
1320 =item B<LoadPlugin> I<JavaClass>
1322 Instantiates a new I<JavaClass> object. The constructor of this object very
1323 likely then registers one or more callback methods with the server.
1325 See L<collectd-java(5)> for details.
1327 When the first such option is found, the virtual machine (JVM) is created. This
1328 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1329 B<LoadPlugin> options!
1331 =item B<Plugin> I<Name>
1333 The entire block is passed to the Java plugin as an
1334 I<org.collectd.api.OConfigItem> object.
1336 For this to work, the plugin has to register a configuration callback first,
1337 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1338 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1339 depends on the (Java) plugin registering the callback and is completely
1340 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1344 =head2 Plugin C<libvirt>
1346 This plugin allows CPU, disk and network load to be collected for virtualized
1347 guests on the machine. This means that these characteristics can be collected
1348 for guest systems without installing any software on them - collectd only runs
1349 on the hosting system. The statistics are collected through libvirt
1350 (L<http://libvirt.org/>).
1352 Only I<Connection> is required.
1356 =item B<Connection> I<uri>
1358 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1360 Connection "xen:///"
1362 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1364 =item B<RefreshInterval> I<seconds>
1366 Refresh the list of domains and devices every I<seconds>. The default is 60
1367 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1368 the list of domains and devices to be refreshed on every iteration.
1370 Refreshing the devices in particular is quite a costly operation, so if your
1371 virtualization setup is static you might consider increasing this. If this
1372 option is set to 0, refreshing is disabled completely.
1374 =item B<Domain> I<name>
1376 =item B<BlockDevice> I<name:dev>
1378 =item B<InterfaceDevice> I<name:dev>
1380 =item B<IgnoreSelected> I<true>|I<false>
1382 Select which domains and devices are collected.
1384 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1385 disk/network devices are collected.
1387 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1388 domains and disk/network devices are ignored, while the rest are collected.
1390 The domain name and device names may use a regular expression, if the name is
1391 surrounded by I</.../> and collectd was compiled with support for regexps.
1393 The default is to collect statistics for all domains and all their devices.
1397 BlockDevice "/:hdb/"
1398 IgnoreSelected "true"
1400 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1403 =item B<HostnameFormat> B<name|uuid|hostname|...>
1405 When the libvirt plugin logs data, it sets the hostname of the collected data
1406 according to this setting. The default is to use the guest name as provided by
1407 the hypervisor, which is equal to setting B<name>.
1409 B<uuid> means use the guest's UUID. This is useful if you want to track the
1410 same guest across migrations.
1412 B<hostname> means to use the global B<Hostname> setting, which is probably not
1413 useful on its own because all guests will appear to have the same name.
1415 You can also specify combinations of these fields. For example B<name uuid>
1416 means to concatenate the guest name and UUID (with a literal colon character
1417 between, thus I<"foo:1234-1234-1234-1234">).
1421 =head2 Plugin C<logfile>
1425 =item B<LogLevel> B<debug|info|notice|warning|err>
1427 Sets the log-level. If, for example, set to B<notice>, then all events with
1428 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1430 Please note that B<debug> is only available if collectd has been compiled with
1433 =item B<File> I<File>
1435 Sets the file to write log messages to. The special strings B<stdout> and
1436 B<stderr> can be used to write to the standard output and standard error
1437 channels, respectively. This, of course, only makes much sense when collectd is
1438 running in foreground- or non-daemon-mode.
1440 =item B<Timestamp> B<true>|B<false>
1442 Prefix all lines printed by the current time. Defaults to B<true>.
1446 B<Note>: There is no need to notify the daemon after moving or removing the
1447 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1448 for each line it writes.
1450 =head2 Plugin C<mbmon>
1452 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
1454 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
1455 B<Host> and B<Port> options can be used to change these values, see below.
1456 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
1457 timeouts may appear which may interfere with other statistics..
1459 C<mbmon> must be run with the -r option ("print TAG and Value format");
1460 Debian's F</etc/init.d/mbmon> script already does this, other people
1461 will need to ensure that this is the case.
1465 =item B<Host> I<Hostname>
1467 Hostname to connect to. Defaults to B<127.0.0.1>.
1469 =item B<Port> I<Port>
1471 TCP-Port to connect to. Defaults to B<411>.
1475 =head2 Plugin C<memcachec>
1477 The C<memcachec plugin> connects to a memcached server, queries one or more
1478 given I<pages> and parses the returned data according to user specification.
1479 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
1482 In order to talk to the memcached server, this plugin uses the I<libmemcached>
1483 library. Please note that there is another library with a very similar name,
1484 libmemcache (notice the missing `d'), which is not applicable.
1486 Synopsis of the configuration:
1488 <Plugin "memcachec">
1489 <Page "plugin_instance">
1493 Regex "(\\d+) bytes sent"
1496 Instance "type_instance"
1501 The configuration options are:
1505 =item E<lt>B<Page> I<Name>E<gt>
1507 Each B<Page> block defines one I<page> to be queried from the memcached server.
1508 The block requires one string argument which is used as I<plugin instance>.
1510 =item B<Server> I<Address>
1512 Sets the server address to connect to when querying the page. Must be inside a
1517 When connected to the memcached server, asks for the page I<Key>.
1519 =item E<lt>B<Match>E<gt>
1521 Match blocks define which strings to look for and how matches substrings are
1522 interpreted. For a description of match blocks, please see L<"Plugin tail">.
1526 =head2 Plugin C<memcached>
1528 The C<memcached plugin> connects to a memcached server and queries statistics
1529 about cache utilization, memory and bandwidth used.
1530 L<http://www.danga.com/memcached/>
1534 =item B<Host> I<Hostname>
1536 Hostname to connect to. Defaults to B<127.0.0.1>.
1538 =item B<Port> I<Port>
1540 TCP-Port to connect to. Defaults to B<11211>.
1544 =head2 Plugin C<mysql>
1546 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
1547 one or more databases when started and keeps the connection up as long as
1548 possible. When the connection is interrupted for whatever reason it will try
1549 to re-connect. The plugin will complaint loudly in case anything goes wrong.
1551 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
1552 and collects information about MySQL network traffic, executed statements,
1553 requests, the query cache and threads by evaluating the
1554 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
1555 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
1556 Status Variables> for an explanation of these values.
1558 Optionally, master and slave statistics may be collected in a MySQL
1559 replication setup. In that case, information about the synchronization state
1560 of the nodes are collected by evaluating the C<Position> return value of the
1561 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
1562 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
1563 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
1564 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
1565 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
1580 Socket "/var/run/mysql/mysqld.sock"
1582 SlaveNotifications true
1586 A B<Database> block defines one connection to a MySQL database. It accepts a
1587 single argument which specifies the name of the database. None of the other
1588 options are required. MySQL will use default values as documented in the
1589 section "mysql_real_connect()" in the B<MySQL reference manual>.
1593 =item B<Host> I<Hostname>
1595 Hostname of the database server. Defaults to B<localhost>.
1597 =item B<User> I<Username>
1599 Username to use when connecting to the database. The user does not have to be
1600 granted any privileges (which is synonym to granting the C<USAGE> privilege).
1601 Any existing MySQL user will do.
1603 =item B<Password> I<Password>
1605 Password needed to log into the database.
1607 =item B<Database> I<Database>
1609 Select this database. Defaults to I<no database> which is a perfectly reasonable
1610 option for what this plugin does.
1612 =item B<Port> I<Port>
1614 TCP-port to connect to. The port must be specified in its numeric form, but it
1615 must be passed as a string nonetheless. For example:
1619 If B<Host> is set to B<localhost> (the default), this setting has no effect.
1620 See the documentation for the C<mysql_real_connect> function for details.
1622 =item B<Socket> I<Socket>
1624 Specifies the path to the UNIX domain socket of the MySQL server. This option
1625 only has any effect, if B<Host> is set to B<localhost> (the default).
1626 Otherwise, use the B<Port> option above. See the documentation for the
1627 C<mysql_real_connect> function for details.
1629 =item B<MasterStats> I<true|false>
1631 =item B<SlaveStats> I<true|false>
1633 Enable the collection of master / slave statistics in a replication setup.
1635 =item B<SlaveNotifications> I<true|false>
1637 If enabled, the plugin sends a notification if the replication slave I/O and /
1638 or SQL threads are not running.
1642 =head2 Plugin C<netlink>
1644 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
1645 statistics of various interface and routing aspects.
1649 =item B<Interface> I<Interface>
1651 =item B<VerboseInterface> I<Interface>
1653 Instruct the plugin to collect interface statistics. This is basically the same
1654 as the statistics provided by the C<interface> plugin (see above) but
1655 potentially much more detailed.
1657 When configuring with B<Interface> only the basic statistics will be collected,
1658 namely octets, packets, and errors. These statistics are collected by
1659 the C<interface> plugin, too, so using both at the same time is no benefit.
1661 When configured with B<VerboseInterface> all counters B<except> the basic ones,
1662 so that no data needs to be collected twice if you use the C<interface> plugin.
1663 This includes dropped packets, received multicast packets, collisions and a
1664 whole zoo of differentiated RX and TX errors. You can try the following command
1665 to get an idea of what awaits you:
1669 If I<Interface> is B<All>, all interfaces will be selected.
1671 =item B<QDisc> I<Interface> [I<QDisc>]
1673 =item B<Class> I<Interface> [I<Class>]
1675 =item B<Filter> I<Interface> [I<Filter>]
1677 Collect the octets and packets that pass a certain qdisc, class or filter.
1679 QDiscs and classes are identified by their type and handle (or classid).
1680 Filters don't necessarily have a handle, therefore the parent's handle is used.
1681 The notation used in collectd differs from that used in tc(1) in that it
1682 doesn't skip the major or minor number if it's zero and doesn't print special
1683 ids by their name. So, for example, a qdisc may be identified by
1684 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
1685 thus not displayed by tc(1).
1687 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
1688 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
1689 associated with that interface will be collected.
1691 Since a filter itself doesn't necessarily have a handle, the parent's handle is
1692 used. This may lead to problems when more than one filter is attached to a
1693 qdisc or class. This isn't nice, but we don't know how this could be done any
1694 better. If you have a idea, please don't hesitate to tell us.
1696 As with the B<Interface> option you can specify B<All> as the interface,
1697 meaning all interfaces.
1699 Here are some examples to help you understand the above text more easily:
1702 VerboseInterface "All"
1703 QDisc "eth0" "pfifo_fast-1:0"
1705 Class "ppp0" "htb-1:10"
1706 Filter "ppp0" "u32-1:0"
1709 =item B<IgnoreSelected>
1711 The behaviour is the same as with all other similar plugins: If nothing is
1712 selected at all, everything is collected. If some things are selected using the
1713 options described above, only these statistics are collected. If you set
1714 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
1715 specified statistics will not be collected.
1719 =head2 Plugin C<network>
1721 The Network plugin sends data to a remote instance of collectd, receives data
1722 from a remote instance, or both at the same time. Data which has been received
1723 from the network is usually not transmitted again, but this can be actived, see
1724 the B<Forward> option below.
1726 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
1727 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
1729 Both, B<Server> and B<Listen> can be used as single option or as block. When
1730 used as block, given options are valid for this socket only. For example:
1733 Server "collectd.internal.tld"
1734 <Server "collectd.external.tld">
1735 SecurityLevel "sign"
1736 Username "myhostname"
1743 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
1745 The B<Server> statement/block sets the server to send datagrams to. The
1746 statement may occur multiple times to send each datagram to multiple
1749 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
1750 optional second argument specifies a port number or a service name. If not
1751 given, the default, B<25826>, is used.
1753 The following options are recognized within B<Server> blocks:
1757 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
1759 Set the security you require for network communication. When the security level
1760 has been set to B<Encrypt>, data sent over the network will be encrypted using
1761 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
1762 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
1763 authentication code. When set to B<None>, data is sent without any security.
1765 This feature is only available if the I<network> plugin was linked with
1768 =item B<Username> I<Username>
1770 Sets the username to transmit. This is used by the server to lookup the
1771 password. See B<AuthFile> below. All security levels except B<None> require
1774 This feature is only available if the I<network> plugin was linked with
1777 =item B<Password> I<Password>
1779 Sets a password (shared secret) for this socket. All security levels except
1780 B<None> require this setting.
1782 This feature is only available if the I<network> plugin was linked with
1787 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
1789 The B<Listen> statement sets the interfaces to bind to. When multiple
1790 statements are found the daemon will bind to multiple interfaces.
1792 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
1793 the argument is a multicast address the daemon will join that multicast group.
1794 The optional second argument specifies a port number or a service name. If not
1795 given, the default, B<25826>, is used.
1797 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
1801 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
1803 Set the security you require for network communication. When the security level
1804 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
1805 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
1806 signed and encrypted data is accepted. When set to B<None>, all data will be
1807 accepted. If an B<AuthFile> option was given (see below), encrypted data is
1808 decrypted if possible.
1810 This feature is only available if the I<network> plugin was linked with
1813 =item B<AuthFile> I<Filename>
1815 Sets a file in which usernames are mapped to passwords. These passwords are
1816 used to verify signatures and to decrypt encrypted network packets. If
1817 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
1818 verified and encrypted packets are decrypted. Otherwise, signed data is
1819 accepted without checking the signature and encrypted data cannot be decrypted.
1820 For the other security levels this option is mandatory.
1822 The file format is very simple: Each line consists of a username followed by a
1823 colon and any number of spaces followed by the password. To demonstrate, an
1824 example file could look like this:
1829 Each time a packet is received, the modification time of the file is checked
1830 using L<stat(2)>. If the file has been changed, the contents is re-read. While
1831 the file is being read, it is locked using L<fcntl(2)>.
1835 =item B<TimeToLive> I<1-255>
1837 Set the time-to-live of sent packets. This applies to all, unicast and
1838 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
1839 That means that multicast packets will be sent with a TTL of C<1> (one) on most
1842 =item B<MaxPacketSize> I<1024-65535>
1844 Set the maximum size for datagrams received over the network. Packets larger
1845 than this will be truncated.
1847 =item B<Forward> I<true|false>
1849 If set to I<true>, write packets that were received via the network plugin to
1850 the sending sockets. This should only be activated when the B<Listen>- and
1851 B<Server>-statements differ. Otherwise packets may be send multiple times to
1852 the same multicast group. While this results in more network traffic than
1853 necessary it's not a huge problem since the plugin has a duplicate detection,
1854 so the values will not loop.
1856 =item B<CacheFlush> I<Seconds>
1858 For each host/plugin/type combination the C<network plugin> caches the time of
1859 the last value being sent or received. Every I<Seconds> seconds the plugin
1860 searches and removes all entries that are older than I<Seconds> seconds, thus
1861 freeing the unused memory again. Since this process is somewhat expensive and
1862 normally doesn't do much, this value should not be too small. The default is
1863 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
1868 =head2 Plugin C<nginx>
1870 This plugin collects the number of connections and requests handled by the
1871 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
1872 queries the page provided by the C<ngx_http_stub_status_module> module, which
1873 isn't compiled by default. Please refer to
1874 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
1875 how to compile and configure nginx and this module.
1877 The following options are accepted by the C<nginx plugin>:
1881 =item B<URL> I<http://host/nginx_status>
1883 Sets the URL of the C<ngx_http_stub_status_module> output.
1885 =item B<User> I<Username>
1887 Optional user name needed for authentication.
1889 =item B<Password> I<Password>
1891 Optional password needed for authentication.
1893 =item B<VerifyPeer> B<true|false>
1895 Enable or disable peer SSL certificate verification. See
1896 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1898 =item B<VerifyHost> B<true|false>
1900 Enable or disable peer host name verification. If enabled, the plugin checks
1901 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1902 certificate matches the host name provided by the B<URL> option. If this
1903 identity check fails, the connection is aborted. Obviously, only works when
1904 connecting to a SSL enabled server. Enabled by default.
1906 =item B<CACert> I<File>
1908 File that holds one or more SSL certificates. If you want to use HTTPS you will
1909 possibly need this option. What CA certificates come bundled with C<libcurl>
1910 and are checked by default depends on the distribution you use.
1914 =head2 Plugin C<notify_desktop>
1916 This plugin sends a desktop notification to a notification daemon, as defined
1917 in the Desktop Notification Specification. To actually display the
1918 notifications, B<notification-daemon> is required and B<collectd> has to be
1919 able to access the X server.
1921 The Desktop Notification Specification can be found at
1922 L<http://www.galago-project.org/specs/notification/>.
1926 =item B<OkayTimeout> I<timeout>
1928 =item B<WarningTimeout> I<timeout>
1930 =item B<FailureTimeout> I<timeout>
1932 Set the I<timeout>, in milliseconds, after which to expire the notification
1933 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
1934 been specified, the displayed notification will not be closed at all - the
1935 user has to do so herself. These options default to 5000. If a negative number
1936 has been specified, the default is used as well.
1940 =head2 Plugin C<notify_email>
1942 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
1943 configured email address.
1945 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
1947 Available configuration options:
1951 =item B<From> I<Address>
1953 Email address from which the emails should appear to come from.
1955 Default: C<root@localhost>
1957 =item B<Recipient> I<Address>
1959 Configures the email address(es) to which the notifications should be mailed.
1960 May be repeated to send notifications to multiple addresses.
1962 At least one B<Recipient> must be present for the plugin to work correctly.
1964 =item B<SMTPServer> I<Hostname>
1966 Hostname of the SMTP server to connect to.
1968 Default: C<localhost>
1970 =item B<SMTPPort> I<Port>
1972 TCP port to connect to.
1976 =item B<SMTPUser> I<Username>
1978 Username for ASMTP authentication. Optional.
1980 =item B<SMTPPassword> I<Password>
1982 Password for ASMTP authentication. Optional.
1984 =item B<Subject> I<Subject>
1986 Subject-template to use when sending emails. There must be exactly two
1987 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
1988 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
1991 Default: C<Collectd notify: %s@%s>
1995 =head2 Plugin C<ntpd>
1999 =item B<Host> I<Hostname>
2001 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
2003 =item B<Port> I<Port>
2005 UDP-Port to connect to. Defaults to B<123>.
2007 =item B<ReverseLookups> B<true>|B<false>
2009 Sets wether or not to perform reverse lookups on peers. Since the name or
2010 IP-address may be used in a filename it is recommended to disable reverse
2011 lookups. The default is to do reverse lookups to preserve backwards
2012 compatibility, though.
2016 =head2 Plugin C<nut>
2020 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
2022 Add a UPS to collect data from. The format is identical to the one accepted by
2027 =head2 Plugin C<olsrd>
2029 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
2030 the Optimized Link State Routing daemon and reads information about the current
2031 state of the meshed network.
2033 The following configuration options are understood:
2037 =item B<Host> I<Host>
2039 Connect to I<Host>. Defaults to B<"localhost">.
2041 =item B<Port> I<Port>
2043 Specifies the port to connect to. This must be a string, even if you give the
2044 port as a number rather than a service name. Defaults to B<"2006">.
2046 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
2048 Specifies what information to collect about links, i.E<nbsp>e. direct
2049 connections of the daemon queried. If set to B<No>, no information is
2050 collected. If set to B<Summary>, the number of links and the average of all
2051 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
2052 If set to B<Detail> LQ and NLQ are collected per link.
2054 Defaults to B<Detail>.
2056 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
2058 Specifies what information to collect about routes of the daemon queried. If
2059 set to B<No>, no information is collected. If set to B<Summary>, the number of
2060 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
2061 metric and ETX are collected per route.
2063 Defaults to B<Summary>.
2065 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
2067 Specifies what information to collect about the global topology. If set to
2068 B<No>, no information is collected. If set to B<Summary>, the number of links
2069 in the entire topology and the average I<link quality> (LQ) is calculated.
2070 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
2072 Defaults to B<Summary>.
2076 =head2 Plugin C<onewire>
2078 B<EXPERIMENTAL!> See notes below.
2080 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
2081 L<http://owfs.org/> to read sensors connected via the onewire bus.
2083 Currently only temperature sensors (sensors with the family code C<10>,
2084 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
2085 would like to have included, please send a sort request to the mailing list.
2087 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
2088 experimental, below.
2092 =item B<Device> I<Device>
2094 Sets the device to read the values from. This can either be a "real" hardware
2095 device, such as a serial port or an USB port, or the address of the
2096 L<owserver(1)> socket, usually B<localhost:4304>.
2098 Though the documentation claims to automatically recognize the given address
2099 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
2100 with that version, the following configuration worked for us:
2103 Device "-s localhost:4304"
2106 This directive is B<required> and does not have a default value.
2108 =item B<Sensor> I<Sensor>
2110 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
2111 below. Sensors are specified without the family byte at the beginning, to you'd
2112 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
2115 =item B<IgnoreSelected> I<true>|I<false>
2117 If no configuration if given, the B<onewire> plugin will collect data from all
2118 sensors found. This may not be practical, especially if sensors are added and
2119 removed regularly. Sometimes, however, it's easier/preferred to collect only
2120 specific sensors or all sensors I<except> a few specified ones. This option
2121 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
2122 B<Sensor> is inverted: All selected interfaces are ignored and all other
2123 interfaces are collected.
2125 =item B<Interval> I<Seconds>
2127 Sets the interval in which all sensors should be read. If not specified, the
2128 global B<Interval> setting is used.
2132 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
2133 work with big setups. It works with one sensor being attached to one
2134 controller, but as soon as you throw in a couple more senors and maybe a hub
2135 or two, reading all values will take more than ten seconds (the default
2136 interval). We will probably add some separate thread for reading the sensors
2137 and some cache or something like that, but it's not done yet. We will try to
2138 maintain backwards compatibility in the future, but we can't promise. So in
2139 short: If it works for you: Great! But keep in mind that the config I<might>
2140 change, though this is unlikely. Oh, and if you want to help improving this
2141 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
2143 =head2 Plugin C<openvpn>
2145 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
2146 traffic statistics about connected clients.
2148 To set up OpenVPN to write to the status file periodically, use the
2149 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
2150 you need to set the required format, too. This is done by setting
2151 B<--status-version> to B<2>.
2153 So, in a nutshell you need:
2155 openvpn $OTHER_OPTIONS \
2156 --status "/var/run/openvpn-status" 10 \
2163 =item B<StatusFile> I<File>
2165 Specifies the location of the status file.
2169 =head2 Plugin C<oracle>
2171 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
2172 Oracle® Database and lets you execute SQL statements there. It is very similar
2173 to the "dbi" plugin, because it was written around the same time. See the "dbi"
2174 plugin's documentation above for details.
2177 <Query "out_of_stock">
2178 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2181 # InstancePrefix "foo"
2182 InstancesFrom "category"
2186 <Database "product_information">
2190 Query "out_of_stock"
2194 =head3 B<Query> blocks
2196 The Query blocks are handled identically to the Query blocks of the "dbi"
2197 plugin. Please see its documentation above for details on how to specify
2200 =head3 B<Database> blocks
2202 Database blocks define a connection to a database and which queries should be
2203 sent to that database. Each database needs a "name" as string argument in the
2204 starting tag of the block. This name will be used as "PluginInstance" in the
2205 values submitted to the daemon. Other than that, that name is not used.
2209 =item B<ConnectID> I<ID>
2211 Defines the "database alias" or "service name" to connect to. Usually, these
2212 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
2214 =item B<Username> I<Username>
2216 Username used for authentication.
2218 =item B<Password> I<Password>
2220 Password used for authentication.
2222 =item B<Query> I<QueryName>
2224 Associates the query named I<QueryName> with this database connection. The
2225 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2226 blocks you want to refer to must be placed above the database block you want to
2231 =head2 Plugin C<perl>
2233 This plugin embeds a Perl-interpreter into collectd and provides an interface
2234 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
2236 =head2 Plugin C<ping>
2238 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
2239 configured hosts periodically and measures the network latency. Whenever the
2240 C<read> function of the plugin is called, it submits the average latency, the
2241 standard deviation and the drop rate for each host.
2243 Available configuration options:
2247 =item B<Host> I<IP-address>
2249 Host to ping periodically. This option may be repeated several times to ping
2252 =item B<Interval> I<Seconds>
2254 Sets the interval in which to send ICMP echo packets to the configured hosts.
2255 This is B<not> the interval in which statistics are queries from the plugin but
2256 the interval in which the hosts are "pinged". Therefore, the setting here
2257 should be smaller than or equal to the global B<Interval> setting. Fractional
2258 times, such as "1.24" are allowed.
2262 =item B<Timeout> I<Seconds>
2264 Time to wait for a response from the host to which an ICMP packet had been
2265 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
2266 to be down or the packet to be dropped. This setting must be smaller than the
2267 B<Interval> setting above for the plugin to work correctly. Fractional
2268 arguments are accepted.
2272 =item B<TTL> I<0-255>
2274 Sets the Time-To-Live of generated ICMP packets.
2278 =head2 Plugin C<postgresql>
2280 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
2281 keeps a persistent connection to all configured databases and tries to
2282 reconnect if the connection has been interrupted. A database is configured by
2283 specifying a B<Database> block as described below. The default statistics are
2284 collected from PostgreSQL's B<statistics collector> which thus has to be
2285 enabled for this plugin to work correctly. This should usually be the case by
2286 default. See the section "The Statistics Collector" of the B<PostgreSQL
2287 Documentation> for details.
2289 By specifying custom database queries using a B<Query> block as described
2290 below, you may collect any data that is available from some PostgreSQL
2291 database. This way, you are able to access statistics of external daemons
2292 which are available in a PostgreSQL database or use future or special
2293 statistics provided by PostgreSQL without the need to upgrade your collectd
2296 The B<PostgreSQL Documentation> manual can be found at
2297 L<http://www.postgresql.org/docs/manuals/>.
2301 Statement "SELECT magic FROM wizard WHERE host = $1;"
2305 InstancePrefix "magic"
2310 <Query rt36_tickets>
2311 Statement "SELECT COUNT(type) AS count, type \
2313 WHEN resolved = 'epoch' THEN 'open' \
2314 ELSE 'resolved' END AS type \
2315 FROM tickets) type \
2319 InstancePrefix "rt36_tickets"
2320 InstancesFrom "type"
2331 KRBSrvName "kerberos_service_name"
2336 Service "service_name"
2337 Query backend # predefined
2342 The B<Query> block defines one database query which may later be used by a
2343 database definition. It accepts a single mandatory argument which specifies
2344 the name of the query. The names of all queries have to be unique (see the
2345 B<MinVersion> and B<MaxVersion> options below for an exception to this
2346 rule). The following configuration options are available to define the query:
2348 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
2349 blocks define how to handle the values returned from the query. They define
2350 which column holds which value and how to dispatch that value to the daemon.
2351 Multiple B<Result> blocks may be used to extract multiple values from a single
2356 =item B<Statement> I<sql query statement>
2358 Specify the I<sql query statement> which the plugin should execute. The string
2359 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
2360 first, second, etc. parameter. The value of the parameters is specified by the
2361 B<Param> configuration option - see below for details. To include a literal
2362 B<$> character followed by a number, surround it with single quotes (B<'>).
2364 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
2365 allowed. Note, however, that only a single command may be used. Semicolons are
2366 allowed as long as a single non-empty command has been specified only.
2368 The returned lines will be handled separately one after another.
2370 =item B<Query> I<sql query statement>
2372 This is a deprecated synonym for B<Statement>. It will be removed in version 5
2375 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
2377 Specify the parameters which should be passed to the SQL query. The parameters
2378 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
2379 they appear in the configuration file. The value of the parameter is
2380 determined depending on the value of the B<Param> option as follows:
2386 The configured hostname of the database connection. If a UNIX domain socket is
2387 used, the parameter expands to "localhost".
2391 The name of the database of the current connection.
2395 The username used to connect to the database.
2399 The interval collectd is using (as specified by the B<Interval> option).
2403 Please note that parameters are only supported by PostgreSQL's protocol
2404 version 3 and above which was introduced in version 7.4 of PostgreSQL.
2406 =item B<Type> I<type>
2408 The I<type> name to be used when dispatching the values. The type describes
2409 how to handle the data and where to store it. See L<types.db(5)> for more
2410 details on types and their configuration. The number and type of values (as
2411 selected by the B<ValuesFrom> option) has to match the type of the given name.
2413 This option is required inside a B<Result> block.
2415 =item B<InstancePrefix> I<prefix>
2417 =item B<InstancesFrom> I<column0> [I<column1> ...]
2419 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
2420 B<InstancePrefix> defines a static prefix that will be prepended to all type
2421 instances. B<InstancesFrom> defines the column names whose values will be used
2422 to create the type instance. Multiple values will be joined together using the
2423 hyphen (C<->) as separation character.
2425 The plugin itself does not check whether or not all built instances are
2426 different. It is your responsibility to assure that each is unique.
2428 Both options are optional. If none is specified, the type instance will be
2431 =item B<ValuesFrom> I<column0> [I<column1> ...]
2433 Names the columns whose content is used as the actual data for the data sets
2434 that are dispatched to the daemon. How many such columns you need is
2435 determined by the B<Type> setting as explained above. If you specify too many
2436 or not enough columns, the plugin will complain about that and no data will be
2437 submitted to the daemon.
2439 The actual data type, as seen by PostgreSQL, is not that important as long as
2440 it represents numbers. The plugin will automatically cast the values to the
2441 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
2442 L<strtod(3)> functions, so anything supported by those functions is supported
2443 by the plugin as well.
2445 This option is required inside a B<Result> block and may be specified multiple
2446 times. If multiple B<ValuesFrom> options are specified, the columns are read
2449 =item B<Column> I<type> [I<type instance>]
2451 This is a deprecated alternative to a B<Result> block. It will be removed in
2452 version 5 of collectd. It is equivalent to the following B<Result> block:
2456 InstancePrefix I<type instance>
2457 ValuesFrom I<name of the x. column>
2460 The order of the B<Column> options defines which columns of the query result
2461 should be used. The first option specifies the data found in the first column,
2462 the second option that of the second column, and so on.
2464 =item B<MinVersion> I<version>
2466 =item B<MaxVersion> I<version>
2468 Specify the minimum or maximum version of PostgreSQL that this query should be
2469 used with. Some statistics might only be available with certain versions of
2470 PostgreSQL. This allows you to specify multiple queries with the same name but
2471 which apply to different versions, thus allowing you to use the same
2472 configuration in a heterogeneous environment.
2474 The I<version> has to be specified as the concatenation of the major, minor
2475 and patch-level versions, each represented as two-decimal-digit numbers. For
2476 example, version 8.2.3 will become 80203.
2478 =item B<MinPGVersion> I<version>
2480 =item B<MaxPGVersion> I<version>
2482 These are deprecated synonyms for B<MinVersion> and B<MaxVersion>
2483 respectively. They will be removed in version 5 of collectd.
2487 The following predefined queries are available (the definitions can be found
2488 in the F<postgresql_default.conf> file which, by default, is available at
2489 C<I<prefix>/share/collectd/>):
2495 This query collects the number of backends, i.E<nbsp>e. the number of
2498 =item B<transactions>
2500 This query collects the numbers of committed and rolled-back transactions of
2505 This query collects the numbers of various table modifications (i.E<nbsp>e.
2506 insertions, updates, deletions) of the user tables.
2508 =item B<query_plans>
2510 This query collects the numbers of various table scans and returned tuples of
2513 =item B<table_states>
2515 This query collects the numbers of live and dead rows in the user tables.
2519 This query collects disk block access counts for user tables.
2523 This query collects the on-disk size of the database in bytes.
2527 The B<Database> block defines one PostgreSQL database for which to collect
2528 statistics. It accepts a single mandatory argument which specifies the
2529 database name. None of the other options are required. PostgreSQL will use
2530 default values as documented in the section "CONNECTING TO A DATABASE" in the
2531 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
2532 the user collectd is run as and special environment variables. See the manpage
2537 =item B<Host> I<hostname>
2539 Specify the hostname or IP of the PostgreSQL server to connect to. If the
2540 value begins with a slash, it is interpreted as the directory name in which to
2541 look for the UNIX domain socket.
2543 This option is also used to determine the hostname that is associated with a
2544 collected data set. If it has been omitted or either begins with with a slash
2545 or equals B<localhost> it will be replaced with the global hostname definition
2546 of collectd. Any other value will be passed literally to collectd when
2547 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
2549 =item B<Port> I<port>
2551 Specify the TCP port or the local UNIX domain socket file extension of the
2554 =item B<User> I<username>
2556 Specify the username to be used when connecting to the server.
2558 =item B<Password> I<password>
2560 Specify the password to be used when connecting to the server.
2562 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
2564 Specify whether to use an SSL connection when contacting the server. The
2565 following modes are supported:
2571 Do not use SSL at all.
2575 First, try to connect without using SSL. If that fails, try using SSL.
2577 =item I<prefer> (default)
2579 First, try to connect using SSL. If that fails, try without using SSL.
2587 =item B<KRBSrvName> I<kerberos_service_name>
2589 Specify the Kerberos service name to use when authenticating with Kerberos 5
2590 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
2591 B<PostgreSQL Documentation> for details.
2593 =item B<Service> I<service_name>
2595 Specify the PostgreSQL service name to use for additional parameters. That
2596 service has to be defined in F<pg_service.conf> and holds additional
2597 connection parameters. See the section "The Connection Service File" in the
2598 B<PostgreSQL Documentation> for details.
2600 =item B<Query> I<query>
2602 Specify a I<query> which should be executed for the database connection. This
2603 may be any of the predefined or user-defined queries. If no such option is
2604 given, it defaults to "backends", "transactions", "queries", "query_plans",
2605 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
2610 =head2 Plugin C<powerdns>
2612 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
2613 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
2614 values, many of which are probably meaningless to most users, but may be useful
2615 for some. So you may chose which values to collect, but if you don't, some
2616 reasonable defaults will be collected.
2619 <Server "server_name">
2621 Collect "udp-answers" "udp-queries"
2622 Socket "/var/run/pdns.controlsocket"
2624 <Recursor "recursor_name">
2626 Collect "cache-hits" "cache-misses"
2627 Socket "/var/run/pdns_recursor.controlsocket"
2629 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
2634 =item B<Server> and B<Recursor> block
2636 The B<Server> block defines one authoritative server to query, the B<Recursor>
2637 does the same for an recursing server. The possible options in both blocks are
2638 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
2643 =item B<Collect> I<Field>
2645 Using the B<Collect> statement you can select which values to collect. Here,
2646 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
2647 C<dlg-only-drops>, C<answers10-100>.
2649 The method of getting the values differs for B<Server> and B<Recursor> blocks:
2650 When querying the server a C<SHOW *> command is issued in any case, because
2651 that's the only way of getting multiple values out of the server at once.
2652 collectd then picks out the values you have selected. When querying the
2653 recursor, a command is generated to query exactly these values. So if you
2654 specify invalid fields when querying the recursor, a syntax error may be
2655 returned by the daemon and collectd may not collect any values at all.
2657 If no B<Collect> statement is given, the following B<Server> values will be
2664 =item packetcache-hit
2666 =item packetcache-miss
2668 =item packetcache-size
2670 =item query-cache-hit
2672 =item query-cache-miss
2674 =item recursing-answers
2676 =item recursing-questions
2688 The following B<Recursor> values will be collected by default:
2692 =item noerror-answers
2694 =item nxdomain-answers
2696 =item servfail-answers
2714 Please note that up to that point collectd doesn't know what values are
2715 available on the server and values that are added do not need a change of the
2716 mechanism so far. However, the values must be mapped to collectd's naming
2717 scheme, which is done using a lookup table that lists all known values. If
2718 values are added in the future and collectd does not know about them, you will
2719 get an error much like this:
2721 powerdns plugin: submit: Not found in lookup table: foobar = 42
2723 In this case please file a bug report with the collectd team.
2725 =item B<Socket> I<Path>
2727 Configures the path to the UNIX domain socket to be used when connecting to the
2728 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
2729 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
2730 will be used for the recursor.
2734 =item B<LocalSocket> I<Path>
2736 Querying the recursor is done using UDP. When using UDP over UNIX domain
2737 sockets, the client socket needs a name in the file system, too. You can set
2738 this local name to I<Path> using the B<LocalSocket> option. The default is
2739 C<I<prefix>/var/run/collectd-powerdns>.
2743 =head2 Plugin C<processes>
2747 =item B<Process> I<Name>
2749 Select more detailed statistics of processes matching this name. The statistics
2750 collected for these selected processes are size of the resident segment size
2751 (RSS), user- and system-time used, number of processes and number of threads,
2752 and minor and major pagefaults.
2754 =item B<ProcessMatch> I<name> I<regex>
2756 Similar to the B<Process> option this allows to select more detailed
2757 statistics of processes matching the specified I<regex> (see L<regex(7)> for
2758 details). The statistics of all matching processes are summed up and
2759 dispatched to the daemon using the specified I<name> as an identifier. This
2760 allows to "group" several processes together. I<name> must not contain
2765 =head2 Plugin C<protocols>
2767 Collects a lot of information about various network protocols, such as I<IP>,
2768 I<TCP>, I<UDP>, etc.
2770 Available configuration options:
2774 =item B<Value> I<Selector>
2776 Selects whether or not to select a specific value. The string being matched is
2777 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
2778 plugin instance and I<ValueName> will be used as type instance. An example of
2779 the string being used would be C<Tcp:RetransSegs>.
2781 You can use regular expressions to match a large number of values with just one
2782 configuration option. To select all "extended" I<TCP> values, you could use the
2783 following statement:
2787 Whether only matched values are selected or all matched values are ignored
2788 depends on the B<IgnoreSelected>. By default, only matched values are selected.
2789 If no value is configured at all, all values will be selected.
2791 =item B<IgnoreSelected> B<true>|B<false>
2793 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
2794 matching values will be ignored.
2798 =head2 Plugin C<rrdcached>
2800 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
2801 to store values to RRD files in an efficient manner. The combination of the
2802 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
2803 way the C<rrdtool> plugin works (see below). The added abstraction layer
2804 provides a number of benefits, though: Because the cache is not within
2805 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
2806 restarted. This results in much shorter (if any) gaps in graphs, especially
2807 under heavy load. Also, the C<rrdtool> command line utility is aware of the
2808 daemon so that it can flush values to disk automatically when needed. This
2809 allows to integrate automated flushing of values into graphing solutions much
2812 There are disadvantages, though: The daemon may reside on a different host, so
2813 it may not be possible for C<collectd> to create the appropriate RRD files
2814 anymore. And even if C<rrdcached> runs on the same host, it may run in a
2815 different base directory, so relative paths may do weird stuff if you're not
2818 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
2819 on the same host, communicating via a UNIX domain socket. The B<DataDir>
2820 setting should be set to an absolute path, so that a changed base directory
2821 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
2825 =item B<DaemonAddress> I<Address>
2827 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
2828 library. See L<rrdcached(1)> for details. Example:
2830 <Plugin "rrdcached">
2831 DaemonAddress "unix:/var/run/rrdcached.sock"
2834 =item B<DataDir> I<Directory>
2836 Set the base directory in which the RRD files reside. If this is a relative
2837 path, it is relative to the working base directory of the C<rrdcached> daemon!
2838 Use of an absolute path is recommended.
2840 =item B<CreateFiles> B<true>|B<false>
2842 Enables or disables the creation of RRD files. If the daemon is not running
2843 locally, or B<DataDir> is set to a relative path, this will not work as
2844 expected. Default is B<true>.
2848 =head2 Plugin C<rrdtool>
2850 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
2851 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
2852 using these settings. If you don't want to dive into the depths of RRDtool, you
2853 can safely ignore these settings.
2857 =item B<DataDir> I<Directory>
2859 Set the directory to store RRD-files under. Per default RRD-files are generated
2860 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
2862 =item B<StepSize> I<Seconds>
2864 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
2865 this setting is unset and the stepsize is set to the interval in which the data
2866 is collected. Do not use this option unless you absolutely have to for some
2867 reason. Setting this option may cause problems with the C<snmp plugin>, the
2868 C<exec plugin> or when the daemon is set up to receive data from other hosts.
2870 =item B<HeartBeat> I<Seconds>
2872 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
2873 in which case the heartbeat is set to twice the B<StepSize> which should equal
2874 the interval in which data is collected. Do not set this option unless you have
2875 a very good reason to do so.
2877 =item B<RRARows> I<NumRows>
2879 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
2880 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
2881 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
2882 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
2883 week, one month, and one year.
2885 So for each timespan, it calculates how many PDPs need to be consolidated into
2886 one CDP by calculating:
2887 number of PDPs = timespan / (stepsize * rrarows)
2889 Bottom line is, set this no smaller than the width of you graphs in pixels. The
2892 =item B<RRATimespan> I<Seconds>
2894 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
2895 more then one RRA. If this option is never used, the built-in default of (3600,
2896 86400, 604800, 2678400, 31622400) is used.
2898 For more information on how RRA-sizes are calculated see B<RRARows> above.
2900 =item B<XFF> I<Factor>
2902 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
2904 =item B<CacheFlush> I<Seconds>
2906 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
2907 it writes all values for a certain RRD-file if the oldest value is older than
2908 (or equal to) the number of seconds specified. If some RRD-file is not updated
2909 anymore for some reason (the computer was shut down, the network is broken,
2910 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
2911 entire cache is searched for entries older than B<CacheTimeout> seconds and
2912 written to disk every I<Seconds> seconds. Since this is kind of expensive and
2913 does nothing under normal circumstances, this value should not be too small.
2914 900 seconds might be a good value, though setting this to 7200 seconds doesn't
2915 normally do much harm either.
2917 =item B<CacheTimeout> I<Seconds>
2919 If this option is set to a value greater than zero, the C<rrdtool plugin> will
2920 save values in a cache, as described above. Writing multiple values at once
2921 reduces IO-operations and thus lessens the load produced by updating the files.
2922 The trade off is that the graphs kind of "drag behind" and that more memory is
2925 =item B<WritesPerSecond> I<Updates>
2927 When collecting many statistics with collectd and the C<rrdtool> plugin, you
2928 will run serious performance problems. The B<CacheFlush> setting and the
2929 internal update queue assert that collectd continues to work just fine even
2930 under heavy load, but the system may become very unresponsive and slow. This is
2931 a problem especially if you create graphs from the RRD files on the same
2932 machine, for example using the C<graph.cgi> script included in the
2933 C<contrib/collection3/> directory.
2935 This setting is designed for very large setups. Setting this option to a value
2936 between 25 and 80 updates per second, depending on your hardware, will leave
2937 the server responsive enough to draw graphs even while all the cached values
2938 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
2939 by the B<FLUSH> command, are B<not> effected by this limit. They are still
2940 written as fast as possible, so that web frontends have up to date data when
2943 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
2944 updates per second, writing all values to disk will take approximately
2945 56E<nbsp>minutes. Together with the flushing ability that's integrated into
2946 "collection3" you'll end up with a responsive and fast system, up to date
2947 graphs and basically a "backup" of your values every hour.
2949 =item B<RandomTimeout> I<Seconds>
2951 When set, the actual timeout for each value is chosen randomly between
2952 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
2953 intention is to avoid high load situations that appear when many values timeout
2954 at the same time. This is especially a problem shortly after the daemon starts,
2955 because all values were added to the internal cache at roughly the same time.
2959 =head2 Plugin C<sensors>
2961 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
2962 that all the needed modules have to be loaded and lm_sensors has to be
2963 configured (most likely by editing F</etc/sensors.conf>. Read
2964 L<sensors.conf(5)> for details.
2966 The B<lm_sensors> homepage can be found at
2967 L<http://secure.netroedge.com/~lm78/>.
2971 =item B<Sensor> I<chip-bus-address/type-feature>
2973 Selects the name of the sensor which you want to collect or ignore, depending
2974 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
2975 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
2976 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
2978 =item B<IgnoreSelected> I<true>|I<false>
2980 If no configuration if given, the B<sensors>-plugin will collect data from all
2981 sensors. This may not be practical, especially for uninteresting sensors.
2982 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
2983 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
2984 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2985 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
2986 and all other sensors are collected.
2990 =head2 Plugin C<snmp>
2992 Since the configuration of the C<snmp plugin> is a little more complicated than
2993 other plugins, its documentation has been moved to an own manpage,
2994 L<collectd-snmp(5)>. Please see there for details.
2996 =head2 Plugin C<syslog>
3000 =item B<LogLevel> B<debug|info|notice|warning|err>
3002 Sets the log-level. If, for example, set to B<notice>, then all events with
3003 severity B<notice>, B<warning>, or B<err> will be submitted to the
3006 Please note that B<debug> is only available if collectd has been compiled with
3011 =head2 Plugin C<table>
3013 The C<table plugin> provides generic means to parse tabular data and dispatch
3014 user specified values. Values are selected based on column numbers. For
3015 example, this plugin may be used to get values from the Linux L<proc(5)>
3016 filesystem or CSV (comma separated values) files.
3019 <Table "/proc/slabinfo">
3024 InstancePrefix "active_objs"
3030 InstancePrefix "objperslab"
3037 The configuration consists of one or more B<Table> blocks, each of which
3038 configures one file to parse. Within each B<Table> block, there are one or
3039 more B<Result> blocks, which configure which data to select and how to
3042 The following options are available inside a B<Table> block:
3046 =item B<Instance> I<instance>
3048 If specified, I<instance> is used as the plugin instance. So, in the above
3049 example, the plugin name C<table-slabinfo> would be used. If omitted, the
3050 filename of the table is used instead, with all special characters replaced
3051 with an underscore (C<_>).
3053 =item B<Separator> I<string>
3055 Any character of I<string> is interpreted as a delimiter between the different
3056 columns of the table. A sequence of two or more contiguous delimiters in the
3057 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
3058 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
3059 of a table - see its documentation for more details. This option is mandatory.
3061 A horizontal tab, newline and carriage return may be specified by C<\\t>,
3062 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
3063 required because of collectd's config parsing.
3067 The following options are available inside a B<Result> block:
3071 =item B<Type> I<type>
3073 Sets the type used to dispatch the values to the daemon. Detailed information
3074 about types and their configuration can be found in L<types.db(5)>. This
3075 option is mandatory.
3077 =item B<InstancePrefix> I<prefix>
3079 If specified, prepend I<prefix> to the type instance. If omitted, only the
3080 B<InstancesFrom> option is considered for the type instance.
3082 =item B<InstancesFrom> I<column0> [I<column1> ...]
3084 If specified, the content of the given columns (identified by the column
3085 number starting at zero) will be used to create the type instance for each
3086 row. Multiple values (and the instance prefix) will be joined together with
3087 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
3088 option is considered for the type instance.
3090 The plugin itself does not check whether or not all built instances are
3091 different. It’s your responsibility to assure that each is unique. This is
3092 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
3093 sure that the table only contains one row.
3095 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
3098 =item B<ValuesFrom> I<column0> [I<column1> ...]
3100 Specifies the columns (identified by the column numbers starting at zero)
3101 whose content is used as the actual data for the data sets that are dispatched
3102 to the daemon. How many such columns you need is determined by the B<Type>
3103 setting above. If you specify too many or not enough columns, the plugin will
3104 complain about that and no data will be submitted to the daemon. The plugin
3105 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
3106 respectively, so anything supported by those functions is supported by the
3107 plugin as well. This option is mandatory.
3111 =head2 Plugin C<tail>
3113 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
3114 each line and dispatches found values. What is matched can be configured by the
3115 user using (extended) regular expressions, as described in L<regex(7)>.
3118 <File "/var/log/exim4/mainlog">
3121 Regex "S=([1-9][0-9]*)"
3127 Regex "\\<R=local_user\\>"
3130 Instance "local_user"
3135 The config consists of one or more B<File> blocks, each of which configures one
3136 logfile to parse. Within each B<File> block, there are one or more B<Match>
3137 blocks, which configure a regular expression to search for.
3139 The B<Instance> option in the B<File> block may be used to set the plugin
3140 instance. So in the above example the plugin name C<tail-foo> would be used.
3141 This plugin instance is for all B<Match> blocks that B<follow> it, until the
3142 next B<Instance> option. This way you can extract several plugin instances from
3143 one logfile, handy when parsing syslog and the like.
3145 Each B<Match> block has the following options to describe how the match should
3150 =item B<Regex> I<regex>
3152 Sets the regular expression to use for matching against a line. The first
3153 subexpression has to match something that can be turned into a number by
3154 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
3155 below. Because B<extended> regular expressions are used, you do not need to use
3156 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
3157 collectd's config parsing you need to escape backslashes, though. So if you
3158 want to match literal parentheses you need to do the following:
3160 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
3162 =item B<DSType> I<Type>
3164 Sets how the values are cumulated. I<Type> is one of:
3168 =item B<GaugeAverage>
3170 Calculate the average.
3174 Use the smallest number only.
3178 Use the greatest number only.
3182 Use the last number found.
3186 The matched number is a counter. Simply sets the internal counter to this
3191 Add the matched value to the internal counter.
3195 Increase the internal counter by one. This B<DSType> is the only one that does
3196 not use the matched subexpression, but simply counts the number of matched
3197 lines. Thus, you may use a regular expression without submatch in this case.
3201 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
3202 number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
3203 submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
3204 submatch at all and it may be omitted in this case.
3206 =item B<Type> I<Type>
3208 Sets the type used to dispatch this value. Detailed information about types and
3209 their configuration can be found in L<types.db(5)>.
3211 =item B<Instance> I<TypeInstance>
3213 This optional setting sets the type instance to use.
3217 =head2 Plugin C<teamspeak2>
3219 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
3220 polls interesting global and virtual server data. The plugin can query only one
3221 physical server but unlimited virtual servers. You can use the following
3222 options to configure it:
3226 =item B<Host> I<hostname/ip>
3228 The hostname or ip which identifies the physical server.
3231 =item B<Port> I<port>
3233 The query port of the physical server. This needs to be a string.
3236 =item B<Server> I<port>
3238 This option has to be added once for every virtual server the plugin should
3239 query. If you want to query the virtual server on port 8767 this is what the
3240 option would look like:
3244 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
3245 use quotes around it! If no such statement is given only global information
3250 =head2 Plugin C<ted>
3252 The I<TED> plugin connects to a device of "The Energy Detective", a device to
3253 measure power consumption. These devices are usually connected to a serial
3254 (RS232) or USB port. The plugin opens a configured device and tries to read the
3255 current energy readings. For more information on TED, visit
3256 L<http://www.theenergydetective.com/>.
3258 Available configuration options:
3262 =item B<Device> I<Path>
3264 Path to the device on which TED is connected. collectd will need read and write
3265 permissions on that file.
3267 Default: B</dev/ttyUSB0>
3269 =item B<Retries> I<Num>
3271 Apparently reading from TED is not that reliable. You can therefore configure a
3272 number of retries here. You only configure the I<retries> here, to if you
3273 specify zero, one reading will be performed (but no retries if that fails); if
3274 you specify three, a maximum of four readings are performed. Negative values
3281 =head2 Plugin C<tcpconns>
3283 The C<tcpconns plugin> counts the number of currently established TCP
3284 connections based on the local port and/or the remote port. Since there may be
3285 a lot of connections the default if to count all connections with a local port,
3286 for which a listening socket is opened. You can use the following options to
3287 fine-tune the ports you are interested in:
3291 =item B<ListeningPorts> I<true>|I<false>
3293 If this option is set to I<true>, statistics for all local ports for which a
3294 listening socket exists are collected. The default depends on B<LocalPort> and
3295 B<RemotePort> (see below): If no port at all is specifically selected, the
3296 default is to collect listening ports. If specific ports (no matter if local or
3297 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
3298 the selected ports will be collected unless this option is set to I<true>
3301 =item B<LocalPort> I<Port>
3303 Count the connections to a specific local port. This can be used to see how
3304 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
3305 You have to specify the port in numeric form, so for the mailserver example
3306 you'd need to set B<25>.
3308 =item B<RemotePort> I<Port>
3310 Count the connections to a specific remote port. This is useful to see how
3311 much a remote service is used. This is most useful if you want to know how many
3312 connections a local service has opened to remote services, e.E<nbsp>g. how many
3313 connections a mail server or news server has to other mail or news servers, or
3314 how many connections a web proxy holds to web servers. You have to give the
3315 port in numeric form.
3319 =head2 Plugin C<thermal>
3323 =item B<ForceUseProcfs> I<true>|I<false>
3325 By default, the C<thermal> plugin tries to read the statistics from the Linux
3326 C<sysfs> interface. If that is not available, the plugin falls back to the
3327 C<procfs> interface. By setting this option to I<true>, you can force the
3328 plugin to use the latter. This option defaults to I<false>.
3330 =item B<Device> I<Device>
3332 Selects the name of the thermal device that you want to collect or ignore,
3333 depending on the value of the B<IgnoreSelected> option. This option may be
3334 used multiple times to specify a list of devices.
3336 =item B<IgnoreSelected> I<true>|I<false>
3338 Invert the selection: If set to true, all devices B<except> the ones that
3339 match the device names specified by the B<Device> option are collected. By
3340 default only selected devices are collected if a selection is made. If no
3341 selection is configured at all, B<all> devices are selected.
3345 =head2 Plugin C<tokyotyrant>
3347 The C<tokyotyrant plugin> connects to a TokyoTyrant server and collects a
3348 couple metrics: number of records, and database size on disk.
3352 =item B<Host> I<Hostname/IP>
3354 The hostname or ip which identifies the server.
3355 Default: B<127.0.0.1>
3357 =item B<Port> I<Service/Port>
3359 The query port of the server. This needs to be a string, even if the port is
3360 given in its numeric form.
3365 =head2 Plugin C<unixsock>
3369 =item B<SocketFile> I<Path>
3371 Sets the socket-file which is to be created.
3373 =item B<SocketGroup> I<Group>
3375 If running as root change the group of the UNIX-socket after it has been
3376 created. Defaults to B<collectd>.
3378 =item B<SocketPerms> I<Permissions>
3380 Change the file permissions of the UNIX-socket after it has been created. The
3381 permissions must be given as a numeric, octal value as you would pass to
3382 L<chmod(1)>. Defaults to B<0770>.
3386 =head2 Plugin C<uuid>
3388 This plugin, if loaded, causes the Hostname to be taken from the machine's
3389 UUID. The UUID is a universally unique designation for the machine, usually
3390 taken from the machine's BIOS. This is most useful if the machine is running in
3391 a virtual environment such as Xen, in which case the UUID is preserved across
3392 shutdowns and migration.
3394 The following methods are used to find the machine's UUID, in order:
3400 Check I</etc/uuid> (or I<UUIDFile>).
3404 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
3409 Check for UUID from C<dmidecode> / SMBIOS.
3413 Check for UUID from Xen hypervisor.
3417 If no UUID can be found then the hostname is not modified.
3421 =item B<UUIDFile> I<Path>
3423 Take the UUID from the given file (default I</etc/uuid>).
3427 =head2 Plugin C<vmem>
3429 The C<vmem> plugin collects information about the usage of virtual memory.
3430 Since the statistics provided by the Linux kernel are very detailed, they are
3431 collected very detailed. However, to get all the details, you have to switch
3432 them on manually. Most people just want an overview over, such as the number of
3433 pages read from swap space.
3437 =item B<Verbose> B<true>|B<false>
3439 Enables verbose collection of information. This will start collecting page
3440 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
3441 Part of these statistics are collected on a "per zone" basis.
3445 =head2 Plugin C<vserver>
3447 This plugin doesn't have any options. B<VServer> support is only available for
3448 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
3449 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
3450 need to apply the patches and compile your own kernel, which will then provide
3451 the F</proc/virtual> filesystem that is required by this plugin.
3453 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
3455 B<Note>: The traffic collected by this plugin accounts for the amount of
3456 traffic passing a socket which might be a lot less than the actual on-wire
3457 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
3458 collect on-wire traffic you could, for example, use the logging facilities of
3459 iptables to feed data for the guest IPs into the iptables plugin.
3461 =head2 Plugin C<write_http>
3463 This output plugin submits values to an http server by POST them using the
3464 PUTVAL plain-text protocol. Each destination you want to post data to needs to
3465 have one B<URL> block, within which the destination can be configured further,
3466 for example by specifying authentication data.
3470 <Plugin "write_http">
3471 <URL "http://example.com/post-collectd">
3477 B<URL> blocks need one string argument which is used as the URL to which data
3478 is posted. The following options are understood within B<URL> blocks.
3482 =item B<User> I<Username>
3484 Optional user name needed for authentication.
3486 =item B<Password> I<Password>
3488 Optional password needed for authentication.
3490 =item B<VerifyPeer> B<true>|B<false>
3492 Enable or disable peer SSL certificate verification. See
3493 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3495 =item B<VerifyHost> B<true|false>
3497 Enable or disable peer host name verification. If enabled, the plugin checks if
3498 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
3499 matches the host name provided by the B<URL> option. If this identity check
3500 fails, the connection is aborted. Obviously, only works when connecting to a
3501 SSL enabled server. Enabled by default.
3503 =item B<CACert> I<File>
3505 File that holds one or more SSL certificates. If you want to use HTTPS you will
3506 possibly need this option. What CA certificates come bundled with C<libcurl>
3507 and are checked by default depends on the distribution you use.
3509 =item B<Format> B<Command>|B<JSON>
3511 Format of the output to generate. If set to B<Command>, will create output that
3512 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
3513 create output in the I<JavaScript Object Notation> (JSON).
3515 Defaults to B<Command>.
3519 =head1 THRESHOLD CONFIGURATION
3521 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
3522 we mean that the values are not only stored or sent somewhere, but that they
3523 are judged and, if a problem is recognized, acted upon. The only action
3524 collectd takes itself is to generate and dispatch a "notification". Plugins can
3525 register to receive notifications and perform appropriate further actions.
3527 Since systems and what you expect them to do differ a lot, you can configure
3528 B<thresholds> for your values freely. This gives you a lot of flexibility but
3529 also a lot of responsibility.
3531 Every time a value is out of range a notification is dispatched. This means
3532 that the idle percentage of your CPU needs to be less then the configured
3533 threshold only once for a notification to be generated. There's no such thing
3534 as a moving average or similar - at least not now.
3536 Also, all values that match a threshold are considered to be relevant or
3537 "interesting". As a consequence collectd will issue a notification if they are
3538 not received for twice the last timeout of the values. If, for example, some
3539 hosts sends it's CPU statistics to the server every 60 seconds, a notification
3540 will be dispatched after about 120 seconds. It may take a little longer because
3541 the timeout is checked only once each B<Interval> on the server.
3543 When a value comes within range again or is received after it was missing, an
3544 "OKAY-notification" is dispatched.
3546 Here is a configuration example to get you started. Read below for more
3559 <Plugin "interface">
3576 WarningMin 100000000
3582 There are basically two types of configuration statements: The C<Host>,
3583 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
3584 configured. The C<Plugin> and C<Type> blocks may be specified further using the
3585 C<Instance> option. You can combine the block by nesting the blocks, though
3586 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
3587 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
3588 C<Type> may not contain other blocks. If multiple blocks apply to the same
3589 value the most specific block is used.
3591 The other statements specify the threshold to configure. They B<must> be
3592 included in a C<Type> block. Currently the following statements are recognized:
3596 =item B<FailureMax> I<Value>
3598 =item B<WarningMax> I<Value>
3600 Sets the upper bound of acceptable values. If unset defaults to positive
3601 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
3602 will be created. If the value is greater than B<WarningMax> but less than (or
3603 equal to) B<FailureMax> a B<WARNING> notification will be created.
3605 =item B<FailureMin> I<Value>
3607 =item B<WarningMin> I<Value>
3609 Sets the lower bound of acceptable values. If unset defaults to negative
3610 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
3611 be created. If the value is less than B<WarningMin> but greater than (or equal
3612 to) B<FailureMin> a B<WARNING> notification will be created.
3614 =item B<DataSource> I<DSName>
3616 Some data sets have more than one "data source". Interesting examples are the
3617 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
3618 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
3619 system load data set, C<load>, even has three data sources: C<shortterm>,
3620 C<midterm>, and C<longterm>.
3622 Normally, all data sources are checked against a configured threshold. If this
3623 is undesirable, or if you want to specify different limits for each data
3624 source, you can use the B<DataSource> option to have a threshold apply only to
3627 =item B<Invert> B<true>|B<false>
3629 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
3630 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
3631 B<WarningMax>) are not okay. Defaults to B<false>.
3633 =item B<Persist> B<true>|B<false>
3635 Sets how often notifications are generated. If set to B<true> one notification
3636 will be generated for each value that is out of the acceptable range. If set to
3637 B<false> (the default) then a notification is only generated if a value is out
3638 of range but the previous value was okay.
3640 This applies to missing values, too: If set to B<true> a notification about a
3641 missing value is generated once every B<Interval> seconds. If set to B<false>
3642 only one such notification is generated until the value appears again.
3644 =item B<Percentage> B<true>|B<false>
3646 If set to B<true>, the minimum and maximum values given are interpreted as
3647 percentage value, relative to the other data sources. This is helpful for
3648 example for the "df" type, where you may want to issue a warning when less than
3649 5E<nbsp>% of the total space is available. Defaults to B<false>.
3653 =head1 FILTER CONFIGURATION
3655 Starting with collectd 4.6 there is a powerful filtering infrastructure
3656 implemented in the daemon. The concept has mostly been copied from
3657 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
3658 terminology, so that users that are familiar with iptables feel right at home.
3662 The following are the terms used in the remainder of the filter configuration
3663 documentation. For an ASCII-art schema of the mechanism, see
3664 L<"General structure"> below.
3670 A I<match> is a criteria to select specific values. Examples are, of course, the
3671 name of the value or it's current value.
3673 Matches are implemented in plugins which you have to load prior to using the
3674 match. The name of such plugins starts with the "match_" prefix.
3678 A I<target> is some action that is to be performed with data. Such actions
3679 could, for example, be to change part of the value's identifier or to ignore
3680 the value completely.
3682 Some of these targets are built into the daemon, see L<"Built-in targets">
3683 below. Other targets are implemented in plugins which you have to load prior to
3684 using the target. The name of such plugins starts with the "target_" prefix.
3688 The combination of any number of matches and at least one target is called a
3689 I<rule>. The target actions will be performed for all values for which B<all>
3690 matches apply. If the rule does not have any matches associated with it, the
3691 target action will be performed for all values.
3695 A I<chain> is a list of rules and possibly default targets. The rules are tried
3696 in order and if one matches, the associated target will be called. If a value
3697 is handled by a rule, it depends on the target whether or not any subsequent
3698 rules are considered or if traversal of the chain is aborted, see
3699 L<"Flow control"> below. After all rules have been checked, the default targets
3704 =head2 General structure
3706 The following shows the resulting structure:
3713 +---------+ +---------+ +---------+ +---------+
3714 ! Rule !->! Match !->! Match !->! Target !
3715 +---------+ +---------+ +---------+ +---------+
3718 +---------+ +---------+ +---------+
3719 ! Rule !->! Target !->! Target !
3720 +---------+ +---------+ +---------+
3727 +---------+ +---------+ +---------+
3728 ! Rule !->! Match !->! Target !
3729 +---------+ +---------+ +---------+
3739 There are four ways to control which way a value takes through the filter
3746 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
3747 process the value with another chain. When the called chain finishes, usually
3748 the next target or rule after the jump is executed.
3752 The stop condition, signaled for example by the built-in target B<stop>, causes
3753 all processing of the value to be stopped immediately.
3757 Causes processing in the current chain to be aborted, but processing of the
3758 value generally will continue. This means that if the chain was called via
3759 B<Jump>, the next target or rule after the jump will be executed. If the chain
3760 was not called by another chain, control will be returned to the daemon and it
3761 may pass the value to another chain.
3765 Most targets will signal the B<continue> condition, meaning that processing
3766 should continue normally. There is no special built-in target for this
3773 The configuration reflects this structure directly:
3775 PostCacheChain "PostCache"
3777 <Rule "ignore_mysql_show">
3780 Type "^mysql_command$"
3781 TypeInstance "^show_"
3791 The above configuration example will ignore all values where the plugin field
3792 is "mysql", the type is "mysql_command" and the type instance begins with
3793 "show_". All other values will be sent to the C<rrdtool> write plugin via the
3794 default target of the chain. Since this chain is run after the value has been
3795 added to the cache, the MySQL C<show_*> command statistics will be available
3796 via the C<unixsock> plugin.
3798 =head2 List of configuration options
3802 =item B<PreCacheChain> I<ChainName>
3804 =item B<PostCacheChain> I<ChainName>
3806 Configure the name of the "pre-cache chain" and the "post-cache chain". The
3807 argument is the name of a I<chain> that should be executed before and/or after
3808 the values have been added to the cache.
3810 To understand the implications, it's important you know what is going on inside
3811 I<collectd>. The following diagram shows how values are passed from the
3812 read-plugins to the write-plugins:
3818 + - - - - V - - - - +
3819 : +---------------+ :
3822 : +-------+-------+ :
3825 : +-------+-------+ : +---------------+
3826 : ! Cache !--->! Value Cache !
3827 : ! insert ! : +---+---+-------+
3828 : +-------+-------+ : ! !
3829 : ! ,------------' !
3831 : +-------+---+---+ : +-------+-------+
3832 : ! Post-Cache +--->! Write-Plugins !
3833 : ! Chain ! : +---------------+
3834 : +---------------+ :
3837 + - - - - - - - - - +
3839 After the values are passed from the "read" plugins to the dispatch functions,
3840 the pre-cache chain is run first. The values are added to the internal cache
3841 afterwards. The post-cache chain is run after the values have been added to the
3842 cache. So why is it such a huge deal if chains are run before or after the
3843 values have been added to this cache?
3845 Targets that change the identifier of a value list should be executed before
3846 the values are added to the cache, so that the name in the cache matches the
3847 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
3848 this cache to receive a list of all available values. If you change the
3849 identifier after the value list has been added to the cache, this may easily
3850 lead to confusion, but it's not forbidden of course.
3852 The cache is also used to convert counter values to rates. These rates are, for
3853 example, used by the C<value> match (see below). If you use the rate stored in
3854 the cache B<before> the new value is added, you will use the old, B<previous>
3855 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
3856 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
3859 Last but not last, the B<stop> target makes a difference: If the pre-cache
3860 chain returns the stop condition, the value will not be added to the cache and
3861 the post-cache chain will not be run.
3863 =item B<Chain> I<Name>
3865 Adds a new chain with a certain name. This name can be used to refer to a
3866 specific chain, for example to jump to it.
3868 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
3870 =item B<Rule> [I<Name>]
3872 Adds a new rule to the current chain. The name of the rule is optional and
3873 currently has no meaning for the daemon.
3875 Within the B<Rule> block, there may be any number of B<Match> blocks and there
3876 must be at least one B<Target> block.
3878 =item B<Match> I<Name>
3880 Adds a match to a B<Rule> block. The name specifies what kind of match should
3881 be performed. Available matches depend on the plugins that have been loaded.
3883 The arguments inside the B<Match> block are passed to the plugin implementing
3884 the match, so which arguments are valid here depends on the plugin being used.
3885 If you do not need any to pass any arguments to a match, you can use the
3890 Which is equivalent to:
3895 =item B<Target> I<Name>
3897 Add a target to a rule or a default target to a chain. The name specifies what
3898 kind of target is to be added. Which targets are available depends on the
3899 plugins being loaded.
3901 The arguments inside the B<Target> block are passed to the plugin implementing
3902 the target, so which arguments are valid here depends on the plugin being used.
3903 If you do not need any to pass any arguments to a target, you can use the
3908 This is the same as writing:
3915 =head2 Built-in targets
3917 The following targets are built into the core daemon and therefore need no
3918 plugins to be loaded:
3924 Signals the "return" condition, see the L<"Flow control"> section above. This
3925 causes the current chain to stop processing the value and returns control to
3926 the calling chain. The calling chain will continue processing targets and rules
3927 just after the B<jump> target (see below). This is very similar to the
3928 B<RETURN> target of iptables, see L<iptables(8)>.
3930 This target does not have any options.
3938 Signals the "stop" condition, see the L<"Flow control"> section above. This
3939 causes processing of the value to be aborted immediately. This is similar to
3940 the B<DROP> target of iptables, see L<iptables(8)>.
3942 This target does not have any options.
3950 Sends the value to "write" plugins.
3956 =item B<Plugin> I<Name>
3958 Name of the write plugin to which the data should be sent. This option may be
3959 given multiple times to send the data to more than one write plugin.
3963 If no plugin is explicitly specified, the values will be sent to all available
3974 Starts processing the rules of another chain, see L<"Flow control"> above. If
3975 the end of that chain is reached, or a stop condition is encountered,
3976 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
3977 next target or the next rule. This is similar to the B<-j> command line option
3978 of iptables, see L<iptables(8)>.
3984 =item B<Chain> I<Name>
3986 Jumps to the chain I<Name>. This argument is required and may appear only once.
3998 =head2 Available matches
4004 Matches a value using regular expressions.
4010 =item B<Host> I<Regex>
4012 =item B<Plugin> I<Regex>
4014 =item B<PluginInstance> I<Regex>
4016 =item B<Type> I<Regex>
4018 =item B<TypeInstance> I<Regex>
4020 Match values where the given regular expressions match the various fields of
4021 the identifier of a value. If multiple regular expressions are given, B<all>
4022 regexen must match for a value to match.
4029 Host "customer[0-9]+"
4035 Matches values that have a time which differs from the time on the server.
4037 This match is mainly intended for servers that receive values over the
4038 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
4039 is very sensitive to the timestamp used when updating the RRD files. In
4040 particular, the time must be ever increasing. If a misbehaving client sends one
4041 packet with a timestamp far in the future, all further packets with a correct
4042 time will be ignored because of that one packet. What's worse, such corrupted
4043 RRD files are hard to fix.
4045 This match lets one match all values B<outside> a specified time range
4046 (relative to the server's time), so you can use the B<stop> target (see below)
4047 to ignore the value, for example.
4053 =item B<Future> I<Seconds>
4055 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
4056 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
4059 =item B<Past> I<Seconds>
4061 Matches all values that are I<behind> of the server's time by I<Seconds> or
4062 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
4074 This example matches all values that are five minutes or more ahead of the
4075 server or one hour (or more) lagging behind.
4079 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
4080 values. If a data-set consists of more than one data-source, all data-sources
4081 must match the specified ranges for a positive match.
4087 =item B<Min> I<Value>
4089 Sets the smallest value which still results in a match. If unset, behaves like
4092 =item B<Max> I<Value>
4094 Sets the largest value which still results in a match. If unset, behaves like
4097 =item B<Invert> B<true>|B<false>
4099 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
4100 no-match is returned and vice versa. Please note that the B<Invert> setting
4101 only effects how B<Min> and B<Max> are applied to a specific value. Especially
4102 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
4104 =item B<DataSource> I<DSName> [I<DSName> ...]
4106 Select one or more of the data sources. If no data source is configured, all
4107 data sources will be checked. If the type handled by the match does not have a
4108 data source of the specified name(s), this will always result in no match
4109 (independent of the B<Invert> setting).
4111 =item B<Satisfy> B<Any>|B<All>
4113 Specifies how checking with several data sources is performed. If set to
4114 B<Any>, the match succeeds if one of the data sources is in the configured
4115 range. If set to B<All> the match only succeeds if all data sources are within
4116 the configured range. Default is B<All>.
4118 Usually B<All> is used for positive matches, B<Any> is used for negative
4119 matches. This means that with B<All> you usually check that all values are in a
4120 "good" range, while with B<Any> you check if any value is within a "bad" range
4121 (or outside the "good" range).
4125 Either B<Min> or B<Max>, but not both, may be unset.
4129 # Match all values smaller than or equal to 100. Matches only if all data
4130 # sources are below 100.
4136 # Match if the value of any data source is outside the range of 0 - 100.
4144 =item B<empty_counter>
4146 Matches all values with one or more data sources of type B<COUNTER> and where
4147 all counter values are zero. These counters usually I<never> increased since
4148 they started existing (and are therefore uninteresting), or got reset recently
4149 or overflowed and you had really, I<really> bad luck.
4151 Please keep in mind that ignoring such counters can result in confusing
4152 behavior: Counters which hardly ever increase will be zero for long periods of
4153 time. If the counter is reset for some reason (machine or service restarted,
4154 usually), the graph will be empty (NAN) for a long time. People may not
4159 =head2 Available targets
4163 =item B<notification>
4165 Creates and dispatches a notification.
4171 =item B<Message> I<String>
4173 This required option sets the message of the notification. The following
4174 placeholders will be replaced by an appropriate value:
4182 =item B<%{plugin_instance}>
4186 =item B<%{type_instance}>
4188 These placeholders are replaced by the identifier field of the same name.
4190 =item B<%{ds:>I<name>B<}>
4192 These placeholders are replaced by a (hopefully) human readable representation
4193 of the current rate of this data source. If you changed the instance name
4194 (using the B<set> or B<replace> targets, see below), it may not be possible to
4195 convert counter values to rates.
4199 Please note that these placeholders are B<case sensitive>!
4201 =item B<Severity> B<"FATAL">|B<"WARNING">|B<"OKAY">
4203 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
4210 <Target "notification">
4211 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
4217 Replaces parts of the identifier using regular expressions.
4223 =item B<Host> I<Regex> I<Replacement>
4225 =item B<Plugin> I<Regex> I<Replacement>
4227 =item B<PluginInstance> I<Regex> I<Replacement>
4229 =item B<TypeInstance> I<Regex> I<Replacement>
4231 Match the appropriate field with the given regular expression I<Regex>. If the
4232 regular expression matches, that part that matches is replaced with
4233 I<Replacement>. If multiple places of the input buffer match a given regular
4234 expression, only the first occurrence will be replaced.
4236 You can specify each option multiple times to use multiple regular expressions
4244 # Replace "example.net" with "example.com"
4245 Host "\\<example.net\\>" "example.com"
4247 # Strip "www." from hostnames
4253 Sets part of the identifier of a value to a given string.
4259 =item B<Host> I<String>
4261 =item B<Plugin> I<String>
4263 =item B<PluginInstance> I<String>
4265 =item B<TypeInstance> I<String>
4267 Set the appropriate field to the given string. The strings for plugin instance
4268 and type instance may be empty, the strings for host and plugin may not be
4269 empty. It's currently not possible to set the type of a value this way.
4276 PluginInstance "coretemp"
4277 TypeInstance "core3"
4282 =head2 Backwards compatibility
4284 If you use collectd with an old configuration, i.E<nbsp>e. one without a
4285 B<Chain> block, it will behave as it used to. This is equivalent to the
4286 following configuration:
4292 If you specify a B<PostCacheChain>, the B<write> target will not be added
4293 anywhere and you will have to make sure that it is called where appropriate. We
4294 suggest to add the above snippet as default target to your "PostCache" chain.
4298 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
4314 L<collectd-exec(5)>,
4315 L<collectd-perl(5)>,
4316 L<collectd-unixsock(5)>,
4329 Florian Forster E<lt>octo@verplant.orgE<gt>